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.6\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-09-01 18:55+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:336 ../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:484
374 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186 ../resize/virt-resize.pod:486 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
379 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:488 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
380 msgid "Display version number and exit."
384 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod: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, and C<file> is the full path to the file."
493 #: ../cat/virt-cat.pod:191 ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:262 ../resize/virt-resize.pod:568 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
494 msgid "SHELL QUOTING"
498 #: ../cat/virt-cat.pod:193 ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:264 ../resize/virt-resize.pod:570 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
500 "Libvirt guest names can contain arbitrary characters, some of which have "
501 "meaning to the shell such as C<#> and space. You may need to quote or "
502 "escape these characters on the command line. See the shell manual page "
503 "L<sh(1)> for details."
507 #: ../cat/virt-cat.pod:198 ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:575 ../test-tool/libguestfs-test-tool.pod:77
512 #: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377 ../resize/virt-resize.pod:577
513 msgid "This program returns 0 if successful, or non-zero if there was an error."
517 #: ../cat/virt-cat.pod:203 ../cat/virt-filesystems.pod:377 ../cat/virt-ls.pod:495 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:308 ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284 ../resize/virt-resize.pod:580 ../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
522 #: ../cat/virt-cat.pod:205
524 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
525 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
529 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:388 ../cat/virt-ls.pod:507 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:601 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:772
534 #: ../cat/virt-cat.pod:214 ../cat/virt-filesystems.pod:390 ../cat/virt-ls.pod:509 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:294 ../resize/virt-resize.pod:603 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
535 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
539 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:392 ../cat/virt-ls.pod:511 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372 ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400 ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:323 ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:61 ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55 ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:605 ../ruby/examples/guestfs-ruby.pod:51 ../src/guestfs.pod: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
544 #: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405 ../resize/virt-resize.pod:607
545 msgid "Copyright (C) 2010-2011 Red Hat Inc."
549 #: ../cat/virt-cat.pod:220 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:609 ../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
551 "This program is free software; you can redistribute it and/or modify it "
552 "under the terms of the GNU General Public License as published by the Free "
553 "Software Foundation; either version 2 of the License, or (at your option) "
558 #: ../cat/virt-cat.pod:225 ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:333 ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:614 ../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
560 "This program is distributed in the hope that it will be useful, but WITHOUT "
561 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
562 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
567 #: ../cat/virt-cat.pod:230 ../cat/virt-filesystems.pod:406 ../cat/virt-ls.pod:525 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:338 ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:619 ../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
569 "You should have received a copy of the GNU General Public License along with "
570 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
571 "Ave, Cambridge, MA 02139, USA."
575 #: ../cat/virt-filesystems.pod:5
577 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
578 "virtual machine or disk image"
582 #: ../cat/virt-filesystems.pod:9
585 " virt-filesystems [--options] -d domname\n"
590 #: ../cat/virt-filesystems.pod:11
593 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
598 #: ../cat/virt-filesystems.pod:15
600 "This tool allows you to discover filesystems, partitions, logical volumes, "
601 "and their sizes in a disk image or virtual machine. It is a replacement for "
602 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
606 #: ../cat/virt-filesystems.pod:20
608 "One use for this tool is from shell scripts to iterate over all filesystems "
613 #: ../cat/virt-filesystems.pod:23
616 " for fs in $(virt-filesystems -a disk.img); do\n"
623 #: ../cat/virt-filesystems.pod:27
625 "Another use is to list partitions before using another tool to modify those "
626 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
627 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
631 #: ../cat/virt-filesystems.pod:32
633 "Various command line options control what this program displays. You need "
634 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
635 "guest respectively. If you just specify that then the program shows "
636 "filesystems found, one per line, like this:"
640 #: ../cat/virt-filesystems.pod:37
643 " $ virt-filesystems -a disk.img\n"
645 " /dev/vg_guest/lv_root\n"
650 #: ../cat/virt-filesystems.pod:41
651 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
655 #: ../cat/virt-filesystems.pod:44
658 " $ virt-filesystems -a disk.img -l\n"
659 " Name Type VFS Label Size\n"
660 " /dev/sda1 filesystem ext4 boot 524288000\n"
661 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
666 #: ../cat/virt-filesystems.pod:49
668 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
673 #: ../cat/virt-filesystems.pod:52
676 " $ virt-filesystems -a disk.img --extra\n"
678 " /dev/vg_guest/lv_root\n"
679 " /dev/vg_guest/lv_swap\n"
680 " /dev/vg_guest/lv_data\n"
685 #: ../cat/virt-filesystems.pod:58
686 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
690 #: ../cat/virt-filesystems.pod:60
693 " $ virt-filesystems -a disk.img --partitions\n"
700 #: ../cat/virt-filesystems.pod:64
702 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
703 "I<--physical-volumes>, I<--block-devices> to list those items."
707 #: ../cat/virt-filesystems.pod:67
709 "You can use these options in combination as well (if you want a combination "
710 "including filesystems, you have to add I<--filesystems>). Notice that some "
711 "items fall into several categories (eg. C</dev/sda1> might be both a "
712 "partition and a filesystem). These items are listed several times. To get "
713 "a list which includes absolutely everything that virt-filesystems knows "
714 "about, use the I<--all> option."
718 #: ../cat/virt-filesystems.pod:74
720 "UUIDs (because they are quite long) are not shown by default. Add the "
721 "I<--uuid> option to display device and filesystem UUIDs in the long output."
725 #: ../cat/virt-filesystems.pod:78
727 "I<--all --long --uuid> is a useful combination to display all possible "
728 "information about everything."
732 #: ../cat/virt-filesystems.pod:81
735 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
736 " Name Type VFS Label Size Parent UUID\n"
737 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
738 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
739 " /dev/sda1 partition - - 100M /dev/sda -\n"
740 " /dev/sda2 partition - - 20G /dev/sda -\n"
741 " /dev/sda device - - 20G - -\n"
746 #: ../cat/virt-filesystems.pod:89
747 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
751 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
756 #: ../cat/virt-filesystems.pod:112
758 "Display everything. This is currently the same as specifying these options: "
759 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
760 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may "
761 "be added to this list in future)."
765 #: ../cat/virt-filesystems.pod:117
766 msgid "See also I<--long>."
770 #: ../cat/virt-filesystems.pod:119
775 #: ../cat/virt-filesystems.pod:121
776 msgid "B<--block-devices>"
780 #: ../cat/virt-filesystems.pod:123
781 msgid "Display block devices."
785 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
790 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
792 "Write out the results in CSV format (comma-separated values). This format "
793 "can be imported easily into databases and spreadsheets, but read L</NOTE "
794 "ABOUT CSV FORMAT> below."
798 #: ../cat/virt-filesystems.pod:150
800 "When prompting for keys and passphrases, virt-filesystems normally turns "
801 "echoing off so you cannot see what you are typing. If you are not worried "
802 "about Tempest attacks and there is no one else in the room you can specify "
803 "this flag to see what you are typing."
807 #: ../cat/virt-filesystems.pod:155
812 #: ../cat/virt-filesystems.pod:157
814 "This causes filesystems that are not ordinary, mountable filesystems to be "
815 "displayed. This category includes swapspace, and filesystems that are empty "
816 "or contain unknown data."
820 #: ../cat/virt-filesystems.pod:161
821 msgid "This option implies I<--filesystems>."
825 #: ../cat/virt-filesystems.pod:163
826 msgid "B<--filesystems>"
830 #: ../cat/virt-filesystems.pod:165
832 "Display mountable filesystems. If no display option was selected then this "
837 #: ../cat/virt-filesystems.pod:168
838 msgid "With I<--extra>, non-mountable filesystems are shown too."
842 #: ../cat/virt-filesystems.pod:181
845 " virt-filesystems --format=raw -a disk.img\n"
850 #: ../cat/virt-filesystems.pod:185
853 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
858 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
863 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
864 msgid "B<--human-readable>"
868 #: ../cat/virt-filesystems.pod:198
869 msgid "In I<--long> mode, display sizes in human-readable format."
873 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
878 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
883 #: ../cat/virt-filesystems.pod:209
884 msgid "Display extra columns of data (\"long format\")."
888 #: ../cat/virt-filesystems.pod:211
889 msgid "A title row is added unless you also specify I<--no-title>."
893 #: ../cat/virt-filesystems.pod:213
895 "The extra columns displayed depend on what output you select, and the "
896 "ordering of columns may change in future versions. Use the title row, "
897 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
902 #: ../cat/virt-filesystems.pod:218
904 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
905 "default is to show raw numbers of I<bytes>."
909 #: ../cat/virt-filesystems.pod:221
910 msgid "Use I<--uuid> to display UUIDs too."
914 #: ../cat/virt-filesystems.pod:223
919 #: ../cat/virt-filesystems.pod:225
924 #: ../cat/virt-filesystems.pod:227
925 msgid "B<--logical-volumes>"
929 #: ../cat/virt-filesystems.pod:229
931 "Display LVM logical volumes. In this mode, these are displayed irrespective "
932 "of whether the LVs contain filesystems."
936 #: ../cat/virt-filesystems.pod:232
937 msgid "B<--no-title>"
941 #: ../cat/virt-filesystems.pod:234
942 msgid "In I<--long> mode, don't add a title row."
946 #: ../cat/virt-filesystems.pod:236
948 "Note that the order of the columns is not fixed, and may change in future "
949 "versions of virt-filesystems, so using this option may give you unexpected "
954 #: ../cat/virt-filesystems.pod:240
959 #: ../cat/virt-filesystems.pod:242
960 msgid "B<--partitions>"
964 #: ../cat/virt-filesystems.pod:244
966 "Display partitions. In this mode, these are displayed irrespective of "
967 "whether the partitions contain filesystems."
971 #: ../cat/virt-filesystems.pod:247
976 #: ../cat/virt-filesystems.pod:249
977 msgid "B<--physvols>"
981 #: ../cat/virt-filesystems.pod:251
982 msgid "B<--physical-volumes>"
986 #: ../cat/virt-filesystems.pod:253
987 msgid "Display LVM physical volumes."
991 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
996 #: ../cat/virt-filesystems.pod:257
1001 #: ../cat/virt-filesystems.pod:259
1002 msgid "In I<--long> mode, display UUIDs as well."
1006 #: ../cat/virt-filesystems.pod:273
1011 #: ../cat/virt-filesystems.pod:275
1012 msgid "B<--volgroups>"
1016 #: ../cat/virt-filesystems.pod:277
1017 msgid "B<--volume-groups>"
1021 #: ../cat/virt-filesystems.pod:279
1022 msgid "Display LVM volume groups."
1026 #: ../cat/virt-filesystems.pod:287
1031 #: ../cat/virt-filesystems.pod:289
1033 "Note that columns in the output are subject to reordering and change in "
1034 "future versions of this tool."
1038 #: ../cat/virt-filesystems.pod:294
1043 #: ../cat/virt-filesystems.pod:296
1044 msgid "The filesystem, partition, block device or LVM name."
1048 #: ../cat/virt-filesystems.pod:298
1050 "For device and partition names these are displayed as canonical libguestfs "
1051 "names, so that for example C</dev/sda2> is the second partition on the first "
1056 #: ../cat/virt-filesystems.pod:302
1058 "If the I<--long> option is B<not> specified, then only the name column is "
1059 "shown in the output."
1063 #: ../cat/virt-filesystems.pod:305
1068 #: ../cat/virt-filesystems.pod:307
1069 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1073 #: ../cat/virt-filesystems.pod:309
1078 #: ../cat/virt-filesystems.pod:311
1080 "If there is a filesystem, then this column displays the filesystem type if "
1081 "one could be detected, eg. C<ext4>."
1085 #: ../cat/virt-filesystems.pod:314
1090 #: ../cat/virt-filesystems.pod:316
1092 "If the object has a label (used for identifying and mounting filesystems) "
1093 "then this column contains the label."
1097 #: ../cat/virt-filesystems.pod:319
1102 #: ../cat/virt-filesystems.pod:321
1104 "The size of the object in bytes. If the I<--human> option is used then the "
1105 "size is displayed in a human-readable form."
1109 #: ../cat/virt-filesystems.pod:324
1114 #: ../cat/virt-filesystems.pod:326
1116 "The parent column records the parent relationship between objects. For "
1117 "example, if the object is a partition, then this column contains the name of "
1118 "the containing device. If the object is a logical volume, then this column "
1119 "is the name of the volume group."
1123 #: ../cat/virt-filesystems.pod:331
1128 #: ../cat/virt-filesystems.pod:333
1130 "If the object has a UUID (used for identifying and mounting filesystems and "
1131 "block devices) then this column contains the UUID as a string."
1135 #: ../cat/virt-filesystems.pod:337
1136 msgid "The UUID is only displayed if the I<--uuid> option is given."
1140 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1141 msgid "NOTE ABOUT CSV FORMAT"
1145 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1147 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1148 "should be easy to parse, but it is definitely not easy to parse."
1152 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1154 "Myth: Just split fields at commas. Reality: This does I<not> work "
1155 "reliably. This example has two columns:"
1159 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1162 " \"foo,bar\",baz\n"
1167 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1169 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1170 "reliably. This example has one row:"
1174 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1183 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1185 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1186 "packaged in major Linux distributions)."
1190 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1192 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1193 "or Python's built-in csv library)."
1197 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1198 msgid "Most spreadsheets and databases can import CSV directly."
1202 #: ../cat/virt-filesystems.pod:379
1204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1205 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1206 "L<http://libguestfs.org/>."
1210 #: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
1211 msgid "Copyright (C) 2010 Red Hat Inc."
1215 #: ../cat/virt-ls.pod:5
1216 msgid "virt-ls - List files in a virtual machine"
1220 #: ../cat/virt-ls.pod:9
1223 " virt-ls [--options] -d domname directory [directory ...]\n"
1228 #: ../cat/virt-ls.pod:11
1231 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1237 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1242 #: ../cat/virt-ls.pod:15
1245 " virt-ls [--options] domname directory\n"
1250 #: ../cat/virt-ls.pod:17
1253 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1258 #: ../cat/virt-ls.pod:21
1260 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1261 "more from a virtual machine or disk image."
1265 #: ../cat/virt-ls.pod:24
1267 "Multiple directory names can be given, in which case the output from each is "
1272 #: ../cat/virt-ls.pod:27
1274 "To list directories from a libvirt guest use the I<-d> option to specify the "
1275 "name of the guest. For a disk image, use the I<-a> option."
1279 #: ../cat/virt-ls.pod:31
1281 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1282 "may need to use L<guestfish(1)>, or write a program directly to the "
1283 "L<guestfs(3)> API."
1287 #: ../cat/virt-ls.pod:37
1288 msgid "Get a list of all files and directories in a virtual machine:"
1292 #: ../cat/virt-ls.pod:39
1295 " virt-ls -R -d guest /\n"
1300 #: ../cat/virt-ls.pod:41
1301 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1305 #: ../cat/virt-ls.pod:43
1308 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1313 #: ../cat/virt-ls.pod:45
1314 msgid "List all public-writable directories in a Linux virtual machine:"
1318 #: ../cat/virt-ls.pod:47
1321 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1326 #: ../cat/virt-ls.pod:49
1327 msgid "List all Unix domain sockets in a Linux virtual machine:"
1331 #: ../cat/virt-ls.pod:51
1334 " virt-ls -lR -d guest / | grep '^s'\n"
1339 #: ../cat/virt-ls.pod:53
1340 msgid "List all regular files with filenames ending in '.png':"
1344 #: ../cat/virt-ls.pod:55
1347 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1352 #: ../cat/virt-ls.pod:57
1353 msgid "To display files larger than 10MB in home directories:"
1357 #: ../cat/virt-ls.pod:59
1360 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1365 #: ../cat/virt-ls.pod:61
1366 msgid "Find everything modified in the last 7 days:"
1370 #: ../cat/virt-ls.pod:63
1373 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1378 #: ../cat/virt-ls.pod:65
1379 msgid "Find regular files modified in the last 24 hours:"
1383 #: ../cat/virt-ls.pod:67
1386 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1391 #: ../cat/virt-ls.pod:69
1392 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1396 #: ../cat/virt-ls.pod:71
1398 "Find the differences between files in a guest and an earlier snapshot of the "
1403 #: ../cat/virt-ls.pod:74
1406 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1407 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1408 " diff -u old new | less\n"
1413 #: ../cat/virt-ls.pod:78
1415 "The commands above won't find files where the content has changed but the "
1416 "metadata (eg. file size and modification date) is the same. To do that, you "
1417 "need to add the I<--checksum> parameter to both C<virt-ls> commands. "
1418 "I<--checksum> can be quite slow since it has to read and compute a checksum "
1419 "of every regular file in the virtual machine."
1423 #: ../cat/virt-ls.pod:84
1424 msgid "OUTPUT MODES"
1428 #: ../cat/virt-ls.pod:86
1430 "C<virt-ls> has four output modes, controlled by different combinations of "
1431 "the I<-l> and I<-R> options."
1435 #: ../cat/virt-ls.pod:89
1436 msgid "SIMPLE LISTING"
1440 #: ../cat/virt-ls.pod:91
1441 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1445 #: ../cat/virt-ls.pod:93
1448 " $ virt-ls -d guest /\n"
1456 #: ../cat/virt-ls.pod:98
1457 msgid "LONG LISTING"
1461 #: ../cat/virt-ls.pod:100
1463 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1464 "(more specifically, like the C<guestfs_ll> function)."
1468 #: ../cat/virt-ls.pod:103
1471 " $ virt-ls -l -d guest /\n"
1473 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1474 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1480 #: ../cat/virt-ls.pod:109
1482 "Note that while this is useful for displaying a directory, do not try "
1483 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1488 #: ../cat/virt-ls.pod:113
1489 msgid "RECURSIVE LISTING"
1493 #: ../cat/virt-ls.pod:115
1495 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1496 "and directories recursively:"
1500 #: ../cat/virt-ls.pod:118
1503 " $ virt-ls -R -d guest /tmp\n"
1511 #: ../cat/virt-ls.pod:123
1513 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1514 "converts C<\\0> characters to C<\\n>."
1518 #: ../cat/virt-ls.pod:126
1519 msgid "RECURSIVE LONG LISTING"
1523 #: ../cat/virt-ls.pod:128
1525 "Using I<-lR> options together changes the output to display directories "
1526 "recursively, with file stats, and optionally other features such as "
1527 "checksums and extended attributes."
1531 #: ../cat/virt-ls.pod:132
1533 "Most of the interesting features of C<virt-ls> are only available when using "
1538 #: ../cat/virt-ls.pod:135
1540 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1541 "you cannot use the output in another program (because filenames can contain "
1542 "spaces and other unsafe characters). If the guest was untrusted and someone "
1543 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1544 "on you by creating filenames with embedded newline characters. To B<safely> "
1545 "parse the output in another program, use the I<--csv> (Comma-Separated "
1550 #: ../cat/virt-ls.pod:143
1552 "Note that this output format is completely unrelated to the C<ls -lR> "
1557 #: ../cat/virt-ls.pod:146
1560 " $ virt-ls -lR -d guest /bin\n"
1561 " d 0555 4096 /bin\n"
1562 " - 0755 123 /bin/alsaunmute\n"
1563 " - 0755 28328 /bin/arch\n"
1564 " l 0777 4 /bin/awk -> gawk\n"
1565 " - 0755 27216 /bin/basename\n"
1566 " - 0755 943360 /bin/bash\n"
1572 #: ../cat/virt-ls.pod:155
1573 msgid "These basic fields are always shown:"
1577 #: ../cat/virt-ls.pod:159
1582 #: ../cat/virt-ls.pod:161
1584 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1585 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1586 "link), C<s> (socket) or C<u> (unknown)."
1590 #: ../cat/virt-ls.pod:171
1595 #: ../cat/virt-ls.pod:173
1596 msgid "The Unix permissions, displayed as a 4 digit octal number."
1600 #: ../cat/virt-ls.pod:175
1605 #: ../cat/virt-ls.pod:177
1607 "The size of the file. This is shown in bytes unless I<-h> or "
1608 "I<--human-readable> option is given, in which case this is shown as a "
1609 "human-readable number."
1613 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4188
1618 #: ../cat/virt-ls.pod:183
1619 msgid "The full path of the file or directory."
1623 #: ../cat/virt-ls.pod:185
1628 #: ../cat/virt-ls.pod:187
1629 msgid "For symbolic links only, the link target."
1633 #: ../cat/virt-ls.pod:191
1635 "In I<-lR> mode, additional command line options enable the display of more "
1640 #: ../cat/virt-ls.pod:194
1642 "With the I<--uids> flag, these additional fields are displayed before the "
1647 #: ../cat/virt-ls.pod:199
1652 #: ../cat/virt-ls.pod:201
1657 #: ../cat/virt-ls.pod:203
1659 "The UID and GID of the owner of the file (displayed numerically). Note "
1660 "these only make sense in the context of a Unix-like guest."
1664 #: ../cat/virt-ls.pod:208
1665 msgid "With the I<--times> flag, these additional fields are displayed:"
1669 #: ../cat/virt-ls.pod:212
1674 #: ../cat/virt-ls.pod:214
1675 msgid "The time of last access."
1679 #: ../cat/virt-ls.pod:216
1684 #: ../cat/virt-ls.pod:218
1685 msgid "The time of last modification."
1689 #: ../cat/virt-ls.pod:220
1694 #: ../cat/virt-ls.pod:222
1695 msgid "The time of last status change."
1699 #: ../cat/virt-ls.pod:226
1701 "The time fields are displayed as string dates and times, unless one of the "
1702 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1706 #: ../cat/virt-ls.pod:229
1707 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1711 #: ../cat/virt-ls.pod:233
1716 #: ../cat/virt-ls.pod:235
1718 "The device containing the file (displayed as major:minor). This may not "
1719 "match devices as known to the guest."
1723 #: ../cat/virt-ls.pod:238
1728 #: ../cat/virt-ls.pod:240
1729 msgid "The inode number."
1733 #: ../cat/virt-ls.pod:242
1738 #: ../cat/virt-ls.pod:244
1739 msgid "The number of hard links."
1743 #: ../cat/virt-ls.pod:246
1748 #: ../cat/virt-ls.pod:248
1749 msgid "For block and char special files, the device (displayed as major:minor)."
1753 #: ../cat/virt-ls.pod:251
1758 #: ../cat/virt-ls.pod:253
1759 msgid "The number of 512 byte blocks allocated to the file."
1763 #: ../cat/virt-ls.pod:257
1765 "With the I<--checksum> flag, the checksum of the file contents is shown "
1766 "(only for regular files). Computing file checksums can take a considerable "
1771 #: ../cat/virt-ls.pod:280
1772 msgid "B<--checksum>"
1776 #: ../cat/virt-ls.pod:282
1777 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
1781 #: ../cat/virt-ls.pod:284
1783 "Display checksum over file contents for regular files. With no argument, "
1784 "this defaults to using I<md5>. Using an argument, you can select the "
1785 "checksum type to use."
1789 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
1791 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
1796 #: ../cat/virt-ls.pod:316
1798 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
1799 "so you cannot see what you are typing. If you are not worried about Tempest "
1800 "attacks and there is no one else in the room you can specify this flag to "
1801 "see what you are typing."
1805 #: ../cat/virt-ls.pod:321
1806 msgid "B<--extra-stats>"
1810 #: ../cat/virt-ls.pod:323
1811 msgid "Display extra stats."
1815 #: ../cat/virt-ls.pod:339
1818 " virt-ls --format=raw -a disk.img /dir\n"
1823 #: ../cat/virt-ls.pod:343
1826 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
1831 #: ../cat/virt-ls.pod:356
1832 msgid "Display file sizes in human-readable format."
1836 #: ../cat/virt-ls.pod:370
1841 #: ../cat/virt-ls.pod:372
1842 msgid "B<--recursive>"
1846 #: ../cat/virt-ls.pod:374
1848 "Select the mode. With neither of these options, C<virt-ls> produces a "
1849 "simple, flat list of the files in the named directory. See L</SIMPLE "
1854 #: ../cat/virt-ls.pod:378
1856 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See "
1861 #: ../cat/virt-ls.pod:381
1863 "C<virt-ls -R> produces a recursive list of files starting at the named "
1864 "directory. See L</RECURSIVE LISTING>."
1868 #: ../cat/virt-ls.pod:384
1870 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
1871 "parsed. See L</RECURSIVE LONG LISTING>."
1875 #: ../cat/virt-ls.pod:387
1880 #: ../cat/virt-ls.pod:389
1881 msgid "Display time fields."
1885 #: ../cat/virt-ls.pod:394
1886 msgid "B<--time-days>"
1890 #: ../cat/virt-ls.pod:396
1891 msgid "Display time fields as days before now (negative if in the future)."
1895 #: ../cat/virt-ls.pod:398
1897 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
1898 "of the file is between 0 and 86399 seconds."
1902 #: ../cat/virt-ls.pod:404
1903 msgid "B<--time-relative>"
1907 #: ../cat/virt-ls.pod:406
1908 msgid "Display time fields as seconds before now (negative if in the future)."
1912 #: ../cat/virt-ls.pod:411
1917 #: ../cat/virt-ls.pod:413
1918 msgid "Display time fields as seconds since the Unix epoch."
1922 #: ../cat/virt-ls.pod:418
1927 #: ../cat/virt-ls.pod:420
1928 msgid "Display UID and GID fields."
1932 #: ../cat/virt-ls.pod:445
1933 msgid "Previous versions of virt-ls allowed you to write either:"
1937 #: ../cat/virt-ls.pod:447
1940 " virt-ls disk.img [disk.img ...] /dir\n"
1945 #: ../cat/virt-ls.pod:451
1948 " virt-ls guestname /dir\n"
1953 #: ../cat/virt-ls.pod:497
1955 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
1956 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
1957 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
1961 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:298
1962 msgid "Copyright (C) 2009-2011 Red Hat Inc."
1966 #: ../df/virt-df.pod:5
1967 msgid "virt-df - Display free space on virtual filesystems"
1971 #: ../df/virt-df.pod:9
1974 " virt-df [--options]\n"
1979 #: ../df/virt-df.pod:11
1982 " virt-df [--options] -d domname\n"
1987 #: ../df/virt-df.pod:13
1990 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
1995 #: ../df/virt-df.pod:17
1998 " virt-df [--options] domname\n"
2003 #: ../df/virt-df.pod:19
2006 " virt-df [--options] disk.img [disk.img ...]\n"
2011 #: ../df/virt-df.pod:23
2013 "C<virt-df> is a command line tool to display free space on virtual machine "
2014 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2015 "allocated to a virtual machine, but can look inside disk images to see how "
2016 "much space is really being used."
2020 #: ../df/virt-df.pod:28
2022 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2023 "to get a list of all active and inactive guests, and performs a C<df>-type "
2024 "operation on each one in turn, printing out the results."
2028 #: ../df/virt-df.pod:32
2030 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
2031 "C<df>-type operation on either the single named libvirt domain, or on the "
2032 "disk image(s) listed on the command line (which must all belong to a single "
2033 "VM). In this mode (with arguments), C<virt-df> will I<only work for a "
2034 "single guest>. If you want to run on multiple guests, then you have to "
2035 "invoke C<virt-df> multiple times."
2039 #: ../df/virt-df.pod:39
2041 "Use the I<--csv> option to get a format which can be easily parsed by other "
2042 "programs. Other options are similar to the standard L<df(1)> command."
2046 #: ../df/virt-df.pod:45
2048 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2049 "output human-readable:"
2053 #: ../df/virt-df.pod:48
2056 " # virt-df -d F14x64 -h\n"
2057 " Filesystem Size Used Available Use%\n"
2058 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2059 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2064 #: ../df/virt-df.pod:53
2065 msgid "Show disk usage for a disk image file called C<test.img>:"
2069 #: ../df/virt-df.pod:55
2072 " $ virt-df -a test1.img\n"
2073 " Filesystem 1K-blocks Used Available Use%\n"
2074 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2079 #: ../df/virt-df.pod:112
2082 " virt-df --format=raw -a disk.img\n"
2087 #: ../df/virt-df.pod:116
2090 " virt-df --format=raw -a disk.img --format -a another.img\n"
2095 #: ../df/virt-df.pod:129
2096 msgid "Print sizes in human-readable format."
2100 #: ../df/virt-df.pod:131
2101 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2105 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2110 #: ../df/virt-df.pod:135
2115 #: ../df/virt-df.pod:137
2116 msgid "Print inodes instead of blocks."
2120 #: ../df/virt-df.pod:139
2121 msgid "B<--one-per-guest>"
2125 #: ../df/virt-df.pod:141
2127 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2128 "disks from several guests to a single libguestfs appliance."
2132 #: ../df/virt-df.pod:144
2133 msgid "You might use this option in the following circumstances:"
2137 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398 ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412 ../fish/guestfish-actions.pod: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:393 ../inspector/virt-inspector.pod:397 ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1679 ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1709 ../src/guestfs-actions.pod:1713 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1926 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod: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
2142 #: ../df/virt-df.pod:150
2144 "If you think an untrusted guest might actively try to exploit the libguestfs "
2145 "appliance kernel, then this prevents one guest from interfering with the "
2146 "stats printed for another guest."
2150 #: ../df/virt-df.pod:156
2152 "If the kernel has a bug which stops it from accessing a filesystem in one "
2153 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2154 "and report stats for further guests."
2158 #: ../df/virt-df.pod:165
2160 "Print UUIDs instead of names. This is useful for following a guest even "
2161 "when the guest is migrated or renamed, or when two guests happen to have the "
2166 #: ../df/virt-df.pod:169
2168 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2169 "images, we still print the disk image name even when this option is "
2174 #: ../df/virt-df.pod:229
2176 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
2177 "L<http://libguestfs.org/>."
2181 #: ../edit/virt-edit.pod:5
2182 msgid "virt-edit - Edit a file in a virtual machine"
2186 #: ../edit/virt-edit.pod:9
2189 " virt-edit [--options] -d domname file [file ...]\n"
2194 #: ../edit/virt-edit.pod:11
2197 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2202 #: ../edit/virt-edit.pod:13
2205 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2210 #: ../edit/virt-edit.pod:17
2213 " virt-edit domname file\n"
2218 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2221 " virt-edit disk.img [disk.img ...] file\n"
2226 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2231 #: ../edit/virt-edit.pod:23
2233 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2234 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2235 "doing this, but doesn't catch all cases."
2239 #: ../edit/virt-edit.pod:29
2241 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2242 "exists in the named virtual machine (or disk image)."
2246 #: ../edit/virt-edit.pod:32
2248 "Multiple filenames can be given, in which case they are each edited in "
2249 "turn. Each filename must be a full path, starting at the root directory "
2250 "(starting with '/')."
2254 #: ../edit/virt-edit.pod:36
2255 msgid "If you want to just view a file, use L<virt-cat(1)>."
2259 #: ../edit/virt-edit.pod:38
2261 "For more complex cases you should look at the L<guestfish(1)> tool (see "
2262 "L</USING GUESTFISH> below)."
2266 #: ../edit/virt-edit.pod:41
2268 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2269 "that and much more."
2273 #: ../edit/virt-edit.pod:46
2274 msgid "Edit the named files interactively:"
2278 #: ../edit/virt-edit.pod:48
2281 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2286 #: ../edit/virt-edit.pod:50
2289 " virt-edit -d mydomain /etc/passwd\n"
2294 #: ../edit/virt-edit.pod:52
2295 msgid "For Windows guests, some Windows paths are understood:"
2299 #: ../edit/virt-edit.pod:54
2302 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2307 #: ../edit/virt-edit.pod:56
2309 "If Perl is installed, you can also edit files non-interactively (see "
2310 "L</NON-INTERACTIVE EDITING> below). To change the init default level to 5:"
2314 #: ../edit/virt-edit.pod:60
2317 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2322 #: ../edit/virt-edit.pod:81
2323 msgid "B<-b> extension"
2327 #: ../edit/virt-edit.pod:83
2328 msgid "B<--backup> extension"
2332 #: ../edit/virt-edit.pod:85
2334 "Create a backup of the original file I<in the guest disk image>. The backup "
2335 "has the original filename with C<extension> added."
2339 #: ../edit/virt-edit.pod:88
2341 "Usually the first character of C<extension> would be a dot C<.> so you would "
2346 #: ../edit/virt-edit.pod:91
2349 " virt-edit -b .orig [etc]\n"
2354 #: ../edit/virt-edit.pod:93
2355 msgid "By default, no backup file is made."
2359 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2364 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2365 msgid "B<--connect URI>"
2369 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
2371 "If you specify guest block devices directly, then libvirt is not used at "
2376 #: ../edit/virt-edit.pod:114
2378 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2379 "off so you cannot see what you are typing. If you are not worried about "
2380 "Tempest attacks and there is no one else in the room you can specify this "
2381 "flag to see what you are typing."
2385 #: ../edit/virt-edit.pod:119
2390 #: ../edit/virt-edit.pod:121
2391 msgid "B<--expr> EXPR"
2395 #: ../edit/virt-edit.pod:123
2397 "Instead of launching the external editor, non-interactively apply the Perl "
2398 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2403 #: ../edit/virt-edit.pod:127
2405 "Be careful to properly quote the expression to prevent it from being altered "
2410 #: ../edit/virt-edit.pod:130
2411 msgid "Note that this option is only available when Perl 5 is installed."
2415 #: ../edit/virt-edit.pod:132
2416 msgid "B<--format> raw|qcow2|..."
2420 #: ../edit/virt-edit.pod:143
2423 " virt-edit --format=raw -a disk.img file\n"
2428 #: ../edit/virt-edit.pod:147
2431 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2436 #: ../edit/virt-edit.pod:181
2437 msgid "Previous versions of virt-edit allowed you to write either:"
2441 #: ../edit/virt-edit.pod:187
2444 " virt-edit guestname file\n"
2449 #: ../edit/virt-edit.pod:195
2450 msgid "NON-INTERACTIVE EDITING"
2454 #: ../edit/virt-edit.pod:197
2456 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2457 "administrator can interactively edit the file."
2461 #: ../edit/virt-edit.pod:200
2463 "There are two ways also to use C<virt-edit> from scripts in order to make "
2464 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2465 "like this, it's less error-prone to write scripts directly using the "
2466 "libguestfs API and Augeas for configuration file editing.)"
2470 #: ../edit/virt-edit.pod:206
2472 "The first method is to temporarily set C<$EDITOR> to any script or program "
2473 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2474 "update C<tmpfile> in place however it likes."
2478 #: ../edit/virt-edit.pod:210
2480 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2481 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2482 "instances of C<foo> with C<bar> in a file:"
2486 #: ../edit/virt-edit.pod:214
2489 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2494 #: ../edit/virt-edit.pod:216
2496 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2497 "For example to delete root's password you could do:"
2501 #: ../edit/virt-edit.pod:219
2504 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2509 #: ../edit/virt-edit.pod:221
2511 "What really happens is that the snippet is evaluated as a Perl expression "
2512 "for each line of the file. The line, including the final C<\\n>, is passed "
2513 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2517 #: ../edit/virt-edit.pod:226
2519 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2520 "C<apache> user account from the password file you can do:"
2524 #: ../edit/virt-edit.pod:229
2527 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2532 #: ../edit/virt-edit.pod:231
2534 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2535 "the end of the file is rather difficult this way since there is no concept "
2536 "of \"last line of the file\" - your expression just doesn't get called "
2537 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2542 #: ../edit/virt-edit.pod:237
2544 "The variable C<$lineno> contains the current line number. As is "
2545 "traditional, the first line in the file is number C<1>."
2549 #: ../edit/virt-edit.pod:240
2551 "The return value from the expression is ignored, but the expression may call "
2552 "C<die> in order to abort the whole program, leaving the original file "
2557 #: ../edit/virt-edit.pod:244
2559 "Remember when matching the end of a line that C<$_> may contain the final "
2560 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2561 "newline then neither of these. Thus to match or substitute some text at the "
2562 "end of a line, use this regular expression:"
2566 #: ../edit/virt-edit.pod:249
2569 " /some text(\\r?\\n)?$/\n"
2574 #: ../edit/virt-edit.pod:251
2576 "Alternately, use the perl C<chomp> function, being careful not to chomp "
2577 "C<$_> itself (since that would remove all newlines from the file):"
2581 #: ../edit/virt-edit.pod:255
2584 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2589 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2590 msgid "WINDOWS PATHS"
2594 #: ../edit/virt-edit.pod:259
2596 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2597 "paths (eg. C<E:\\foo\\bar.txt>)."
2601 #: ../edit/virt-edit.pod:262
2602 msgid "If and only if the guest is running Windows then:"
2606 #: ../edit/virt-edit.pod:268
2608 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2609 "to the correct filesystem."
2613 #: ../edit/virt-edit.pod:273
2615 "Any backslash (C<\\>) characters in the path are replaced with forward "
2616 "slashes so that libguestfs can process it."
2620 #: ../edit/virt-edit.pod:278
2622 "The path is resolved case insensitively to locate the file that should be "
2627 #: ../edit/virt-edit.pod:283
2628 msgid "There are some known shortcomings:"
2632 #: ../edit/virt-edit.pod:289
2633 msgid "Some NTFS symbolic links may not be followed correctly."
2637 #: ../edit/virt-edit.pod:293
2638 msgid "NTFS junction points that cross filesystems are not followed."
2642 #: ../edit/virt-edit.pod:299
2644 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2645 "C<virt-edit> doesn't work."
2649 #: ../edit/virt-edit.pod:302
2650 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2654 #: ../edit/virt-edit.pod:304
2657 " guestfish --rw -i -d domname edit /file\n"
2662 #: ../edit/virt-edit.pod:306
2664 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2669 #: ../edit/virt-edit.pod:309
2671 "The command above uses libguestfs's guest inspection feature and so does not "
2672 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2673 "disk images that don't contain guests. To edit a file on a disk image "
2678 #: ../edit/virt-edit.pod:314
2681 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2686 #: ../edit/virt-edit.pod:316
2688 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2689 "the disk image to edit, and C</file> is the full path to the file."
2693 #: ../edit/virt-edit.pod:320
2695 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2696 "C<write> or C<upload> instead:"
2700 #: ../edit/virt-edit.pod:323
2703 " guestfish --rw -i -d domname touch /newfile\n"
2708 #: ../edit/virt-edit.pod:325
2711 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
2716 #: ../edit/virt-edit.pod:327
2719 " guestfish --rw -i -d domname upload localfile /newfile\n"
2724 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2965 ../test-tool/libguestfs-test-tool.pod:82
2725 msgid "ENVIRONMENT VARIABLES"
2729 #: ../edit/virt-edit.pod:333
2734 #: ../edit/virt-edit.pod:335
2736 "If set, this string is used as the editor. It may contain arguments, "
2737 "eg. C<\"emacs -nw\">"
2741 #: ../edit/virt-edit.pod:338
2742 msgid "If not set, C<vi> is used."
2746 #: ../edit/virt-edit.pod:356
2748 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
2749 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2750 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
2754 #: ../examples/guestfs-examples.pod:5
2755 msgid "guestfs-examples - Examples of using libguestfs from C"
2759 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
2762 " #include <guestfs.h>\n"
2767 #: ../examples/guestfs-examples.pod:11
2770 " guestfs_h *g = guestfs_create ();\n"
2771 " guestfs_add_drive_ro (g, \"disk.img\");\n"
2772 " guestfs_launch (g);\n"
2777 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
2780 " cc prog.c -o prog -lguestfs\n"
2782 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
2787 #: ../examples/guestfs-examples.pod:21
2789 "This manual page contains examples of calling libguestfs from the C "
2790 "programming language. If you are not familiar with using libguestfs, you "
2791 "also need to read L<guestfs(3)>."
2795 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
2796 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2800 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
2805 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
2806 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2810 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
2815 #: ../examples/guestfs-examples.pod:35
2817 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
2818 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
2819 "L<http://libguestfs.org/>."
2823 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396 ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:319 ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod: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
2828 #: ../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:321 ../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
2829 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2833 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96 ../python/examples/guestfs-python.pod:59 ../ruby/examples/guestfs-ruby.pod:53
2834 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
2838 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404 ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98 ../perl/examples/guestfs-perl.pod:59 ../python/examples/guestfs-python.pod:61 ../ruby/examples/guestfs-ruby.pod:55
2840 "The examples in this manual page may be freely copied, modified and "
2841 "distributed without any restrictions."
2845 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407 ../java/examples/guestfs-java.pod:68 ../ocaml/examples/guestfs-ocaml.pod:101 ../perl/examples/guestfs-perl.pod:62 ../python/examples/guestfs-python.pod:64 ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3107
2847 "This library is free software; you can redistribute it and/or modify it "
2848 "under the terms of the GNU Lesser General Public License as published by the "
2849 "Free Software Foundation; either version 2 of the License, or (at your "
2850 "option) any later version."
2854 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412 ../java/examples/guestfs-java.pod:73 ../ocaml/examples/guestfs-ocaml.pod:106 ../perl/examples/guestfs-perl.pod:67 ../python/examples/guestfs-python.pod:69 ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3112
2856 "This library is distributed in the hope that it will be useful, but WITHOUT "
2857 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
2858 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
2863 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417 ../java/examples/guestfs-java.pod:78 ../ocaml/examples/guestfs-ocaml.pod:111 ../perl/examples/guestfs-perl.pod:72 ../python/examples/guestfs-python.pod:74 ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3117
2865 "You should have received a copy of the GNU Lesser General Public License "
2866 "along with this library; if not, write to the Free Software Foundation, "
2867 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
2871 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
2876 #: ../examples/guestfs-recipes.pod:5
2878 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
2879 "here. The only way which works for both sorts of output is to just write "
2880 "the URL directly. Do NOT use L<...> for URLs."
2884 #: ../examples/guestfs-recipes.pod:9
2886 "We break with tradition here and don't use ALL CAPS for the section "
2887 "headings, as this makes them much easier to read."
2891 #: ../examples/guestfs-recipes.pod:16
2892 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
2896 #: ../examples/guestfs-recipes.pod:20
2898 "This page contains recipes for and links to things you can do using "
2899 "libguestfs, L<guestfish(1)> and the virt tools."
2903 #: ../examples/guestfs-recipes.pod:23
2904 msgid "Audit a virtual machine for setuid files"
2908 #: ../examples/guestfs-recipes.pod:25
2910 "The link below contains a small program which can be used to audit a Linux "
2911 "virtual machine to see what setuid and setgid files it contains."
2915 #: ../examples/guestfs-recipes.pod:28
2916 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
2920 #: ../examples/guestfs-recipes.pod:30
2921 msgid "Change the background image in a Windows XP VM"
2925 #: ../examples/guestfs-recipes.pod:32
2927 "The links below explain how to use L<guestfish(1)> to change the background "
2928 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
2929 "be substantially different for each version of Windows."
2933 #: ../examples/guestfs-recipes.pod:37
2935 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
2936 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
2940 #: ../examples/guestfs-recipes.pod:40
2941 msgid "Cloning a virtual machine (Linux)"
2945 #: ../examples/guestfs-recipes.pod:42
2947 "The guestfish technique described in the link below works well for most "
2948 "Linux VMs. Depending on the Linux distro you may need to change the paths "
2953 #: ../examples/guestfs-recipes.pod:46
2954 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
2958 #: ../examples/guestfs-recipes.pod:48
2960 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
2965 #: ../examples/guestfs-recipes.pod:51
2966 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2970 #: ../examples/guestfs-recipes.pod:53
2971 msgid "Cloning a virtual machine (Windows)"
2975 #: ../examples/guestfs-recipes.pod:55
2977 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
2978 "straightforward. Currently there is code in the Aeolus Oz project which "
2979 "does this (using libguestfs). As part of our review of the virt-clone tool, "
2980 "we may add sysprepping ability."
2984 #: ../examples/guestfs-recipes.pod:60
2986 "https://github.com/clalancette/oz "
2987 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2991 #: ../examples/guestfs-recipes.pod:63
2992 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
2996 #: ../examples/guestfs-recipes.pod:65
2997 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3001 #: ../examples/guestfs-recipes.pod:67
3004 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3009 #: ../examples/guestfs-recipes.pod:69
3010 msgid "To export just a subdirectory, eg. C</files>, do:"
3014 #: ../examples/guestfs-recipes.pod:71
3017 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3022 #: ../examples/guestfs-recipes.pod:73
3023 msgid "Create empty disk images"
3027 #: ../examples/guestfs-recipes.pod:75
3029 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3030 "The useful guide below explains the options available."
3034 #: ../examples/guestfs-recipes.pod:78
3035 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3039 #: ../examples/guestfs-recipes.pod:80
3040 msgid "Dump raw filesystem content from inside a disk image or VM"
3044 #: ../examples/guestfs-recipes.pod:82
3046 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3047 "filesystem content from any filesystem in a disk image or a VM (even one "
3048 "which is encrypted or buried inside an LV):"
3052 #: ../examples/guestfs-recipes.pod:86
3055 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3060 #: ../examples/guestfs-recipes.pod:88
3063 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3068 #: ../examples/guestfs-recipes.pod:90
3069 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3073 #: ../examples/guestfs-recipes.pod:92
3074 msgid "Edit grub configuration in a VM"
3078 #: ../examples/guestfs-recipes.pod:94
3079 msgid "You can use this to:"
3083 #: ../examples/guestfs-recipes.pod:100
3084 msgid "Fix a virtual machine that does not boot."
3088 #: ../examples/guestfs-recipes.pod:104
3089 msgid "Change which kernel is used to boot the VM."
3093 #: ../examples/guestfs-recipes.pod:108
3094 msgid "Change kernel command line options."
3098 #: ../examples/guestfs-recipes.pod:112
3099 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3103 #: ../examples/guestfs-recipes.pod:114
3106 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3111 #: ../examples/guestfs-recipes.pod:116
3113 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3118 #: ../examples/guestfs-recipes.pod:119
3121 " virt-rescue -d BrokenGuest\n"
3126 #: ../examples/guestfs-recipes.pod:121
3127 msgid "Export any directory from a VM"
3131 #: ../examples/guestfs-recipes.pod:123
3132 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3136 #: ../examples/guestfs-recipes.pod:126
3139 " virt-copy-out -d Guest /home .\n"
3144 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod: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
3149 #: ../examples/guestfs-recipes.pod:134
3151 "The final dot of the command is not a printing error. It means we want to "
3152 "copy out to the current directory."
3156 #: ../examples/guestfs-recipes.pod:139
3157 msgid "This creates a directory called C<home> under the current directory."
3161 #: ../examples/guestfs-recipes.pod:143
3163 "If the guest is a Windows guest then you can use drive letters and "
3164 "backslashes, but you must prefix the path with C<win:> and quote it to "
3165 "protect it from the shell, like this:"
3169 #: ../examples/guestfs-recipes.pod:147
3172 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3177 #: ../examples/guestfs-recipes.pod:149
3178 msgid "To get the output as a compressed tarball, do:"
3182 #: ../examples/guestfs-recipes.pod:151
3185 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3190 #: ../examples/guestfs-recipes.pod:153
3192 "Although it sounds tempting, this is usually not a reliable way to get a "
3193 "backup from a running guest. See the entry in the FAQ: "
3194 "http://libguestfs.org/FAQ.html#backup"
3198 #: ../examples/guestfs-recipes.pod:157
3199 msgid "Find out which user is using the most space"
3203 #: ../examples/guestfs-recipes.pod:159
3205 "This simple script examines a Linux guest to find out which user is using "
3206 "the most space in their home directory:"
3210 #: ../examples/guestfs-recipes.pod:162
3218 #: ../examples/guestfs-recipes.pod:164
3226 #: ../examples/guestfs-recipes.pod:166
3235 #: ../examples/guestfs-recipes.pod:169
3238 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3243 #: ../examples/guestfs-recipes.pod:171
3246 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3247 " echo -n \"$dir/$d\"\n"
3249 " guestfish --remote du \"$dir/$d\";\n"
3250 " done | sort -nr -k 2\n"
3255 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3258 " guestfish --remote exit\n"
3263 #: ../examples/guestfs-recipes.pod:179
3264 msgid "Get DHCP address from a VM"
3268 #: ../examples/guestfs-recipes.pod:181
3270 "The link below explains the many different possible techniques for getting "
3271 "the last assigned DHCP address of a virtual machine."
3275 #: ../examples/guestfs-recipes.pod:184
3276 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3280 #: ../examples/guestfs-recipes.pod:186
3282 "In the libguestfs source examples directory you will find the latest version "
3283 "of the C<virt-dhcp-address.c> program."
3287 #: ../examples/guestfs-recipes.pod:189
3288 msgid "Get the operating system product name string"
3292 #: ../examples/guestfs-recipes.pod:191
3293 msgid "Save the following script into a file called C<product-name.sh>:"
3297 #: ../examples/guestfs-recipes.pod:193
3302 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3303 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3304 " guestfish --remote inspect-get-product-name \"$root\"\n"
3305 " guestfish --remote exit\n"
3310 #: ../examples/guestfs-recipes.pod:200
3311 msgid "Make the script executable and run it on a named guest:"
3315 #: ../examples/guestfs-recipes.pod:202
3318 " # product-name.sh RHEL60x64\n"
3319 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3324 #: ../examples/guestfs-recipes.pod:205
3326 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3327 "C<xpath> command line tool or from your favourite programming language:"
3331 #: ../examples/guestfs-recipes.pod:209
3334 " # virt-inspector RHEL60x64 > xml\n"
3335 " # xpath '//product_name' < xml\n"
3338 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3339 "(Santiago)</product_name>\n"
3344 #: ../examples/guestfs-recipes.pod:215
3345 msgid "Get the default boot kernel for a Linux VM"
3349 #: ../examples/guestfs-recipes.pod:217
3351 "The link below contains a program to print the default boot kernel for a "
3356 #: ../examples/guestfs-recipes.pod:220
3357 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3361 #: ../examples/guestfs-recipes.pod:222
3363 "It uses Augeas, and the technique is generally applicable for many different "
3368 #: ../examples/guestfs-recipes.pod:229
3369 msgid "listing the user accounts in the guest"
3373 #: ../examples/guestfs-recipes.pod:233
3374 msgid "what repositories is it configured to use"
3378 #: ../examples/guestfs-recipes.pod:237
3379 msgid "what NTP servers does it connect to"
3383 #: ../examples/guestfs-recipes.pod:241
3384 msgid "what were the boot messages last time it booted"
3388 #: ../examples/guestfs-recipes.pod:245
3389 msgid "listing who was logged in recently"
3393 #: ../examples/guestfs-recipes.pod:249
3394 msgid "http://augeas.net/"
3398 #: ../examples/guestfs-recipes.pod:251
3399 msgid "Install RPMs in a guest"
3403 #: ../examples/guestfs-recipes.pod:253
3405 "The link below contains a method to install RPMs in a guest. In fact the "
3406 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3407 "installs them next time the guest is booted. You could use this technique "
3408 "to install vital security updates in an offline guest."
3412 #: ../examples/guestfs-recipes.pod:259
3413 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3417 #: ../examples/guestfs-recipes.pod:261
3418 msgid "List applications installed in a VM"
3422 #: ../examples/guestfs-recipes.pod:263
3423 msgid "Save the following to a file C<list-apps.sh>:"
3427 #: ../examples/guestfs-recipes.pod:265
3432 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3433 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3434 " guestfish --remote inspect-list-applications \"$root\"\n"
3435 " guestfish --remote exit\n"
3440 #: ../examples/guestfs-recipes.pod:272
3442 "Make the file executable and then you can run it on any named virtual "
3447 #: ../examples/guestfs-recipes.pod:275
3450 " # list-apps.sh WinGuest\n"
3452 " app_name: Mozilla Firefox (3.6.12)\n"
3453 " app_display_name: Mozilla Firefox (3.6.12)\n"
3455 " app_version: 3.6.12 (en-GB)\n"
3457 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3458 " app_trans_path:\n"
3459 " app_publisher: Mozilla\n"
3460 " app_url: http://www.mozilla.com/en-GB/\n"
3461 " app_source_package:\n"
3463 " app_description: Mozilla Firefox\n"
3466 " app_name: VLC media player\n"
3467 " app_display_name: VLC media player 1.1.5\n"
3469 " app_version: 1.1.5\n"
3471 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3472 " app_trans_path:\n"
3473 " app_publisher: VideoLAN\n"
3474 " app_url: http://www.videolan.org/\n"
3475 " app_source_package:\n"
3477 " app_description:\n"
3483 #: ../examples/guestfs-recipes.pod:305
3485 "If you want to run the script on disk images (instead of libvirt virtual "
3486 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
3487 "L<virt-inspector(1)>."
3491 #: ../examples/guestfs-recipes.pod:309
3492 msgid "List files and directories in a VM"
3496 #: ../examples/guestfs-recipes.pod:311
3497 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3501 #: ../examples/guestfs-recipes.pod:313
3504 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3509 #: ../examples/guestfs-recipes.pod:315
3510 msgid "List services in a Windows VM"
3514 #: ../examples/guestfs-recipes.pod:317
3516 "The link below contains a script that can be used to list out the services "
3517 "from a Windows VM, and whether those services run at boot time or are loaded "
3522 #: ../examples/guestfs-recipes.pod:321
3523 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3527 #: ../examples/guestfs-recipes.pod:323
3528 msgid "Make a disk image sparse"
3532 #: ../examples/guestfs-recipes.pod:325
3534 "The link below contains some guides for making a disk image sparse (or "
3535 "reintroducing sparseness)."
3539 #: ../examples/guestfs-recipes.pod:328
3540 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3544 #: ../examples/guestfs-recipes.pod:330
3545 msgid "Monitor disk usage over time"
3549 #: ../examples/guestfs-recipes.pod:332
3551 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3552 "The link below contains a guide."
3556 #: ../examples/guestfs-recipes.pod:335
3557 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3561 #: ../examples/guestfs-recipes.pod:337
3562 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3566 #: ../examples/guestfs-recipes.pod:339
3568 "L<guestfish(1)> plus the tools described in the link below can be used to "
3569 "read out the Windows Event Log from any virtual machine running Windows "
3570 "Vista or a later version."
3574 #: ../examples/guestfs-recipes.pod:343
3575 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3579 #: ../examples/guestfs-recipes.pod:345
3580 msgid "Remove root password (Linux)"
3584 #: ../examples/guestfs-recipes.pod:347
3586 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3587 "files. One use is to remove the root password from a Linux guest:"
3591 #: ../examples/guestfs-recipes.pod:350
3594 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3599 #: ../examples/guestfs-recipes.pod:352
3600 msgid "Remove Administrator password (Windows)"
3604 #: ../examples/guestfs-recipes.pod:354
3606 "The link below contains one technique for removing the Administrator "
3607 "password from a Windows VM, or to be more precise, it gives you a command "
3608 "prompt the next time you log in which you can use to bypass any security:"
3612 #: ../examples/guestfs-recipes.pod:359
3613 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3617 #: ../examples/guestfs-recipes.pod:361
3618 msgid "Unpack a live CD"
3622 #: ../examples/guestfs-recipes.pod:363
3624 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3625 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
3626 "layers, as outlined in the guide below."
3630 #: ../examples/guestfs-recipes.pod:367
3631 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3635 #: ../examples/guestfs-recipes.pod:369
3636 msgid "Uploading and downloading files"
3640 #: ../examples/guestfs-recipes.pod:371
3642 "The link below contains general tips on uploading (copying in) and "
3643 "downloading (copying out) files from VMs."
3647 #: ../examples/guestfs-recipes.pod:374
3648 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3652 #: ../examples/guestfs-recipes.pod:376
3653 msgid "Use libguestfs tools on VMware ESX guests"
3657 #: ../examples/guestfs-recipes.pod:378
3659 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3660 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3664 #: ../examples/guestfs-recipes.pod:382
3665 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3669 #: ../examples/guestfs-recipes.pod:386
3671 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
3672 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3673 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3677 #: ../examples/guestfs-recipes.pod:402
3678 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3682 #: ../fish/guestfish-actions.pod:1
3687 #: ../fish/guestfish-actions.pod:3
3690 " add-cdrom filename\n"
3695 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:7
3696 msgid "This function adds a virtual CD-ROM disk image to the guest."
3700 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
3701 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3705 #: ../fish/guestfish-actions.pod:15
3707 "This call checks for the existence of C<filename>. This stops you from "
3708 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3709 "and C<http:> URLs. To specify those, use the general L</config> call "
3714 #: ../fish/guestfish-actions.pod:22
3716 "If you just want to add an ISO file (often you use this as an efficient way "
3717 "to transfer large files into the guest), then you should probably use "
3718 "L</add-drive-ro> instead."
3722 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3724 "This function is deprecated. In new code, use the L</add_drive_opts> call "
3729 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:991 ../fish/guestfish-actions.pod:1351 ../fish/guestfish-actions.pod:1365 ../fish/guestfish-actions.pod: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:5198 ../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:7897
3731 "Deprecated functions will not be removed from the API, but the fact that "
3732 "they are deprecated indicates that there are problems with correct use of "
3737 #: ../fish/guestfish-actions.pod:35
3742 #: ../fish/guestfish-actions.pod:37
3747 #: ../fish/guestfish-actions.pod:39
3750 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3756 #: ../fish/guestfish-actions.pod:41
3758 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3759 "It works by connecting to libvirt, requesting the domain and domain XML from "
3760 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3764 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3766 "The number of disks added is returned. This operation is atomic: if an "
3767 "error is returned, then no disks are added."
3771 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3773 "This function does some minimal checks to make sure the libvirt domain is "
3774 "not running (unless C<readonly> is true). In a future version we will try "
3775 "to acquire the libvirt lock on each disk."
3779 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3781 "Disks must be accessible locally. This often means that adding disks from a "
3782 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3783 "unless those disks are accessible via the same device path locally too."
3787 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3789 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3790 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
3791 "default libvirt URI (or one set through an environment variable, see the "
3792 "libvirt documentation for full details)."
3796 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3798 "The optional C<live> flag controls whether this call will try to connect to "
3799 "a running virtual machine C<guestfsd> process if it sees a suitable "
3800 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
3801 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
3802 "DAEMONS> for more information."
3806 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
3808 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
3809 "passed instead of the domain name. The C<dom> string is treated as a UUID "
3810 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
3815 #: ../fish/guestfish-actions.pod:76
3817 "The other optional parameters are passed directly through to "
3818 "L</add-drive-opts>."
3822 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1973 ../fish/guestfish-actions.pod:3139 ../fish/guestfish-actions.pod:3312 ../fish/guestfish-actions.pod:3447
3824 "This command has one or more optional arguments. See L</OPTIONAL "
3829 #: ../fish/guestfish-actions.pod:81
3834 #: ../fish/guestfish-actions.pod:83
3837 " add-drive filename\n"
3842 #: ../fish/guestfish-actions.pod:85
3844 "This function is the equivalent of calling L</add-drive-opts> with no "
3845 "optional parameters, so the disk is added writable, with the format being "
3846 "detected automatically."
3850 #: ../fish/guestfish-actions.pod:89
3852 "Automatic detection of the format opens you up to a potential security hole "
3853 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3854 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3855 "you should think about replacing calls to this function with calls to "
3856 "L</add-drive-opts>, and specifying the format."
3860 #: ../fish/guestfish-actions.pod:96
3861 msgid "add-drive-opts"
3865 #: ../fish/guestfish-actions.pod:98
3870 #: ../fish/guestfish-actions.pod:100
3873 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
3878 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
3880 "This function adds a virtual machine disk image C<filename> to libguestfs. "
3881 "The first time you call this function, the disk appears as C</dev/sda>, the "
3882 "second time as C</dev/sdb>, and so on."
3886 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
3888 "You don't necessarily need to be root when using libguestfs. However you "
3889 "obviously do need sufficient permissions to access the filename for whatever "
3890 "operations you want to perform (ie. read access if you just want to read the "
3891 "image or write access if you want to modify the image)."
3895 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
3896 msgid "This call checks that C<filename> exists."
3900 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3101 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4660
3901 msgid "The optional arguments are:"
3905 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
3910 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
3912 "If true then the image is treated as read-only. Writes are still allowed, "
3913 "but they are stored in a temporary snapshot overlay which is discarded at "
3914 "the end. The disk that you add is not modified."
3918 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
3923 #: ../fish/guestfish-actions.pod:127
3925 "This forces the image format. If you omit this (or use L</add-drive> or "
3926 "L</add-drive-ro>) then the format is automatically detected. Possible "
3927 "formats include C<raw> and C<qcow2>."
3931 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
3933 "Automatic detection of the format opens you up to a potential security hole "
3934 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3935 "RHBZ#642934. Specifying the format closes this security hole."
3939 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
3944 #: ../fish/guestfish-actions.pod:138
3946 "This rarely-used option lets you emulate the behaviour of the deprecated "
3947 "L</add-drive-with-if> call (q.v.)"
3951 #: ../fish/guestfish-actions.pod:145
3952 msgid "add-drive-ro"
3956 #: ../fish/guestfish-actions.pod:147
3961 #: ../fish/guestfish-actions.pod:149
3964 " add-drive-ro filename\n"
3969 #: ../fish/guestfish-actions.pod:151
3971 "This function is the equivalent of calling L</add-drive-opts> with the "
3972 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
3973 "is added read-only, with the format being detected automatically."
3977 #: ../fish/guestfish-actions.pod:156
3978 msgid "add-drive-ro-with-if"
3982 #: ../fish/guestfish-actions.pod:158
3985 " add-drive-ro-with-if filename iface\n"
3990 #: ../fish/guestfish-actions.pod:160
3992 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
3993 "interface emulation to use at run time."
3997 #: ../fish/guestfish-actions.pod:170
3998 msgid "add-drive-with-if"
4002 #: ../fish/guestfish-actions.pod:172
4005 " add-drive-with-if filename iface\n"
4010 #: ../fish/guestfish-actions.pod:174
4012 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4013 "interface emulation to use at run time."
4017 #: ../fish/guestfish-actions.pod:184
4022 #: ../fish/guestfish-actions.pod:186
4025 " aug-clear augpath\n"
4030 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4032 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4033 "L<augtool(1)> C<clear> command."
4037 #: ../fish/guestfish-actions.pod:191
4042 #: ../fish/guestfish-actions.pod:193
4050 #: ../fish/guestfish-actions.pod:195
4052 "Close the current Augeas handle and free up any resources used by it. After "
4053 "calling this, you have to call L</aug-init> again before you can use any "
4054 "other Augeas functions."
4058 #: ../fish/guestfish-actions.pod:200
4063 #: ../fish/guestfish-actions.pod:202
4066 " aug-defnode name expr val\n"
4071 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4072 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4076 #: ../fish/guestfish-actions.pod:207
4078 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4079 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4080 "containing that single node."
4084 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4086 "On success this returns a pair containing the number of nodes in the "
4087 "nodeset, and a boolean flag if a node was created."
4091 #: ../fish/guestfish-actions.pod:215
4096 #: ../fish/guestfish-actions.pod:217
4099 " aug-defvar name expr\n"
4104 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4106 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4107 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4111 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4113 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4114 "evaluates to something which is not a nodeset."
4118 #: ../fish/guestfish-actions.pod:226
4123 #: ../fish/guestfish-actions.pod:228
4126 " aug-get augpath\n"
4131 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4133 "Look up the value associated with C<path>. If C<path> matches exactly one "
4134 "node, the C<value> is returned."
4138 #: ../fish/guestfish-actions.pod:233
4143 #: ../fish/guestfish-actions.pod:235
4146 " aug-init root flags\n"
4151 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4153 "Create a new Augeas handle for editing configuration files. If there was "
4154 "any previous Augeas handle associated with this guestfs session, then it is "
4159 #: ../fish/guestfish-actions.pod:241
4160 msgid "You must call this before using any other L</aug-*> commands."
4164 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4165 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4169 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4171 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4172 "logical I<or> of the following integers:"
4176 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4177 msgid "C<AUG_SAVE_BACKUP> = 1"
4181 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4182 msgid "Keep the original file with a C<.augsave> extension."
4186 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4187 msgid "C<AUG_SAVE_NEWFILE> = 2"
4191 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4193 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4194 "original. Overrides C<AUG_SAVE_BACKUP>."
4198 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4199 msgid "C<AUG_TYPE_CHECK> = 4"
4203 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4204 msgid "Typecheck lenses."
4208 #: ../fish/guestfish-actions.pod:266
4210 "This option is only useful when debugging Augeas lenses. Use of this option "
4211 "may require additional memory for the libguestfs appliance. You may need to "
4212 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4216 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4217 msgid "C<AUG_NO_STDINC> = 8"
4221 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4222 msgid "Do not use standard load path for modules."
4226 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4227 msgid "C<AUG_SAVE_NOOP> = 16"
4231 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4232 msgid "Make save a no-op, just record what would have been changed."
4236 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4237 msgid "C<AUG_NO_LOAD> = 32"
4241 #: ../fish/guestfish-actions.pod:281
4242 msgid "Do not load the tree in L</aug-init>."
4246 #: ../fish/guestfish-actions.pod:285
4247 msgid "To close the handle, you can call L</aug-close>."
4251 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4252 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4256 #: ../fish/guestfish-actions.pod:289
4261 #: ../fish/guestfish-actions.pod:291
4264 " aug-insert augpath label true|false\n"
4269 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4271 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4272 "or after C<path> (depending on the boolean flag C<before>)."
4276 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4278 "C<path> must match exactly one existing node in the tree, and C<label> must "
4279 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4283 #: ../fish/guestfish-actions.pod:301
4288 #: ../fish/guestfish-actions.pod:303
4296 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4297 msgid "Load files into the tree."
4301 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4302 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4306 #: ../fish/guestfish-actions.pod:310
4311 #: ../fish/guestfish-actions.pod:312
4319 #: ../fish/guestfish-actions.pod:314
4321 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4322 "resulting nodes into alphabetical order."
4326 #: ../fish/guestfish-actions.pod:317
4331 #: ../fish/guestfish-actions.pod:319
4334 " aug-match augpath\n"
4339 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4341 "Returns a list of paths which match the path expression C<path>. The "
4342 "returned paths are sufficiently qualified so that they match exactly one "
4343 "node in the current tree."
4347 #: ../fish/guestfish-actions.pod:325
4352 #: ../fish/guestfish-actions.pod:327
4355 " aug-mv src dest\n"
4360 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4362 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4363 "C<dest> is overwritten if it exists."
4367 #: ../fish/guestfish-actions.pod:332
4372 #: ../fish/guestfish-actions.pod:334
4380 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4381 msgid "Remove C<path> and all of its children."
4385 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4386 msgid "On success this returns the number of entries which were removed."
4390 #: ../fish/guestfish-actions.pod:340
4395 #: ../fish/guestfish-actions.pod:342
4403 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4404 msgid "This writes all pending changes to disk."
4408 #: ../fish/guestfish-actions.pod:346
4410 "The flags which were passed to L</aug-init> affect exactly how files are "
4415 #: ../fish/guestfish-actions.pod:349
4420 #: ../fish/guestfish-actions.pod:351
4423 " aug-set augpath val\n"
4428 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4429 msgid "Set the value associated with C<path> to C<val>."
4433 #: ../fish/guestfish-actions.pod:355
4435 "In the Augeas API, it is possible to clear a node by setting the value to "
4436 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4437 "this call. Instead you must use the L</aug-clear> call."
4441 #: ../fish/guestfish-actions.pod:360
4446 #: ../fish/guestfish-actions.pod:362
4449 " available 'groups ...'\n"
4454 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4456 "This command is used to check the availability of some groups of "
4457 "functionality in the appliance, which not all builds of the libguestfs "
4458 "appliance will be able to provide."
4462 #: ../fish/guestfish-actions.pod:368
4464 "The libguestfs groups, and the functions that those groups correspond to, "
4465 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4466 "runtime by calling L</available-all-groups>."
4470 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4472 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4473 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4474 "and Augeas (configuration file editing) functions."
4478 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4479 msgid "The command returns no error if I<all> requested groups are available."
4483 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4485 "It fails with an error if one or more of the requested groups is unavailable "
4490 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4492 "If an unknown group name is included in the list of groups then an error is "
4497 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4502 #: ../fish/guestfish-actions.pod:392
4503 msgid "You must call L</launch> before calling this function."
4507 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4509 "The reason is because we don't know what groups are supported by the "
4510 "appliance/daemon until it is running and can be queried."
4514 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4516 "If a group of functions is available, this does not necessarily mean that "
4517 "they will work. You still have to check for errors when calling individual "
4518 "API functions even if they are available."
4522 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4524 "It is usually the job of distro packagers to build complete functionality "
4525 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4526 "with all requirements satisfied, will support everything."
4530 #: ../fish/guestfish-actions.pod:414
4532 "This call was added in version C<1.0.80>. In previous versions of "
4533 "libguestfs all you could do would be to speculatively execute a command to "
4534 "find out if the daemon implemented it. See also L</version>."
4538 #: ../fish/guestfish-actions.pod:421
4539 msgid "available-all-groups"
4543 #: ../fish/guestfish-actions.pod:423
4546 " available-all-groups\n"
4551 #: ../fish/guestfish-actions.pod:425
4553 "This command returns a list of all optional groups that this daemon knows "
4554 "about. Note this returns both supported and unsupported groups. To find "
4555 "out which ones the daemon can actually support you have to call "
4556 "L</available> on each member of the returned list."
4560 #: ../fish/guestfish-actions.pod:431
4561 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4565 #: ../fish/guestfish-actions.pod:433
4570 #: ../fish/guestfish-actions.pod:435
4573 " base64-in (base64file|-) filename\n"
4578 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4579 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4583 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:867 ../fish/guestfish-actions.pod:886 ../fish/guestfish-actions.pod:1260 ../fish/guestfish-actions.pod: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
4584 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4588 #: ../fish/guestfish-actions.pod:442
4593 #: ../fish/guestfish-actions.pod:444
4596 " base64-out filename (base64file|-)\n"
4601 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
4603 "This command downloads the contents of C<filename>, writing it out to local "
4604 "file C<base64file> encoded as base64."
4608 #: ../fish/guestfish-actions.pod:451
4609 msgid "blockdev-flushbufs"
4613 #: ../fish/guestfish-actions.pod:453
4616 " blockdev-flushbufs device\n"
4621 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
4622 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4626 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513 ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532 ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
4627 msgid "This uses the L<blockdev(8)> command."
4631 #: ../fish/guestfish-actions.pod:460
4632 msgid "blockdev-getbsz"
4636 #: ../fish/guestfish-actions.pod:462
4639 " blockdev-getbsz device\n"
4644 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
4645 msgid "This returns the block size of a device."
4649 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
4651 "(Note this is different from both I<size in blocks> and I<filesystem block "
4656 #: ../fish/guestfish-actions.pod:471
4657 msgid "blockdev-getro"
4661 #: ../fish/guestfish-actions.pod:473
4664 " blockdev-getro device\n"
4669 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
4671 "Returns a boolean indicating if the block device is read-only (true if "
4672 "read-only, false if not)."
4676 #: ../fish/guestfish-actions.pod:480
4677 msgid "blockdev-getsize64"
4681 #: ../fish/guestfish-actions.pod:482
4684 " blockdev-getsize64 device\n"
4689 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
4690 msgid "This returns the size of the device in bytes."
4694 #: ../fish/guestfish-actions.pod:486
4695 msgid "See also L</blockdev-getsz>."
4699 #: ../fish/guestfish-actions.pod:490
4700 msgid "blockdev-getss"
4704 #: ../fish/guestfish-actions.pod:492
4707 " blockdev-getss device\n"
4712 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
4714 "This returns the size of sectors on a block device. Usually 512, but can be "
4715 "larger for modern devices."
4719 #: ../fish/guestfish-actions.pod:497
4720 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4724 #: ../fish/guestfish-actions.pod:502
4725 msgid "blockdev-getsz"
4729 #: ../fish/guestfish-actions.pod:504
4732 " blockdev-getsz device\n"
4737 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
4739 "This returns the size of the device in units of 512-byte sectors (even if "
4740 "the sectorsize isn't 512 bytes ... weird)."
4744 #: ../fish/guestfish-actions.pod:509
4746 "See also L</blockdev-getss> for the real sector size of the device, and "
4747 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4751 #: ../fish/guestfish-actions.pod:515
4752 msgid "blockdev-rereadpt"
4756 #: ../fish/guestfish-actions.pod:517
4759 " blockdev-rereadpt device\n"
4764 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
4765 msgid "Reread the partition table on C<device>."
4769 #: ../fish/guestfish-actions.pod:523
4770 msgid "blockdev-setbsz"
4774 #: ../fish/guestfish-actions.pod:525
4777 " blockdev-setbsz device blocksize\n"
4782 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
4783 msgid "This sets the block size of a device."
4787 #: ../fish/guestfish-actions.pod:534
4788 msgid "blockdev-setro"
4792 #: ../fish/guestfish-actions.pod:536
4795 " blockdev-setro device\n"
4800 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
4801 msgid "Sets the block device named C<device> to read-only."
4805 #: ../fish/guestfish-actions.pod:542
4806 msgid "blockdev-setrw"
4810 #: ../fish/guestfish-actions.pod:544
4813 " blockdev-setrw device\n"
4818 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
4819 msgid "Sets the block device named C<device> to read-write."
4823 #: ../fish/guestfish-actions.pod:550
4824 msgid "btrfs-filesystem-resize"
4828 #: ../fish/guestfish-actions.pod:552
4831 " btrfs-filesystem-resize mountpoint [size:..]\n"
4836 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
4837 msgid "This command resizes a btrfs filesystem."
4841 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
4843 "Note that unlike other resize calls, the filesystem has to be mounted and "
4844 "the parameter is the mountpoint not the device (this is a requirement of "
4849 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3422 ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5194
4850 msgid "The optional parameters are:"
4854 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3426 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5198
4859 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
4861 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
4862 "resized to the maximum size."
4866 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
4867 msgid "See also L<btrfs(8)>."
4871 #: ../fish/guestfish-actions.pod:575
4872 msgid "case-sensitive-path"
4876 #: ../fish/guestfish-actions.pod:577
4879 " case-sensitive-path path\n"
4884 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
4886 "This can be used to resolve case insensitive paths on a filesystem which is "
4887 "case sensitive. The use case is to resolve paths which you have read from "
4888 "Windows configuration files or the Windows Registry, to the true path."
4892 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
4894 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
4895 "(and probably others), which is that although the underlying filesystem is "
4896 "case-insensitive, the driver exports the filesystem to Linux as "
4901 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
4903 "One consequence of this is that special directories such as C<c:\\windows> "
4904 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
4905 "precise details of how they were created. In Windows itself this would not "
4910 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
4912 "Bug or feature? You decide: "
4913 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
4917 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
4919 "This function resolves the true case of each element in the path and returns "
4920 "the case-sensitive path."
4924 #: ../fish/guestfish-actions.pod:601
4926 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
4927 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
4928 "how the directories were originally created under Windows)."
4932 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
4933 msgid "I<Note>: This function does not handle drive names, backslashes etc."
4937 #: ../fish/guestfish-actions.pod:609
4938 msgid "See also L</realpath>."
4942 #: ../fish/guestfish-actions.pod:611
4947 #: ../fish/guestfish-actions.pod:613
4955 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3842 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5837
4956 msgid "Return the contents of the file named C<path>."
4960 #: ../fish/guestfish-actions.pod:617
4962 "Note that this function cannot correctly handle binary files (specifically, "
4963 "files containing C<\\0> character which is treated as end of string). For "
4964 "those you need to use the L</read-file> or L</download> functions which have "
4965 "a more complex interface."
4969 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757 ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:955 ../fish/guestfish-actions.pod:1022 ../fish/guestfish-actions.pod:1032 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod: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:5170 ../fish/guestfish-actions.pod:5180 ../fish/guestfish-actions.pod:5209 ../fish/guestfish-actions.pod:5219 ../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:7852 ../src/guestfs-actions.pod:7871 ../src/guestfs-actions.pod:7917 ../src/guestfs-actions.pod:7936
4971 "Because of the message protocol, there is a transfer limit of somewhere "
4972 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4976 #: ../fish/guestfish-actions.pod:625
4981 #: ../fish/guestfish-actions.pod:627
4984 " checksum csumtype path\n"
4989 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
4990 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
4994 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
4996 "The type of checksum to compute is given by the C<csumtype> parameter which "
4997 "must have one of the following values:"
5001 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5006 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5008 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5013 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5018 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5019 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5023 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5028 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5029 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5033 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5038 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5039 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5043 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5048 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5049 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5053 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5058 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5059 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5063 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5068 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5069 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5073 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5074 msgid "The checksum is returned as a printable string."
5078 #: ../fish/guestfish-actions.pod:670
5079 msgid "To get the checksum for a device, use L</checksum-device>."
5083 #: ../fish/guestfish-actions.pod:672
5084 msgid "To get the checksums for many files, use L</checksums-out>."
5088 #: ../fish/guestfish-actions.pod:674
5089 msgid "checksum-device"
5093 #: ../fish/guestfish-actions.pod:676
5096 " checksum-device csumtype device\n"
5101 #: ../fish/guestfish-actions.pod:678
5103 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5104 "device named C<device>. For the types of checksums supported see the "
5105 "L</checksum> command."
5109 #: ../fish/guestfish-actions.pod:682
5110 msgid "checksums-out"
5114 #: ../fish/guestfish-actions.pod:684
5117 " checksums-out csumtype directory (sumsfile|-)\n"
5122 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5124 "This command computes the checksums of all regular files in C<directory> and "
5125 "then emits a list of those checksums to the local output file C<sumsfile>."
5129 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5131 "This can be used for verifying the integrity of a virtual machine. However "
5132 "to be properly secure you should pay attention to the output of the checksum "
5133 "command (it uses the ones from GNU coreutils). In particular when the "
5134 "filename is not printable, coreutils uses a special backslash syntax. For "
5135 "more information, see the GNU coreutils info file."
5139 #: ../fish/guestfish-actions.pod:700
5144 #: ../fish/guestfish-actions.pod:702
5147 " chmod mode path\n"
5152 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5154 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5159 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5161 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5162 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5167 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod: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
5168 msgid "The mode actually set is affected by the umask."
5172 #: ../fish/guestfish-actions.pod:713
5177 #: ../fish/guestfish-actions.pod:715
5180 " chown owner group path\n"
5185 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5186 msgid "Change the file owner to C<owner> and group to C<group>."
5190 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2500 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3662
5192 "Only numeric uid and gid are supported. If you want to use names, you will "
5193 "need to locate and parse the password file yourself (Augeas support makes "
5194 "this relatively easy)."
5198 #: ../fish/guestfish-actions.pod:723
5203 #: ../fish/guestfish-actions.pod:725
5206 " command 'arguments ...'\n"
5211 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5213 "This call runs a command from the guest filesystem. The filesystem must be "
5214 "mounted, and must contain a compatible operating system (ie. something "
5215 "Linux, with the same or compatible processor architecture)."
5219 #: ../fish/guestfish-actions.pod:732
5221 "The single parameter is an argv-style list of arguments. The first element "
5222 "is the name of the program to run. Subsequent elements are parameters. The "
5223 "list must be non-empty (ie. must contain a program name). Note that the "
5224 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5228 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5229 msgid "The return value is anything printed to I<stdout> by the command."
5233 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5235 "If the command returns a non-zero exit status, then this function returns an "
5236 "error message. The error message string is the content of I<stderr> from "
5241 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5243 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5244 "C</bin>. If you require a program from another location, you should provide "
5245 "the full path in the first parameter."
5249 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5251 "Shared libraries and data files required by the program must be available on "
5252 "filesystems which are mounted in the correct places. It is the caller's "
5253 "responsibility to ensure all filesystems that are needed are mounted at the "
5258 #: ../fish/guestfish-actions.pod:760
5259 msgid "command-lines"
5263 #: ../fish/guestfish-actions.pod:762
5266 " command-lines 'arguments ...'\n"
5271 #: ../fish/guestfish-actions.pod:764
5272 msgid "This is the same as L</command>, but splits the result into a list of lines."
5276 #: ../fish/guestfish-actions.pod:767
5277 msgid "See also: L</sh-lines>"
5281 #: ../fish/guestfish-actions.pod:772
5286 #: ../fish/guestfish-actions.pod:774
5289 " config qemuparam qemuvalue\n"
5294 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5296 "This can be used to add arbitrary qemu command line parameters of the form "
5297 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5298 "setting some parameters which would interfere with parameters that we use."
5302 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5303 msgid "The first character of C<param> string must be a C<-> (dash)."
5307 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
5308 msgid "C<value> can be NULL."
5312 #: ../fish/guestfish-actions.pod:785
5317 #: ../fish/guestfish-actions.pod:787
5320 " copy-size src dest size\n"
5325 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
5327 "This command copies exactly C<size> bytes from one source device or file "
5328 "C<src> to another destination device or file C<dest>."
5332 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
5334 "Note this will fail if the source is too short or if the destination is not "
5339 #: ../fish/guestfish-actions.pod:795
5344 #: ../fish/guestfish-actions.pod:797
5352 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
5354 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5355 "destination filename or destination directory."
5359 #: ../fish/guestfish-actions.pod:802
5364 #: ../fish/guestfish-actions.pod:804
5372 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
5374 "This copies a file or directory from C<src> to C<dest> recursively using the "
5379 #: ../fish/guestfish-actions.pod:809
5384 #: ../fish/guestfish-actions.pod:811
5392 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
5394 "This command copies from one source device or file C<src> to another "
5395 "destination device or file C<dest>. Normally you would use this to copy to "
5396 "or from a device or partition, for example to duplicate a filesystem."
5400 #: ../fish/guestfish-actions.pod:818
5402 "If the destination is a device, it must be as large or larger than the "
5403 "source file or device, otherwise the copy will fail. This command cannot do "
5404 "partial copies (see L</copy-size>)."
5408 #: ../fish/guestfish-actions.pod:822
5413 #: ../fish/guestfish-actions.pod:824
5421 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
5422 msgid "This command runs the C<df> command to report disk space used."
5426 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
5428 "This command is mostly useful for interactive sessions. It is I<not> "
5429 "intended that you try to parse the output string. Use L</statvfs> from "
5434 #: ../fish/guestfish-actions.pod:832
5439 #: ../fish/guestfish-actions.pod:834
5447 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
5449 "This command runs the C<df -h> command to report disk space used in "
5450 "human-readable format."
5454 #: ../fish/guestfish-actions.pod:843
5459 #: ../fish/guestfish-actions.pod:845
5467 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
5469 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5470 "This is sometimes useful for extended debugging of problems."
5474 #: ../fish/guestfish-actions.pod:851
5476 "Another way to get the same information is to enable verbose messages with "
5477 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5478 "before running the program."
5482 #: ../fish/guestfish-actions.pod:856
5487 #: ../fish/guestfish-actions.pod:858
5490 " download remotefilename (filename|-)\n"
5495 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873 ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
5497 "Download file C<remotefilename> and save it as C<filename> on the local "
5502 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4808 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7237
5503 msgid "C<filename> can also be a named pipe."
5507 #: ../fish/guestfish-actions.pod:865
5508 msgid "See also L</upload>, L</cat>."
5512 #: ../fish/guestfish-actions.pod:869
5513 msgid "download-offset"
5517 #: ../fish/guestfish-actions.pod:871
5520 " download-offset remotefilename (filename|-) offset size\n"
5525 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
5527 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5528 "region must be within the file or device)."
5532 #: ../fish/guestfish-actions.pod:879
5534 "Note that there is no limit on the amount of data that can be downloaded "
5535 "with this call, unlike with L</pread>, and this call always reads the full "
5536 "amount unless an error occurs."
5540 #: ../fish/guestfish-actions.pod:884
5541 msgid "See also L</download>, L</pread>."
5545 #: ../fish/guestfish-actions.pod:888
5550 #: ../fish/guestfish-actions.pod:890
5553 " drop-caches whattodrop\n"
5558 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
5560 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5561 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5562 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5566 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
5567 msgid "Setting C<whattodrop> to 3 should drop everything."
5571 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
5573 "This automatically calls L<sync(2)> before the operation, so that the "
5574 "maximum guest memory is freed."
5578 #: ../fish/guestfish-actions.pod:902
5583 #: ../fish/guestfish-actions.pod:904
5591 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
5593 "This command runs the C<du -s> command to estimate file space usage for "
5598 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
5600 "C<path> can be a file or a directory. If C<path> is a directory then the "
5601 "estimate includes the contents of the directory and all subdirectories "
5606 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
5607 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5611 #: ../fish/guestfish-actions.pod:916
5616 #: ../fish/guestfish-actions.pod:918
5619 " e2fsck-f device\n"
5624 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
5626 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5627 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5632 #: ../fish/guestfish-actions.pod:924
5634 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
5635 "should use L</fsck>."
5639 #: ../fish/guestfish-actions.pod:927
5644 #: ../fish/guestfish-actions.pod:929
5647 " echo-daemon 'words ...'\n"
5652 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
5654 "This command concatenates the list of C<words> passed with single spaces "
5655 "between them and returns the resulting string."
5659 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
5660 msgid "You can use this command to test the connection through to the daemon."
5664 #: ../fish/guestfish-actions.pod:936
5665 msgid "See also L</ping-daemon>."
5669 #: ../fish/guestfish-actions.pod:938
5674 #: ../fish/guestfish-actions.pod:940
5677 " egrep regex path\n"
5682 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
5683 msgid "This calls the external C<egrep> program and returns the matching lines."
5687 #: ../fish/guestfish-actions.pod:948
5692 #: ../fish/guestfish-actions.pod:950
5695 " egrepi regex path\n"
5700 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
5701 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5705 #: ../fish/guestfish-actions.pod:958
5710 #: ../fish/guestfish-actions.pod:960
5713 " equal file1 file2\n"
5718 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
5720 "This compares the two files C<file1> and C<file2> and returns true if their "
5721 "content is exactly equal, or false otherwise."
5725 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
5726 msgid "The external L<cmp(1)> program is used for the comparison."
5730 #: ../fish/guestfish-actions.pod:967
5735 #: ../fish/guestfish-actions.pod:969
5743 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
5745 "This returns C<true> if and only if there is a file, directory (or anything) "
5746 "with the given C<path> name."
5750 #: ../fish/guestfish-actions.pod:974
5751 msgid "See also L</is-file>, L</is-dir>, L</stat>."
5755 #: ../fish/guestfish-actions.pod:976
5760 #: ../fish/guestfish-actions.pod:978
5763 " fallocate path len\n"
5768 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999 ../src/guestfs-actions.pod:1505 ../src/guestfs-actions.pod:1531
5770 "This command preallocates a file (containing zero bytes) named C<path> of "
5771 "size C<len> bytes. If the file exists already, it is overwritten."
5775 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1509
5777 "Do not confuse this with the guestfish-specific C<alloc> command which "
5778 "allocates a file in the host and attaches it as a device."
5782 #: ../fish/guestfish-actions.pod:988
5784 "This function is deprecated. In new code, use the L</fallocate64> call "
5789 #: ../fish/guestfish-actions.pod:995
5794 #: ../fish/guestfish-actions.pod:997
5797 " fallocate64 path len\n"
5802 #: ../fish/guestfish-actions.pod:1003
5804 "Note that this call allocates disk blocks for the file. To create a sparse "
5805 "file use L</truncate-size> instead."
5809 #: ../fish/guestfish-actions.pod:1006
5811 "The deprecated call L</fallocate> does the same, but owing to an oversight "
5812 "it only allowed 30 bit lengths to be specified, effectively limiting the "
5813 "maximum size of files created through that call to 1GB."
5817 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
5819 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
5820 "commands which create a file in the host and attach it as a device."
5824 #: ../fish/guestfish-actions.pod:1015
5829 #: ../fish/guestfish-actions.pod:1017
5832 " fgrep pattern path\n"
5837 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
5838 msgid "This calls the external C<fgrep> program and returns the matching lines."
5842 #: ../fish/guestfish-actions.pod:1025
5847 #: ../fish/guestfish-actions.pod:1027
5850 " fgrepi pattern path\n"
5855 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
5856 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
5860 #: ../fish/guestfish-actions.pod:1035
5865 #: ../fish/guestfish-actions.pod:1037
5873 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
5875 "This call uses the standard L<file(1)> command to determine the type or "
5876 "contents of the file."
5880 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
5882 "This call will also transparently look inside various types of compressed "
5887 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
5889 "The exact command which runs is C<file -zb path>. Note in particular that "
5890 "the filename is not prepended to the output (the I<-b> option)."
5894 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
5896 "The output depends on the output of the underlying L<file(1)> command and it "
5897 "can change in future in ways beyond our control. In other words, the output "
5898 "is not guaranteed by the ABI."
5902 #: ../fish/guestfish-actions.pod:1053
5904 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
5905 "(etc), L</is-zero>."
5909 #: ../fish/guestfish-actions.pod:1056
5910 msgid "file-architecture"
5914 #: ../fish/guestfish-actions.pod:1058
5917 " file-architecture filename\n"
5922 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
5924 "This detects the architecture of the binary C<filename>, and returns it if "
5929 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
5930 msgid "Currently defined architectures are:"
5934 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
5939 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
5941 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
5942 "irrespective of the precise processor requirements of the binary."
5946 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
5951 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
5952 msgid "64 bit x86-64."
5956 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
5961 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
5962 msgid "32 bit SPARC."
5966 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
5971 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
5972 msgid "64 bit SPARC V9 and above."
5976 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
5981 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
5982 msgid "Intel Itanium."
5986 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
5991 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
5992 msgid "32 bit Power PC."
5996 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
6001 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
6002 msgid "64 bit Power PC."
6006 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
6007 msgid "Libguestfs may return other architecture strings in future."
6011 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6012 msgid "The function works on at least the following types of files:"
6016 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6017 msgid "many types of Un*x and Linux binary"
6021 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6022 msgid "many types of Un*x and Linux shared library"
6026 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6027 msgid "Windows Win32 and Win64 binaries"
6031 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6032 msgid "Windows Win32 and Win64 DLLs"
6036 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6037 msgid "Win32 binaries and DLLs return C<i386>."
6041 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6042 msgid "Win64 binaries and DLLs return C<x86_64>."
6046 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6047 msgid "Linux kernel modules"
6051 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6052 msgid "Linux new-style initrd images"
6056 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6057 msgid "some non-x86 Linux vmlinuz kernels"
6061 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6062 msgid "What it can't do currently:"
6066 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6067 msgid "static libraries (libfoo.a)"
6071 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6072 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6076 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6077 msgid "x86 Linux vmlinuz kernels"
6081 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6083 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6084 "compressed code, and are horribly hard to unpack. If you want to find the "
6085 "architecture of a kernel, use the architecture of the associated initrd or "
6086 "kernel module(s) instead."
6090 #: ../fish/guestfish-actions.pod:1161
6095 #: ../fish/guestfish-actions.pod:1163
6103 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6104 msgid "This command returns the size of C<file> in bytes."
6108 #: ../fish/guestfish-actions.pod:1167
6110 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6111 "L</is-file> etc. To get the size of block devices, use "
6112 "L</blockdev-getsize64>."
6116 #: ../fish/guestfish-actions.pod:1171
6121 #: ../fish/guestfish-actions.pod:1173
6124 " fill c len path\n"
6129 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6131 "This command creates a new file called C<path>. The initial content of the "
6132 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6137 #: ../fish/guestfish-actions.pod:1179
6139 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6140 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6145 #: ../fish/guestfish-actions.pod:1184
6146 msgid "fill-pattern"
6150 #: ../fish/guestfish-actions.pod:1186
6153 " fill-pattern pattern len path\n"
6158 #: ../fish/guestfish-actions.pod:1188
6160 "This function is like L</fill> except that it creates a new file of length "
6161 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6162 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6167 #: ../fish/guestfish-actions.pod:1193
6172 #: ../fish/guestfish-actions.pod:1195
6180 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6182 "This command lists out all files and directories, recursively, starting at "
6183 "C<directory>. It is essentially equivalent to running the shell command "
6184 "C<find directory -print> but some post-processing happens on the output, "
6189 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6191 "This returns a list of strings I<without any prefix>. Thus if the directory "
6196 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6206 #: ../fish/guestfish-actions.pod:1209
6207 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6211 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6222 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6223 msgid "If C<directory> is not a directory, then this command returns an error."
6227 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6228 msgid "The returned list is sorted."
6232 #: ../fish/guestfish-actions.pod:1222
6233 msgid "See also L</find0>."
6237 #: ../fish/guestfish-actions.pod:1227
6242 #: ../fish/guestfish-actions.pod:1229
6245 " find0 directory (files|-)\n"
6250 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6252 "This command lists out all files and directories, recursively, starting at "
6253 "C<directory>, placing the resulting list in the external file called "
6258 #: ../fish/guestfish-actions.pod:1235
6259 msgid "This command works the same way as L</find> with the following exceptions:"
6263 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6264 msgid "The resulting list is written to an external file."
6268 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6270 "Items (filenames) in the result are separated by C<\\0> characters. See "
6271 "L<find(1)> option I<-print0>."
6275 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6276 msgid "This command is not limited in the number of names that it can return."
6280 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6281 msgid "The result list is not sorted."
6285 #: ../fish/guestfish-actions.pod:1262
6286 msgid "findfs-label"
6290 #: ../fish/guestfish-actions.pod:1264
6293 " findfs-label label\n"
6298 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
6300 "This command searches the filesystems and returns the one which has the "
6301 "given label. An error is returned if no such filesystem can be found."
6305 #: ../fish/guestfish-actions.pod:1270
6306 msgid "To find the label of a filesystem, use L</vfs-label>."
6310 #: ../fish/guestfish-actions.pod:1272
6315 #: ../fish/guestfish-actions.pod:1274
6318 " findfs-uuid uuid\n"
6323 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
6325 "This command searches the filesystems and returns the one which has the "
6326 "given UUID. An error is returned if no such filesystem can be found."
6330 #: ../fish/guestfish-actions.pod:1280
6331 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6335 #: ../fish/guestfish-actions.pod:1282
6340 #: ../fish/guestfish-actions.pod:1284
6343 " fsck fstype device\n"
6348 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
6350 "This runs the filesystem checker (fsck) on C<device> which should have "
6351 "filesystem type C<fstype>."
6355 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
6357 "The returned integer is the status. See L<fsck(8)> for the list of status "
6358 "codes from C<fsck>."
6362 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
6363 msgid "Multiple status codes can be summed together."
6367 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6369 "A non-zero return code can mean \"success\", for example if errors have been "
6370 "corrected on the filesystem."
6374 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6375 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6379 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
6380 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6384 #: ../fish/guestfish-actions.pod:1314
6389 #: ../fish/guestfish-actions.pod:1316
6397 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
6399 "Return the additional kernel options which are added to the guest kernel "
6404 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
6405 msgid "If C<NULL> then no options are added."
6409 #: ../fish/guestfish-actions.pod:1323
6410 msgid "get-attach-method"
6414 #: ../fish/guestfish-actions.pod:1325
6417 " get-attach-method\n"
6422 #: ../fish/guestfish-actions.pod:1327
6423 msgid "Return the current attach method. See L</set-attach-method>."
6427 #: ../fish/guestfish-actions.pod:1329
6428 msgid "get-autosync"
6432 #: ../fish/guestfish-actions.pod:1331
6440 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
6441 msgid "Get the autosync flag."
6445 #: ../fish/guestfish-actions.pod:1335
6450 #: ../fish/guestfish-actions.pod:1337
6458 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
6459 msgid "Return the direct appliance mode flag."
6463 #: ../fish/guestfish-actions.pod:1341
6468 #: ../fish/guestfish-actions.pod:1343
6471 " get-e2label device\n"
6476 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2004
6477 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6481 #: ../fish/guestfish-actions.pod:1348
6483 "This function is deprecated. In new code, use the L</vfs_label> call "
6488 #: ../fish/guestfish-actions.pod:1355
6493 #: ../fish/guestfish-actions.pod:1357
6496 " get-e2uuid device\n"
6501 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2025
6502 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6506 #: ../fish/guestfish-actions.pod:1362
6508 "This function is deprecated. In new code, use the L</vfs_uuid> call "
6513 #: ../fish/guestfish-actions.pod:1369
6518 #: ../fish/guestfish-actions.pod:1371
6526 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
6527 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6531 #: ../fish/guestfish-actions.pod:1376
6533 "If L</set-memsize> was not called on this handle, and if "
6534 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6535 "value for memsize."
6539 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437 ../fish/guestfish-actions.pod: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
6540 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6544 #: ../fish/guestfish-actions.pod:1383
6549 #: ../fish/guestfish-actions.pod:1385
6557 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
6558 msgid "This returns the enable network flag."
6562 #: ../fish/guestfish-actions.pod:1389
6567 #: ../fish/guestfish-actions.pod:1391
6575 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
6576 msgid "Return the current search path."
6580 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
6582 "This is always non-NULL. If it wasn't set already, then this will return "
6587 #: ../fish/guestfish-actions.pod:1398
6592 #: ../fish/guestfish-actions.pod:1400
6600 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
6601 msgid "This returns the process group flag."
6605 #: ../fish/guestfish-actions.pod:1404
6610 #: ../fish/guestfish-actions.pod:1406
6615 #: ../fish/guestfish-actions.pod:1408
6623 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
6625 "Return the process ID of the qemu subprocess. If there is no qemu "
6626 "subprocess, then this will return an error."
6630 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
6631 msgid "This is an internal call used for debugging and testing."
6635 #: ../fish/guestfish-actions.pod:1415
6640 #: ../fish/guestfish-actions.pod:1417
6648 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
6649 msgid "Return the current qemu binary."
6653 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
6655 "This is always non-NULL. If it wasn't set already, then this will return "
6656 "the default qemu binary name."
6660 #: ../fish/guestfish-actions.pod:1424
6661 msgid "get-recovery-proc"
6665 #: ../fish/guestfish-actions.pod:1426
6668 " get-recovery-proc\n"
6673 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
6674 msgid "Return the recovery process enabled flag."
6678 #: ../fish/guestfish-actions.pod:1430
6683 #: ../fish/guestfish-actions.pod:1432
6691 #: ../fish/guestfish-actions.pod:1434
6693 "This returns the current setting of the selinux flag which is passed to the "
6694 "appliance at boot time. See L</set-selinux>."
6698 #: ../fish/guestfish-actions.pod:1440
6703 #: ../fish/guestfish-actions.pod:1442
6711 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
6713 "This returns the current state as an opaque integer. This is only useful "
6714 "for printing debug and internal error messages."
6718 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod: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
6719 msgid "For more information on states, see L<guestfs(3)>."
6723 #: ../fish/guestfish-actions.pod:1449
6728 #: ../fish/guestfish-actions.pod:1451
6736 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
6737 msgid "Return the command trace flag."
6741 #: ../fish/guestfish-actions.pod:1455
6746 #: ../fish/guestfish-actions.pod:1457
6754 #: ../fish/guestfish-actions.pod:1459
6756 "Return the current umask. By default the umask is C<022> unless it has been "
6757 "set by calling L</umask>."
6761 #: ../fish/guestfish-actions.pod:1462
6766 #: ../fish/guestfish-actions.pod:1464
6774 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
6775 msgid "This returns the verbose messages flag."
6779 #: ../fish/guestfish-actions.pod:1468
6784 #: ../fish/guestfish-actions.pod:1470
6792 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
6793 msgid "This gets the SELinux security context of the daemon."
6797 #: ../fish/guestfish-actions.pod:1474
6798 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
6802 #: ../fish/guestfish-actions.pod:1477
6807 #: ../fish/guestfish-actions.pod:1479
6810 " getxattr path name\n"
6815 #: ../fish/guestfish-actions.pod:1481
6817 "Get a single extended attribute from file C<path> named C<name>. This call "
6818 "follows symlinks. If you want to lookup an extended attribute for the "
6819 "symlink itself, use L</lgetxattr>."
6823 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2512
6825 "Normally it is better to get all extended attributes from a file in one go "
6826 "by calling L</getxattrs>. However some Linux filesystem implementations are "
6827 "buggy and do not provide a way to list out attributes. For these "
6828 "filesystems (notably ntfs-3g) you have to know the names of the extended "
6829 "attributes you want in advance and call this function."
6833 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2519 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3689
6835 "Extended attribute values are blobs of binary data. If there is no extended "
6836 "attribute named C<name>, this returns an error."
6840 #: ../fish/guestfish-actions.pod:1495
6841 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
6845 #: ../fish/guestfish-actions.pod:1497
6850 #: ../fish/guestfish-actions.pod:1499
6858 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
6859 msgid "This call lists the extended attributes of the file or directory C<path>."
6863 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
6865 "At the system call level, this is a combination of the L<listxattr(2)> and "
6866 "L<getxattr(2)> calls."
6870 #: ../fish/guestfish-actions.pod:1507
6871 msgid "See also: L</lgetxattrs>, L<attr(5)>."
6875 #: ../fish/guestfish-actions.pod:1509
6880 #: ../fish/guestfish-actions.pod:1511
6883 " glob-expand pattern\n"
6888 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
6890 "This command searches for all the pathnames matching C<pattern> according to "
6891 "the wildcard expansion rules used by the shell."
6895 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
6896 msgid "If no paths match, then this returns an empty list (note: not an error)."
6900 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
6902 "It is just a wrapper around the C L<glob(3)> function with flags "
6903 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
6907 #: ../fish/guestfish-actions.pod:1524
6912 #: ../fish/guestfish-actions.pod:1526
6915 " grep regex path\n"
6920 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
6921 msgid "This calls the external C<grep> program and returns the matching lines."
6925 #: ../fish/guestfish-actions.pod:1534
6930 #: ../fish/guestfish-actions.pod:1536
6933 " grepi regex path\n"
6938 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
6939 msgid "This calls the external C<grep -i> program and returns the matching lines."
6943 #: ../fish/guestfish-actions.pod:1544
6944 msgid "grub-install"
6948 #: ../fish/guestfish-actions.pod:1546
6951 " grub-install root device\n"
6956 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
6958 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
6959 "the root directory being C<root>."
6963 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2335
6965 "Note: If grub-install reports the error \"No suitable drive was found in the "
6966 "generated device map.\" it may be that you need to create a "
6967 "C</boot/grub/device.map> file first that contains the mapping between grub "
6968 "device names and Linux device names. It is usually sufficient to create a "
6973 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2342
6981 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2344
6982 msgid "replacing C</dev/vda> with the name of the installation device."
6986 #: ../fish/guestfish-actions.pod:1562
6991 #: ../fish/guestfish-actions.pod:1564
6999 #: ../fish/guestfish-actions.pod:1566 ../src/guestfs-actions.pod:2356
7001 "This command returns up to the first 10 lines of a file as a list of "
7006 #: ../fish/guestfish-actions.pod:1572
7011 #: ../fish/guestfish-actions.pod:1574
7014 " head-n nrlines path\n"
7019 #: ../fish/guestfish-actions.pod:1576 ../src/guestfs-actions.pod:2375
7021 "If the parameter C<nrlines> is a positive number, this returns the first "
7022 "C<nrlines> lines of the file C<path>."
7026 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2378
7028 "If the parameter C<nrlines> is a negative number, this returns lines from "
7029 "the file C<path>, excluding the last C<nrlines> lines."
7033 #: ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:4648 ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:6996
7034 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7038 #: ../fish/guestfish-actions.pod:1587
7043 #: ../fish/guestfish-actions.pod:1589
7051 #: ../fish/guestfish-actions.pod:1591 ../src/guestfs-actions.pod:2398
7053 "This runs C<hexdump -C> on the given C<path>. The result is the "
7054 "human-readable, canonical hex dump of the file."
7058 #: ../fish/guestfish-actions.pod:1597
7063 #: ../fish/guestfish-actions.pod:1599
7066 " initrd-cat initrdpath filename\n"
7071 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2417
7073 "This command unpacks the file C<filename> from the initrd file called "
7074 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7079 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2421
7081 "For example, in guestfish you could use the following command to examine the "
7082 "boot script (usually called C</init>) contained in a Linux initrd or "
7087 #: ../fish/guestfish-actions.pod:1609 ../src/guestfs-actions.pod:2425
7090 " initrd-cat /boot/initrd-<version>.img init\n"
7095 #: ../fish/guestfish-actions.pod:1611
7096 msgid "See also L</initrd-list>."
7100 #: ../fish/guestfish-actions.pod:1616
7105 #: ../fish/guestfish-actions.pod:1618
7108 " initrd-list path\n"
7113 #: ../fish/guestfish-actions.pod:1620 ../src/guestfs-actions.pod:2444
7114 msgid "This command lists out files contained in an initrd."
7118 #: ../fish/guestfish-actions.pod:1622 ../src/guestfs-actions.pod:2446
7120 "The files are listed without any initial C</> character. The files are "
7121 "listed in the order they appear (not necessarily alphabetical). Directory "
7122 "names are listed as separate items."
7126 #: ../fish/guestfish-actions.pod:1626 ../src/guestfs-actions.pod:2450
7128 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7129 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7134 #: ../fish/guestfish-actions.pod:1630
7135 msgid "inotify-add-watch"
7139 #: ../fish/guestfish-actions.pod:1632
7142 " inotify-add-watch path mask\n"
7147 #: ../fish/guestfish-actions.pod:1634 ../src/guestfs-actions.pod:2467
7148 msgid "Watch C<path> for the events listed in C<mask>."
7152 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2469
7154 "Note that if C<path> is a directory then events within that directory are "
7155 "watched, but this does I<not> happen recursively (in subdirectories)."
7159 #: ../fish/guestfish-actions.pod:1640 ../src/guestfs-actions.pod:2473
7161 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7162 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7166 #: ../fish/guestfish-actions.pod:1644
7167 msgid "inotify-close"
7171 #: ../fish/guestfish-actions.pod:1646
7179 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2486
7181 "This closes the inotify handle which was previously opened by inotify_init. "
7182 "It removes all watches, throws away any pending events, and deallocates all "
7187 #: ../fish/guestfish-actions.pod:1652
7188 msgid "inotify-files"
7192 #: ../fish/guestfish-actions.pod:1654
7200 #: ../fish/guestfish-actions.pod:1656
7202 "This function is a helpful wrapper around L</inotify-read> which just "
7203 "returns a list of pathnames of objects that were touched. The returned "
7204 "pathnames are sorted and deduplicated."
7208 #: ../fish/guestfish-actions.pod:1660
7209 msgid "inotify-init"
7213 #: ../fish/guestfish-actions.pod:1662
7216 " inotify-init maxevents\n"
7221 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2515
7223 "This command creates a new inotify handle. The inotify subsystem can be "
7224 "used to notify events which happen to objects in the guest filesystem."
7228 #: ../fish/guestfish-actions.pod:1668
7230 "C<maxevents> is the maximum number of events which will be queued up between "
7231 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7232 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7233 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7234 "but records the fact that it threw them away by setting a flag "
7235 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7239 #: ../fish/guestfish-actions.pod:1678
7241 "Before any events are generated, you have to add some watches to the "
7242 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7243 "L</inotify-watch-all>."
7247 #: ../fish/guestfish-actions.pod:1684
7249 "Queued up events should be read periodically by calling L</inotify-read> (or "
7250 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7251 "If you don't read the events out often enough then you risk the internal "
7252 "queue overflowing."
7256 #: ../fish/guestfish-actions.pod:1691
7258 "The handle should be closed after use by calling L</inotify-close>. This "
7259 "also removes any watches automatically."
7263 #: ../fish/guestfish-actions.pod:1695 ../src/guestfs-actions.pod:2546
7265 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7266 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7267 "that there is one global inotify handle per libguestfs instance."
7271 #: ../fish/guestfish-actions.pod:1700
7272 msgid "inotify-read"
7276 #: ../fish/guestfish-actions.pod:1702
7284 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7286 "Return the complete queue of events that have happened since the previous "
7291 #: ../fish/guestfish-actions.pod:1707 ../src/guestfs-actions.pod:2563
7292 msgid "If no events have happened, this returns an empty list."
7296 #: ../fish/guestfish-actions.pod:1709 ../src/guestfs-actions.pod:2565
7298 "I<Note>: In order to make sure that all events have been read, you must call "
7299 "this function repeatedly until it returns an empty list. The reason is that "
7300 "the call will read events up to the maximum appliance-to-host message size "
7301 "and leave remaining events in the queue."
7305 #: ../fish/guestfish-actions.pod:1715
7306 msgid "inotify-rm-watch"
7310 #: ../fish/guestfish-actions.pod:1717
7313 " inotify-rm-watch wd\n"
7318 #: ../fish/guestfish-actions.pod:1719
7319 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7323 #: ../fish/guestfish-actions.pod:1722
7324 msgid "inspect-get-arch"
7328 #: ../fish/guestfish-actions.pod:1724
7331 " inspect-get-arch root\n"
7336 #: ../fish/guestfish-actions.pod:1726
7338 "This returns the architecture of the inspected operating system. The "
7339 "possible return values are listed under L</file-architecture>."
7343 #: ../fish/guestfish-actions.pod:1730 ../src/guestfs-actions.pod:2600
7345 "If the architecture could not be determined, then the string C<unknown> is "
7350 #: ../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
7351 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7355 #: ../fish/guestfish-actions.pod:1735
7356 msgid "inspect-get-distro"
7360 #: ../fish/guestfish-actions.pod:1737
7363 " inspect-get-distro root\n"
7368 #: ../fish/guestfish-actions.pod:1739 ../src/guestfs-actions.pod:2616
7369 msgid "This returns the distro (distribution) of the inspected operating system."
7373 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2619
7374 msgid "Currently defined distros are:"
7378 #: ../fish/guestfish-actions.pod:1746 ../src/guestfs-actions.pod:2623
7379 msgid "\"archlinux\""
7383 #: ../fish/guestfish-actions.pod:1748 ../src/guestfs-actions.pod:2625
7388 #: ../fish/guestfish-actions.pod:1750 ../src/guestfs-actions.pod:2627
7393 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2629
7398 #: ../fish/guestfish-actions.pod:1754 ../src/guestfs-actions.pod:2631
7403 #: ../fish/guestfish-actions.pod:1756 ../src/guestfs-actions.pod:2633
7408 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2635
7413 #: ../fish/guestfish-actions.pod:1760 ../src/guestfs-actions.pod:2637
7418 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2639
7423 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7428 #: ../fish/guestfish-actions.pod:1766 ../src/guestfs-actions.pod:2643
7429 msgid "\"linuxmint\""
7433 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7438 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7439 msgid "\"mandriva\""
7443 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7448 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7453 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7458 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7463 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7468 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7469 msgid "\"redhat-based\""
7473 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7474 msgid "Some Red Hat-derived distro."
7478 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
7483 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
7484 msgid "Red Hat Enterprise Linux."
7488 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
7489 msgid "\"scientificlinux\""
7493 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
7494 msgid "Scientific Linux."
7498 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
7499 msgid "\"slackware\""
7503 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
7508 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
7513 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
7518 #: ../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
7523 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
7524 msgid "The distro could not be determined."
7528 #: ../fish/guestfish-actions.pod:1806 ../fish/guestfish-actions.pod:2142 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:3155
7533 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
7535 "Windows does not have distributions. This string is returned if the OS type "
7540 #: ../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
7542 "Future versions of libguestfs may return other strings here. The caller "
7543 "should be prepared to handle any string."
7547 #: ../fish/guestfish-actions.pod:1818
7548 msgid "inspect-get-drive-mappings"
7552 #: ../fish/guestfish-actions.pod:1820
7555 " inspect-get-drive-mappings root\n"
7560 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2706
7562 "This call is useful for Windows which uses a primitive system of assigning "
7563 "drive letters (like \"C:\") to partitions. This inspection API examines the "
7564 "Windows Registry to find out how disks/partitions are mapped to drive "
7565 "letters, and returns a hash table as in the example below:"
7569 #: ../fish/guestfish-actions.pod:1828 ../src/guestfs-actions.pod:2712
7579 #: ../fish/guestfish-actions.pod:1832 ../src/guestfs-actions.pod:2716
7581 "Note that keys are drive letters. For Windows, the key is case insensitive "
7582 "and just contains the drive letter, without the customary colon separator "
7587 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
7589 "In future we may support other operating systems that also used drive "
7590 "letters, but the keys for those might not be case insensitive and might be "
7591 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
7596 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2725
7598 "For Windows guests, currently only hard drive mappings are returned. "
7599 "Removable disks (eg. DVD-ROMs) are ignored."
7603 #: ../fish/guestfish-actions.pod:1844 ../src/guestfs-actions.pod:2728
7605 "For guests that do not use drive mappings, or if the drive mappings could "
7606 "not be determined, this returns an empty hash table."
7610 #: ../fish/guestfish-actions.pod:1847
7612 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7613 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7617 #: ../fish/guestfish-actions.pod:1851
7618 msgid "inspect-get-filesystems"
7622 #: ../fish/guestfish-actions.pod:1853
7625 " inspect-get-filesystems root\n"
7630 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
7632 "This returns a list of all the filesystems that we think are associated with "
7633 "this operating system. This includes the root filesystem, other ordinary "
7634 "filesystems, and non-mounted devices like swap partitions."
7638 #: ../fish/guestfish-actions.pod:1860 ../src/guestfs-actions.pod:2754
7640 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7641 "to be shared between operating systems."
7645 #: ../fish/guestfish-actions.pod:1863
7647 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7648 "L</inspect-get-mountpoints>."
7652 #: ../fish/guestfish-actions.pod:1866
7653 msgid "inspect-get-format"
7657 #: ../fish/guestfish-actions.pod:1868
7660 " inspect-get-format root\n"
7665 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2772
7667 "This returns the format of the inspected operating system. You can use it "
7668 "to detect install images, live CDs and similar."
7672 #: ../fish/guestfish-actions.pod:1873 ../src/guestfs-actions.pod:2775
7673 msgid "Currently defined formats are:"
7677 #: ../fish/guestfish-actions.pod:1877 ../src/guestfs-actions.pod:2779
7678 msgid "\"installed\""
7682 #: ../fish/guestfish-actions.pod:1879 ../src/guestfs-actions.pod:2781
7683 msgid "This is an installed operating system."
7687 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2783
7688 msgid "\"installer\""
7692 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
7694 "The disk image being inspected is not an installed operating system, but a "
7695 "I<bootable> install disk, live CD, or similar."
7699 #: ../fish/guestfish-actions.pod:1888 ../src/guestfs-actions.pod:2790
7700 msgid "The format of this disk image is not known."
7704 #: ../fish/guestfish-actions.pod:1897
7705 msgid "inspect-get-hostname"
7709 #: ../fish/guestfish-actions.pod:1899
7712 " inspect-get-hostname root\n"
7717 #: ../fish/guestfish-actions.pod:1901 ../src/guestfs-actions.pod:2810
7719 "This function returns the hostname of the operating system as found by "
7720 "inspection of the guest's configuration files."
7724 #: ../fish/guestfish-actions.pod:1904 ../src/guestfs-actions.pod:2813
7726 "If the hostname could not be determined, then the string C<unknown> is "
7731 #: ../fish/guestfish-actions.pod:1909
7732 msgid "inspect-get-icon"
7736 #: ../fish/guestfish-actions.pod:1911
7739 " inspect-get-icon root [favicon:..] [highquality:..]\n"
7744 #: ../fish/guestfish-actions.pod:1913 ../src/guestfs-actions.pod:2839
7746 "This function returns an icon corresponding to the inspected operating "
7747 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
7748 "to PNG if necessary)."
7752 #: ../fish/guestfish-actions.pod:1917 ../src/guestfs-actions.pod:2843
7754 "If it was not possible to get an icon this function returns a zero-length "
7755 "(non-NULL) buffer. I<Callers must check for this case>."
7759 #: ../fish/guestfish-actions.pod:1920 ../src/guestfs-actions.pod:2846
7761 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
7762 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
7763 "this file will be returned. You can disable favicons by passing the "
7764 "optional C<favicon> boolean as false (default is true)."
7768 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:2852
7770 "If finding the favicon fails, then we look in other places in the guest for "
7775 #: ../fish/guestfish-actions.pod:1929 ../src/guestfs-actions.pod:2855
7777 "If the optional C<highquality> boolean is true then only high quality icons "
7778 "are returned, which means only icons of high resolution with an alpha "
7779 "channel. The default (false) is to return any icon we can, even if it is of "
7780 "substandard quality."
7784 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2866
7786 "Unlike most other inspection API calls, the guest's disks must be mounted up "
7787 "before you call this, since it needs to read information from the guest "
7788 "filesystem during the call."
7792 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
7794 "B<Security:> The icon data comes from the untrusted guest, and should be "
7795 "treated with caution. PNG files have been known to contain exploits. "
7796 "Ensure that libpng (or other relevant libraries) are fully up to date before "
7797 "trying to process or display the icon."
7801 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:2880
7803 "The PNG image returned can be any size. It might not be square. Libguestfs "
7804 "tries to return the largest, highest quality icon available. The "
7805 "application must scale the icon to the required size."
7809 #: ../fish/guestfish-actions.pod:1961 ../src/guestfs-actions.pod:2887
7811 "Extracting icons from Windows guests requires the external C<wrestool> "
7812 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
7813 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
7814 "installed separately."
7818 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2894
7820 "Operating system icons are usually trademarks. Seek legal advice before "
7821 "using trademarks in applications."
7825 #: ../fish/guestfish-actions.pod:1975
7826 msgid "inspect-get-major-version"
7830 #: ../fish/guestfish-actions.pod:1977
7833 " inspect-get-major-version root\n"
7838 #: ../fish/guestfish-actions.pod:1979 ../src/guestfs-actions.pod:2935
7839 msgid "This returns the major version number of the inspected operating system."
7843 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:2938
7845 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7846 "popular public names used by the operating system. Notably the operating "
7847 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7848 "1). You can find out the real versions corresponding to releases of Windows "
7849 "by consulting Wikipedia or MSDN."
7853 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2000 ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2962
7854 msgid "If the version could not be determined, then C<0> is returned."
7858 #: ../fish/guestfish-actions.pod:1993
7859 msgid "inspect-get-minor-version"
7863 #: ../fish/guestfish-actions.pod:1995
7866 " inspect-get-minor-version root\n"
7871 #: ../fish/guestfish-actions.pod:1997 ../src/guestfs-actions.pod:2959
7872 msgid "This returns the minor version number of the inspected operating system."
7876 #: ../fish/guestfish-actions.pod:2002
7878 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7879 "L</inspect-get-major-version>."
7883 #: ../fish/guestfish-actions.pod:2005
7884 msgid "inspect-get-mountpoints"
7888 #: ../fish/guestfish-actions.pod:2007
7891 " inspect-get-mountpoints root\n"
7896 #: ../fish/guestfish-actions.pod:2009 ../src/guestfs-actions.pod:2977
7898 "This returns a hash of where we think the filesystems associated with this "
7899 "operating system should be mounted. Callers should note that this is at "
7900 "best an educated guess made by reading configuration files such as "
7901 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
7902 "are non-existent or not mountable and callers should be prepared to handle "
7903 "or ignore failures if they try to mount them."
7907 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
7909 "Each element in the returned hashtable has a key which is the path of the "
7910 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7911 "mounted there (eg. C</dev/sda1>)."
7915 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2991
7916 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
7920 #: ../fish/guestfish-actions.pod:2026
7922 "For operating systems like Windows which still use drive letters, this call "
7923 "will only return an entry for the first drive \"mounted on\" C</>. For "
7924 "information about the mapping of drive letters to partitions, see "
7925 "L</inspect-get-drive-mappings>."
7929 #: ../fish/guestfish-actions.pod:2032
7931 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7932 "L</inspect-get-filesystems>."
7936 #: ../fish/guestfish-actions.pod:2035
7937 msgid "inspect-get-package-format"
7941 #: ../fish/guestfish-actions.pod:2037
7944 " inspect-get-package-format root\n"
7949 #: ../fish/guestfish-actions.pod:2039
7951 "This function and L</inspect-get-package-management> return the package "
7952 "format and package management tool used by the inspected operating system. "
7953 "For example for Fedora these functions would return C<rpm> (package format) "
7954 "and C<yum> (package management)."
7958 #: ../fish/guestfish-actions.pod:2045 ../src/guestfs-actions.pod:3023
7960 "This returns the string C<unknown> if we could not determine the package "
7961 "format I<or> if the operating system does not have a real packaging system "
7966 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3027
7968 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
7969 "Future versions of libguestfs may return other strings."
7973 #: ../fish/guestfish-actions.pod:2054
7974 msgid "inspect-get-package-management"
7978 #: ../fish/guestfish-actions.pod:2056
7981 " inspect-get-package-management root\n"
7986 #: ../fish/guestfish-actions.pod:2058
7988 "L</inspect-get-package-format> and this function return the package format "
7989 "and package management tool used by the inspected operating system. For "
7990 "example for Fedora these functions would return C<rpm> (package format) and "
7991 "C<yum> (package management)."
7995 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3049
7997 "This returns the string C<unknown> if we could not determine the package "
7998 "management tool I<or> if the operating system does not have a real packaging "
7999 "system (eg. Windows)."
8003 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3053
8005 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8006 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8007 "libguestfs may return other strings."
8011 #: ../fish/guestfish-actions.pod:2075
8012 msgid "inspect-get-product-name"
8016 #: ../fish/guestfish-actions.pod:2077
8019 " inspect-get-product-name root\n"
8024 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8026 "This returns the product name of the inspected operating system. The "
8027 "product name is generally some freeform string which can be displayed to the "
8028 "user, but should not be parsed by programs."
8032 #: ../fish/guestfish-actions.pod:2084 ../src/guestfs-actions.pod:3076
8034 "If the product name could not be determined, then the string C<unknown> is "
8039 #: ../fish/guestfish-actions.pod:2089
8040 msgid "inspect-get-product-variant"
8044 #: ../fish/guestfish-actions.pod:2091
8047 " inspect-get-product-variant root\n"
8052 #: ../fish/guestfish-actions.pod:2093 ../src/guestfs-actions.pod:3092
8053 msgid "This returns the product variant of the inspected operating system."
8057 #: ../fish/guestfish-actions.pod:2096 ../src/guestfs-actions.pod:3095
8059 "For Windows guests, this returns the contents of the Registry key "
8060 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8061 "which is usually a string such as C<Client> or C<Server> (other values are "
8062 "possible). This can be used to distinguish consumer and enterprise versions "
8063 "of Windows that have the same version number (for example, Windows 7 and "
8064 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8065 "the latter is C<Server>)."
8069 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3104
8071 "For enterprise Linux guests, in future we intend this to return the product "
8072 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8073 "implemented at present."
8077 #: ../fish/guestfish-actions.pod:2109 ../src/guestfs-actions.pod:3108
8079 "If the product variant could not be determined, then the string C<unknown> "
8084 #: ../fish/guestfish-actions.pod:2112
8086 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8087 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8091 #: ../fish/guestfish-actions.pod:2116
8092 msgid "inspect-get-roots"
8096 #: ../fish/guestfish-actions.pod:2118
8099 " inspect-get-roots\n"
8104 #: ../fish/guestfish-actions.pod:2120
8106 "This function is a convenient way to get the list of root devices, as "
8107 "returned from a previous call to L</inspect-os>, but without redoing the "
8108 "whole inspection process."
8112 #: ../fish/guestfish-actions.pod:2124
8114 "This returns an empty list if either no root devices were found or the "
8115 "caller has not called L</inspect-os>."
8119 #: ../fish/guestfish-actions.pod:2129
8120 msgid "inspect-get-type"
8124 #: ../fish/guestfish-actions.pod:2131
8127 " inspect-get-type root\n"
8132 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8134 "This returns the type of the inspected operating system. Currently defined "
8139 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3151
8144 #: ../fish/guestfish-actions.pod:2140 ../src/guestfs-actions.pod:3153
8145 msgid "Any Linux-based operating system."
8149 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3157
8150 msgid "Any Microsoft Windows operating system."
8154 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3159
8159 #: ../fish/guestfish-actions.pod:2148 ../src/guestfs-actions.pod:3161
8164 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3165
8165 msgid "The operating system type could not be determined."
8169 #: ../fish/guestfish-actions.pod:2161
8170 msgid "inspect-get-windows-current-control-set"
8174 #: ../fish/guestfish-actions.pod:2163
8177 " inspect-get-windows-current-control-set root\n"
8182 #: ../fish/guestfish-actions.pod:2165 ../src/guestfs-actions.pod:3185
8184 "This returns the Windows CurrentControlSet of the inspected guest. The "
8185 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8189 #: ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:3188
8191 "This call assumes that the guest is Windows and that the Registry could be "
8192 "examined by inspection. If this is not the case then an error is returned."
8196 #: ../fish/guestfish-actions.pod:2174
8197 msgid "inspect-get-windows-systemroot"
8201 #: ../fish/guestfish-actions.pod:2176
8204 " inspect-get-windows-systemroot root\n"
8209 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3205
8211 "This returns the Windows systemroot of the inspected guest. The systemroot "
8212 "is a directory path such as C</WINDOWS>."
8216 #: ../fish/guestfish-actions.pod:2181 ../src/guestfs-actions.pod:3208
8218 "This call assumes that the guest is Windows and that the systemroot could be "
8219 "determined by inspection. If this is not the case then an error is "
8224 #: ../fish/guestfish-actions.pod:2187
8225 msgid "inspect-is-live"
8229 #: ../fish/guestfish-actions.pod:2189
8232 " inspect-is-live root\n"
8237 #: ../fish/guestfish-actions.pod:2191
8239 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8240 "then this returns true if a live image was detected on the disk."
8244 #: ../fish/guestfish-actions.pod:2197
8245 msgid "inspect-is-multipart"
8249 #: ../fish/guestfish-actions.pod:2199
8252 " inspect-is-multipart root\n"
8257 #: ../fish/guestfish-actions.pod:2201
8259 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8260 "then this returns true if the disk is part of a set."
8264 #: ../fish/guestfish-actions.pod:2207
8265 msgid "inspect-is-netinst"
8269 #: ../fish/guestfish-actions.pod:2209
8272 " inspect-is-netinst root\n"
8277 #: ../fish/guestfish-actions.pod:2211
8279 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8280 "then this returns true if the disk is a network installer, ie. not a "
8281 "self-contained install CD but one which is likely to require network access "
8282 "to complete the install."
8286 #: ../fish/guestfish-actions.pod:2219
8287 msgid "inspect-list-applications"
8291 #: ../fish/guestfish-actions.pod:2221
8294 " inspect-list-applications root\n"
8299 #: ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:3275
8300 msgid "Return the list of applications installed in the operating system."
8304 #: ../fish/guestfish-actions.pod:2225
8306 "I<Note:> This call works differently from other parts of the inspection "
8307 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8308 "then mount up the disks, before calling this. Listing applications is a "
8309 "significantly more difficult operation which requires access to the full "
8310 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8311 "are just returning data cached in the libguestfs handle, this call actually "
8312 "reads parts of the mounted filesystems during the call."
8316 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3287
8318 "This returns an empty list if the inspection code was not able to determine "
8319 "the list of applications."
8323 #: ../fish/guestfish-actions.pod:2238 ../src/guestfs-actions.pod:3290
8324 msgid "The application structure contains the following fields:"
8328 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8333 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8335 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8336 "guests, this is the package name."
8340 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8341 msgid "C<app_display_name>"
8345 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
8347 "The display name of the application, sometimes localized to the install "
8348 "language of the guest operating system."
8352 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8354 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8355 "to display something can use C<app_name> instead."
8359 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8360 msgid "C<app_epoch>"
8364 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8366 "For package managers which use epochs, this contains the epoch of the "
8367 "package (an integer). If unavailable, this is returned as C<0>."
8371 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8372 msgid "C<app_version>"
8376 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8378 "The version string of the application or package. If unavailable this is "
8379 "returned as an empty string C<\"\">."
8383 #: ../fish/guestfish-actions.pod:2265 ../src/guestfs-actions.pod:3317
8384 msgid "C<app_release>"
8388 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3319
8390 "The release string of the application or package, for package managers that "
8391 "use this. If unavailable this is returned as an empty string C<\"\">."
8395 #: ../fish/guestfish-actions.pod:2271 ../src/guestfs-actions.pod:3323
8396 msgid "C<app_install_path>"
8400 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8402 "The installation path of the application (on operating systems such as "
8403 "Windows which use installation paths). This path is in the format used by "
8404 "the guest operating system, it is not a libguestfs path."
8408 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
8409 msgid "If unavailable this is returned as an empty string C<\"\">."
8413 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8414 msgid "C<app_trans_path>"
8418 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8420 "The install path translated into a libguestfs path. If unavailable this is "
8421 "returned as an empty string C<\"\">."
8425 #: ../fish/guestfish-actions.pod:2285 ../src/guestfs-actions.pod:3337
8426 msgid "C<app_publisher>"
8430 #: ../fish/guestfish-actions.pod:2287 ../src/guestfs-actions.pod:3339
8432 "The name of the publisher of the application, for package managers that use "
8433 "this. If unavailable this is returned as an empty string C<\"\">."
8437 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8442 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8444 "The URL (eg. upstream URL) of the application. If unavailable this is "
8445 "returned as an empty string C<\"\">."
8449 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8450 msgid "C<app_source_package>"
8454 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8456 "For packaging systems which support this, the name of the source package. "
8457 "If unavailable this is returned as an empty string C<\"\">."
8461 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8462 msgid "C<app_summary>"
8466 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8468 "A short (usually one line) description of the application or package. If "
8469 "unavailable this is returned as an empty string C<\"\">."
8473 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
8474 msgid "C<app_description>"
8478 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
8480 "A longer description of the application or package. If unavailable this is "
8481 "returned as an empty string C<\"\">."
8485 #: ../fish/guestfish-actions.pod:2315
8490 #: ../fish/guestfish-actions.pod:2317
8498 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3378
8500 "This function uses other libguestfs functions and certain heuristics to "
8501 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8502 "for operating systems."
8506 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3382
8507 msgid "The list returned is empty if no operating systems were found."
8511 #: ../fish/guestfish-actions.pod:2325 ../src/guestfs-actions.pod:3384
8513 "If one operating system was found, then this returns a list with a single "
8514 "element, which is the name of the root filesystem of this operating system. "
8515 "It is also possible for this function to return a list containing more than "
8516 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8517 "element being the root filesystem of one of the operating systems."
8521 #: ../fish/guestfish-actions.pod:2332
8523 "You can pass the root string(s) returned to other L</inspect-get-*> "
8524 "functions in order to query further information about each operating system, "
8525 "such as the name and version."
8529 #: ../fish/guestfish-actions.pod:2337
8531 "This function uses other libguestfs features such as L</mount-ro> and "
8532 "L</umount-all> in order to mount and unmount filesystems and look at the "
8533 "contents. This should be called with no disks currently mounted. The "
8534 "function may also use Augeas, so any existing Augeas handle will be closed."
8538 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3402
8540 "This function cannot decrypt encrypted disks. The caller must do that first "
8541 "(supplying the necessary keys) if the disk is encrypted."
8545 #: ../fish/guestfish-actions.pod:2349 ../fish/guestfish-actions.pod:2547 ../fish/guestfish-actions.pod:2606
8546 msgid "See also L</list-filesystems>."
8550 #: ../fish/guestfish-actions.pod:2351
8555 #: ../fish/guestfish-actions.pod:2353
8558 " is-blockdev path\n"
8563 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3422
8565 "This returns C<true> if and only if there is a block device with the given "
8570 #: ../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
8571 msgid "See also L</stat>."
8575 #: ../fish/guestfish-actions.pod:2360
8580 #: ../fish/guestfish-actions.pod:2362
8588 #: ../fish/guestfish-actions.pod:2364 ../src/guestfs-actions.pod:3436
8590 "This returns true iff this handle is busy processing a command (in the "
8595 #: ../fish/guestfish-actions.pod:2369
8600 #: ../fish/guestfish-actions.pod:2371
8603 " is-chardev path\n"
8608 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3451
8610 "This returns C<true> if and only if there is a character device with the "
8611 "given C<path> name."
8615 #: ../fish/guestfish-actions.pod:2378
8620 #: ../fish/guestfish-actions.pod:2380
8628 #: ../fish/guestfish-actions.pod:2382 ../src/guestfs-actions.pod:3465
8630 "This returns true iff this handle is being configured (in the C<CONFIG> "
8635 #: ../fish/guestfish-actions.pod:2387
8640 #: ../fish/guestfish-actions.pod:2389
8648 #: ../fish/guestfish-actions.pod:2391 ../src/guestfs-actions.pod:3480
8650 "This returns C<true> if and only if there is a directory with the given "
8651 "C<path> name. Note that it returns false for other objects like files."
8655 #: ../fish/guestfish-actions.pod:2397
8660 #: ../fish/guestfish-actions.pod:2399
8668 #: ../fish/guestfish-actions.pod:2401 ../src/guestfs-actions.pod:3496
8670 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8671 "given C<path> name."
8675 #: ../fish/guestfish-actions.pod:2406
8680 #: ../fish/guestfish-actions.pod:2408
8688 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3511
8690 "This returns C<true> if and only if there is a regular file with the given "
8691 "C<path> name. Note that it returns false for other objects like "
8696 #: ../fish/guestfish-actions.pod:2416
8697 msgid "is-launching"
8701 #: ../fish/guestfish-actions.pod:2418
8709 #: ../fish/guestfish-actions.pod:2420 ../src/guestfs-actions.pod:3526
8711 "This returns true iff this handle is launching the subprocess (in the "
8712 "C<LAUNCHING> state)."
8716 #: ../fish/guestfish-actions.pod:2425
8721 #: ../fish/guestfish-actions.pod:2427
8729 #: ../fish/guestfish-actions.pod:2429 ../src/guestfs-actions.pod:3541
8731 "This command tests whether C<device> is a logical volume, and returns true "
8732 "iff this is the case."
8736 #: ../fish/guestfish-actions.pod:2432
8741 #: ../fish/guestfish-actions.pod:2434
8749 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3553
8751 "This returns true iff this handle is ready to accept commands (in the "
8756 #: ../fish/guestfish-actions.pod:2441
8761 #: ../fish/guestfish-actions.pod:2443
8769 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3568
8771 "This returns C<true> if and only if there is a Unix domain socket with the "
8772 "given C<path> name."
8776 #: ../fish/guestfish-actions.pod:2450
8781 #: ../fish/guestfish-actions.pod:2452
8784 " is-symlink path\n"
8789 #: ../fish/guestfish-actions.pod:2454 ../src/guestfs-actions.pod:3583
8791 "This returns C<true> if and only if there is a symbolic link with the given "
8796 #: ../fish/guestfish-actions.pod:2459
8801 #: ../fish/guestfish-actions.pod:2461
8809 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3598
8811 "This returns true iff the file exists and the file is empty or it contains "
8816 #: ../fish/guestfish-actions.pod:2466
8817 msgid "is-zero-device"
8821 #: ../fish/guestfish-actions.pod:2468
8824 " is-zero-device device\n"
8829 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3611
8830 msgid "This returns true iff the device exists and contains all zero bytes."
8834 #: ../fish/guestfish-actions.pod:2472 ../src/guestfs-actions.pod:3613
8835 msgid "Note that for large devices this can take a long time to run."
8839 #: ../fish/guestfish-actions.pod:2474
8840 msgid "kill-subprocess"
8844 #: ../fish/guestfish-actions.pod:2476
8847 " kill-subprocess\n"
8852 #: ../fish/guestfish-actions.pod:2478 ../src/guestfs-actions.pod:3624
8853 msgid "This kills the qemu subprocess. You should never need to call this."
8857 #: ../fish/guestfish-actions.pod:2480
8862 #: ../fish/guestfish-actions.pod:2482
8867 #: ../fish/guestfish-actions.pod:2484
8875 #: ../fish/guestfish-actions.pod:2486 ../src/guestfs-actions.pod:3635
8877 "Internally libguestfs is implemented by running a virtual machine using "
8882 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3638
8884 "You should call this after configuring the handle (eg. adding drives) but "
8885 "before performing any actions."
8889 #: ../fish/guestfish-actions.pod:2492
8894 #: ../fish/guestfish-actions.pod:2494
8897 " lchown owner group path\n"
8902 #: ../fish/guestfish-actions.pod:2496
8904 "Change the file owner to C<owner> and group to C<group>. This is like "
8905 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
8910 #: ../fish/guestfish-actions.pod:2504
8915 #: ../fish/guestfish-actions.pod:2506
8918 " lgetxattr path name\n"
8923 #: ../fish/guestfish-actions.pod:2508 ../src/guestfs-actions.pod:3678
8925 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
8926 "is a symlink, then this call returns an extended attribute from the symlink."
8930 #: ../fish/guestfish-actions.pod:2522
8931 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
8935 #: ../fish/guestfish-actions.pod:2524
8940 #: ../fish/guestfish-actions.pod:2526
8943 " lgetxattrs path\n"
8948 #: ../fish/guestfish-actions.pod:2528
8950 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
8951 "it returns the extended attributes of the link itself."
8955 #: ../fish/guestfish-actions.pod:2532
8960 #: ../fish/guestfish-actions.pod:2534
8968 #: ../fish/guestfish-actions.pod:2536 ../src/guestfs-actions.pod:3721
8970 "List all 9p filesystems attached to the guest. A list of mount tags is "
8975 #: ../fish/guestfish-actions.pod:2539
8976 msgid "list-devices"
8980 #: ../fish/guestfish-actions.pod:2541
8988 #: ../fish/guestfish-actions.pod:2543 ../src/guestfs-actions.pod:3735
8989 msgid "List all the block devices."
8993 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3737
8994 msgid "The full block device names are returned, eg. C</dev/sda>."
8998 #: ../fish/guestfish-actions.pod:2549
8999 msgid "list-dm-devices"
9003 #: ../fish/guestfish-actions.pod:2551
9006 " list-dm-devices\n"
9011 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3752
9012 msgid "List all device mapper devices."
9016 #: ../fish/guestfish-actions.pod:2555
9018 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9019 "previous call to L</luks-open>."
9023 #: ../fish/guestfish-actions.pod:2558
9025 "Device mapper devices which correspond to logical volumes are I<not> "
9026 "returned in this list. Call L</lvs> if you want to list logical volumes."
9030 #: ../fish/guestfish-actions.pod:2562
9031 msgid "list-filesystems"
9035 #: ../fish/guestfish-actions.pod:2564
9038 " list-filesystems\n"
9043 #: ../fish/guestfish-actions.pod:2566 ../src/guestfs-actions.pod:3772
9045 "This inspection command looks for filesystems on partitions, block devices "
9046 "and logical volumes, returning a list of devices containing filesystems and "
9051 #: ../fish/guestfish-actions.pod:2570 ../src/guestfs-actions.pod:3776
9053 "The return value is a hash, where the keys are the devices containing "
9054 "filesystems, and the values are the filesystem types. For example:"
9058 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9061 " \"/dev/sda1\" => \"ntfs\"\n"
9062 " \"/dev/sda2\" => \"ext2\"\n"
9063 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9064 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9069 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3785
9071 "The value can have the special value \"unknown\", meaning the content of the "
9072 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9076 #: ../fish/guestfish-actions.pod:2583
9078 "This command runs other libguestfs commands, which might include L</mount> "
9079 "and L</umount>, and therefore you should use this soon after launch and only "
9080 "when nothing is mounted."
9084 #: ../fish/guestfish-actions.pod:2587
9086 "Not all of the filesystems returned will be mountable. In particular, swap "
9087 "partitions are returned in the list. Also this command does not check that "
9088 "each filesystem found is valid and mountable, and some filesystems might be "
9089 "mountable but require special options. Filesystems may not all belong to a "
9090 "single logical operating system (use L</inspect-os> to look for OSes)."
9094 #: ../fish/guestfish-actions.pod:2595
9095 msgid "list-partitions"
9099 #: ../fish/guestfish-actions.pod:2597
9102 " list-partitions\n"
9107 #: ../fish/guestfish-actions.pod:2599 ../src/guestfs-actions.pod:3814
9108 msgid "List all the partitions detected on all block devices."
9112 #: ../fish/guestfish-actions.pod:2601 ../src/guestfs-actions.pod:3816
9113 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9117 #: ../fish/guestfish-actions.pod:2603
9119 "This does not return logical volumes. For that you will need to call "
9124 #: ../fish/guestfish-actions.pod:2608
9129 #: ../fish/guestfish-actions.pod:2610
9137 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3835
9139 "List the files in C<directory> (relative to the root directory, there is no "
9140 "cwd) in the format of 'ls -la'."
9144 #: ../fish/guestfish-actions.pod:2615 ../src/guestfs-actions.pod:3838
9146 "This command is mostly useful for interactive sessions. It is I<not> "
9147 "intended that you try to parse the output string."
9151 #: ../fish/guestfish-actions.pod:2618
9156 #: ../fish/guestfish-actions.pod:2620
9159 " ln target linkname\n"
9164 #: ../fish/guestfish-actions.pod:2622 ../src/guestfs-actions.pod:3853
9165 msgid "This command creates a hard link using the C<ln> command."
9169 #: ../fish/guestfish-actions.pod:2624
9174 #: ../fish/guestfish-actions.pod:2626
9177 " ln-f target linkname\n"
9182 #: ../fish/guestfish-actions.pod:2628 ../src/guestfs-actions.pod:3866
9184 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9185 "option removes the link (C<linkname>) if it exists already."
9189 #: ../fish/guestfish-actions.pod:2631
9194 #: ../fish/guestfish-actions.pod:2633
9197 " ln-s target linkname\n"
9202 #: ../fish/guestfish-actions.pod:2635 ../src/guestfs-actions.pod:3880
9203 msgid "This command creates a symbolic link using the C<ln -s> command."
9207 #: ../fish/guestfish-actions.pod:2637
9212 #: ../fish/guestfish-actions.pod:2639
9215 " ln-sf target linkname\n"
9220 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3893
9222 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9223 "option removes the link (C<linkname>) if it exists already."
9227 #: ../fish/guestfish-actions.pod:2644
9228 msgid "lremovexattr"
9232 #: ../fish/guestfish-actions.pod:2646
9235 " lremovexattr xattr path\n"
9240 #: ../fish/guestfish-actions.pod:2648
9242 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9243 "it removes an extended attribute of the link itself."
9247 #: ../fish/guestfish-actions.pod:2652
9252 #: ../fish/guestfish-actions.pod:2654
9260 #: ../fish/guestfish-actions.pod:2656 ../src/guestfs-actions.pod:3921
9262 "List the files in C<directory> (relative to the root directory, there is no "
9263 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9268 #: ../fish/guestfish-actions.pod:2660
9270 "This command is mostly useful for interactive sessions. Programs should "
9271 "probably use L</readdir> instead."
9275 #: ../fish/guestfish-actions.pod:2663
9280 #: ../fish/guestfish-actions.pod:2665
9283 " lsetxattr xattr val vallen path\n"
9288 #: ../fish/guestfish-actions.pod:2667
9290 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9291 "sets an extended attribute of the link itself."
9295 #: ../fish/guestfish-actions.pod:2671
9300 #: ../fish/guestfish-actions.pod:2673
9308 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:4483 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6736
9309 msgid "Returns file information for the given C<path>."
9313 #: ../fish/guestfish-actions.pod:2677
9315 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9316 "the link is stat-ed, not the file it refers to."
9320 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:3963
9321 msgid "This is the same as the C<lstat(2)> system call."
9325 #: ../fish/guestfish-actions.pod:2683
9330 #: ../fish/guestfish-actions.pod:2685
9333 " lstatlist path 'names ...'\n"
9338 #: ../fish/guestfish-actions.pod:2687
9340 "This call allows you to perform the L</lstat> operation on multiple files, "
9341 "where all files are in the directory C<path>. C<names> is the list of files "
9342 "from this directory."
9346 #: ../fish/guestfish-actions.pod:2691 ../src/guestfs-actions.pod:3982
9348 "On return you get a list of stat structs, with a one-to-one correspondence "
9349 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9350 "then the C<ino> field of that structure is set to C<-1>."
9354 #: ../fish/guestfish-actions.pod:2696
9356 "This call is intended for programs that want to efficiently list a directory "
9357 "contents without making many round-trips. See also L</lxattrlist> for a "
9358 "similarly efficient call for getting extended attributes. Very long "
9359 "directory listings might cause the protocol message size to be exceeded, "
9360 "causing this call to fail. The caller must split up such requests into "
9361 "smaller groups of names."
9365 #: ../fish/guestfish-actions.pod:2704
9366 msgid "luks-add-key"
9370 #: ../fish/guestfish-actions.pod:2706
9373 " luks-add-key device keyslot\n"
9378 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4010
9380 "This command adds a new key on LUKS device C<device>. C<key> is any "
9381 "existing key, and is used to access the device. C<newkey> is the new key to "
9382 "add. C<keyslot> is the key slot that will be replaced."
9386 #: ../fish/guestfish-actions.pod:2713
9388 "Note that if C<keyslot> already contains a key, then this command will "
9389 "fail. You have to use L</luks-kill-slot> first to remove that key."
9393 #: ../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
9395 "This command has one or more key or passphrase parameters. Guestfish will "
9396 "prompt for these separately."
9400 #: ../fish/guestfish-actions.pod:2720
9405 #: ../fish/guestfish-actions.pod:2722
9408 " luks-close device\n"
9413 #: ../fish/guestfish-actions.pod:2724
9415 "This closes a LUKS device that was created earlier by L</luks-open> or "
9416 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
9417 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9418 "underlying block device."
9422 #: ../fish/guestfish-actions.pod:2730
9427 #: ../fish/guestfish-actions.pod:2732
9430 " luks-format device keyslot\n"
9435 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4051
9437 "This command erases existing data on C<device> and formats the device as a "
9438 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9439 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9443 #: ../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:5145 ../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:7812
9445 "B<This command is dangerous. Without careful use you can easily destroy all "
9450 #: ../fish/guestfish-actions.pod:2745
9451 msgid "luks-format-cipher"
9455 #: ../fish/guestfish-actions.pod:2747
9458 " luks-format-cipher device keyslot cipher\n"
9463 #: ../fish/guestfish-actions.pod:2749
9465 "This command is the same as L</luks-format> but it also allows you to set "
9466 "the C<cipher> used."
9470 #: ../fish/guestfish-actions.pod:2758
9471 msgid "luks-kill-slot"
9475 #: ../fish/guestfish-actions.pod:2760
9478 " luks-kill-slot device keyslot\n"
9483 #: ../fish/guestfish-actions.pod:2762 ../src/guestfs-actions.pod:4098
9485 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9486 "device C<device>. C<key> must be one of the I<other> keys."
9490 #: ../fish/guestfish-actions.pod:2769
9495 #: ../fish/guestfish-actions.pod:2771
9498 " luks-open device mapname\n"
9503 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
9505 "This command opens a block device which has been encrypted according to the "
9506 "Linux Unified Key Setup (LUKS) standard."
9510 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
9511 msgid "C<device> is the encrypted block device or partition."
9515 #: ../fish/guestfish-actions.pod:2778 ../src/guestfs-actions.pod:4123
9517 "The caller must supply one of the keys associated with the LUKS block "
9518 "device, in the C<key> parameter."
9522 #: ../fish/guestfish-actions.pod:2781 ../src/guestfs-actions.pod:4126
9524 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9525 "writes to this block device are decrypted from and encrypted to the "
9526 "underlying C<device> respectively."
9530 #: ../fish/guestfish-actions.pod:2785
9532 "If this block device contains LVM volume groups, then calling L</vgscan> "
9533 "followed by L</vg-activate-all> will make them visible."
9537 #: ../fish/guestfish-actions.pod:2789
9538 msgid "Use L</list-dm-devices> to list all device mapper devices."
9542 #: ../fish/guestfish-actions.pod:2795
9543 msgid "luks-open-ro"
9547 #: ../fish/guestfish-actions.pod:2797
9550 " luks-open-ro device mapname\n"
9555 #: ../fish/guestfish-actions.pod:2799
9557 "This is the same as L</luks-open> except that a read-only mapping is "
9562 #: ../fish/guestfish-actions.pod:2805
9567 #: ../fish/guestfish-actions.pod:2807
9570 " lvcreate logvol volgroup mbytes\n"
9575 #: ../fish/guestfish-actions.pod:2809 ../src/guestfs-actions.pod:4172
9577 "This creates an LVM logical volume called C<logvol> on the volume group "
9578 "C<volgroup>, with C<size> megabytes."
9582 #: ../fish/guestfish-actions.pod:2812
9583 msgid "lvm-canonical-lv-name"
9587 #: ../fish/guestfish-actions.pod:2814
9590 " lvm-canonical-lv-name lvname\n"
9595 #: ../fish/guestfish-actions.pod:2816 ../src/guestfs-actions.pod:4185
9597 "This converts alternative naming schemes for LVs that you might find to the "
9598 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9603 #: ../fish/guestfish-actions.pod:2820 ../src/guestfs-actions.pod:4189
9605 "This command returns an error if the C<lvname> parameter does not refer to a "
9610 #: ../fish/guestfish-actions.pod:2823
9611 msgid "See also L</is-lv>."
9615 #: ../fish/guestfish-actions.pod:2825
9616 msgid "lvm-clear-filter"
9620 #: ../fish/guestfish-actions.pod:2827
9623 " lvm-clear-filter\n"
9628 #: ../fish/guestfish-actions.pod:2829
9630 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
9635 #: ../fish/guestfish-actions.pod:2832 ../fish/guestfish-actions.pod:2863 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4249
9636 msgid "This command also clears the LVM cache and performs a volume group scan."
9640 #: ../fish/guestfish-actions.pod:2835
9641 msgid "lvm-remove-all"
9645 #: ../fish/guestfish-actions.pod:2837
9653 #: ../fish/guestfish-actions.pod:2839 ../src/guestfs-actions.pod:4219
9655 "This command removes all LVM logical volumes, volume groups and physical "
9660 #: ../fish/guestfish-actions.pod:2845
9661 msgid "lvm-set-filter"
9665 #: ../fish/guestfish-actions.pod:2847
9668 " lvm-set-filter 'devices ...'\n"
9673 #: ../fish/guestfish-actions.pod:2849 ../src/guestfs-actions.pod:4235
9675 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9676 "block devices in the list C<devices>, and will ignore all other attached "
9681 #: ../fish/guestfish-actions.pod:2853 ../src/guestfs-actions.pod:4239
9683 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9684 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9685 "there are two types of duplication possible: either cloned PVs/VGs which "
9686 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9687 "same name. In normal operation you cannot create this situation, but you "
9688 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9689 "inside the LVM metadata."
9693 #: ../fish/guestfish-actions.pod:2866 ../src/guestfs-actions.pod:4252
9694 msgid "You can filter whole block devices or individual partitions."
9698 #: ../fish/guestfish-actions.pod:2868 ../src/guestfs-actions.pod:4254
9700 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9701 "filesystem), even if you are not filtering out that VG."
9705 #: ../fish/guestfish-actions.pod:2872
9710 #: ../fish/guestfish-actions.pod:2874
9713 " lvremove device\n"
9718 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4268
9720 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9721 "LV, such as C</dev/VG/LV>."
9725 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4271
9727 "You can also remove all LVs in a volume group by specifying the VG name, "
9732 #: ../fish/guestfish-actions.pod:2882
9737 #: ../fish/guestfish-actions.pod:2884
9740 " lvrename logvol newlogvol\n"
9745 #: ../fish/guestfish-actions.pod:2886 ../src/guestfs-actions.pod:4285
9746 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9750 #: ../fish/guestfish-actions.pod:2888
9755 #: ../fish/guestfish-actions.pod:2890
9758 " lvresize device mbytes\n"
9763 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4298
9765 "This resizes (expands or shrinks) an existing LVM logical volume to "
9766 "C<mbytes>. When reducing, data in the reduced part is lost."
9770 #: ../fish/guestfish-actions.pod:2896
9771 msgid "lvresize-free"
9775 #: ../fish/guestfish-actions.pod:2898
9778 " lvresize-free lv percent\n"
9783 #: ../fish/guestfish-actions.pod:2900 ../src/guestfs-actions.pod:4313
9785 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9786 "remaining free space in the volume group. Commonly you would call this with "
9787 "pc = 100 which expands the logical volume as much as possible, using all "
9788 "remaining free space in the volume group."
9792 #: ../fish/guestfish-actions.pod:2906
9797 #: ../fish/guestfish-actions.pod:2908
9805 #: ../fish/guestfish-actions.pod:2910 ../src/guestfs-actions.pod:4328
9807 "List all the logical volumes detected. This is the equivalent of the "
9808 "L<lvs(8)> command."
9812 #: ../fish/guestfish-actions.pod:2913 ../src/guestfs-actions.pod:4331
9814 "This returns a list of the logical volume device names "
9815 "(eg. C</dev/VolGroup00/LogVol00>)."
9819 #: ../fish/guestfish-actions.pod:2916
9820 msgid "See also L</lvs-full>, L</list-filesystems>."
9824 #: ../fish/guestfish-actions.pod:2918
9829 #: ../fish/guestfish-actions.pod:2920
9837 #: ../fish/guestfish-actions.pod:2922 ../src/guestfs-actions.pod:4347
9839 "List all the logical volumes detected. This is the equivalent of the "
9840 "L<lvs(8)> command. The \"full\" version includes all fields."
9844 #: ../fish/guestfish-actions.pod:2925
9849 #: ../fish/guestfish-actions.pod:2927
9857 #: ../fish/guestfish-actions.pod:2929 ../src/guestfs-actions.pod:4362
9858 msgid "This command returns the UUID of the LVM LV C<device>."
9862 #: ../fish/guestfish-actions.pod:2931
9867 #: ../fish/guestfish-actions.pod:2933
9870 " lxattrlist path 'names ...'\n"
9875 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4376
9877 "This call allows you to get the extended attributes of multiple files, where "
9878 "all files are in the directory C<path>. C<names> is the list of files from "
9883 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4380
9885 "On return you get a flat list of xattr structs which must be interpreted "
9886 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9887 "C<attrval> in this struct is zero-length to indicate there was an error "
9888 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9889 "number (the number of following attributes for this file, which could be "
9890 "C<\"0\">). Then after the first xattr struct are the zero or more "
9891 "attributes for the first named file. This repeats for the second and "
9896 #: ../fish/guestfish-actions.pod:2949
9898 "This call is intended for programs that want to efficiently list a directory "
9899 "contents without making many round-trips. See also L</lstatlist> for a "
9900 "similarly efficient call for getting standard stats. Very long directory "
9901 "listings might cause the protocol message size to be exceeded, causing this "
9902 "call to fail. The caller must split up such requests into smaller groups of "
9907 #: ../fish/guestfish-actions.pod:2957
9912 #: ../fish/guestfish-actions.pod:2959
9920 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4410
9921 msgid "Create a directory named C<path>."
9925 #: ../fish/guestfish-actions.pod:2963
9930 #: ../fish/guestfish-actions.pod:2965
9933 " mkdir-mode path mode\n"
9938 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4423
9940 "This command creates a directory, setting the initial permissions of the "
9941 "directory to C<mode>."
9945 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4426
9947 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9948 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9953 #: ../fish/guestfish-actions.pod:2974
9954 msgid "See also L</mkdir>, L</umask>"
9958 #: ../fish/guestfish-actions.pod:2976
9963 #: ../fish/guestfish-actions.pod:2978
9971 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4442
9973 "Create a directory named C<path>, creating any parent directories as "
9974 "necessary. This is like the C<mkdir -p> shell command."
9978 #: ../fish/guestfish-actions.pod:2983
9983 #: ../fish/guestfish-actions.pod:2985
9986 " mkdtemp template\n"
9991 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
9993 "This command creates a temporary directory. The C<template> parameter "
9994 "should be a full pathname for the temporary directory name with the final "
9995 "six characters being \"XXXXXX\"."
9999 #: ../fish/guestfish-actions.pod:2992 ../src/guestfs-actions.pod:4460
10001 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10002 "being suitable for Windows filesystems."
10006 #: ../fish/guestfish-actions.pod:2995 ../src/guestfs-actions.pod:4463
10007 msgid "The name of the temporary directory that was created is returned."
10011 #: ../fish/guestfish-actions.pod:2998 ../src/guestfs-actions.pod:4466
10012 msgid "The temporary directory is created with mode 0700 and is owned by root."
10016 #: ../fish/guestfish-actions.pod:3001 ../src/guestfs-actions.pod:4469
10018 "The caller is responsible for deleting the temporary directory and its "
10019 "contents after use."
10023 #: ../fish/guestfish-actions.pod:3004 ../src/guestfs-actions.pod:4472
10024 msgid "See also: L<mkdtemp(3)>"
10028 #: ../fish/guestfish-actions.pod:3006
10033 #: ../fish/guestfish-actions.pod:3008
10036 " mke2fs-J fstype blocksize device journal\n"
10041 #: ../fish/guestfish-actions.pod:3010 ../src/guestfs-actions.pod:4488
10043 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10044 "C<journal>. It is equivalent to the command:"
10048 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4492
10051 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10056 #: ../fish/guestfish-actions.pod:3016
10057 msgid "See also L</mke2journal>."
10061 #: ../fish/guestfish-actions.pod:3018
10066 #: ../fish/guestfish-actions.pod:3020
10069 " mke2fs-JL fstype blocksize device label\n"
10074 #: ../fish/guestfish-actions.pod:3022 ../src/guestfs-actions.pod:4509
10076 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10077 "the journal labeled C<label>."
10081 #: ../fish/guestfish-actions.pod:3025
10082 msgid "See also L</mke2journal-L>."
10086 #: ../fish/guestfish-actions.pod:3027
10091 #: ../fish/guestfish-actions.pod:3029
10094 " mke2fs-JU fstype blocksize device uuid\n"
10099 #: ../fish/guestfish-actions.pod:3031 ../src/guestfs-actions.pod:4527
10101 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10102 "the journal with UUID C<uuid>."
10106 #: ../fish/guestfish-actions.pod:3034
10107 msgid "See also L</mke2journal-U>."
10111 #: ../fish/guestfish-actions.pod:3036
10112 msgid "mke2journal"
10116 #: ../fish/guestfish-actions.pod:3038
10119 " mke2journal blocksize device\n"
10124 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4543
10126 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10131 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4546
10134 " mke2fs -O journal_dev -b blocksize device\n"
10139 #: ../fish/guestfish-actions.pod:3045
10140 msgid "mke2journal-L"
10144 #: ../fish/guestfish-actions.pod:3047
10147 " mke2journal-L blocksize label device\n"
10152 #: ../fish/guestfish-actions.pod:3049 ../src/guestfs-actions.pod:4560
10153 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10157 #: ../fish/guestfish-actions.pod:3051
10158 msgid "mke2journal-U"
10162 #: ../fish/guestfish-actions.pod:3053
10165 " mke2journal-U blocksize uuid device\n"
10170 #: ../fish/guestfish-actions.pod:3055 ../src/guestfs-actions.pod:4574
10171 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10175 #: ../fish/guestfish-actions.pod:3057
10180 #: ../fish/guestfish-actions.pod:3059
10183 " mkfifo mode path\n"
10188 #: ../fish/guestfish-actions.pod:3061
10190 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10191 "is just a convenient wrapper around L</mknod>."
10195 #: ../fish/guestfish-actions.pod:3067
10200 #: ../fish/guestfish-actions.pod:3069
10203 " mkfs fstype device\n"
10208 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4604
10210 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10211 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10215 #: ../fish/guestfish-actions.pod:3075
10220 #: ../fish/guestfish-actions.pod:3077
10223 " mkfs-b fstype blocksize device\n"
10228 #: ../fish/guestfish-actions.pod:3079
10230 "This call is similar to L</mkfs>, but it allows you to control the block "
10231 "size of the resulting filesystem. Supported block sizes depend on the "
10232 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10236 #: ../fish/guestfish-actions.pod:3084 ../fish/guestfish-actions.pod:3111 ../src/guestfs-actions.pod:4625 ../src/guestfs-actions.pod:4670
10238 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10243 #: ../fish/guestfish-actions.pod:3087
10245 "This function is deprecated. In new code, use the L</mkfs_opts> call "
10250 #: ../fish/guestfish-actions.pod:3094
10255 #: ../fish/guestfish-actions.pod:3096
10258 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10259 "[sectorsize:..]\n"
10264 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4657
10266 "This function creates a filesystem on C<device>. The filesystem type is "
10267 "C<fstype>, for example C<ext3>."
10271 #: ../fish/guestfish-actions.pod:3105 ../src/guestfs-actions.pod:4664
10272 msgid "C<blocksize>"
10276 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4666
10278 "The filesystem block size. Supported block sizes depend on the filesystem "
10279 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10284 #: ../fish/guestfish-actions.pod:3114 ../src/guestfs-actions.pod:4673
10285 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10289 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4675
10290 msgid "C<features>"
10294 #: ../fish/guestfish-actions.pod:3118 ../src/guestfs-actions.pod:4677
10295 msgid "This passes the I<-O> parameter to the external mkfs program."
10299 #: ../fish/guestfish-actions.pod:3120 ../src/guestfs-actions.pod:4679
10301 "For certain filesystem types, this allows extra filesystem features to be "
10302 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10306 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10308 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10313 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10318 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10320 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10321 "sets the inode size (only for ext2/3/4 filesystems at present)."
10325 #: ../fish/guestfish-actions.pod:3132 ../src/guestfs-actions.pod:4691
10326 msgid "C<sectorsize>"
10330 #: ../fish/guestfish-actions.pod:3134 ../src/guestfs-actions.pod:4693
10332 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10333 "sets sector size for ufs filesystem."
10337 #: ../fish/guestfish-actions.pod:3141
10338 msgid "mkmountpoint"
10342 #: ../fish/guestfish-actions.pod:3143
10345 " mkmountpoint exemptpath\n"
10350 #: ../fish/guestfish-actions.pod:3145
10352 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10353 "to create extra mountpoints before mounting the first filesystem."
10357 #: ../fish/guestfish-actions.pod:3149 ../src/guestfs-actions.pod:4736
10359 "These calls are I<only> necessary in some very limited circumstances, mainly "
10360 "the case where you want to mount a mix of unrelated and/or read-only "
10361 "filesystems together."
10365 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10367 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10368 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10369 "inside that. You can unpack this as follows in guestfish:"
10373 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4745
10376 " add-ro Fedora-11-i686-Live.iso\n"
10378 " mkmountpoint /cd\n"
10379 " mkmountpoint /sqsh\n"
10380 " mkmountpoint /ext3fs\n"
10381 " mount /dev/sda /cd\n"
10382 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10383 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10388 #: ../fish/guestfish-actions.pod:3167 ../src/guestfs-actions.pod:4754
10389 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10393 #: ../fish/guestfish-actions.pod:3169
10395 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10396 "unexpected errors if you try to mix these calls. It is safest to manually "
10397 "unmount filesystems and remove mountpoints after use."
10401 #: ../fish/guestfish-actions.pod:3173
10403 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10404 "for this to work for manual mountpoints, you must ensure that the innermost "
10405 "mountpoints have the longest pathnames, as in the example code above."
10409 #: ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4765
10410 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10414 #: ../fish/guestfish-actions.pod:3180
10416 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10417 "L</umount-all> to be called when the handle is closed which can also trigger "
10422 #: ../fish/guestfish-actions.pod:3184
10427 #: ../fish/guestfish-actions.pod:3186
10430 " mknod mode devmajor devminor path\n"
10435 #: ../fish/guestfish-actions.pod:3188 ../src/guestfs-actions.pod:4784
10437 "This call creates block or character special devices, or named pipes "
10442 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4787
10444 "The C<mode> parameter should be the mode, using the standard constants. "
10445 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10446 "used when creating block and character special devices."
10450 #: ../fish/guestfish-actions.pod:3196
10452 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10453 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10454 "regular file). These constants are available in the standard Linux header "
10455 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10456 "wrappers around this command which bitwise OR in the appropriate constant "
10461 #: ../fish/guestfish-actions.pod:3206
10466 #: ../fish/guestfish-actions.pod:3208
10469 " mknod-b mode devmajor devminor path\n"
10474 #: ../fish/guestfish-actions.pod:3210
10476 "This call creates a block device node called C<path> with mode C<mode> and "
10477 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10478 "wrapper around L</mknod>."
10482 #: ../fish/guestfish-actions.pod:3216
10487 #: ../fish/guestfish-actions.pod:3218
10490 " mknod-c mode devmajor devminor path\n"
10495 #: ../fish/guestfish-actions.pod:3220
10497 "This call creates a char device node called C<path> with mode C<mode> and "
10498 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10499 "wrapper around L</mknod>."
10503 #: ../fish/guestfish-actions.pod:3226
10508 #: ../fish/guestfish-actions.pod:3228
10516 #: ../fish/guestfish-actions.pod:3230 ../src/guestfs-actions.pod:4850
10517 msgid "Create a swap partition on C<device>."
10521 #: ../fish/guestfish-actions.pod:3232
10526 #: ../fish/guestfish-actions.pod:3234
10529 " mkswap-L label device\n"
10534 #: ../fish/guestfish-actions.pod:3236 ../src/guestfs-actions.pod:4863
10535 msgid "Create a swap partition on C<device> with label C<label>."
10539 #: ../fish/guestfish-actions.pod:3238 ../src/guestfs-actions.pod:4865
10541 "Note that you cannot attach a swap label to a block device "
10542 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10543 "the kernel or swap tools."
10547 #: ../fish/guestfish-actions.pod:3242
10552 #: ../fish/guestfish-actions.pod:3244
10555 " mkswap-U uuid device\n"
10560 #: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:4880
10561 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10565 #: ../fish/guestfish-actions.pod:3248
10566 msgid "mkswap-file"
10570 #: ../fish/guestfish-actions.pod:3250
10573 " mkswap-file path\n"
10578 #: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:4892
10579 msgid "Create a swap file."
10583 #: ../fish/guestfish-actions.pod:3254
10585 "This command just writes a swap file signature to an existing file. To "
10586 "create the file itself, use something like L</fallocate>."
10590 #: ../fish/guestfish-actions.pod:3257
10595 #: ../fish/guestfish-actions.pod:3259
10598 " modprobe modulename\n"
10603 #: ../fish/guestfish-actions.pod:3261 ../src/guestfs-actions.pod:4907
10604 msgid "This loads a kernel module in the appliance."
10608 #: ../fish/guestfish-actions.pod:3263 ../src/guestfs-actions.pod:4909
10610 "The kernel module must have been whitelisted when libguestfs was built (see "
10611 "C<appliance/kmod.whitelist.in> in the source)."
10615 #: ../fish/guestfish-actions.pod:3266
10620 #: ../fish/guestfish-actions.pod:3268
10623 " mount device mountpoint\n"
10628 #: ../fish/guestfish-actions.pod:3270 ../src/guestfs-actions.pod:4923
10630 "Mount a guest disk at a position in the filesystem. Block devices are named "
10631 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10632 "those block devices contain partitions, they will have the usual names "
10633 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10637 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4929
10639 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10640 "mounted on C</> before others can be mounted. Other filesystems can only be "
10641 "mounted on directories which already exist."
10645 #: ../fish/guestfish-actions.pod:3281 ../src/guestfs-actions.pod:4934
10647 "The mounted filesystem is writable, if we have sufficient permissions on the "
10648 "underlying device."
10652 #: ../fish/guestfish-actions.pod:3284
10654 "B<Important note:> When you use this call, the filesystem options C<sync> "
10655 "and C<noatime> are set implicitly. This was originally done because we "
10656 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10657 "very large negative performance impact and negligible effect on "
10658 "reliability. Therefore we recommend that you avoid using L</mount> in any "
10659 "code that needs performance, and instead use L</mount-options> (use an empty "
10660 "string for the first parameter if you don't want any options)."
10664 #: ../fish/guestfish-actions.pod:3294
10666 "This function is deprecated. In new code, use the L</mount_options> call "
10671 #: ../fish/guestfish-actions.pod:3301
10676 #: ../fish/guestfish-actions.pod:3303
10679 " mount-9p mounttag mountpoint [options:..]\n"
10684 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:4973
10686 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10691 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:4976
10693 "If required, C<trans=virtio> will be automatically added to the options. "
10694 "Any other options required can be passed in the optional C<options> "
10699 #: ../fish/guestfish-actions.pod:3314
10704 #: ../fish/guestfish-actions.pod:3316
10707 " mount-loop file mountpoint\n"
10712 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5015
10714 "This command lets you mount C<file> (a filesystem image in a file) on a "
10715 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10720 #: ../fish/guestfish-actions.pod:3322
10721 msgid "mount-options"
10725 #: ../fish/guestfish-actions.pod:3324
10728 " mount-options options device mountpoint\n"
10733 #: ../fish/guestfish-actions.pod:3326
10735 "This is the same as the L</mount> command, but it allows you to set the "
10736 "mount options as for the L<mount(8)> I<-o> flag."
10740 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5035
10742 "If the C<options> parameter is an empty string, then no options are passed "
10743 "(all options default to whatever the filesystem uses)."
10747 #: ../fish/guestfish-actions.pod:3334
10752 #: ../fish/guestfish-actions.pod:3336
10755 " mount-ro device mountpoint\n"
10760 #: ../fish/guestfish-actions.pod:3338
10762 "This is the same as the L</mount> command, but it mounts the filesystem with "
10763 "the read-only (I<-o ro>) flag."
10767 #: ../fish/guestfish-actions.pod:3341
10772 #: ../fish/guestfish-actions.pod:3343
10775 " mount-vfs options vfstype device mountpoint\n"
10780 #: ../fish/guestfish-actions.pod:3345
10782 "This is the same as the L</mount> command, but it allows you to set both the "
10783 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
10787 #: ../fish/guestfish-actions.pod:3349
10788 msgid "mountpoints"
10792 #: ../fish/guestfish-actions.pod:3351
10800 #: ../fish/guestfish-actions.pod:3353
10802 "This call is similar to L</mounts>. That call returns a list of devices. "
10803 "This one returns a hash table (map) of device name to directory where the "
10804 "device is mounted."
10808 #: ../fish/guestfish-actions.pod:3357
10813 #: ../fish/guestfish-actions.pod:3359
10821 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5096
10823 "This returns the list of currently mounted filesystems. It returns the list "
10824 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10828 #: ../fish/guestfish-actions.pod:3364 ../src/guestfs-actions.pod:5099
10829 msgid "Some internal mounts are not shown."
10833 #: ../fish/guestfish-actions.pod:3366
10834 msgid "See also: L</mountpoints>"
10838 #: ../fish/guestfish-actions.pod:3368
10843 #: ../fish/guestfish-actions.pod:3370
10851 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5116
10853 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10854 "destination filename or destination directory."
10858 #: ../fish/guestfish-actions.pod:3375
10859 msgid "ntfs-3g-probe"
10863 #: ../fish/guestfish-actions.pod:3377
10866 " ntfs-3g-probe true|false device\n"
10871 #: ../fish/guestfish-actions.pod:3379 ../src/guestfs-actions.pod:5130
10873 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10874 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10875 "read-write, and some cannot be mounted at all)."
10879 #: ../fish/guestfish-actions.pod:3383 ../src/guestfs-actions.pod:5134
10881 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10882 "can be mounted read-write. Set it to false if you want to test if the "
10883 "volume can be mounted read-only."
10887 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5138
10889 "The return value is an integer which C<0> if the operation would succeed, or "
10890 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10894 #: ../fish/guestfish-actions.pod:3391
10899 #: ../fish/guestfish-actions.pod:3393
10902 " ntfsresize device\n"
10907 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3419 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5191
10909 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10910 "size of the underlying device."
10914 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5155
10916 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
10917 "consistency check (for safety). You have to boot into Windows to perform "
10918 "this check and clear this condition. Furthermore, ntfsresize refuses to "
10919 "resize filesystems which have been marked in this way. So in effect it is "
10920 "not possible to call ntfsresize multiple times on a single filesystem "
10921 "without booting into Windows between each resize."
10925 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3445 ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5217
10926 msgid "See also L<ntfsresize(8)>."
10930 #: ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3456
10932 "This function is deprecated. In new code, use the L</ntfsresize_opts> call "
10937 #: ../fish/guestfish-actions.pod:3415
10938 msgid "ntfsresize-opts"
10942 #: ../fish/guestfish-actions.pod:3417
10945 " ntfsresize-opts device [size:..] [force:..]\n"
10950 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
10952 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
10953 "resized to fit the container (eg. partition)."
10957 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5203
10962 #: ../fish/guestfish-actions.pod:3433 ../src/guestfs-actions.pod:5205
10964 "If this option is true, then force the resize of the filesystem even if the "
10965 "filesystem is marked as requiring a consistency check."
10969 #: ../fish/guestfish-actions.pod:3436
10971 "After the resize operation, the filesystem is always marked as requiring a "
10972 "consistency check (for safety). You have to boot into Windows to perform "
10973 "this check and clear this condition. If you I<don't> set the C<force> "
10974 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
10975 "a single filesystem without booting into Windows between each resize."
10979 #: ../fish/guestfish-actions.pod:3449
10980 msgid "ntfsresize-size"
10984 #: ../fish/guestfish-actions.pod:3451
10987 " ntfsresize-size device size\n"
10992 #: ../fish/guestfish-actions.pod:3453
10994 "This command is the same as L</ntfsresize> except that it allows you to "
10995 "specify the new size (in bytes) explicitly."
10999 #: ../fish/guestfish-actions.pod:3463
11004 #: ../fish/guestfish-actions.pod:3465
11007 " part-add device prlogex startsect endsect\n"
11012 #: ../fish/guestfish-actions.pod:3467
11014 "This command adds a partition to C<device>. If there is no partition table "
11015 "on the device, call L</part-init> first."
11019 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11021 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11022 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11023 "C<logical>) and C<e> (or C<extended>) partition types."
11027 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5283
11029 "C<startsect> and C<endsect> are the start and end of the partition in "
11030 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11031 "from the end of the disk (C<-1> is the last sector)."
11035 #: ../fish/guestfish-actions.pod:3479
11037 "Creating a partition which covers the whole disk is not so easy. Use "
11038 "L</part-disk> to do that."
11042 #: ../fish/guestfish-actions.pod:3482
11047 #: ../fish/guestfish-actions.pod:3484
11050 " part-del device partnum\n"
11055 #: ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5301
11056 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11060 #: ../fish/guestfish-actions.pod:3488 ../src/guestfs-actions.pod:5303
11062 "Note that in the case of MBR partitioning, deleting an extended partition "
11063 "also deletes any logical partitions it contains."
11067 #: ../fish/guestfish-actions.pod:3492
11072 #: ../fish/guestfish-actions.pod:3494
11075 " part-disk device parttype\n"
11080 #: ../fish/guestfish-actions.pod:3496
11082 "This command is simply a combination of L</part-init> followed by "
11083 "L</part-add> to create a single primary partition covering the whole disk."
11087 #: ../fish/guestfish-actions.pod:3500
11089 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11090 "possible values are described in L</part-init>."
11094 #: ../fish/guestfish-actions.pod:3506
11095 msgid "part-get-bootable"
11099 #: ../fish/guestfish-actions.pod:3508
11102 " part-get-bootable device partnum\n"
11107 #: ../fish/guestfish-actions.pod:3510 ../src/guestfs-actions.pod:5339
11109 "This command returns true if the partition C<partnum> on C<device> has the "
11110 "bootable flag set."
11114 #: ../fish/guestfish-actions.pod:3513
11115 msgid "See also L</part-set-bootable>."
11119 #: ../fish/guestfish-actions.pod:3515
11120 msgid "part-get-mbr-id"
11124 #: ../fish/guestfish-actions.pod:3517
11127 " part-get-mbr-id device partnum\n"
11132 #: ../fish/guestfish-actions.pod:3519 ../src/guestfs-actions.pod:5355
11134 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11135 "partition C<partnum>."
11139 #: ../fish/guestfish-actions.pod:3522 ../fish/guestfish-actions.pod:3666
11141 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11142 "undefined results for other partition table types (see "
11143 "L</part-get-parttype>)."
11147 #: ../fish/guestfish-actions.pod:3526
11148 msgid "part-get-parttype"
11152 #: ../fish/guestfish-actions.pod:3528
11155 " part-get-parttype device\n"
11160 #: ../fish/guestfish-actions.pod:3530 ../src/guestfs-actions.pod:5372
11162 "This command examines the partition table on C<device> and returns the "
11163 "partition table type (format) being used."
11167 #: ../fish/guestfish-actions.pod:3533
11169 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11170 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11171 "possible, although unusual. See L</part-init> for a full list."
11175 #: ../fish/guestfish-actions.pod:3538
11180 #: ../fish/guestfish-actions.pod:3540
11183 " part-init device parttype\n"
11188 #: ../fish/guestfish-actions.pod:3542 ../src/guestfs-actions.pod:5392
11190 "This creates an empty partition table on C<device> of one of the partition "
11191 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11192 "(for large disks)."
11196 #: ../fish/guestfish-actions.pod:3546
11198 "Initially there are no partitions. Following this, you should call "
11199 "L</part-add> for each partition required."
11203 #: ../fish/guestfish-actions.pod:3549 ../src/guestfs-actions.pod:5399
11204 msgid "Possible values for C<parttype> are:"
11208 #: ../fish/guestfish-actions.pod:3553 ../src/guestfs-actions.pod:5403
11213 #: ../fish/guestfish-actions.pod:3555 ../src/guestfs-actions.pod:5405
11218 #: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:5407
11219 msgid "Intel EFI / GPT partition table."
11223 #: ../fish/guestfish-actions.pod:3559 ../src/guestfs-actions.pod:5409
11225 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11226 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11227 "the C<mbr> format."
11231 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5413
11236 #: ../fish/guestfish-actions.pod:3565 ../src/guestfs-actions.pod:5415
11241 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5417
11243 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11244 "Windows. This partition type will B<only> work for device sizes up to 2 "
11245 "TB. For large disks we recommend using C<gpt>."
11249 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11250 msgid "Other partition table types that may work but are not supported include:"
11254 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11259 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11260 msgid "AIX disk labels."
11264 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
11269 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11274 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5437
11275 msgid "Amiga \"Rigid Disk Block\" format."
11279 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11284 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
11285 msgid "BSD disk labels."
11289 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
11294 #: ../fish/guestfish-actions.pod:3595 ../src/guestfs-actions.pod:5445
11295 msgid "DASD, used on IBM mainframes."
11299 #: ../fish/guestfish-actions.pod:3597 ../src/guestfs-actions.pod:5447
11304 #: ../fish/guestfish-actions.pod:3599 ../src/guestfs-actions.pod:5449
11305 msgid "MIPS/SGI volumes."
11309 #: ../fish/guestfish-actions.pod:3601 ../src/guestfs-actions.pod:5451
11314 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5453
11315 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11319 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11324 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11325 msgid "NEC PC-98 format, common in Japan apparently."
11329 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11334 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11335 msgid "Sun disk labels."
11339 #: ../fish/guestfish-actions.pod:3615
11344 #: ../fish/guestfish-actions.pod:3617
11347 " part-list device\n"
11352 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5475
11354 "This command parses the partition table on C<device> and returns the list of "
11355 "partitions found."
11359 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5478
11360 msgid "The fields in the returned structure are:"
11364 #: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5482
11365 msgid "B<part_num>"
11369 #: ../fish/guestfish-actions.pod:3628 ../src/guestfs-actions.pod:5484
11370 msgid "Partition number, counting from 1."
11374 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11375 msgid "B<part_start>"
11379 #: ../fish/guestfish-actions.pod:3632
11381 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11382 "the device's sector size, see L</blockdev-getss>."
11386 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5491
11387 msgid "B<part_end>"
11391 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5493
11392 msgid "End of the partition in bytes."
11396 #: ../fish/guestfish-actions.pod:3639 ../src/guestfs-actions.pod:5495
11397 msgid "B<part_size>"
11401 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5497
11402 msgid "Size of the partition in bytes."
11406 #: ../fish/guestfish-actions.pod:3645
11407 msgid "part-set-bootable"
11411 #: ../fish/guestfish-actions.pod:3647
11414 " part-set-bootable device partnum true|false\n"
11419 #: ../fish/guestfish-actions.pod:3649 ../src/guestfs-actions.pod:5515
11421 "This sets the bootable flag on partition numbered C<partnum> on device "
11422 "C<device>. Note that partitions are numbered from 1."
11426 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5518
11428 "The bootable flag is used by some operating systems (notably Windows) to "
11429 "determine which partition to boot from. It is by no means universally "
11434 #: ../fish/guestfish-actions.pod:3656
11435 msgid "part-set-mbr-id"
11439 #: ../fish/guestfish-actions.pod:3658
11442 " part-set-mbr-id device partnum idbyte\n"
11447 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5534
11449 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11450 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11451 "documentation are in fact hexadecimal numbers, but usually documented "
11452 "without any leading \"0x\" which might be confusing."
11456 #: ../fish/guestfish-actions.pod:3670
11457 msgid "part-set-name"
11461 #: ../fish/guestfish-actions.pod:3672
11464 " part-set-name device partnum name\n"
11469 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5556
11471 "This sets the partition name on partition numbered C<partnum> on device "
11472 "C<device>. Note that partitions are numbered from 1."
11476 #: ../fish/guestfish-actions.pod:3677 ../src/guestfs-actions.pod:5559
11478 "The partition name can only be set on certain types of partition table. "
11479 "This works on C<gpt> but not on C<mbr> partitions."
11483 #: ../fish/guestfish-actions.pod:3680
11484 msgid "part-to-dev"
11488 #: ../fish/guestfish-actions.pod:3682
11491 " part-to-dev partition\n"
11496 #: ../fish/guestfish-actions.pod:3684 ../src/guestfs-actions.pod:5572
11498 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11499 "partition number, returning the device name (eg. \"/dev/sdb\")."
11503 #: ../fish/guestfish-actions.pod:3688
11505 "The named partition must exist, for example as a string returned from "
11506 "L</list-partitions>."
11510 #: ../fish/guestfish-actions.pod:3691
11511 msgid "ping-daemon"
11515 #: ../fish/guestfish-actions.pod:3693
11523 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5589
11525 "This is a test probe into the guestfs daemon running inside the qemu "
11526 "subprocess. Calling this function checks that the daemon responds to the "
11527 "ping message, without affecting the daemon or attached block device(s) in "
11532 #: ../fish/guestfish-actions.pod:3700
11537 #: ../fish/guestfish-actions.pod:3702
11540 " pread path count offset\n"
11545 #: ../fish/guestfish-actions.pod:3704 ../src/guestfs-actions.pod:5607
11547 "This command lets you read part of a file. It reads C<count> bytes of the "
11548 "file, starting at C<offset>, from file C<path>."
11552 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722 ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
11554 "This may read fewer bytes than requested. For further details see the "
11555 "L<pread(2)> system call."
11559 #: ../fish/guestfish-actions.pod:3710
11560 msgid "See also L</pwrite>, L</pread-device>."
11564 #: ../fish/guestfish-actions.pod:3715
11565 msgid "pread-device"
11569 #: ../fish/guestfish-actions.pod:3717
11572 " pread-device device count offset\n"
11577 #: ../fish/guestfish-actions.pod:3719 ../src/guestfs-actions.pod:5633
11579 "This command lets you read part of a file. It reads C<count> bytes of "
11580 "C<device>, starting at C<offset>."
11584 #: ../fish/guestfish-actions.pod:3725
11585 msgid "See also L</pread>."
11589 #: ../fish/guestfish-actions.pod:3730
11594 #: ../fish/guestfish-actions.pod:3732
11597 " pvcreate device\n"
11602 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5656
11604 "This creates an LVM physical volume on the named C<device>, where C<device> "
11605 "should usually be a partition name such as C</dev/sda1>."
11609 #: ../fish/guestfish-actions.pod:3738
11614 #: ../fish/guestfish-actions.pod:3740
11617 " pvremove device\n"
11622 #: ../fish/guestfish-actions.pod:3742 ../src/guestfs-actions.pod:5670
11624 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11629 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5673
11631 "The implementation uses the C<pvremove> command which refuses to wipe "
11632 "physical volumes that contain any volume groups, so you have to remove those "
11637 #: ../fish/guestfish-actions.pod:3749
11642 #: ../fish/guestfish-actions.pod:3751
11645 " pvresize device\n"
11650 #: ../fish/guestfish-actions.pod:3753 ../src/guestfs-actions.pod:5687
11652 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11653 "the new size of the underlying device."
11657 #: ../fish/guestfish-actions.pod:3756
11658 msgid "pvresize-size"
11662 #: ../fish/guestfish-actions.pod:3758
11665 " pvresize-size device size\n"
11670 #: ../fish/guestfish-actions.pod:3760
11672 "This command is the same as L</pvresize> except that it allows you to "
11673 "specify the new size (in bytes) explicitly."
11677 #: ../fish/guestfish-actions.pod:3763
11682 #: ../fish/guestfish-actions.pod:3765
11690 #: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5713
11692 "List all the physical volumes detected. This is the equivalent of the "
11693 "L<pvs(8)> command."
11697 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5716
11699 "This returns a list of just the device names that contain PVs "
11700 "(eg. C</dev/sda2>)."
11704 #: ../fish/guestfish-actions.pod:3773
11705 msgid "See also L</pvs-full>."
11709 #: ../fish/guestfish-actions.pod:3775
11714 #: ../fish/guestfish-actions.pod:3777
11722 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5732
11724 "List all the physical volumes detected. This is the equivalent of the "
11725 "L<pvs(8)> command. The \"full\" version includes all fields."
11729 #: ../fish/guestfish-actions.pod:3782
11734 #: ../fish/guestfish-actions.pod:3784
11742 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5747
11743 msgid "This command returns the UUID of the LVM PV C<device>."
11747 #: ../fish/guestfish-actions.pod:3788
11752 #: ../fish/guestfish-actions.pod:3790
11755 " pwrite path content offset\n"
11760 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5763
11762 "This command writes to part of a file. It writes the data buffer C<content> "
11763 "to the file C<path> starting at offset C<offset>."
11767 #: ../fish/guestfish-actions.pod:3795 ../src/guestfs-actions.pod:5766
11769 "This command implements the L<pwrite(2)> system call, and like that system "
11770 "call it may not write the full data requested. The return value is the "
11771 "number of bytes that were actually written to the file. This could even be "
11772 "0, although short writes are unlikely for regular files in ordinary "
11777 #: ../fish/guestfish-actions.pod:3801
11778 msgid "See also L</pread>, L</pwrite-device>."
11782 #: ../fish/guestfish-actions.pod:3806
11783 msgid "pwrite-device"
11787 #: ../fish/guestfish-actions.pod:3808
11790 " pwrite-device device content offset\n"
11795 #: ../fish/guestfish-actions.pod:3810 ../src/guestfs-actions.pod:5790
11797 "This command writes to part of a device. It writes the data buffer "
11798 "C<content> to C<device> starting at offset C<offset>."
11802 #: ../fish/guestfish-actions.pod:3813 ../src/guestfs-actions.pod:5793
11804 "This command implements the L<pwrite(2)> system call, and like that system "
11805 "call it may not write the full data requested (although short writes to disk "
11806 "devices and partitions are probably impossible with standard Linux kernels)."
11810 #: ../fish/guestfish-actions.pod:3818
11811 msgid "See also L</pwrite>."
11815 #: ../fish/guestfish-actions.pod:3823
11820 #: ../fish/guestfish-actions.pod:3825
11823 " read-file path\n"
11828 #: ../fish/guestfish-actions.pod:3827 ../src/guestfs-actions.pod:5814
11829 msgid "This calls returns the contents of the file C<path> as a buffer."
11833 #: ../fish/guestfish-actions.pod:3830
11835 "Unlike L</cat>, this function can correctly handle files that contain "
11836 "embedded ASCII NUL characters. However unlike L</download>, this function "
11837 "is limited in the total size of file that can be handled."
11841 #: ../fish/guestfish-actions.pod:3838
11846 #: ../fish/guestfish-actions.pod:3840
11849 " read-lines path\n"
11854 #: ../fish/guestfish-actions.pod:3844 ../src/guestfs-actions.pod:5839
11856 "The file contents are returned as a list of lines. Trailing C<LF> and "
11857 "C<CRLF> character sequences are I<not> returned."
11861 #: ../fish/guestfish-actions.pod:3847
11863 "Note that this function cannot correctly handle binary files (specifically, "
11864 "files containing C<\\0> character which is treated as end of line). For "
11865 "those you need to use the L</read-file> function which has a more complex "
11870 #: ../fish/guestfish-actions.pod:3852
11875 #: ../fish/guestfish-actions.pod:3854
11883 #: ../fish/guestfish-actions.pod:3856 ../src/guestfs-actions.pod:5859
11884 msgid "This returns the list of directory entries in directory C<dir>."
11888 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5861
11890 "All entries in the directory are returned, including C<.> and C<..>. The "
11891 "entries are I<not> sorted, but returned in the same order as the underlying "
11896 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
11898 "Also this call returns basic file type information about each file. The "
11899 "C<ftyp> field will contain one of the following characters:"
11903 #: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:5870
11908 #: ../fish/guestfish-actions.pod:3869 ../src/guestfs-actions.pod:5872
11909 msgid "Block special"
11913 #: ../fish/guestfish-actions.pod:3871 ../src/guestfs-actions.pod:5874
11918 #: ../fish/guestfish-actions.pod:3873 ../src/guestfs-actions.pod:5876
11919 msgid "Char special"
11923 #: ../fish/guestfish-actions.pod:3875 ../src/guestfs-actions.pod:5878
11928 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:5880
11933 #: ../fish/guestfish-actions.pod:3879 ../src/guestfs-actions.pod:5882
11938 #: ../fish/guestfish-actions.pod:3881 ../src/guestfs-actions.pod:5884
11939 msgid "FIFO (named pipe)"
11943 #: ../fish/guestfish-actions.pod:3883 ../src/guestfs-actions.pod:5886
11948 #: ../fish/guestfish-actions.pod:3885 ../src/guestfs-actions.pod:5888
11949 msgid "Symbolic link"
11953 #: ../fish/guestfish-actions.pod:3887 ../src/guestfs-actions.pod:5890
11958 #: ../fish/guestfish-actions.pod:3889 ../src/guestfs-actions.pod:5892
11959 msgid "Regular file"
11963 #: ../fish/guestfish-actions.pod:3891 ../src/guestfs-actions.pod:5894
11968 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
11973 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
11978 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
11979 msgid "Unknown file type"
11983 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
11988 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
11989 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11993 #: ../fish/guestfish-actions.pod:3906
11995 "This function is primarily intended for use by programs. To get a simple "
11996 "list of names, use L</ls>. To get a printable directory for human "
11997 "consumption, use L</ll>."
12001 #: ../fish/guestfish-actions.pod:3910
12006 #: ../fish/guestfish-actions.pod:3912
12014 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:5925
12015 msgid "This command reads the target of a symbolic link."
12019 #: ../fish/guestfish-actions.pod:3916
12020 msgid "readlinklist"
12024 #: ../fish/guestfish-actions.pod:3918
12027 " readlinklist path 'names ...'\n"
12032 #: ../fish/guestfish-actions.pod:3920 ../src/guestfs-actions.pod:5939
12034 "This call allows you to do a C<readlink> operation on multiple files, where "
12035 "all files are in the directory C<path>. C<names> is the list of files from "
12040 #: ../fish/guestfish-actions.pod:3924 ../src/guestfs-actions.pod:5943
12042 "On return you get a list of strings, with a one-to-one correspondence to the "
12043 "C<names> list. Each string is the value of the symbolic link."
12047 #: ../fish/guestfish-actions.pod:3928 ../src/guestfs-actions.pod:5947
12049 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12050 "result string is the empty string C<\"\">. However the whole operation is "
12051 "completed even if there were C<readlink(2)> errors, and so you can call this "
12052 "function with names where you don't know if they are symbolic links already "
12053 "(albeit slightly less efficient)."
12057 #: ../fish/guestfish-actions.pod:3935 ../src/guestfs-actions.pod:5954
12059 "This call is intended for programs that want to efficiently list a directory "
12060 "contents without making many round-trips. Very long directory listings "
12061 "might cause the protocol message size to be exceeded, causing this call to "
12062 "fail. The caller must split up such requests into smaller groups of names."
12066 #: ../fish/guestfish-actions.pod:3942
12071 #: ../fish/guestfish-actions.pod:3944
12079 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5973
12081 "Return the canonicalized absolute pathname of C<path>. The returned path "
12082 "has no C<.>, C<..> or symbolic link path elements."
12086 #: ../fish/guestfish-actions.pod:3949
12087 msgid "removexattr"
12091 #: ../fish/guestfish-actions.pod:3951
12094 " removexattr xattr path\n"
12099 #: ../fish/guestfish-actions.pod:3953 ../src/guestfs-actions.pod:5988
12100 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12104 #: ../fish/guestfish-actions.pod:3956
12105 msgid "See also: L</lremovexattr>, L<attr(5)>."
12109 #: ../fish/guestfish-actions.pod:3958
12114 #: ../fish/guestfish-actions.pod:3960
12117 " resize2fs device\n"
12122 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6003
12124 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12125 "underlying device."
12129 #: ../fish/guestfish-actions.pod:3965
12131 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12132 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12133 "gives an error about this and sometimes not. In any case, it is always safe "
12134 "to call L</e2fsck-f> before calling this function."
12138 #: ../fish/guestfish-actions.pod:3971
12139 msgid "resize2fs-M"
12143 #: ../fish/guestfish-actions.pod:3973
12146 " resize2fs-M device\n"
12151 #: ../fish/guestfish-actions.pod:3975
12153 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12154 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12159 #: ../fish/guestfish-actions.pod:3979
12161 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12162 "and read the C<Block size> and C<Block count> values. These two numbers, "
12163 "multiplied together, give the resulting size of the minimal filesystem in "
12168 #: ../fish/guestfish-actions.pod:3984
12169 msgid "resize2fs-size"
12173 #: ../fish/guestfish-actions.pod:3986
12176 " resize2fs-size device size\n"
12181 #: ../fish/guestfish-actions.pod:3988
12183 "This command is the same as L</resize2fs> except that it allows you to "
12184 "specify the new size (in bytes) explicitly."
12188 #: ../fish/guestfish-actions.pod:3991
12193 #: ../fish/guestfish-actions.pod:3993
12201 #: ../fish/guestfish-actions.pod:3995 ../src/guestfs-actions.pod:6055
12202 msgid "Remove the single file C<path>."
12206 #: ../fish/guestfish-actions.pod:3997
12211 #: ../fish/guestfish-actions.pod:3999
12219 #: ../fish/guestfish-actions.pod:4001 ../src/guestfs-actions.pod:6067
12221 "Remove the file or directory C<path>, recursively removing the contents if "
12222 "its a directory. This is like the C<rm -rf> shell command."
12226 #: ../fish/guestfish-actions.pod:4005
12231 #: ../fish/guestfish-actions.pod:4007
12239 #: ../fish/guestfish-actions.pod:4009 ../src/guestfs-actions.pod:6081
12240 msgid "Remove the single directory C<path>."
12244 #: ../fish/guestfish-actions.pod:4011
12245 msgid "rmmountpoint"
12249 #: ../fish/guestfish-actions.pod:4013
12252 " rmmountpoint exemptpath\n"
12257 #: ../fish/guestfish-actions.pod:4015
12259 "This calls removes a mountpoint that was previously created with "
12260 "L</mkmountpoint>. See L</mkmountpoint> for full details."
12264 #: ../fish/guestfish-actions.pod:4019
12265 msgid "scrub-device"
12269 #: ../fish/guestfish-actions.pod:4021
12272 " scrub-device device\n"
12277 #: ../fish/guestfish-actions.pod:4023 ../src/guestfs-actions.pod:6107
12279 "This command writes patterns over C<device> to make data retrieval more "
12284 #: ../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
12286 "It is an interface to the L<scrub(1)> program. See that manual page for "
12291 #: ../fish/guestfish-actions.pod:4032
12296 #: ../fish/guestfish-actions.pod:4034
12299 " scrub-file file\n"
12304 #: ../fish/guestfish-actions.pod:4036 ../src/guestfs-actions.pod:6126
12306 "This command writes patterns over a file to make data retrieval more "
12311 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6129
12312 msgid "The file is I<removed> after scrubbing."
12316 #: ../fish/guestfish-actions.pod:4044
12317 msgid "scrub-freespace"
12321 #: ../fish/guestfish-actions.pod:4046
12324 " scrub-freespace dir\n"
12329 #: ../fish/guestfish-actions.pod:4048
12331 "This command creates the directory C<dir> and then fills it with files until "
12332 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12333 "deletes them. The intention is to scrub any free space on the partition "
12334 "containing C<dir>."
12338 #: ../fish/guestfish-actions.pod:4057
12343 #: ../fish/guestfish-actions.pod:4059
12348 #: ../fish/guestfish-actions.pod:4061
12351 " set-append append\n"
12356 #: ../fish/guestfish-actions.pod:4063 ../src/guestfs-actions.pod:6163
12358 "This function is used to add additional options to the guest kernel command "
12363 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6166
12365 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12366 "environment variable."
12370 #: ../fish/guestfish-actions.pod:4069 ../src/guestfs-actions.pod:6169
12372 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12373 "(libguestfs always adds a few of its own)."
12377 #: ../fish/guestfish-actions.pod:4072
12378 msgid "set-attach-method"
12382 #: ../fish/guestfish-actions.pod:4074
12383 msgid "attach-method"
12387 #: ../fish/guestfish-actions.pod:4076
12390 " set-attach-method attachmethod\n"
12395 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182
12397 "Set the method that libguestfs uses to connect to the back end guestfsd "
12398 "daemon. Possible methods are:"
12402 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187 ../src/guestfs.pod:2687
12403 msgid "C<appliance>"
12407 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12409 "Launch an appliance and connect to it. This is the ordinary method and the "
12414 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6192
12415 msgid "C<unix:I<path>>"
12419 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6194
12420 msgid "Connect to the Unix domain socket I<path>."
12424 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6196
12426 "This method lets you connect to an existing daemon or (using virtio-serial) "
12427 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12428 "RUNNING DAEMONS>."
12432 #: ../fish/guestfish-actions.pod:4098
12433 msgid "set-autosync"
12437 #: ../fish/guestfish-actions.pod:4100
12442 #: ../fish/guestfish-actions.pod:4102
12445 " set-autosync true|false\n"
12450 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
12452 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12453 "effort attempt to make filesystems consistent and synchronized when the "
12454 "handle is closed (also if the program exits without closing handles)."
12458 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6217
12460 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12461 "disabled by default)."
12465 #: ../fish/guestfish-actions.pod:4112
12470 #: ../fish/guestfish-actions.pod:4114
12475 #: ../fish/guestfish-actions.pod:4116
12478 " set-direct true|false\n"
12483 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6230
12485 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12486 "passed directly through to the appliance once it is launched."
12490 #: ../fish/guestfish-actions.pod:4122
12492 "One consequence of this is that log messages aren't caught by the library "
12493 "and handled by L</set-log-message-callback>, but go straight to stdout."
12497 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6238
12498 msgid "You probably don't want to use this unless you know what you are doing."
12502 #: ../fish/guestfish-actions.pod:4129 ../src/guestfs-actions.pod:6241
12503 msgid "The default is disabled."
12507 #: ../fish/guestfish-actions.pod:4131
12508 msgid "set-e2label"
12512 #: ../fish/guestfish-actions.pod:4133
12515 " set-e2label device label\n"
12520 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6254
12522 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12523 "C<label>. Filesystem labels are limited to 16 characters."
12527 #: ../fish/guestfish-actions.pod:4139
12529 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12530 "label on a filesystem."
12534 #: ../fish/guestfish-actions.pod:4142
12539 #: ../fish/guestfish-actions.pod:4144
12542 " set-e2uuid device uuid\n"
12547 #: ../fish/guestfish-actions.pod:4146 ../src/guestfs-actions.pod:6272
12549 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12550 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12551 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12555 #: ../fish/guestfish-actions.pod:4151
12557 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12558 "UUID of a filesystem."
12562 #: ../fish/guestfish-actions.pod:4154
12563 msgid "set-memsize"
12567 #: ../fish/guestfish-actions.pod:4156
12572 #: ../fish/guestfish-actions.pod:4158
12575 " set-memsize memsize\n"
12580 #: ../fish/guestfish-actions.pod:4160
12582 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12583 "This only has any effect if called before L</launch>."
12587 #: ../fish/guestfish-actions.pod:4164 ../src/guestfs-actions.pod:6294
12589 "You can also change this by setting the environment variable "
12590 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12594 #: ../fish/guestfish-actions.pod:4171
12595 msgid "set-network"
12599 #: ../fish/guestfish-actions.pod:4173
12604 #: ../fish/guestfish-actions.pod:4175
12607 " set-network true|false\n"
12612 #: ../fish/guestfish-actions.pod:4177 ../src/guestfs-actions.pod:6311
12614 "If C<network> is true, then the network is enabled in the libguestfs "
12615 "appliance. The default is false."
12619 #: ../fish/guestfish-actions.pod:4180 ../src/guestfs-actions.pod:6314
12621 "This affects whether commands are able to access the network (see "
12622 "L<guestfs(3)/RUNNING COMMANDS>)."
12626 #: ../fish/guestfish-actions.pod:4183
12627 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12631 #: ../fish/guestfish-actions.pod:4186
12636 #: ../fish/guestfish-actions.pod:4190
12639 " set-path searchpath\n"
12644 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
12645 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12649 #: ../fish/guestfish-actions.pod:4194 ../src/guestfs-actions.pod:6332
12651 "The default is C<$libdir/guestfs> unless overridden by setting "
12652 "C<LIBGUESTFS_PATH> environment variable."
12656 #: ../fish/guestfish-actions.pod:4197 ../src/guestfs-actions.pod:6335
12657 msgid "Setting C<path> to C<NULL> restores the default path."
12661 #: ../fish/guestfish-actions.pod:4199
12666 #: ../fish/guestfish-actions.pod:4201
12671 #: ../fish/guestfish-actions.pod:4203
12674 " set-pgroup true|false\n"
12679 #: ../fish/guestfish-actions.pod:4205 ../src/guestfs-actions.pod:6347
12681 "If C<pgroup> is true, child processes are placed into their own process "
12686 #: ../fish/guestfish-actions.pod:4208 ../src/guestfs-actions.pod:6350
12688 "The practical upshot of this is that signals like C<SIGINT> (from users "
12689 "pressing C<^C>) won't be received by the child process."
12693 #: ../fish/guestfish-actions.pod:4211 ../src/guestfs-actions.pod:6353
12695 "The default for this flag is false, because usually you want C<^C> to kill "
12700 #: ../fish/guestfish-actions.pod:4214
12705 #: ../fish/guestfish-actions.pod:4216
12710 #: ../fish/guestfish-actions.pod:4218
12718 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
12719 msgid "Set the qemu binary that we will use."
12723 #: ../fish/guestfish-actions.pod:4222 ../src/guestfs-actions.pod:6368
12724 msgid "The default is chosen when the library was compiled by the configure script."
12728 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
12730 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12735 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6374
12736 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12740 #: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6376
12742 "Note that you should call this function as early as possible after creating "
12743 "the handle. This is because some pre-launch operations depend on testing "
12744 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12745 "don't retest features, and so you might see inconsistent results. Using the "
12746 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12747 "the qemu binary at the same time as the handle is created."
12751 #: ../fish/guestfish-actions.pod:4238
12752 msgid "set-recovery-proc"
12756 #: ../fish/guestfish-actions.pod:4240
12757 msgid "recovery-proc"
12761 #: ../fish/guestfish-actions.pod:4242
12764 " set-recovery-proc true|false\n"
12769 #: ../fish/guestfish-actions.pod:4244
12771 "If this is called with the parameter C<false> then L</launch> does not "
12772 "create a recovery process. The purpose of the recovery process is to stop "
12773 "runaway qemu processes in the case where the main program aborts abruptly."
12777 #: ../fish/guestfish-actions.pod:4249
12779 "This only has any effect if called before L</launch>, and the default is "
12784 #: ../fish/guestfish-actions.pod:4252 ../src/guestfs-actions.pod:6402
12786 "About the only time when you would want to disable this is if the main "
12787 "process will fork itself into the background (\"daemonize\" itself). In "
12788 "this case the recovery process thinks that the main program has disappeared "
12789 "and so kills qemu, which is not very helpful."
12793 #: ../fish/guestfish-actions.pod:4258
12794 msgid "set-selinux"
12798 #: ../fish/guestfish-actions.pod:4260
12803 #: ../fish/guestfish-actions.pod:4262
12806 " set-selinux true|false\n"
12811 #: ../fish/guestfish-actions.pod:4264 ../src/guestfs-actions.pod:6418
12813 "This sets the selinux flag that is passed to the appliance at boot time. "
12814 "The default is C<selinux=0> (disabled)."
12818 #: ../fish/guestfish-actions.pod:4267 ../src/guestfs-actions.pod:6421
12820 "Note that if SELinux is enabled, it is always in Permissive mode "
12821 "(C<enforcing=0>)."
12825 #: ../fish/guestfish-actions.pod:4273
12830 #: ../fish/guestfish-actions.pod:4275
12835 #: ../fish/guestfish-actions.pod:4277
12838 " set-trace true|false\n"
12843 #: ../fish/guestfish-actions.pod:4279 ../src/guestfs-actions.pod:6437
12845 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
12846 "return values are traced."
12850 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6440
12852 "If you want to trace C API calls into libguestfs (and other libraries) then "
12853 "possibly a better way is to use the external ltrace(1) command."
12857 #: ../fish/guestfish-actions.pod:4286 ../src/guestfs-actions.pod:6444
12859 "Command traces are disabled unless the environment variable "
12860 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12864 #: ../fish/guestfish-actions.pod:4289
12866 "Trace messages are normally sent to C<stderr>, unless you register a "
12867 "callback to send them somewhere else (see L</set-event-callback>)."
12871 #: ../fish/guestfish-actions.pod:4293
12872 msgid "set-verbose"
12876 #: ../fish/guestfish-actions.pod:4295
12881 #: ../fish/guestfish-actions.pod:4297
12884 " set-verbose true|false\n"
12889 #: ../fish/guestfish-actions.pod:4299 ../src/guestfs-actions.pod:6461
12890 msgid "If C<verbose> is true, this turns on verbose messages."
12894 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6463
12896 "Verbose messages are disabled unless the environment variable "
12897 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12901 #: ../fish/guestfish-actions.pod:4304
12903 "Verbose messages are normally sent to C<stderr>, unless you register a "
12904 "callback to send them somewhere else (see L</set-event-callback>)."
12908 #: ../fish/guestfish-actions.pod:4308
12913 #: ../fish/guestfish-actions.pod:4310
12916 " setcon context\n"
12921 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6480
12923 "This sets the SELinux security context of the daemon to the string "
12928 #: ../fish/guestfish-actions.pod:4315 ../src/guestfs-actions.pod:6483
12929 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12933 #: ../fish/guestfish-actions.pod:4317
12938 #: ../fish/guestfish-actions.pod:4319
12941 " setxattr xattr val vallen path\n"
12946 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6498
12948 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12949 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12953 #: ../fish/guestfish-actions.pod:4325
12954 msgid "See also: L</lsetxattr>, L<attr(5)>."
12958 #: ../fish/guestfish-actions.pod:4327
12963 #: ../fish/guestfish-actions.pod:4329
12966 " sfdisk device cyls heads sectors 'lines ...'\n"
12971 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6518
12973 "This is a direct interface to the L<sfdisk(8)> program for creating "
12974 "partitions on block devices."
12978 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6521
12979 msgid "C<device> should be a block device, for example C</dev/sda>."
12983 #: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6523
12985 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12986 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
12987 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12988 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12989 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12990 "the kernel) cannot work out the right geometry and you will need to tell it."
12994 #: ../fish/guestfish-actions.pod:4344 ../src/guestfs-actions.pod:6531
12996 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12997 "refer to the L<sfdisk(8)> manpage."
13001 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6534
13003 "To create a single partition occupying the whole disk, you would pass "
13004 "C<lines> as a single element list, when the single element being the string "
13009 #: ../fish/guestfish-actions.pod:4351
13010 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13014 #: ../fish/guestfish-actions.pod:4357 ../fish/guestfish-actions.pod:4380 ../fish/guestfish-actions.pod:4402
13016 "This function is deprecated. In new code, use the L</part_add> call "
13021 #: ../fish/guestfish-actions.pod:4364
13026 #: ../fish/guestfish-actions.pod:4366
13029 " sfdiskM device 'lines ...'\n"
13034 #: ../fish/guestfish-actions.pod:4368
13036 "This is a simplified interface to the L</sfdisk> command, where partition "
13037 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13038 "you don't need to specify the cyls, heads and sectors parameters which were "
13039 "rarely if ever used anyway."
13043 #: ../fish/guestfish-actions.pod:4374
13044 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13048 #: ../fish/guestfish-actions.pod:4387
13053 #: ../fish/guestfish-actions.pod:4389
13056 " sfdisk-N device partnum cyls heads sectors line\n"
13061 #: ../fish/guestfish-actions.pod:4391 ../src/guestfs-actions.pod:6596
13063 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13064 "(note: C<n> counts from 1)."
13068 #: ../fish/guestfish-actions.pod:4394
13070 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13071 "cyls/heads/sectors parameters."
13075 #: ../fish/guestfish-actions.pod:4397
13076 msgid "See also: L</part-add>"
13080 #: ../fish/guestfish-actions.pod:4409
13081 msgid "sfdisk-disk-geometry"
13085 #: ../fish/guestfish-actions.pod:4411
13088 " sfdisk-disk-geometry device\n"
13093 #: ../fish/guestfish-actions.pod:4413
13095 "This displays the disk geometry of C<device> read from the partition table. "
13096 "Especially in the case where the underlying block device has been resized, "
13097 "this can be different from the kernel's idea of the geometry (see "
13098 "L</sfdisk-kernel-geometry>)."
13102 #: ../fish/guestfish-actions.pod:4418 ../fish/guestfish-actions.pod:4427 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6645
13103 msgid "The result is in human-readable format, and not designed to be parsed."
13107 #: ../fish/guestfish-actions.pod:4421
13108 msgid "sfdisk-kernel-geometry"
13112 #: ../fish/guestfish-actions.pod:4423
13115 " sfdisk-kernel-geometry device\n"
13120 #: ../fish/guestfish-actions.pod:4425 ../src/guestfs-actions.pod:6643
13121 msgid "This displays the kernel's idea of the geometry of C<device>."
13125 #: ../fish/guestfish-actions.pod:4430
13130 #: ../fish/guestfish-actions.pod:4432
13133 " sfdisk-l device\n"
13138 #: ../fish/guestfish-actions.pod:4434 ../src/guestfs-actions.pod:6659
13140 "This displays the partition table on C<device>, in the human-readable output "
13141 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13145 #: ../fish/guestfish-actions.pod:4438
13146 msgid "See also: L</part-list>"
13150 #: ../fish/guestfish-actions.pod:4440
13152 "This function is deprecated. In new code, use the L</part_list> call "
13157 #: ../fish/guestfish-actions.pod:4447
13162 #: ../fish/guestfish-actions.pod:4449
13170 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13172 "This call runs a command from the guest filesystem via the guest's "
13177 #: ../fish/guestfish-actions.pod:4454
13178 msgid "This is like L</command>, but passes the command to:"
13182 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6688
13185 " /bin/sh -c \"command\"\n"
13190 #: ../fish/guestfish-actions.pod:4458 ../src/guestfs-actions.pod:6690
13192 "Depending on the guest's shell, this usually results in wildcards being "
13193 "expanded, shell expressions being interpolated and so on."
13197 #: ../fish/guestfish-actions.pod:4462
13198 msgid "All the provisos about L</command> apply to this call."
13202 #: ../fish/guestfish-actions.pod:4464
13207 #: ../fish/guestfish-actions.pod:4466
13210 " sh-lines command\n"
13215 #: ../fish/guestfish-actions.pod:4468
13216 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13220 #: ../fish/guestfish-actions.pod:4471
13221 msgid "See also: L</command-lines>"
13225 #: ../fish/guestfish-actions.pod:4473
13230 #: ../fish/guestfish-actions.pod:4475
13238 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6724
13239 msgid "Sleep for C<secs> seconds."
13243 #: ../fish/guestfish-actions.pod:4479
13248 #: ../fish/guestfish-actions.pod:4481
13256 #: ../fish/guestfish-actions.pod:4485 ../src/guestfs-actions.pod:6738
13257 msgid "This is the same as the C<stat(2)> system call."
13261 #: ../fish/guestfish-actions.pod:4487
13266 #: ../fish/guestfish-actions.pod:4489
13274 #: ../fish/guestfish-actions.pod:4491 ../src/guestfs-actions.pod:6752
13276 "Returns file system statistics for any mounted file system. C<path> should "
13277 "be a file or directory in the mounted file system (typically it is the mount "
13278 "point itself, but it doesn't need to be)."
13282 #: ../fish/guestfish-actions.pod:4495 ../src/guestfs-actions.pod:6756
13283 msgid "This is the same as the C<statvfs(2)> system call."
13287 #: ../fish/guestfish-actions.pod:4497
13292 #: ../fish/guestfish-actions.pod:4499
13300 #: ../fish/guestfish-actions.pod:4501 ../src/guestfs-actions.pod:6770
13302 "This runs the L<strings(1)> command on a file and returns the list of "
13303 "printable strings found."
13307 #: ../fish/guestfish-actions.pod:4507
13312 #: ../fish/guestfish-actions.pod:4509
13315 " strings-e encoding path\n"
13320 #: ../fish/guestfish-actions.pod:4511
13322 "This is like the L</strings> command, but allows you to specify the encoding "
13323 "of strings that are looked for in the source file C<path>."
13327 #: ../fish/guestfish-actions.pod:4515 ../src/guestfs-actions.pod:6793
13328 msgid "Allowed encodings are:"
13332 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13337 #: ../fish/guestfish-actions.pod:4521
13339 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13340 "ISO-8859-X (this is what L</strings> uses)."
13344 #: ../fish/guestfish-actions.pod:4524 ../src/guestfs-actions.pod:6802
13349 #: ../fish/guestfish-actions.pod:4526 ../src/guestfs-actions.pod:6804
13350 msgid "Single 8-bit-byte characters."
13354 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13359 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13360 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13364 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13365 msgid "l (lower case letter L)"
13369 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13371 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13372 "examining binaries in Windows guests."
13376 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:6816
13381 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:6818
13382 msgid "32-bit big endian such as UCS-4BE."
13386 #: ../fish/guestfish-actions.pod:4542 ../src/guestfs-actions.pod:6820
13391 #: ../fish/guestfish-actions.pod:4544 ../src/guestfs-actions.pod:6822
13392 msgid "32-bit little endian such as UCS-4LE."
13396 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:6826
13397 msgid "The returned strings are transcoded to UTF-8."
13401 #: ../fish/guestfish-actions.pod:4553
13402 msgid "swapoff-device"
13406 #: ../fish/guestfish-actions.pod:4555
13409 " swapoff-device device\n"
13414 #: ../fish/guestfish-actions.pod:4557
13416 "This command disables the libguestfs appliance swap device or partition "
13417 "named C<device>. See L</swapon-device>."
13421 #: ../fish/guestfish-actions.pod:4561
13422 msgid "swapoff-file"
13426 #: ../fish/guestfish-actions.pod:4563
13429 " swapoff-file file\n"
13434 #: ../fish/guestfish-actions.pod:4565 ../src/guestfs-actions.pod:6857
13435 msgid "This command disables the libguestfs appliance swap on file."
13439 #: ../fish/guestfish-actions.pod:4567
13440 msgid "swapoff-label"
13444 #: ../fish/guestfish-actions.pod:4569
13447 " swapoff-label label\n"
13452 #: ../fish/guestfish-actions.pod:4571 ../src/guestfs-actions.pod:6869
13454 "This command disables the libguestfs appliance swap on labeled swap "
13459 #: ../fish/guestfish-actions.pod:4574
13460 msgid "swapoff-uuid"
13464 #: ../fish/guestfish-actions.pod:4576
13467 " swapoff-uuid uuid\n"
13472 #: ../fish/guestfish-actions.pod:4578 ../src/guestfs-actions.pod:6882
13474 "This command disables the libguestfs appliance swap partition with the given "
13479 #: ../fish/guestfish-actions.pod:4581
13480 msgid "swapon-device"
13484 #: ../fish/guestfish-actions.pod:4583
13487 " swapon-device device\n"
13492 #: ../fish/guestfish-actions.pod:4585
13494 "This command enables the libguestfs appliance to use the swap device or "
13495 "partition named C<device>. The increased memory is made available for all "
13496 "commands, for example those run using L</command> or L</sh>."
13500 #: ../fish/guestfish-actions.pod:4590 ../src/guestfs-actions.pod:6900
13502 "Note that you should not swap to existing guest swap partitions unless you "
13503 "know what you are doing. They may contain hibernation information, or other "
13504 "information that the guest doesn't want you to trash. You also risk leaking "
13505 "information about the host to the guest this way. Instead, attach a new "
13506 "host device to the guest and swap on that."
13510 #: ../fish/guestfish-actions.pod:4597
13511 msgid "swapon-file"
13515 #: ../fish/guestfish-actions.pod:4599
13518 " swapon-file file\n"
13523 #: ../fish/guestfish-actions.pod:4601
13524 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
13528 #: ../fish/guestfish-actions.pod:4604
13529 msgid "swapon-label"
13533 #: ../fish/guestfish-actions.pod:4606
13536 " swapon-label label\n"
13541 #: ../fish/guestfish-actions.pod:4608
13543 "This command enables swap to a labeled swap partition. See "
13544 "L</swapon-device> for other notes."
13548 #: ../fish/guestfish-actions.pod:4611
13549 msgid "swapon-uuid"
13553 #: ../fish/guestfish-actions.pod:4613
13556 " swapon-uuid uuid\n"
13561 #: ../fish/guestfish-actions.pod:4615
13563 "This command enables swap to a swap partition with the given UUID. See "
13564 "L</swapon-device> for other notes."
13568 #: ../fish/guestfish-actions.pod:4618
13573 #: ../fish/guestfish-actions.pod:4620
13581 #: ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:6955
13583 "This syncs the disk, so that any writes are flushed through to the "
13584 "underlying disk image."
13588 #: ../fish/guestfish-actions.pod:4625 ../src/guestfs-actions.pod:6958
13590 "You should always call this if you have modified a disk image, before "
13591 "closing the handle."
13595 #: ../fish/guestfish-actions.pod:4628
13600 #: ../fish/guestfish-actions.pod:4630
13608 #: ../fish/guestfish-actions.pod:4632 ../src/guestfs-actions.pod:6971
13609 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13613 #: ../fish/guestfish-actions.pod:4638
13618 #: ../fish/guestfish-actions.pod:4640
13621 " tail-n nrlines path\n"
13626 #: ../fish/guestfish-actions.pod:4642 ../src/guestfs-actions.pod:6990
13628 "If the parameter C<nrlines> is a positive number, this returns the last "
13629 "C<nrlines> lines of the file C<path>."
13633 #: ../fish/guestfish-actions.pod:4645 ../src/guestfs-actions.pod:6993
13635 "If the parameter C<nrlines> is a negative number, this returns lines from "
13636 "the file C<path>, starting with the C<-nrlines>th line."
13640 #: ../fish/guestfish-actions.pod:4653
13645 #: ../fish/guestfish-actions.pod:4655
13648 " tar-in (tarfile|-) directory\n"
13653 #: ../fish/guestfish-actions.pod:4657 ../src/guestfs-actions.pod:7014
13655 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13656 "tar file) into C<directory>."
13660 #: ../fish/guestfish-actions.pod:4660
13661 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
13665 #: ../fish/guestfish-actions.pod:4665
13670 #: ../fish/guestfish-actions.pod:4667
13673 " tar-out directory (tarfile|-)\n"
13678 #: ../fish/guestfish-actions.pod:4669 ../src/guestfs-actions.pod:7031
13680 "This command packs the contents of C<directory> and downloads it to local "
13685 #: ../fish/guestfish-actions.pod:4672
13686 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
13690 #: ../fish/guestfish-actions.pod:4677
13695 #: ../fish/guestfish-actions.pod:4679
13698 " tgz-in (tarball|-) directory\n"
13703 #: ../fish/guestfish-actions.pod:4681 ../src/guestfs-actions.pod:7048
13705 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13706 "tar file) into C<directory>."
13710 #: ../fish/guestfish-actions.pod:4684
13711 msgid "To upload an uncompressed tarball, use L</tar-in>."
13715 #: ../fish/guestfish-actions.pod:4688
13720 #: ../fish/guestfish-actions.pod:4690
13723 " tgz-out directory (tarball|-)\n"
13728 #: ../fish/guestfish-actions.pod:4692 ../src/guestfs-actions.pod:7064
13730 "This command packs the contents of C<directory> and downloads it to local "
13735 #: ../fish/guestfish-actions.pod:4695
13736 msgid "To download an uncompressed tarball, use L</tar-out>."
13740 #: ../fish/guestfish-actions.pod:4699
13745 #: ../fish/guestfish-actions.pod:4701
13753 #: ../fish/guestfish-actions.pod:4703 ../src/guestfs-actions.pod:7079
13755 "Touch acts like the L<touch(1)> command. It can be used to update the "
13756 "timestamps on a file, or, if the file does not exist, to create a new "
13757 "zero-length file."
13761 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7083
13763 "This command only works on regular files, and will fail on other file types "
13764 "such as directories, symbolic links, block special etc."
13768 #: ../fish/guestfish-actions.pod:4710
13773 #: ../fish/guestfish-actions.pod:4712
13781 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7096
13783 "This command truncates C<path> to a zero-length file. The file must exist "
13788 #: ../fish/guestfish-actions.pod:4717
13789 msgid "truncate-size"
13793 #: ../fish/guestfish-actions.pod:4719
13796 " truncate-size path size\n"
13801 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7110
13803 "This command truncates C<path> to size C<size> bytes. The file must exist "
13808 #: ../fish/guestfish-actions.pod:4724
13810 "If the current file size is less than C<size> then the file is extended to "
13811 "the required size with zero bytes. This creates a sparse file (ie. disk "
13812 "blocks are not allocated for the file until you write to it). To create a "
13813 "non-sparse file of zeroes, use L</fallocate64> instead."
13817 #: ../fish/guestfish-actions.pod:4730
13822 #: ../fish/guestfish-actions.pod:4732
13825 " tune2fs-l device\n"
13830 #: ../fish/guestfish-actions.pod:4734 ../src/guestfs-actions.pod:7129
13832 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13837 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7132
13839 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13840 "for more details. The list of fields returned isn't clearly defined, and "
13841 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13842 "and the filesystem itself."
13846 #: ../fish/guestfish-actions.pod:4742
13851 #: ../fish/guestfish-actions.pod:4744
13854 " txz-in (tarball|-) directory\n"
13859 #: ../fish/guestfish-actions.pod:4746 ../src/guestfs-actions.pod:7152
13861 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13862 "tar file) into C<directory>."
13866 #: ../fish/guestfish-actions.pod:4751
13871 #: ../fish/guestfish-actions.pod:4753
13874 " txz-out directory (tarball|-)\n"
13879 #: ../fish/guestfish-actions.pod:4755 ../src/guestfs-actions.pod:7166
13881 "This command packs the contents of C<directory> and downloads it to local "
13882 "file C<tarball> (as an xz compressed tar archive)."
13886 #: ../fish/guestfish-actions.pod:4760
13891 #: ../fish/guestfish-actions.pod:4762
13899 #: ../fish/guestfish-actions.pod:4764 ../src/guestfs-actions.pod:7179
13901 "This function sets the mask used for creating new files and device nodes to "
13906 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
13908 "Typical umask values would be C<022> which creates new files with "
13909 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13910 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13914 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7187
13916 "The default umask is C<022>. This is important because it means that "
13917 "directories and device nodes will be created with C<0644> or C<0755> mode "
13918 "even if you specify C<0777>."
13922 #: ../fish/guestfish-actions.pod:4776
13923 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
13927 #: ../fish/guestfish-actions.pod:4779 ../src/guestfs-actions.pod:7194
13928 msgid "This call returns the previous umask."
13932 #: ../fish/guestfish-actions.pod:4781
13937 #: ../fish/guestfish-actions.pod:4783
13942 #: ../fish/guestfish-actions.pod:4785
13945 " umount pathordevice\n"
13950 #: ../fish/guestfish-actions.pod:4787 ../src/guestfs-actions.pod:7206
13952 "This unmounts the given filesystem. The filesystem may be specified either "
13953 "by its mountpoint (path) or the device which contains the filesystem."
13957 #: ../fish/guestfish-actions.pod:4791
13962 #: ../fish/guestfish-actions.pod:4793
13963 msgid "unmount-all"
13967 #: ../fish/guestfish-actions.pod:4795
13975 #: ../fish/guestfish-actions.pod:4797 ../src/guestfs-actions.pod:7219
13976 msgid "This unmounts all mounted filesystems."
13980 #: ../fish/guestfish-actions.pod:4799 ../src/guestfs-actions.pod:7221
13981 msgid "Some internal mounts are not unmounted by this call."
13985 #: ../fish/guestfish-actions.pod:4801
13990 #: ../fish/guestfish-actions.pod:4803
13993 " upload (filename|-) remotefilename\n"
13998 #: ../fish/guestfish-actions.pod:4805 ../fish/guestfish-actions.pod:4818 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7258
13999 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14003 #: ../fish/guestfish-actions.pod:4810
14004 msgid "See also L</download>."
14008 #: ../fish/guestfish-actions.pod:4814
14009 msgid "upload-offset"
14013 #: ../fish/guestfish-actions.pod:4816
14016 " upload-offset (filename|-) remotefilename offset\n"
14021 #: ../fish/guestfish-actions.pod:4821 ../src/guestfs-actions.pod:7261
14023 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14024 "The intention is to overwrite parts of existing files or devices, although "
14025 "if a non-existant file is specified then it is created with a \"hole\" "
14026 "before C<offset>. The size of the data written is implicit in the size of "
14027 "the source C<filename>."
14031 #: ../fish/guestfish-actions.pod:4828
14033 "Note that there is no limit on the amount of data that can be uploaded with "
14034 "this call, unlike with L</pwrite>, and this call always writes the full "
14035 "amount unless an error occurs."
14039 #: ../fish/guestfish-actions.pod:4833
14040 msgid "See also L</upload>, L</pwrite>."
14044 #: ../fish/guestfish-actions.pod:4837
14049 #: ../fish/guestfish-actions.pod:4839
14052 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14057 #: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7294
14058 msgid "This command sets the timestamps of a file with nanosecond precision."
14062 #: ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7297
14064 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14069 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7300
14071 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14072 "nanoseconds from the epoch."
14076 #: ../fish/guestfish-actions.pod:4850 ../src/guestfs-actions.pod:7303
14078 "If the C<*nsecs> field contains the special value C<-1> then the "
14079 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14080 "ignored in this case)."
14084 #: ../fish/guestfish-actions.pod:4854 ../src/guestfs-actions.pod:7307
14086 "If the C<*nsecs> field contains the special value C<-2> then the "
14087 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14092 #: ../fish/guestfish-actions.pod:4858
14097 #: ../fish/guestfish-actions.pod:4860
14105 #: ../fish/guestfish-actions.pod:4862 ../src/guestfs-actions.pod:7320
14106 msgid "Return the libguestfs version number that the program is linked against."
14110 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14112 "Note that because of dynamic linking this is not necessarily the version of "
14113 "libguestfs that you compiled against. You can compile the program, and then "
14114 "at runtime dynamically link against a completely different C<libguestfs.so> "
14119 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7328
14121 "This call was added in version C<1.0.58>. In previous versions of "
14122 "libguestfs there was no way to get the version number. From C code you can "
14123 "use dynamic linker functions to find out if this symbol exists (if it "
14124 "doesn't, then it's an earlier version)."
14128 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7334
14130 "The call returns a structure with four elements. The first three (C<major>, "
14131 "C<minor> and C<release>) are numbers and correspond to the usual version "
14132 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14133 "but may be used for distro-specific information."
14137 #: ../fish/guestfish-actions.pod:4882 ../src/guestfs-actions.pod:7340
14138 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14142 #: ../fish/guestfish-actions.pod:4885 ../src/guestfs-actions.pod:7343
14143 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14147 #: ../fish/guestfish-actions.pod:4887
14149 "I<Note:> Don't use this call to test for availability of features. In "
14150 "enterprise distributions we backport features from later versions into "
14151 "earlier versions, making this an unreliable way to test for features. Use "
14152 "L</available> instead."
14156 #: ../fish/guestfish-actions.pod:4893
14161 #: ../fish/guestfish-actions.pod:4895
14164 " vfs-label device\n"
14169 #: ../fish/guestfish-actions.pod:4897 ../src/guestfs-actions.pod:7363
14170 msgid "This returns the filesystem label of the filesystem on C<device>."
14174 #: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7366
14175 msgid "If the filesystem is unlabeled, this returns the empty string."
14179 #: ../fish/guestfish-actions.pod:4902
14180 msgid "To find a filesystem from the label, use L</findfs-label>."
14184 #: ../fish/guestfish-actions.pod:4904
14189 #: ../fish/guestfish-actions.pod:4906
14192 " vfs-type device\n"
14197 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7381
14199 "This command gets the filesystem type corresponding to the filesystem on "
14204 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7384
14206 "For most filesystems, the result is the name of the Linux VFS module which "
14207 "would be used to mount this filesystem if you mounted it without specifying "
14208 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14212 #: ../fish/guestfish-actions.pod:4916
14217 #: ../fish/guestfish-actions.pod:4918
14220 " vfs-uuid device\n"
14225 #: ../fish/guestfish-actions.pod:4920 ../src/guestfs-actions.pod:7400
14226 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14230 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7403
14231 msgid "If the filesystem does not have a UUID, this returns the empty string."
14235 #: ../fish/guestfish-actions.pod:4925
14236 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14240 #: ../fish/guestfish-actions.pod:4927
14241 msgid "vg-activate"
14245 #: ../fish/guestfish-actions.pod:4929
14248 " vg-activate true|false 'volgroups ...'\n"
14253 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14255 "This command activates or (if C<activate> is false) deactivates all logical "
14256 "volumes in the listed volume groups C<volgroups>."
14260 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7422
14261 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14265 #: ../fish/guestfish-actions.pod:4936 ../src/guestfs-actions.pod:7424
14267 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14268 "activated or deactivated."
14272 #: ../fish/guestfish-actions.pod:4939
14273 msgid "vg-activate-all"
14277 #: ../fish/guestfish-actions.pod:4941
14280 " vg-activate-all true|false\n"
14285 #: ../fish/guestfish-actions.pod:4943 ../src/guestfs-actions.pod:7437
14287 "This command activates or (if C<activate> is false) deactivates all logical "
14288 "volumes in all volume groups."
14292 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7440
14293 msgid "This command is the same as running C<vgchange -a y|n>"
14297 #: ../fish/guestfish-actions.pod:4948
14302 #: ../fish/guestfish-actions.pod:4950
14305 " vgcreate volgroup 'physvols ...'\n"
14310 #: ../fish/guestfish-actions.pod:4952 ../src/guestfs-actions.pod:7453
14312 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14313 "of physical volumes C<physvols>."
14317 #: ../fish/guestfish-actions.pod:4955
14322 #: ../fish/guestfish-actions.pod:4957
14325 " vglvuuids vgname\n"
14330 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7466
14332 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14333 "volumes created in this volume group."
14337 #: ../fish/guestfish-actions.pod:4962
14339 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14340 "logical volumes and volume groups."
14344 #: ../fish/guestfish-actions.pod:4965
14345 msgid "See also L</vgpvuuids>."
14349 #: ../fish/guestfish-actions.pod:4967
14354 #: ../fish/guestfish-actions.pod:4969
14357 " vgpvuuids vgname\n"
14362 #: ../fish/guestfish-actions.pod:4971 ../src/guestfs-actions.pod:7486
14364 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14365 "volumes that this volume group resides on."
14369 #: ../fish/guestfish-actions.pod:4974
14371 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14372 "physical volumes and volume groups."
14376 #: ../fish/guestfish-actions.pod:4977
14377 msgid "See also L</vglvuuids>."
14381 #: ../fish/guestfish-actions.pod:4979
14386 #: ../fish/guestfish-actions.pod:4981
14389 " vgremove vgname\n"
14394 #: ../fish/guestfish-actions.pod:4983 ../src/guestfs-actions.pod:7506
14395 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14399 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7508
14400 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14404 #: ../fish/guestfish-actions.pod:4988
14409 #: ../fish/guestfish-actions.pod:4990
14412 " vgrename volgroup newvolgroup\n"
14417 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7522
14418 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14422 #: ../fish/guestfish-actions.pod:4994
14427 #: ../fish/guestfish-actions.pod:4996
14435 #: ../fish/guestfish-actions.pod:4998 ../src/guestfs-actions.pod:7533
14437 "List all the volumes groups detected. This is the equivalent of the "
14438 "L<vgs(8)> command."
14442 #: ../fish/guestfish-actions.pod:5001 ../src/guestfs-actions.pod:7536
14444 "This returns a list of just the volume group names that were detected "
14445 "(eg. C<VolGroup00>)."
14449 #: ../fish/guestfish-actions.pod:5004
14450 msgid "See also L</vgs-full>."
14454 #: ../fish/guestfish-actions.pod:5006
14459 #: ../fish/guestfish-actions.pod:5008
14467 #: ../fish/guestfish-actions.pod:5010 ../src/guestfs-actions.pod:7552
14469 "List all the volumes groups detected. This is the equivalent of the "
14470 "L<vgs(8)> command. The \"full\" version includes all fields."
14474 #: ../fish/guestfish-actions.pod:5013
14479 #: ../fish/guestfish-actions.pod:5015
14487 #: ../fish/guestfish-actions.pod:5017 ../src/guestfs-actions.pod:7566
14489 "This rescans all block devices and rebuilds the list of LVM physical "
14490 "volumes, volume groups and logical volumes."
14494 #: ../fish/guestfish-actions.pod:5020
14499 #: ../fish/guestfish-actions.pod:5022
14507 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7579
14508 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14512 #: ../fish/guestfish-actions.pod:5026
14517 #: ../fish/guestfish-actions.pod:5028
14525 #: ../fish/guestfish-actions.pod:5030 ../src/guestfs-actions.pod:7619
14527 "This command counts the characters in a file, using the C<wc -c> external "
14532 #: ../fish/guestfish-actions.pod:5033
14537 #: ../fish/guestfish-actions.pod:5035
14545 #: ../fish/guestfish-actions.pod:5037 ../src/guestfs-actions.pod:7632
14547 "This command counts the lines in a file, using the C<wc -l> external "
14552 #: ../fish/guestfish-actions.pod:5040
14557 #: ../fish/guestfish-actions.pod:5042
14565 #: ../fish/guestfish-actions.pod:5044 ../src/guestfs-actions.pod:7645
14567 "This command counts the words in a file, using the C<wc -w> external "
14572 #: ../fish/guestfish-actions.pod:5047
14577 #: ../fish/guestfish-actions.pod:5049
14580 " write path content\n"
14585 #: ../fish/guestfish-actions.pod:5051 ../src/guestfs-actions.pod:7660
14587 "This call creates a file called C<path>. The content of the file is the "
14588 "string C<content> (which can contain any 8 bit data)."
14592 #: ../fish/guestfish-actions.pod:5054
14593 msgid "See also L</write-append>."
14597 #: ../fish/guestfish-actions.pod:5059
14598 msgid "write-append"
14602 #: ../fish/guestfish-actions.pod:5061
14605 " write-append path content\n"
14610 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7680
14612 "This call appends C<content> to the end of file C<path>. If C<path> does "
14613 "not exist, then a new file is created."
14617 #: ../fish/guestfish-actions.pod:5066
14618 msgid "See also L</write>."
14622 #: ../fish/guestfish-actions.pod:5071
14627 #: ../fish/guestfish-actions.pod:5073
14630 " write-file path content size\n"
14635 #: ../fish/guestfish-actions.pod:5075 ../src/guestfs-actions.pod:7700
14637 "This call creates a file called C<path>. The contents of the file is the "
14638 "string C<content> (which can contain any 8 bit data), with length C<size>."
14642 #: ../fish/guestfish-actions.pod:5079 ../src/guestfs-actions.pod:7704
14644 "As a special case, if C<size> is C<0> then the length is calculated using "
14645 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14649 #: ../fish/guestfish-actions.pod:5083 ../src/guestfs-actions.pod:7708
14651 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14652 "I<not> work, even if the length is specified."
14656 #: ../fish/guestfish-actions.pod:5089
14657 msgid "This function is deprecated. In new code, use the L</write> call instead."
14661 #: ../fish/guestfish-actions.pod:5096
14666 #: ../fish/guestfish-actions.pod:5098
14669 " zegrep regex path\n"
14674 #: ../fish/guestfish-actions.pod:5100 ../src/guestfs-actions.pod:7732
14675 msgid "This calls the external C<zegrep> program and returns the matching lines."
14679 #: ../fish/guestfish-actions.pod:5106
14684 #: ../fish/guestfish-actions.pod:5108
14687 " zegrepi regex path\n"
14692 #: ../fish/guestfish-actions.pod:5110 ../src/guestfs-actions.pod:7751
14693 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14697 #: ../fish/guestfish-actions.pod:5116
14702 #: ../fish/guestfish-actions.pod:5118
14710 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7769
14711 msgid "This command writes zeroes over the first few blocks of C<device>."
14715 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7771
14717 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14718 "securely wipe the device). It should be sufficient to remove any partition "
14719 "tables, filesystem superblocks and so on."
14723 #: ../fish/guestfish-actions.pod:5126 ../fish/guestfish-actions.pod:5141 ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7801
14725 "If blocks are already zero, then this command avoids writing zeroes. This "
14726 "prevents the underlying device from becoming non-sparse or growing "
14731 #: ../fish/guestfish-actions.pod:5130
14732 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
14736 #: ../fish/guestfish-actions.pod:5133
14737 msgid "zero-device"
14741 #: ../fish/guestfish-actions.pod:5135
14744 " zero-device device\n"
14749 #: ../fish/guestfish-actions.pod:5137
14751 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
14752 "which just zeroes the first few blocks of a device."
14756 #: ../fish/guestfish-actions.pod:5148
14761 #: ../fish/guestfish-actions.pod:5150
14764 " zerofree device\n"
14769 #: ../fish/guestfish-actions.pod:5152 ../src/guestfs-actions.pod:7823
14771 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14772 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14773 "possible to compress the filesystem more effectively."
14777 #: ../fish/guestfish-actions.pod:5157 ../src/guestfs-actions.pod:7828
14778 msgid "You should B<not> run this program if the filesystem is mounted."
14782 #: ../fish/guestfish-actions.pod:5160 ../src/guestfs-actions.pod:7831
14784 "It is possible that using this program can damage the filesystem or data on "
14789 #: ../fish/guestfish-actions.pod:5163
14794 #: ../fish/guestfish-actions.pod:5165
14797 " zfgrep pattern path\n"
14802 #: ../fish/guestfish-actions.pod:5167 ../src/guestfs-actions.pod:7845
14803 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14807 #: ../fish/guestfish-actions.pod:5173
14812 #: ../fish/guestfish-actions.pod:5175
14815 " zfgrepi pattern path\n"
14820 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7864
14821 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14825 #: ../fish/guestfish-actions.pod:5183
14830 #: ../fish/guestfish-actions.pod:5185
14833 " zfile meth path\n"
14838 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7883
14839 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14843 #: ../fish/guestfish-actions.pod:5190 ../src/guestfs-actions.pod:7886
14844 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14848 #: ../fish/guestfish-actions.pod:5192
14849 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
14853 #: ../fish/guestfish-actions.pod:5195
14854 msgid "This function is deprecated. In new code, use the L</file> call instead."
14858 #: ../fish/guestfish-actions.pod:5202
14863 #: ../fish/guestfish-actions.pod:5204
14866 " zgrep regex path\n"
14871 #: ../fish/guestfish-actions.pod:5206 ../src/guestfs-actions.pod:7910
14872 msgid "This calls the external C<zgrep> program and returns the matching lines."
14876 #: ../fish/guestfish-actions.pod:5212
14881 #: ../fish/guestfish-actions.pod:5214
14884 " zgrepi regex path\n"
14889 #: ../fish/guestfish-actions.pod:5216 ../src/guestfs-actions.pod:7929
14890 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
14894 #: ../fish/guestfish-commands.pod:1
14899 #: ../fish/guestfish-commands.pod:3
14904 #: ../fish/guestfish-commands.pod:5
14907 " alloc filename size\n"
14912 #: ../fish/guestfish-commands.pod:7
14914 "This creates an empty (zeroed) file of the given size, and then adds so it "
14915 "can be further examined."
14919 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
14920 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
14924 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
14925 msgid "Size can be specified using standard suffixes, eg. C<1M>."
14929 #: ../fish/guestfish-commands.pod:14
14931 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
14932 "image, see L</PREPARED DISK IMAGES>."
14936 #: ../fish/guestfish-commands.pod:17
14941 #: ../fish/guestfish-commands.pod:19
14944 " copy-in local [local ...] /remotedir\n"
14949 #: ../fish/guestfish-commands.pod:21
14951 "C<copy-in> copies local files or directories recursively into the disk "
14952 "image, placing them in the directory called C</remotedir> (which must "
14953 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
14954 "other commands as necessary."
14958 #: ../fish/guestfish-commands.pod:26
14960 "Multiple local files and directories can be specified, but the last "
14961 "parameter must always be a remote directory. Wildcards cannot be used."
14965 #: ../fish/guestfish-commands.pod:30
14970 #: ../fish/guestfish-commands.pod:32
14973 " copy-out remote [remote ...] localdir\n"
14978 #: ../fish/guestfish-commands.pod:34
14980 "C<copy-out> copies remote files or directories recursively out of the disk "
14981 "image, placing them on the host disk in a local directory called C<localdir> "
14982 "(which must exist). This guestfish meta-command turns into a sequence of "
14983 "L</download>, L</tar-out> and other commands as necessary."
14987 #: ../fish/guestfish-commands.pod:40
14989 "Multiple remote files and directories can be specified, but the last "
14990 "parameter must always be a local directory. To download to the current "
14991 "directory, use C<.> as in:"
14995 #: ../fish/guestfish-commands.pod:44
14998 " copy-out /home .\n"
15003 #: ../fish/guestfish-commands.pod:46
15005 "Wildcards cannot be used in the ordinary command, but you can use them with "
15006 "the help of L</glob> like this:"
15010 #: ../fish/guestfish-commands.pod:49
15013 " glob copy-out /home/* .\n"
15018 #: ../fish/guestfish-commands.pod:51
15023 #: ../fish/guestfish-commands.pod:53
15026 " display filename\n"
15031 #: ../fish/guestfish-commands.pod:55
15033 "Use C<display> (a graphical display program) to display an image file. It "
15034 "downloads the file, and runs C<display> on it."
15038 #: ../fish/guestfish-commands.pod:58
15040 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15041 "environment variable. For example to use the GNOME display program:"
15045 #: ../fish/guestfish-commands.pod:61
15048 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15053 #: ../fish/guestfish-commands.pod:63
15054 msgid "See also L<display(1)>."
15058 #: ../fish/guestfish-commands.pod:65
15063 #: ../fish/guestfish-commands.pod:67
15066 " echo [params ...]\n"
15071 #: ../fish/guestfish-commands.pod:69
15072 msgid "This echos the parameters to the terminal."
15076 #: ../fish/guestfish-commands.pod:71
15081 #: ../fish/guestfish-commands.pod:73
15086 #: ../fish/guestfish-commands.pod:75
15091 #: ../fish/guestfish-commands.pod:77
15099 #: ../fish/guestfish-commands.pod:79
15101 "This is used to edit a file. It downloads the file, edits it locally using "
15102 "your editor, then uploads the result."
15106 #: ../fish/guestfish-commands.pod:82
15108 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15109 "or C<emacs> you will get those corresponding editors."
15113 #: ../fish/guestfish-commands.pod:86
15118 #: ../fish/guestfish-commands.pod:88
15121 " glob command args...\n"
15126 #: ../fish/guestfish-commands.pod:90
15128 "Expand wildcards in any paths in the args list, and run C<command> "
15129 "repeatedly on each matching path."
15133 #: ../fish/guestfish-commands.pod:93
15134 msgid "See L</WILDCARDS AND GLOBBING>."
15138 #: ../fish/guestfish-commands.pod:95
15143 #: ../fish/guestfish-commands.pod:97
15146 " hexedit <filename|device>\n"
15147 " hexedit <filename|device> <max>\n"
15148 " hexedit <filename|device> <start> <max>\n"
15153 #: ../fish/guestfish-commands.pod:101
15155 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15160 #: ../fish/guestfish-commands.pod:104
15162 "This command works by downloading potentially the whole file or device, "
15163 "editing it locally, then uploading it. If the file or device is large, you "
15164 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15165 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15166 "usual modifiers allowed such as C<1M> (1 megabyte)."
15170 #: ../fish/guestfish-commands.pod:111
15171 msgid "For example to edit the first few sectors of a disk you might do:"
15175 #: ../fish/guestfish-commands.pod:114
15178 " hexedit /dev/sda 1M\n"
15183 #: ../fish/guestfish-commands.pod:116
15185 "which would allow you to edit anywhere within the first megabyte of the "
15190 #: ../fish/guestfish-commands.pod:119
15191 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15195 #: ../fish/guestfish-commands.pod:121
15198 " hexedit /dev/sda1 0x400 0x400\n"
15203 #: ../fish/guestfish-commands.pod:123
15204 msgid "(assuming the superblock is in the standard location)."
15208 #: ../fish/guestfish-commands.pod:125
15210 "This command requires the external L<hexedit(1)> program. You can specify "
15211 "another program to use by setting the C<HEXEDITOR> environment variable."
15215 #: ../fish/guestfish-commands.pod:129
15216 msgid "See also L</hexdump>."
15220 #: ../fish/guestfish-commands.pod:131
15225 #: ../fish/guestfish-commands.pod:133
15233 #: ../fish/guestfish-commands.pod:135
15234 msgid "Change the local directory, ie. the current directory of guestfish itself."
15238 #: ../fish/guestfish-commands.pod:138
15239 msgid "Note that C<!cd> won't do what you might expect."
15243 #: ../fish/guestfish-commands.pod:140
15248 #: ../fish/guestfish-commands.pod:142
15253 #: ../fish/guestfish-commands.pod:144
15261 #: ../fish/guestfish-commands.pod:146
15262 msgid "Opens the manual page for guestfish."
15266 #: ../fish/guestfish-commands.pod:148
15271 #: ../fish/guestfish-commands.pod:150
15276 #: ../fish/guestfish-commands.pod:152
15284 #: ../fish/guestfish-commands.pod:154
15292 #: ../fish/guestfish-commands.pod:156
15293 msgid "This is used to view a file."
15297 #: ../fish/guestfish-commands.pod:158
15299 "The default viewer is C<$PAGER>. However if you use the alternate command "
15300 "C<less> you will get the C<less> command specifically."
15304 #: ../fish/guestfish-commands.pod:161
15309 #: ../fish/guestfish-commands.pod:163
15317 #: ../fish/guestfish-commands.pod:165
15319 "Close and reopen the libguestfs handle. It is not necessary to use this "
15320 "normally, because the handle is closed properly when guestfish exits. "
15321 "However this is occasionally useful for testing."
15325 #: ../fish/guestfish-commands.pod:169
15330 #: ../fish/guestfish-commands.pod:171
15333 " sparse filename size\n"
15338 #: ../fish/guestfish-commands.pod:173
15340 "This creates an empty sparse file of the given size, and then adds so it can "
15341 "be further examined."
15345 #: ../fish/guestfish-commands.pod:176
15347 "In all respects it works the same as the L</alloc> command, except that the "
15348 "image file is allocated sparsely, which means that disk blocks are not "
15349 "assigned to the file until they are needed. Sparse disk files only use "
15350 "space when written to, but they are slower and there is a danger you could "
15351 "run out of real disk space during a write operation."
15355 #: ../fish/guestfish-commands.pod:186
15360 #: ../fish/guestfish-commands.pod:188
15368 #: ../fish/guestfish-commands.pod:190
15370 "This command returns a list of the optional groups known to the daemon, and "
15371 "indicates which ones are supported by this build of the libguestfs "
15376 #: ../fish/guestfish-commands.pod:194
15377 msgid "See also L<guestfs(3)/AVAILABILITY>."
15381 #: ../fish/guestfish-commands.pod:196
15386 #: ../fish/guestfish-commands.pod:198
15389 " time command args...\n"
15394 #: ../fish/guestfish-commands.pod:200
15396 "Run the command as usual, but print the elapsed time afterwards. This can "
15397 "be useful for benchmarking operations."
15401 #: ../fish/guestfish.pod:5
15402 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15406 #: ../fish/guestfish.pod:9
15409 " guestfish [--options] [commands]\n"
15414 #: ../fish/guestfish.pod:11
15422 #: ../fish/guestfish.pod:13
15425 " guestfish [--ro|--rw] -a disk.img\n"
15430 #: ../fish/guestfish.pod:15
15433 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15438 #: ../fish/guestfish.pod:17
15441 " guestfish -d libvirt-domain\n"
15446 #: ../fish/guestfish.pod:19
15449 " guestfish [--ro|--rw] -a disk.img -i\n"
15454 #: ../fish/guestfish.pod:21
15457 " guestfish -d libvirt-domain -i\n"
15462 #: ../fish/guestfish.pod:25
15464 "Using guestfish in read/write mode on live virtual machines can be "
15465 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15466 "option to use guestfish safely if the disk image or virtual machine might be "
15471 #: ../fish/guestfish.pod:32
15473 "Guestfish is a shell and command-line tool for examining and modifying "
15474 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15475 "functionality of the guestfs API, see L<guestfs(3)>."
15479 #: ../fish/guestfish.pod:36
15481 "Guestfish gives you structured access to the libguestfs API, from shell "
15482 "scripts or the command line or interactively. If you want to rescue a "
15483 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15488 #: ../fish/guestfish.pod:43
15489 msgid "As an interactive shell"
15493 #: ../fish/guestfish.pod:45
15501 #: ../fish/guestfish.pod:47
15504 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15505 " editing virtual machine filesystems.\n"
15510 #: ../fish/guestfish.pod:50
15513 " Type: 'help' for a list of commands\n"
15514 " 'man' to read the manual\n"
15515 " 'quit' to quit the shell\n"
15520 #: ../fish/guestfish.pod:54
15523 " ><fs> add-ro disk.img\n"
15525 " ><fs> list-filesystems\n"
15526 " /dev/sda1: ext4\n"
15527 " /dev/vg_guest/lv_root: ext4\n"
15528 " /dev/vg_guest/lv_swap: swap\n"
15529 " ><fs> mount /dev/vg_guest/lv_root /\n"
15530 " ><fs> cat /etc/fstab\n"
15532 " # Created by anaconda\n"
15539 #: ../fish/guestfish.pod:67
15540 msgid "From shell scripts"
15544 #: ../fish/guestfish.pod:69
15545 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15549 #: ../fish/guestfish.pod:71
15552 " guestfish <<_EOF_\n"
15555 " mount /dev/vg_guest/lv_root /\n"
15556 " write /etc/motd \"Welcome, new users\"\n"
15562 #: ../fish/guestfish.pod:78
15563 msgid "List the LVM logical volumes in a disk image:"
15567 #: ../fish/guestfish.pod:80
15570 " guestfish -a disk.img --ro <<_EOF_\n"
15578 #: ../fish/guestfish.pod:85
15579 msgid "List all the filesystems in a disk image:"
15583 #: ../fish/guestfish.pod:87
15586 " guestfish -a disk.img --ro <<_EOF_\n"
15588 " list-filesystems\n"
15594 #: ../fish/guestfish.pod:92
15595 msgid "On one command line"
15599 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15600 msgid "Update C</etc/resolv.conf> in a guest:"
15604 #: ../fish/guestfish.pod:96
15608 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15609 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15614 #: ../fish/guestfish.pod:100
15615 msgid "Edit C</boot/grub/grub.conf> interactively:"
15619 #: ../fish/guestfish.pod:102
15622 " guestfish --rw --add disk.img \\\n"
15623 " --mount /dev/vg_guest/lv_root \\\n"
15624 " --mount /dev/sda1:/boot \\\n"
15625 " edit /boot/grub/grub.conf\n"
15630 #: ../fish/guestfish.pod:107
15631 msgid "Mount disks automatically"
15635 #: ../fish/guestfish.pod:109
15637 "Use the I<-i> option to automatically mount the disks from a virtual "
15642 #: ../fish/guestfish.pod:112
15645 " guestfish --ro -a disk.img -i cat /etc/group\n"
15650 #: ../fish/guestfish.pod:114
15653 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15658 #: ../fish/guestfish.pod:116
15659 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15663 #: ../fish/guestfish.pod:118
15666 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
15671 #: ../fish/guestfish.pod:120
15672 msgid "As a script interpreter"
15676 #: ../fish/guestfish.pod:122
15677 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15681 #: ../fish/guestfish.pod:124
15684 " #!/usr/bin/guestfish -f\n"
15685 " sparse test1.img 100M\n"
15687 " part-disk /dev/sda mbr\n"
15688 " mkfs ext2 /dev/sda1\n"
15693 #: ../fish/guestfish.pod:130
15694 msgid "Start with a prepared disk"
15698 #: ../fish/guestfish.pod:132
15700 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15701 "single ext2-formatted partition:"
15705 #: ../fish/guestfish.pod:135
15708 " guestfish -N fs\n"
15713 #: ../fish/guestfish.pod:137
15714 msgid "To list what is available do:"
15718 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
15721 " guestfish -N help | less\n"
15726 #: ../fish/guestfish.pod:141
15727 msgid "Remote control"
15731 #: ../fish/guestfish.pod:143
15734 " eval \"`guestfish --listen`\"\n"
15735 " guestfish --remote add-ro disk.img\n"
15736 " guestfish --remote run\n"
15737 " guestfish --remote lvs\n"
15742 #: ../fish/guestfish.pod:154
15743 msgid "Displays general help on options."
15747 #: ../fish/guestfish.pod:158
15748 msgid "B<--cmd-help>"
15752 #: ../fish/guestfish.pod:160
15753 msgid "Lists all available guestfish commands."
15757 #: ../fish/guestfish.pod:162
15762 #: ../fish/guestfish.pod:164
15763 msgid "B<--cmd-help cmd>"
15767 #: ../fish/guestfish.pod:166
15768 msgid "Displays detailed help on a single command C<cmd>."
15772 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
15773 msgid "B<-a image>"
15777 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
15778 msgid "B<--add image>"
15782 #: ../fish/guestfish.pod:172
15783 msgid "Add a block device or virtual machine image to the shell."
15787 #: ../fish/guestfish.pod:177
15789 "Using this flag is mostly equivalent to using the C<add> command, with "
15790 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
15791 "the I<--format=...> flag was given."
15795 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
15797 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15798 "URI to use. The default is to use the default libvirt connection."
15802 #: ../fish/guestfish.pod:189
15807 #: ../fish/guestfish.pod:191
15809 "If using the I<--listen> option and a csh-like shell, use this option. See "
15810 "section L</REMOTE CONTROL AND CSH> below."
15814 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
15815 msgid "B<-d libvirt-domain>"
15819 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
15820 msgid "B<--domain libvirt-domain>"
15824 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
15826 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15827 "used, then any libvirt domain can be used. However in write mode, only "
15828 "libvirt domains which are shut down can be named here."
15832 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
15833 msgid "Domain UUIDs can be used instead of names."
15837 #: ../fish/guestfish.pod:204
15839 "Using this flag is mostly equivalent to using the C<add-domain> command, "
15840 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
15841 "if the I<--format:...> flag was given."
15845 #: ../fish/guestfish.pod:208
15850 #: ../fish/guestfish.pod:210
15851 msgid "B<--no-dest-paths>"
15855 #: ../fish/guestfish.pod:212
15857 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15858 "to hit the tab key to complete paths on the guest filesystem, but this "
15859 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15860 "allow this feature to be disabled."
15864 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
15866 "When prompting for keys and passphrases, guestfish normally turns echoing "
15867 "off so you cannot see what you are typing. If you are not worried about "
15868 "Tempest attacks and there is no one else in the room you can specify this "
15869 "flag to see what you are typing."
15873 #: ../fish/guestfish.pod:224
15878 #: ../fish/guestfish.pod:226
15879 msgid "B<--file file>"
15883 #: ../fish/guestfish.pod:228
15884 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15888 #: ../fish/guestfish.pod:231
15891 " #!/usr/bin/guestfish -f\n"
15896 #: ../fish/guestfish.pod:244
15899 " guestfish --format=raw -a disk.img\n"
15904 #: ../fish/guestfish.pod:248
15907 " guestfish --format=raw -a disk.img --format -a another.img\n"
15912 #: ../fish/guestfish.pod:253
15914 "If you have untrusted raw-format guest disk images, you should use this "
15915 "option to specify the disk format. This avoids a possible security problem "
15916 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
15920 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
15921 msgid "B<--inspector>"
15925 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
15927 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15928 "system and mount filesystems as they would be mounted on the real virtual "
15933 #: ../fish/guestfish.pod:266
15934 msgid "Typical usage is either:"
15938 #: ../fish/guestfish.pod:268
15941 " guestfish -d myguest -i\n"
15946 #: ../fish/guestfish.pod:270
15947 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15951 #: ../fish/guestfish.pod:272
15954 " guestfish --ro -d myguest -i\n"
15959 #: ../fish/guestfish.pod:274
15960 msgid "(for active domains, readonly), or specify the block device directly:"
15964 #: ../fish/guestfish.pod:276
15967 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
15972 #: ../fish/guestfish.pod:278
15974 "Note that the command line syntax changed slightly over older versions of "
15975 "guestfish. You can still use the old syntax:"
15979 #: ../fish/guestfish.pod:281
15982 " guestfish [--ro] -i disk.img\n"
15987 #: ../fish/guestfish.pod:283
15990 " guestfish [--ro] -i libvirt-domain\n"
15995 #: ../fish/guestfish.pod:285
15997 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
15998 "then using other commands to mount the filesystems that were found."
16002 #: ../fish/guestfish.pod:294
16003 msgid "B<--listen>"
16007 #: ../fish/guestfish.pod:296
16009 "Fork into the background and listen for remote commands. See section "
16010 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16014 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16019 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16021 "Connect to a live virtual machine. (Experimental, see "
16022 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16026 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16027 msgid "B<-m dev[:mountpoint[:options]]>"
16031 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16032 msgid "B<--mount dev[:mountpoint[:options]]>"
16036 #: ../fish/guestfish.pod:308
16037 msgid "Mount the named partition or logical volume on the given mountpoint."
16041 #: ../fish/guestfish.pod:310
16042 msgid "If the mountpoint is omitted, it defaults to C</>."
16046 #: ../fish/guestfish.pod:312
16047 msgid "You have to mount something on C</> before most commands will work."
16051 #: ../fish/guestfish.pod:314
16053 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16058 #: ../fish/guestfish.pod:317
16060 "If you don't know what filesystems a disk image contains, you can either run "
16061 "guestfish without this option, then list the partitions, filesystems and LVs "
16062 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16063 "commands), or you can use the L<virt-filesystems(1)> program."
16067 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16069 "The third (and rarely used) part of the mount parameter is the list of mount "
16070 "options used to mount the underlying filesystem. If this is not given, then "
16071 "the mount options are either the empty string or C<ro> (the latter if the "
16072 "I<--ro> flag is used). By specifying the mount options, you override this "
16073 "default choice. Probably the only time you would use this is to enable ACLs "
16074 "and/or extended attributes if the filesystem can support them:"
16078 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16081 " -m /dev/sda1:/:acl,user_xattr\n"
16086 #: ../fish/guestfish.pod:333
16087 msgid "Using this flag is equivalent to using the C<mount-options> command."
16091 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193 ../resize/virt-resize.pod:358
16096 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16097 msgid "B<--no-sync>"
16101 #: ../fish/guestfish.pod:339
16103 "Disable autosync. This is enabled by default. See the discussion of "
16104 "autosync in the L<guestfs(3)> manpage."
16108 #: ../fish/guestfish.pod:342
16113 #: ../fish/guestfish.pod:344
16114 msgid "B<--new type>"
16118 #: ../fish/guestfish.pod:346
16123 #: ../fish/guestfish.pod:348
16125 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16126 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16127 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16132 #: ../fish/guestfish.pod:353
16133 msgid "B<--progress-bars>"
16137 #: ../fish/guestfish.pod:355
16138 msgid "Enable progress bars, even when guestfish is used non-interactively."
16142 #: ../fish/guestfish.pod:357
16144 "Progress bars are enabled by default when guestfish is used as an "
16145 "interactive shell."
16149 #: ../fish/guestfish.pod:360
16150 msgid "B<--no-progress-bars>"
16154 #: ../fish/guestfish.pod:362
16155 msgid "Disable progress bars."
16159 #: ../fish/guestfish.pod:364
16160 msgid "B<--remote[=pid]>"
16164 #: ../fish/guestfish.pod:366
16166 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16167 "CONTROL GUESTFISH OVER A SOCKET> below."
16171 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239 ../rescue/virt-rescue.pod:161
16176 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241 ../rescue/virt-rescue.pod:163
16181 #: ../fish/guestfish.pod:373
16183 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16184 "mounts are done read-only."
16188 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16190 "The option must always be used if the disk image or virtual machine might be "
16191 "running, and is generally recommended in cases where you don't need write "
16192 "access to the disk."
16196 #: ../fish/guestfish.pod:380
16198 "Note that prepared disk images created with I<-N> are not affected by this "
16199 "option. Also commands like C<add> are not affected - you have to specify "
16200 "the C<readonly:true> option explicitly if you need it."
16204 #: ../fish/guestfish.pod:384
16205 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16209 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253 ../rescue/virt-rescue.pod:173
16210 msgid "B<--selinux>"
16214 #: ../fish/guestfish.pod:388
16215 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16219 #: ../fish/guestfish.pod:394
16221 "Enable very verbose messages. This is particularly useful if you find a "
16226 #: ../fish/guestfish.pod:401
16227 msgid "Display the guestfish / libguestfs version number and exit."
16231 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269 ../rescue/virt-rescue.pod:190
16236 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271 ../rescue/virt-rescue.pod:192
16241 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16243 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16244 "mounts are done read-write."
16248 #: ../fish/guestfish.pod:410
16249 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16253 #: ../fish/guestfish.pod:414
16254 msgid "Echo each command before executing it."
16258 #: ../fish/guestfish.pod:418
16259 msgid "COMMANDS ON COMMAND LINE"
16263 #: ../fish/guestfish.pod:420
16264 msgid "Any additional (non-option) arguments are treated as commands to execute."
16268 #: ../fish/guestfish.pod:423
16270 "Commands to execute should be separated by a colon (C<:>), where the colon "
16271 "is a separate parameter. Thus:"
16275 #: ../fish/guestfish.pod:426
16278 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16283 #: ../fish/guestfish.pod:428
16285 "If there are no additional arguments, then we enter a shell, either an "
16286 "interactive shell with a prompt (if the input is a terminal) or a "
16287 "non-interactive shell."
16291 #: ../fish/guestfish.pod:432
16293 "In either command line mode or non-interactive shell, the first command that "
16294 "gives an error causes the whole shell to exit. In interactive mode (with a "
16295 "prompt) if a command fails, you can continue to enter commands."
16299 #: ../fish/guestfish.pod:437
16300 msgid "USING launch (OR run)"
16304 #: ../fish/guestfish.pod:439
16306 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16307 "then launch it, then mount any disks you need, and finally issue "
16308 "actions/commands. So the general order of the day is:"
16312 #: ../fish/guestfish.pod:447
16313 msgid "add or -a/--add"
16317 #: ../fish/guestfish.pod:451
16318 msgid "launch (aka run)"
16322 #: ../fish/guestfish.pod:455
16323 msgid "mount or -m/--mount"
16327 #: ../fish/guestfish.pod:459
16328 msgid "any other commands"
16332 #: ../fish/guestfish.pod:463
16334 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16335 "guest before mounting or performing any other commands."
16339 #: ../fish/guestfish.pod:466
16341 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16342 "I<--new> options were given then C<run> is done automatically, simply "
16343 "because guestfish can't perform the action you asked for without doing this."
16347 #: ../fish/guestfish.pod:471
16348 msgid "OPENING DISKS FOR READ AND WRITE"
16352 #: ../fish/guestfish.pod:473
16354 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16355 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16356 "I<-i> and I<-m> open disk images read-only or for writing."
16360 #: ../fish/guestfish.pod:478
16362 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16363 "opening disk images supplied on the command line for write. To open a disk "
16364 "image read-only you have to do I<-a image --ro>."
16368 #: ../fish/guestfish.pod:482
16370 "This matters: If you accidentally open a live VM disk image writable then "
16371 "you will cause irreversible disk corruption."
16375 #: ../fish/guestfish.pod:485
16377 "In a future libguestfs we intend to change the default the other way. Disk "
16378 "images will be opened read-only. You will have to either specify "
16379 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16380 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16381 "access for disk images specified by those other command line options."
16385 #: ../fish/guestfish.pod:492
16387 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16388 "which does nothing (it is already the default). However it is highly "
16389 "recommended that you use this option to indicate that you need write access, "
16390 "and prepare your scripts for the day when this option will be required for "
16395 #: ../fish/guestfish.pod:498
16397 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16398 "other libguestfs program apart from guestfish and guestmount."
16402 #: ../fish/guestfish.pod:501
16407 #: ../fish/guestfish.pod:503
16409 "You can quote ordinary parameters using either single or double quotes. For "
16414 #: ../fish/guestfish.pod:506
16417 " add \"file with a space.img\"\n"
16422 #: ../fish/guestfish.pod:508
16425 " rm '/file name'\n"
16430 #: ../fish/guestfish.pod:510
16438 #: ../fish/guestfish.pod:512
16440 "A few commands require a list of strings to be passed. For these, use a "
16441 "whitespace-separated list, enclosed in quotes. Strings containing "
16442 "whitespace to be passed through must be enclosed in single quotes. A "
16443 "literal single quote must be escaped with a backslash."
16447 #: ../fish/guestfish.pod:517
16450 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16451 " command \"/bin/echo 'foo bar'\"\n"
16452 " command \"/bin/echo \\'foo\\'\"\n"
16457 #: ../fish/guestfish.pod:521
16458 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16462 #: ../fish/guestfish.pod:523
16464 "In double-quoted arguments (only) use backslash to insert special "
16469 #: ../fish/guestfish.pod:528
16474 #: ../fish/guestfish.pod:530
16475 msgid "Alert (bell) character."
16479 #: ../fish/guestfish.pod:532
16484 #: ../fish/guestfish.pod:534
16485 msgid "Backspace character."
16489 #: ../fish/guestfish.pod:536
16494 #: ../fish/guestfish.pod:538
16495 msgid "Form feed character."
16499 #: ../fish/guestfish.pod:540
16504 #: ../fish/guestfish.pod:542
16505 msgid "Newline character."
16509 #: ../fish/guestfish.pod:544
16514 #: ../fish/guestfish.pod:546
16515 msgid "Carriage return character."
16519 #: ../fish/guestfish.pod:548
16524 #: ../fish/guestfish.pod:550
16525 msgid "Horizontal tab character."
16529 #: ../fish/guestfish.pod:552
16534 #: ../fish/guestfish.pod:554
16535 msgid "Vertical tab character."
16539 #: ../fish/guestfish.pod:556
16544 #: ../fish/guestfish.pod:558
16545 msgid "A literal double quote character."
16549 #: ../fish/guestfish.pod:560
16554 #: ../fish/guestfish.pod:562
16556 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
16561 #: ../fish/guestfish.pod:565
16566 #: ../fish/guestfish.pod:567
16567 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
16571 #: ../fish/guestfish.pod:570
16573 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16578 #: ../fish/guestfish.pod:573
16583 #: ../fish/guestfish.pod:575
16584 msgid "A literal backslash character."
16588 #: ../fish/guestfish.pod:579
16589 msgid "OPTIONAL ARGUMENTS"
16593 #: ../fish/guestfish.pod:581
16595 "Some commands take optional arguments. These arguments appear in this "
16596 "documentation as C<[argname:..]>. You can use them as in these examples:"
16600 #: ../fish/guestfish.pod:585
16603 " add-drive-opts filename\n"
16608 #: ../fish/guestfish.pod:587
16611 " add-drive-opts filename readonly:true\n"
16616 #: ../fish/guestfish.pod:589
16619 " add-drive-opts filename format:qcow2 readonly:false\n"
16624 #: ../fish/guestfish.pod:591
16626 "Each optional argument can appear at most once. All optional arguments must "
16627 "appear after the required ones."
16631 #: ../fish/guestfish.pod:594
16636 #: ../fish/guestfish.pod:596
16637 msgid "This section applies to all commands which can take integers as parameters."
16641 #: ../fish/guestfish.pod:599
16642 msgid "SIZE SUFFIX"
16646 #: ../fish/guestfish.pod:601
16648 "When the command takes a parameter measured in bytes, you can use one of the "
16649 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16653 #: ../fish/guestfish.pod:607
16654 msgid "B<k> or B<K> or B<KiB>"
16658 #: ../fish/guestfish.pod:609
16659 msgid "The size in kilobytes (multiplied by 1024)."
16663 #: ../fish/guestfish.pod:611
16668 #: ../fish/guestfish.pod:613
16669 msgid "The size in SI 1000 byte units."
16673 #: ../fish/guestfish.pod:615
16674 msgid "B<M> or B<MiB>"
16678 #: ../fish/guestfish.pod:617
16679 msgid "The size in megabytes (multiplied by 1048576)."
16683 #: ../fish/guestfish.pod:619
16688 #: ../fish/guestfish.pod:621
16689 msgid "The size in SI 1000000 byte units."
16693 #: ../fish/guestfish.pod:623
16694 msgid "B<G> or B<GiB>"
16698 #: ../fish/guestfish.pod:625
16699 msgid "The size in gigabytes (multiplied by 2**30)."
16703 #: ../fish/guestfish.pod:627
16708 #: ../fish/guestfish.pod:629
16709 msgid "The size in SI 10**9 byte units."
16713 #: ../fish/guestfish.pod:631
16714 msgid "B<T> or B<TiB>"
16718 #: ../fish/guestfish.pod:633
16719 msgid "The size in terabytes (multiplied by 2**40)."
16723 #: ../fish/guestfish.pod:635
16728 #: ../fish/guestfish.pod:637
16729 msgid "The size in SI 10**12 byte units."
16733 #: ../fish/guestfish.pod:639
16734 msgid "B<P> or B<PiB>"
16738 #: ../fish/guestfish.pod:641
16739 msgid "The size in petabytes (multiplied by 2**50)."
16743 #: ../fish/guestfish.pod:643
16748 #: ../fish/guestfish.pod:645
16749 msgid "The size in SI 10**15 byte units."
16753 #: ../fish/guestfish.pod:647
16754 msgid "B<E> or B<EiB>"
16758 #: ../fish/guestfish.pod:649
16759 msgid "The size in exabytes (multiplied by 2**60)."
16763 #: ../fish/guestfish.pod:651
16768 #: ../fish/guestfish.pod:653
16769 msgid "The size in SI 10**18 byte units."
16773 #: ../fish/guestfish.pod:655
16774 msgid "B<Z> or B<ZiB>"
16778 #: ../fish/guestfish.pod:657
16779 msgid "The size in zettabytes (multiplied by 2**70)."
16783 #: ../fish/guestfish.pod:659
16788 #: ../fish/guestfish.pod:661
16789 msgid "The size in SI 10**21 byte units."
16793 #: ../fish/guestfish.pod:663
16794 msgid "B<Y> or B<YiB>"
16798 #: ../fish/guestfish.pod:665
16799 msgid "The size in yottabytes (multiplied by 2**80)."
16803 #: ../fish/guestfish.pod:667
16808 #: ../fish/guestfish.pod:669
16809 msgid "The size in SI 10**24 byte units."
16813 #: ../fish/guestfish.pod:675
16816 " truncate-size /file 1G\n"
16821 #: ../fish/guestfish.pod:677
16822 msgid "would truncate the file to 1 gigabyte."
16826 #: ../fish/guestfish.pod:679
16828 "Be careful because a few commands take sizes in kilobytes or megabytes "
16829 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16830 "Adding a suffix will probably not do what you expect."
16834 #: ../fish/guestfish.pod:683
16835 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16839 #: ../fish/guestfish.pod:685
16841 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16842 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16846 #: ../fish/guestfish.pod:688
16849 " 1234 decimal number 1234\n"
16850 " 02322 octal number, equivalent to decimal 1234\n"
16851 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16856 #: ../fish/guestfish.pod:692
16858 "When using the C<chmod> command, you almost always want to specify an octal "
16859 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16860 "L<chmod(1)> program):"
16864 #: ../fish/guestfish.pod:696
16867 " chmod 0777 /public # OK\n"
16868 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16873 #: ../fish/guestfish.pod:699
16875 "Commands that return numbers usually print them in decimal, but some "
16876 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16877 "octal, preceeded by C<0>)."
16881 #: ../fish/guestfish.pod:703
16882 msgid "WILDCARDS AND GLOBBING"
16886 #: ../fish/guestfish.pod:705
16888 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16889 "(globbing) by default. So for example the following will not do what you "
16894 #: ../fish/guestfish.pod:709
16902 #: ../fish/guestfish.pod:711
16904 "Assuming you don't have a directory called literally C</home/*> then the "
16905 "above command will return an error."
16909 #: ../fish/guestfish.pod:714
16910 msgid "To perform wildcard expansion, use the C<glob> command."
16914 #: ../fish/guestfish.pod:716
16917 " glob rm-rf /home/*\n"
16922 #: ../fish/guestfish.pod:718
16924 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16925 "many times), equivalent to:"
16929 #: ../fish/guestfish.pod:721
16932 " rm-rf /home/jim\n"
16933 " rm-rf /home/joe\n"
16934 " rm-rf /home/mary\n"
16939 #: ../fish/guestfish.pod:725
16940 msgid "C<glob> only works on simple guest paths and not on device names."
16944 #: ../fish/guestfish.pod:727
16946 "If you have several parameters, each containing a wildcard, then glob will "
16947 "perform a Cartesian product."
16951 #: ../fish/guestfish.pod:730
16956 #: ../fish/guestfish.pod:732
16958 "Any line which starts with a I<#> character is treated as a comment and "
16959 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16960 "a command. For example:"
16964 #: ../fish/guestfish.pod:736
16967 " # this is a comment\n"
16968 " # this is a comment\n"
16969 " foo # NOT a comment\n"
16974 #: ../fish/guestfish.pod:740
16975 msgid "Blank lines are also ignored."
16979 #: ../fish/guestfish.pod:742
16980 msgid "RUNNING COMMANDS LOCALLY"
16984 #: ../fish/guestfish.pod:744
16986 "Any line which starts with a I<!> character is treated as a command sent to "
16987 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
16991 #: ../fish/guestfish.pod:748
16995 " tgz-out /remote local/remote-data.tar.gz\n"
17000 #: ../fish/guestfish.pod:751
17002 "will create a directory C<local> on the host, and then export the contents "
17003 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17004 "(See C<tgz-out>)."
17008 #: ../fish/guestfish.pod:755
17010 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17011 "effect, due to the way that subprocesses work in Unix."
17015 #: ../fish/guestfish.pod:758
17016 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17020 #: ../fish/guestfish.pod:760
17022 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17023 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17024 "and executed as guestfish commands."
17028 #: ../fish/guestfish.pod:764
17030 "Thus you can use shell script to construct arbitrary guestfish commands "
17031 "which are then parsed by guestfish."
17035 #: ../fish/guestfish.pod:767
17037 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17038 "through C</foo.100>) using guestfish commands alone. However this is simple "
17039 "if we use a shell script to create the guestfish commands for us:"
17043 #: ../fish/guestfish.pod:772
17046 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17051 #: ../fish/guestfish.pod:774
17052 msgid "or with names like C</foo.001>:"
17056 #: ../fish/guestfish.pod:776
17059 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17064 #: ../fish/guestfish.pod:778
17066 "When using guestfish interactively it can be helpful to just run the shell "
17067 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17068 "ordinary I<!> local command), see what guestfish commands it would run, and "
17069 "when you are happy with those prepend the C<E<lt>> character to run the "
17070 "guestfish commands for real."
17074 #: ../fish/guestfish.pod:784
17079 #: ../fish/guestfish.pod:786
17081 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17082 "command (a guestfish command) to the second command (any host command). For "
17087 #: ../fish/guestfish.pod:790
17090 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17095 #: ../fish/guestfish.pod:792
17097 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17098 "program). The above command would list all accounts in the guest filesystem "
17099 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17103 #: ../fish/guestfish.pod:797
17106 " hexdump /bin/ls | head\n"
17107 " list-devices | tail -1\n"
17108 " tgz-out / - | tar ztf -\n"
17113 #: ../fish/guestfish.pod:801
17115 "The space before the pipe symbol is required, any space after the pipe "
17116 "symbol is optional. Everything after the pipe symbol is just passed "
17117 "straight to the host shell, so it can contain redirections, globs and "
17118 "anything else that makes sense on the host side."
17122 #: ../fish/guestfish.pod:806
17124 "To use a literal argument which begins with a pipe symbol, you have to quote "
17129 #: ../fish/guestfish.pod:809
17137 #: ../fish/guestfish.pod:811
17138 msgid "HOME DIRECTORIES"
17142 #: ../fish/guestfish.pod:813
17144 "If a parameter starts with the character C<~> then the tilde may be expanded "
17145 "as a home directory path (either C<~> for the current user's home directory, "
17146 "or C<~user> for another user)."
17150 #: ../fish/guestfish.pod:817
17152 "Note that home directory expansion happens for users known I<on the host>, "
17153 "not in the guest filesystem."
17157 #: ../fish/guestfish.pod:820
17159 "To use a literal argument which begins with a tilde, you have to quote it, "
17164 #: ../fish/guestfish.pod:823
17172 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17173 msgid "ENCRYPTED DISKS"
17177 #: ../fish/guestfish.pod:827
17179 "Libguestfs has some support for Linux guests encrypted according to the "
17180 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17181 "disk encryption systems used by modern Linux guests. Currently only "
17182 "LVM-on-LUKS is supported."
17186 #: ../fish/guestfish.pod:832
17187 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17191 #: ../fish/guestfish.pod:834
17194 " ><fs> vfs-type /dev/sda2\n"
17200 #: ../fish/guestfish.pod:837
17202 "Then open those devices using L</luks-open>. This creates a device-mapper "
17203 "device called C</dev/mapper/luksdev>."
17207 #: ../fish/guestfish.pod:840
17210 " ><fs> luks-open /dev/sda2 luksdev\n"
17211 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17216 #: ../fish/guestfish.pod:843
17218 "Finally you have to tell LVM to scan for volume groups on the newly created "
17223 #: ../fish/guestfish.pod:846
17227 " vg-activate-all true\n"
17232 #: ../fish/guestfish.pod:849
17233 msgid "The logical volume(s) can now be mounted in the usual way."
17237 #: ../fish/guestfish.pod:851
17239 "Before closing a LUKS device you must unmount any logical volumes on it and "
17240 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17241 "one. Then you can close the mapper device:"
17245 #: ../fish/guestfish.pod:855
17248 " vg-activate false /dev/VG\n"
17249 " luks-close /dev/mapper/luksdev\n"
17254 #: ../fish/guestfish.pod:860
17256 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17257 "letters and paths (with some limitations). The following commands are "
17262 #: ../fish/guestfish.pod:864
17265 " file /WINDOWS/system32/config/system.LOG\n"
17270 #: ../fish/guestfish.pod:866
17273 " file win:\\windows\\system32\\config\\system.log\n"
17278 #: ../fish/guestfish.pod:868
17281 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17286 #: ../fish/guestfish.pod:870
17288 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17289 "where the drive is mounted, prepending that to the path, changing all "
17290 "backslash characters to forward slash, then resolving the result using "
17291 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
17292 "then the parameter might be rewritten like this:"
17296 #: ../fish/guestfish.pod:876
17299 " win:e:\\foo\\bar => /e/FOO/bar\n"
17304 #: ../fish/guestfish.pod:878
17305 msgid "This only works in argument positions that expect a path."
17309 #: ../fish/guestfish.pod:880
17310 msgid "UPLOADING AND DOWNLOADING FILES"
17314 #: ../fish/guestfish.pod:882
17316 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17317 "others which upload from or download to a local file, you can use the "
17318 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17322 #: ../fish/guestfish.pod:886
17330 #: ../fish/guestfish.pod:888
17331 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17335 #: ../fish/guestfish.pod:891
17338 " tar-out /etc - | tar tf -\n"
17343 #: ../fish/guestfish.pod:893
17345 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17346 "command (see L</PIPES>)."
17350 #: ../fish/guestfish.pod:896
17352 "When using C<-> to read from stdin, the input is read up to the end of "
17353 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17354 "some arbitrary end marker:"
17358 #: ../fish/guestfish.pod:900
17361 " upload -<<END /foo\n"
17370 #: ../fish/guestfish.pod:906
17372 "Any string of characters can be used instead of C<END>. The end marker must "
17373 "appear on a line of its own, without any preceeding or following characters "
17374 "(not even spaces)."
17378 #: ../fish/guestfish.pod:910
17380 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17381 "upload local files (so-called \"FileIn\" parameters in the generator)."
17385 #: ../fish/guestfish.pod:913
17386 msgid "EXIT ON ERROR BEHAVIOUR"
17390 #: ../fish/guestfish.pod:915
17392 "By default, guestfish will ignore any errors when in interactive mode "
17393 "(ie. taking commands from a human over a tty), and will exit on the first "
17394 "error in non-interactive mode (scripts, commands given on the command line)."
17398 #: ../fish/guestfish.pod:920
17400 "If you prefix a command with a I<-> character, then that command will not "
17401 "cause guestfish to exit, even if that (one) command returns an error."
17405 #: ../fish/guestfish.pod:924
17406 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17410 #: ../fish/guestfish.pod:926
17412 "Guestfish can be remote-controlled over a socket. This is useful "
17413 "particularly in shell scripts where you want to make several different "
17414 "changes to a filesystem, but you don't want the overhead of starting up a "
17415 "guestfish process each time."
17419 #: ../fish/guestfish.pod:931
17420 msgid "Start a guestfish server process using:"
17424 #: ../fish/guestfish.pod:933
17427 " eval \"`guestfish --listen`\"\n"
17432 #: ../fish/guestfish.pod:935
17433 msgid "and then send it commands by doing:"
17437 #: ../fish/guestfish.pod:937
17440 " guestfish --remote cmd [...]\n"
17445 #: ../fish/guestfish.pod:939
17446 msgid "To cause the server to exit, send it the exit command:"
17450 #: ../fish/guestfish.pod:943
17452 "Note that the server will normally exit if there is an error in a command. "
17453 "You can change this in the usual way. See section L</EXIT ON ERROR "
17458 #: ../fish/guestfish.pod:947
17459 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17463 #: ../fish/guestfish.pod:949
17465 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17466 "is how the I<--remote> option knows where to send the commands. You can "
17467 "have several guestfish listener processes running using:"
17471 #: ../fish/guestfish.pod:953
17474 " eval \"`guestfish --listen`\"\n"
17475 " pid1=$GUESTFISH_PID\n"
17476 " eval \"`guestfish --listen`\"\n"
17477 " pid2=$GUESTFISH_PID\n"
17479 " guestfish --remote=$pid1 cmd\n"
17480 " guestfish --remote=$pid2 cmd\n"
17485 #: ../fish/guestfish.pod:961
17486 msgid "REMOTE CONTROL AND CSH"
17490 #: ../fish/guestfish.pod:963
17492 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17497 #: ../fish/guestfish.pod:966
17500 " eval \"`guestfish --listen --csh`\"\n"
17505 #: ../fish/guestfish.pod:968
17506 msgid "REMOTE CONTROL DETAILS"
17510 #: ../fish/guestfish.pod:970
17512 "Remote control happens over a Unix domain socket called "
17513 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17514 "of the process, and C<$PID> is the process ID of the server."
17518 #: ../fish/guestfish.pod:974
17519 msgid "Guestfish client and server versions must match exactly."
17523 #: ../fish/guestfish.pod:976
17524 msgid "REMOTE CONTROL RUN COMMAND HANGING"
17528 #: ../fish/guestfish.pod:978
17530 "Using the C<run> (or C<launch>) command remotely in a command substitution "
17531 "context hangs, ie. don't do (note the backquotes):"
17535 #: ../fish/guestfish.pod:981
17538 " a=`guestfish --remote run`\n"
17543 #: ../fish/guestfish.pod:983
17545 "Since the C<run> command produces no output on stdout, this is not useful "
17546 "anyway. For further information see "
17547 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
17551 #: ../fish/guestfish.pod:987
17552 msgid "PREPARED DISK IMAGES"
17556 #: ../fish/guestfish.pod:989
17558 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17559 "preformatted disk images that guestfish can make for you to save typing. "
17560 "This is particularly useful for testing purposes. This option is used "
17561 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17562 "can be mixed with I<-a>)."
17566 #: ../fish/guestfish.pod:995
17568 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17569 "the second and so on. Existing files in the current directory are "
17574 #: ../fish/guestfish.pod:999
17576 "The type briefly describes how the disk should be sized, partitioned, how "
17577 "filesystem(s) should be created, and how content should be added. "
17578 "Optionally the type can be followed by extra parameters, separated by C<:> "
17579 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17580 "sparsely-allocated disk, containing a single partition, with the partition "
17581 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17582 "on a 1GB disk instead."
17586 #: ../fish/guestfish.pod:1007
17587 msgid "To list the available types and any extra parameters they take, run:"
17591 #: ../fish/guestfish.pod:1011
17593 "Note that the prepared filesystem is not mounted. You would usually have to "
17594 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17598 #: ../fish/guestfish.pod:1015
17600 "If any I<-N> or I<--new> options are given, the guest is automatically "
17605 #: ../fish/guestfish.pod:1020
17606 msgid "Create a 100MB disk with an ext4-formatted partition:"
17610 #: ../fish/guestfish.pod:1022
17613 " guestfish -N fs:ext4\n"
17618 #: ../fish/guestfish.pod:1024
17619 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17623 #: ../fish/guestfish.pod:1026
17626 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17631 #: ../fish/guestfish.pod:1028
17632 msgid "Create a blank 200MB disk:"
17636 #: ../fish/guestfish.pod:1030
17639 " guestfish -N disk:200M\n"
17644 #: ../fish/guestfish.pod:1032
17645 msgid "PROGRESS BARS"
17649 #: ../fish/guestfish.pod:1034
17651 "Some (not all) long-running commands send progress notification messages as "
17652 "they are running. Guestfish turns these messages into progress bars."
17656 #: ../fish/guestfish.pod:1038
17658 "When a command that supports progress bars takes longer than two seconds to "
17659 "run, and if progress bars are enabled, then you will see one appearing below "
17664 #: ../fish/guestfish.pod:1042
17667 " ><fs> copy-size /large-file /another-file 2048M\n"
17668 " / 10% [#####-----------------------------------------] 00:30\n"
17673 #: ../fish/guestfish.pod:1045
17675 "The spinner on the left hand side moves round once for every progress "
17676 "notification received from the backend. This is a (reasonably) golden "
17677 "assurance that the command is \"doing something\" even if the progress bar "
17678 "is not moving, because the command is able to send the progress "
17679 "notifications. When the bar reaches 100% and the command finishes, the "
17680 "spinner disappears."
17684 #: ../fish/guestfish.pod:1052
17686 "Progress bars are enabled by default when guestfish is used interactively. "
17687 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17688 "and you can disable them completely using I<--no-progress-bars>."
17692 #: ../fish/guestfish.pod:1057
17693 msgid "GUESTFISH COMMANDS"
17697 #: ../fish/guestfish.pod:1059
17699 "The commands in this section are guestfish convenience commands, in other "
17700 "words, they are not part of the L<guestfs(3)> API."
17704 #: ../fish/guestfish.pod:1062
17709 #: ../fish/guestfish.pod:1064
17718 #: ../fish/guestfish.pod:1067
17719 msgid "Without any parameter, this provides general help."
17723 #: ../fish/guestfish.pod:1069
17724 msgid "With a C<cmd> parameter, this displays detailed help for that command."
17728 #: ../fish/guestfish.pod:1071
17729 msgid "quit | exit"
17733 #: ../fish/guestfish.pod:1073
17734 msgid "This exits guestfish. You can also use C<^D> key."
17738 #: ../fish/guestfish.pod:1075
17739 msgid "@FISH_COMMANDS@"
17743 #: ../fish/guestfish.pod:1077
17748 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1474
17753 #: ../fish/guestfish.pod:1083
17755 "guestfish returns 0 if the commands completed without error, or 1 if there "
17760 #: ../fish/guestfish.pod:1090
17765 #: ../fish/guestfish.pod:1092
17767 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17772 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:2969
17773 msgid "FEBOOTSTRAP_KERNEL"
17777 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:2971
17778 msgid "FEBOOTSTRAP_MODULES"
17782 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:2973
17784 "These two environment variables allow the kernel that libguestfs uses in the "
17785 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
17786 "most recent host kernel is chosen. For more information about kernel "
17787 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
17788 "available in febootstrap E<ge> 3.8."
17792 #: ../fish/guestfish.pod:1105
17793 msgid "GUESTFISH_DISPLAY_IMAGE"
17797 #: ../fish/guestfish.pod:1107
17799 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
17800 "If not set, it uses L<display(1)>."
17804 #: ../fish/guestfish.pod:1110
17805 msgid "GUESTFISH_PID"
17809 #: ../fish/guestfish.pod:1112
17811 "Used with the I<--remote> option to specify the remote guestfish process to "
17812 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17816 #: ../fish/guestfish.pod:1116
17821 #: ../fish/guestfish.pod:1118
17823 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17824 "not specified, the external L<hexedit(1)> program is used."
17828 #: ../fish/guestfish.pod:1122
17833 #: ../fish/guestfish.pod:1124
17835 "If compiled with GNU readline support, various files in the home directory "
17836 "can be used. See L</FILES>."
17840 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2979
17841 msgid "LIBGUESTFS_APPEND"
17845 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:2981
17846 msgid "Pass additional options to the guest kernel."
17850 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:2983
17851 msgid "LIBGUESTFS_DEBUG"
17855 #: ../fish/guestfish.pod:1133
17857 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17858 "effect as using the B<-v> option."
17862 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:2988
17863 msgid "LIBGUESTFS_MEMSIZE"
17867 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:2990
17868 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
17872 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:2993
17875 " LIBGUESTFS_MEMSIZE=700\n"
17880 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:2995
17881 msgid "LIBGUESTFS_PATH"
17885 #: ../fish/guestfish.pod:1145
17887 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17888 "the discussion of paths in L<guestfs(3)>."
17892 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3000
17893 msgid "LIBGUESTFS_QEMU"
17897 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3002
17899 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
17900 "which was found at compile time by the configure script is used."
17904 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3008
17905 msgid "LIBGUESTFS_TRACE"
17909 #: ../fish/guestfish.pod:1156
17910 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17914 #: ../fish/guestfish.pod:1158
17919 #: ../fish/guestfish.pod:1160
17921 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17926 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3013
17931 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3015
17933 "Location of temporary directory, defaults to C</tmp> except for the cached "
17934 "supermin appliance which defaults to C</var/tmp>."
17938 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3018
17940 "If libguestfs was compiled to use the supermin appliance then the real "
17941 "appliance is cached in this directory, shared between all handles belonging "
17942 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
17943 "use in case C</var/tmp> is not large enough."
17947 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288 ../rescue/virt-rescue.pod:269
17952 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292 ../rescue/virt-rescue.pod:273
17953 msgid "$HOME/.libguestfs-tools.rc"
17957 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294 ../rescue/virt-rescue.pod:275
17958 msgid "/etc/libguestfs-tools.conf"
17962 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296 ../rescue/virt-rescue.pod:277
17964 "This configuration file controls the default read-only or read-write mode "
17965 "(I<--ro> or I<--rw>)."
17969 #: ../fish/guestfish.pod:1187
17970 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
17974 #: ../fish/guestfish.pod:1189
17975 msgid "$HOME/.guestfish"
17979 #: ../fish/guestfish.pod:1191
17981 "If compiled with GNU readline support, then the command history is saved in "
17986 #: ../fish/guestfish.pod:1194
17987 msgid "$HOME/.inputrc"
17991 #: ../fish/guestfish.pod:1196
17992 msgid "/etc/inputrc"
17996 #: ../fish/guestfish.pod:1198
17998 "If compiled with GNU readline support, then these files can be used to "
17999 "configure readline. For further information, please see "
18000 "L<readline(3)/INITIALIZATION FILE>."
18004 #: ../fish/guestfish.pod:1202
18005 msgid "To write rules which only apply to guestfish, use:"
18009 #: ../fish/guestfish.pod:1204
18019 #: ../fish/guestfish.pod:1208
18021 "Variables that you can set in inputrc that change the behaviour of guestfish "
18022 "in useful ways include:"
18026 #: ../fish/guestfish.pod:1213
18027 msgid "completion-ignore-case (default: on)"
18031 #: ../fish/guestfish.pod:1215
18033 "By default, guestfish will ignore case when tab-completing paths on the "
18038 #: ../fish/guestfish.pod:1218
18041 " set completion-ignore-case off\n"
18046 #: ../fish/guestfish.pod:1220
18047 msgid "to make guestfish case sensitive."
18051 #: ../fish/guestfish.pod:1224
18056 #: ../fish/guestfish.pod:1226
18057 msgid "test2.img (etc)"
18061 #: ../fish/guestfish.pod:1228
18063 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18064 "will be created in the file C<test1.img> in the current directory. The "
18065 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18066 "the same name will be overwritten."
18070 #: ../fish/guestfish.pod:1237
18072 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18073 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18074 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18075 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18076 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18077 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18078 "L<febootstrap-supermin-helper(8)>."
18082 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3104 ../test-tool/libguestfs-test-tool.pod:99
18083 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18087 #: ../fish/virt-copy-in.pod:5
18088 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18092 #: ../fish/virt-copy-in.pod:9
18095 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18100 #: ../fish/virt-copy-in.pod:11
18103 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18108 #: ../fish/virt-copy-in.pod:15
18110 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18111 "causing disk corruption. The virtual machine must be shut down before you "
18112 "use this command."
18116 #: ../fish/virt-copy-in.pod:21
18118 "C<virt-copy-in> copies files and directories from the local disk into a "
18119 "virtual machine disk image or named libvirt domain."
18123 #: ../fish/virt-copy-in.pod:24
18125 "You can give one of more filenames and directories on the command line. "
18126 "Directories are copied in recursively. The final parameter must be the "
18127 "destination directory in the disk image which must be an absolute path "
18128 "starting with a C</> character."
18132 #: ../fish/virt-copy-in.pod:33
18135 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18140 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18141 msgid "Upload a home directory to a guest:"
18145 #: ../fish/virt-copy-in.pod:37
18148 " virt-copy-in -d MyGuest skel /home\n"
18153 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18154 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18158 #: ../fish/virt-copy-in.pod:41
18160 "This command is just a simple shell script wrapper around the "
18161 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
18162 "trivial copy, you are probably better off using guestfish directly."
18166 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18168 "Since the shell script just passes options straight to guestfish, read "
18169 "L<guestfish(1)> to see the full list of options."
18173 #: ../fish/virt-copy-in.pod:52
18175 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18176 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18180 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18181 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18185 #: ../fish/virt-copy-out.pod:5
18187 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18192 #: ../fish/virt-copy-out.pod:9
18195 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18200 #: ../fish/virt-copy-out.pod:11
18203 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18208 #: ../fish/virt-copy-out.pod:15
18210 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18211 "image or named libvirt domain."
18215 #: ../fish/virt-copy-out.pod:18
18217 "You can give one of more filenames and directories on the command line. "
18218 "Directories are copied out recursively."
18222 #: ../fish/virt-copy-out.pod:23
18223 msgid "Download the home directories from a virtual machine:"
18227 #: ../fish/virt-copy-out.pod:25
18231 " virt-copy-out -d MyGuest /home homes\n"
18236 #: ../fish/virt-copy-out.pod:30
18238 "This command is just a simple shell script wrapper around the "
18239 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
18240 "trivial copy, you are probably better off using guestfish directly."
18244 #: ../fish/virt-copy-out.pod:41
18246 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18247 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18251 #: ../fish/virt-tar-in.pod:5
18252 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18256 #: ../fish/virt-tar-in.pod:9
18259 " virt-tar-in -a disk.img data.tar /destination\n"
18264 #: ../fish/virt-tar-in.pod:11
18267 " virt-tar-in -d domain data.tar /destination\n"
18272 #: ../fish/virt-tar-in.pod:13
18275 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18280 #: ../fish/virt-tar-in.pod:17
18282 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18283 "causing disk corruption. The virtual machine must be shut down before you "
18284 "use this command."
18288 #: ../fish/virt-tar-in.pod:23
18290 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18291 "image or named libvirt domain."
18295 #: ../fish/virt-tar-in.pod:26
18297 "The first parameter is the tar file. Use C<-> to read the tar file from "
18298 "standard input. The second parameter is the absolute target directory to "
18303 #: ../fish/virt-tar-in.pod:34
18306 " virt-tar-in -d MyGuest homes.tar /home\n"
18311 #: ../fish/virt-tar-in.pod:38
18313 "This command is just a simple shell script wrapper around the "
18314 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
18315 "copy, you are probably better off using guestfish directly."
18319 #: ../fish/virt-tar-in.pod:49
18321 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18322 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18323 "L<http://libguestfs.org/>."
18327 #: ../fish/virt-tar-out.pod:5
18328 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18332 #: ../fish/virt-tar-out.pod:9
18335 " virt-tar-out -a disk.img /dir files.tar\n"
18340 #: ../fish/virt-tar-out.pod:11
18343 " virt-tar-out -d domain /dir files.tar\n"
18348 #: ../fish/virt-tar-out.pod:13
18351 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18356 #: ../fish/virt-tar-out.pod:17
18357 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18361 #: ../fish/virt-tar-out.pod:20
18363 "The first parameter is the absolute path of the virtual machine directory. "
18364 "The second parameter is the tar file to write. Use C<-> to write to "
18369 #: ../fish/virt-tar-out.pod:26
18370 msgid "Download the home directories from a guest:"
18374 #: ../fish/virt-tar-out.pod:28
18377 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18382 #: ../fish/virt-tar-out.pod:32
18384 "This command is just a simple shell script wrapper around the "
18385 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
18386 "trivial copy, you are probably better off using guestfish directly."
18390 #: ../fish/virt-tar-out.pod:43
18392 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18393 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18397 #: ../fuse/guestmount.pod:5
18398 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18402 #: ../fuse/guestmount.pod:9
18405 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18410 #: ../fuse/guestmount.pod:11
18413 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18418 #: ../fuse/guestmount.pod:13
18421 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18426 #: ../fuse/guestmount.pod:17
18428 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18429 "machines. If you do this, you risk disk corruption in the VM."
18433 #: ../fuse/guestmount.pod:22
18435 "The guestmount program can be used to mount virtual machine filesystems and "
18436 "other disk images on the host. It uses libguestfs for access to the guest "
18437 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18438 "a mountable device."
18442 #: ../fuse/guestmount.pod:27
18444 "Along with other options, you have to give at least one device (I<-a> "
18445 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18446 "option) or use the I<-i> inspection option. How this works is better "
18447 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18452 #: ../fuse/guestmount.pod:33
18454 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18455 "by you, and the filesystem will not be visible to any other users unless you "
18456 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18457 "the filesystem, use the C<fusermount -u> command."
18461 #: ../fuse/guestmount.pod:41
18463 "For a typical Windows guest which has its main filesystem on the first "
18468 #: ../fuse/guestmount.pod:44
18471 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18476 #: ../fuse/guestmount.pod:46
18478 "For a typical Linux guest which has a /boot filesystem on the first "
18479 "partition, and the root filesystem on a logical volume:"
18483 #: ../fuse/guestmount.pod:49
18486 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18491 #: ../fuse/guestmount.pod:51
18492 msgid "To get libguestfs to detect guest mountpoints for you:"
18496 #: ../fuse/guestmount.pod:53
18499 " guestmount -a guest.img -i --ro /mnt\n"
18504 #: ../fuse/guestmount.pod:55
18505 msgid "For a libvirt guest called \"Guest\" you could do:"
18509 #: ../fuse/guestmount.pod:57
18512 " guestmount -d Guest -i --ro /mnt\n"
18517 #: ../fuse/guestmount.pod:59
18519 "If you don't know what filesystems are contained in a guest or disk image, "
18520 "use L<virt-filesystems(1)> first:"
18524 #: ../fuse/guestmount.pod:62
18527 " virt-filesystems MyGuest\n"
18532 #: ../fuse/guestmount.pod:64
18534 "If you want to trace the libguestfs calls but without excessive debugging "
18535 "information, we recommend:"
18539 #: ../fuse/guestmount.pod:67
18542 " guestmount [...] --trace /mnt\n"
18547 #: ../fuse/guestmount.pod:69
18548 msgid "If you want to debug the program, we recommend:"
18552 #: ../fuse/guestmount.pod:71
18555 " guestmount [...] --trace --verbose /mnt\n"
18560 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:511
18565 #: ../fuse/guestmount.pod:75
18566 msgid "Other users cannot see the filesystem by default"
18570 #: ../fuse/guestmount.pod:77
18572 "If you mount a filesystem as one user (eg. root), then other users will not "
18573 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
18574 "option when mounting:"
18578 #: ../fuse/guestmount.pod:81
18581 " sudo guestmount [...] -o allow_other /mnt\n"
18586 #: ../fuse/guestmount.pod:91
18587 msgid "Add a block device or virtual machine image."
18591 #: ../fuse/guestmount.pod:114
18592 msgid "B<--dir-cache-timeout N>"
18596 #: ../fuse/guestmount.pod:116
18598 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18599 "seconds. The readdir cache [actually, there are several semi-independent "
18600 "caches] is populated after a readdir(2) call with the stat and extended "
18601 "attributes of the files in the directory, in anticipation that they will be "
18602 "requested soon after."
18606 #: ../fuse/guestmount.pod:122
18608 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18609 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18610 "requests, only cache existing ones."
18614 #: ../fuse/guestmount.pod:142
18616 "If you have untrusted raw-format guest disk images, you should use this "
18617 "option to specify the disk format. This avoids a possible security problem "
18618 "with malicious guests (CVE-2010-3851). See also "
18619 "L<guestfs(3)/guestfs_add_drive_opts>."
18623 #: ../fuse/guestmount.pod:147
18624 msgid "B<--fuse-help>"
18628 #: ../fuse/guestmount.pod:149
18629 msgid "Display help on special FUSE options (see I<-o> below)."
18633 #: ../fuse/guestmount.pod:153
18634 msgid "Display brief help and exit."
18638 #: ../fuse/guestmount.pod:177
18640 "Mount the named partition or logical volume on the given mountpoint B<in the "
18641 "guest> (this has nothing to do with mountpoints in the host)."
18645 #: ../fuse/guestmount.pod:180
18647 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
18648 "something on C</>."
18652 #: ../fuse/guestmount.pod:197
18654 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
18655 "unmounted. If you specify this option, then we don't attempt to sync the "
18656 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
18660 #: ../fuse/guestmount.pod:202
18661 msgid "B<-o option>"
18665 #: ../fuse/guestmount.pod:204
18666 msgid "B<--option option>"
18670 #: ../fuse/guestmount.pod:206
18671 msgid "Pass extra options to FUSE."
18675 #: ../fuse/guestmount.pod:208
18677 "To get a list of all the extra options supported by FUSE, use the command "
18678 "below. Note that only the FUSE I<-o> options can be passed, and only some "
18679 "of them are a good idea."
18683 #: ../fuse/guestmount.pod:212
18686 " guestmount --fuse-help\n"
18691 #: ../fuse/guestmount.pod:214
18692 msgid "Some potentially useful FUSE options:"
18696 #: ../fuse/guestmount.pod:218
18697 msgid "B<-o allow_other>"
18701 #: ../fuse/guestmount.pod:220
18702 msgid "Allow other users to see the filesystem."
18706 #: ../fuse/guestmount.pod:222
18707 msgid "B<-o attr_timeout=N>"
18711 #: ../fuse/guestmount.pod:224
18712 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
18716 #: ../fuse/guestmount.pod:226
18717 msgid "B<-o kernel_cache>"
18721 #: ../fuse/guestmount.pod:228
18723 "Allow the kernel to cache files (reduces the number of reads that have to go "
18724 "through the L<guestfs(3)> API). This is generally a good idea if you can "
18725 "afford the extra memory usage."
18729 #: ../fuse/guestmount.pod:232
18730 msgid "B<-o uid=N> B<-o gid=N>"
18734 #: ../fuse/guestmount.pod:234
18736 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
18737 "the chosen values."
18741 #: ../fuse/guestmount.pod:243
18743 "Add devices and mount everything read-only. Also disallow writes and make "
18744 "the disk appear read-only to FUSE."
18748 #: ../fuse/guestmount.pod:246
18750 "This is highly recommended if you are not going to edit the guest disk. If "
18751 "the guest is running and this option is I<not> supplied, then there is a "
18752 "strong risk of disk corruption in the guest. We try to prevent this from "
18753 "happening, but it is not always possible."
18757 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
18758 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18762 #: ../fuse/guestmount.pod:255
18763 msgid "Enable SELinux support for the guest."
18767 #: ../fuse/guestmount.pod:261
18768 msgid "Enable verbose messages from underlying libguestfs."
18772 #: ../fuse/guestmount.pod:267
18773 msgid "Display the program version and exit."
18777 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299 ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
18778 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18782 #: ../fuse/guestmount.pod:280
18787 #: ../fuse/guestmount.pod:282
18788 msgid "Trace libguestfs calls and entry into each FUSE function."
18792 #: ../fuse/guestmount.pod:284
18793 msgid "This also stops the daemon from forking into the background."
18797 #: ../fuse/guestmount.pod:310
18799 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
18800 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
18801 "L<http://fuse.sf.net/>."
18805 #: ../fuse/guestmount.pod:325
18806 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
18810 #: ../inspector/virt-inspector.pod:5
18812 "virt-inspector - Display operating system version and other information "
18813 "about a virtual machine"
18817 #: ../inspector/virt-inspector.pod:9
18820 " virt-inspector [--options] -d domname\n"
18825 #: ../inspector/virt-inspector.pod:11
18828 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
18833 #: ../inspector/virt-inspector.pod:15
18836 " virt-inspector domname\n"
18841 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
18844 " virt-inspector disk.img [disk.img ...]\n"
18849 #: ../inspector/virt-inspector.pod:21
18851 "B<virt-inspector> examines a virtual machine or disk image and tries to "
18852 "determine the version of the operating system and other information about "
18853 "the virtual machine."
18857 #: ../inspector/virt-inspector.pod:25
18858 msgid "Virt-inspector produces XML output for feeding into other programs."
18862 #: ../inspector/virt-inspector.pod:27
18864 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
18865 "the libvirt domain (see: C<virsh list --all>)."
18869 #: ../inspector/virt-inspector.pod:30
18871 "You can also run virt-inspector directly on disk images from a single "
18872 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
18873 "has several block devices, in which case you should list several I<-a> "
18874 "options one after another, with the first corresponding to the guest's "
18875 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
18879 #: ../inspector/virt-inspector.pod:37
18881 "You can also run virt-inspector on install disks, live CDs, bootable USB "
18882 "keys and similar."
18886 #: ../inspector/virt-inspector.pod:40
18888 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
18889 "inspect several virtual machines, you have to run virt-inspector several "
18890 "times (for example, from a shell script for-loop)."
18894 #: ../inspector/virt-inspector.pod:45
18896 "Because virt-inspector needs direct access to guest images, it won't "
18897 "normally work over remote libvirt connections."
18901 #: ../inspector/virt-inspector.pod:48
18903 "All of the information available from virt-inspector is also available "
18904 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
18905 "The same information can also be fetched using guestfish or via libguestfs "
18906 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
18907 "WITH OTHER PROGRAMMING LANGUAGES>)."
18911 #: ../inspector/virt-inspector.pod:81
18913 "Libvirt is only used if you specify a C<domname> on the command line. If "
18914 "you specify guest block devices directly (I<-a>), then libvirt is not used "
18919 #: ../inspector/virt-inspector.pod:94
18921 "When prompting for keys and passphrases, virt-inspector normally turns "
18922 "echoing off so you cannot see what you are typing. If you are not worried "
18923 "about Tempest attacks and there is no one else in the room you can specify "
18924 "this flag to see what you are typing."
18928 #: ../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
18930 "Specify the format of disk images given on the command line. If this is "
18931 "omitted then the format is autodetected from the content of the disk image."
18935 #: ../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
18937 "If disk images are requested from libvirt, then this program asks libvirt "
18938 "for this information. In this case, the value of the format parameter is "
18943 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
18945 "If working with untrusted raw-format guest disk images, you should ensure "
18946 "the format is always specified."
18950 #: ../inspector/virt-inspector.pod:139
18951 msgid "Previous versions of virt-inspector allowed you to write either:"
18955 #: ../inspector/virt-inspector.pod:145
18958 " virt-inspector guestname\n"
18963 #: ../inspector/virt-inspector.pod:153
18968 #: ../inspector/virt-inspector.pod:155
18970 "The virt-inspector XML is described precisely in a RELAX NG schema file "
18971 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
18972 "just an overview."
18976 #: ../inspector/virt-inspector.pod:159
18978 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
18979 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
18980 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
18981 "which is vanishingly rare in real world VMs."
18985 #: ../inspector/virt-inspector.pod:164
18986 msgid "E<lt>operatingsystemE<gt>"
18990 #: ../inspector/virt-inspector.pod:166
18992 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
18993 "describe the operating system, its architecture, the descriptive \"product "
18994 "name\" string, the type of OS and so on, as in this example:"
18998 #: ../inspector/virt-inspector.pod:170
19001 " <operatingsystems>\n"
19002 " <operatingsystem>\n"
19003 " <root>/dev/sda2</root>\n"
19004 " <name>windows</name>\n"
19005 " <arch>i386</arch>\n"
19006 " <distro>windows</distro>\n"
19007 " <product_name>Windows 7 Enterprise</product_name>\n"
19008 " <product_variant>Client</product_variant>\n"
19009 " <major_version>6</major_version>\n"
19010 " <minor_version>1</minor_version>\n"
19011 " <windows_systemroot>/Windows</windows_systemroot>\n"
19012 " <format>installed</format>\n"
19017 #: ../inspector/virt-inspector.pod:183
19019 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19020 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19021 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19022 "architecture. The other fields are fairly self-explanatory, but because "
19023 "these fields are taken directly from the libguestfs inspection API you can "
19024 "find precise information from L<guestfs(3)/INSPECTION>."
19028 #: ../inspector/virt-inspector.pod:191
19030 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19031 "of view of libguestfs (block devices may have completely different names "
19032 "inside the VM itself)."
19036 #: ../inspector/virt-inspector.pod:195
19037 msgid "E<lt>mountpointsE<gt>"
19041 #: ../inspector/virt-inspector.pod:197
19043 "Un*x-like guests typically have multiple filesystems which are mounted at "
19044 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19045 "element which looks like this:"
19049 #: ../inspector/virt-inspector.pod:201
19052 " <operatingsystems>\n"
19053 " <operatingsystem>\n"
19056 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19057 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19058 " </mountpoints>\n"
19063 #: ../inspector/virt-inspector.pod:209
19065 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19066 "and may have completely different names inside the guest. Only mountable "
19067 "filesystems appear in this list, not things like swap devices."
19071 #: ../inspector/virt-inspector.pod:214
19072 msgid "E<lt>filesystemsE<gt>"
19076 #: ../inspector/virt-inspector.pod:216
19078 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19079 "filesystems belonging to the guest, including swap and empty partitions. "
19080 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19081 "this OS or shared with this OS and other OSes)."
19085 #: ../inspector/virt-inspector.pod:222
19086 msgid "You might see something like this:"
19090 #: ../inspector/virt-inspector.pod:224
19093 " <operatingsystems>\n"
19094 " <operatingsystem>\n"
19097 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19098 " <type>ext4</type>\n"
19099 " <label>Fedora-13-x86_64</label>\n"
19100 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19106 #: ../inspector/virt-inspector.pod:234
19108 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19109 "the label, and the UUID."
19113 #: ../inspector/virt-inspector.pod:237
19114 msgid "E<lt>applicationsE<gt>"
19118 #: ../inspector/virt-inspector.pod:239
19120 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19121 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19126 #: ../inspector/virt-inspector.pod:243
19128 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19129 "Typical values would be C<rpm> and C<deb>."
19133 #: ../inspector/virt-inspector.pod:246
19135 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19136 "Typical values include C<yum>, C<up2date> and C<apt>"
19140 #: ../inspector/virt-inspector.pod:249
19141 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19145 #: ../inspector/virt-inspector.pod:252
19148 " <operatingsystems>\n"
19149 " <operatingsystem>\n"
19151 " <applications>\n"
19153 " <name>coreutils</name>\n"
19154 " <version>8.5</version>\n"
19155 " <release>1</release>\n"
19156 " </application>\n"
19161 #: ../inspector/virt-inspector.pod:262
19163 "The version and release fields may not be available for some types guests. "
19164 "Other fields are possible, see "
19165 "L<guestfs(3)/guestfs_inspect_list_applications>."
19169 #: ../inspector/virt-inspector.pod:266
19170 msgid "E<lt>drive_mappingsE<gt>"
19174 #: ../inspector/virt-inspector.pod:268
19176 "For operating systems like Windows which use drive letters, virt-inspector "
19177 "is able to find out how drive letters map to filesystems."
19181 #: ../inspector/virt-inspector.pod:272
19184 " <operatingsystems>\n"
19185 " <operatingsystem>\n"
19187 " <drive_mappings>\n"
19188 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19189 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19190 " </drive_mappings>\n"
19195 #: ../inspector/virt-inspector.pod:280
19197 "In the example above, drive C maps to the filesystem on the second partition "
19198 "on the first disk, and drive E maps to the filesystem on the first partition "
19199 "on the second disk."
19203 #: ../inspector/virt-inspector.pod:284
19205 "Note that this only covers permanent local filesystem mappings, not things "
19206 "like network shares. Furthermore NTFS volume mount points may not be listed "
19211 #: ../inspector/virt-inspector.pod:288
19212 msgid "E<lt>iconE<gt>"
19216 #: ../inspector/virt-inspector.pod:290
19218 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19219 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19220 "very large and high quality."
19224 #: ../inspector/virt-inspector.pod:294
19227 " <operatingsystems>\n"
19228 " <operatingsystem>\n"
19231 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19232 " [... many lines of base64 data ...]\n"
19238 #: ../inspector/virt-inspector.pod:302
19240 "To display the icon, you have to extract it and convert the base64 data back "
19241 "to a binary file. Use an XPath query or simply an editor to extract the "
19242 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19247 #: ../inspector/virt-inspector.pod:307
19250 " base64 -i -d < icon.data > icon.png\n"
19255 #: ../inspector/virt-inspector.pod:309
19256 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19260 #: ../inspector/virt-inspector.pod:311
19262 "Virt-inspector can detect some operating system installers on install disks, "
19263 "live CDs, bootable USB keys and more."
19267 #: ../inspector/virt-inspector.pod:314
19269 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19270 "fields may be present to indicate a live CD, network installer, or one part "
19271 "of a multipart CD. For example:"
19275 #: ../inspector/virt-inspector.pod:318
19278 " <operatingsystems>\n"
19279 " <operatingsystem>\n"
19280 " <root>/dev/sda</root>\n"
19281 " <name>linux</name>\n"
19282 " <arch>i386</arch>\n"
19283 " <distro>ubuntu</distro>\n"
19284 " <product_name>Ubuntu 10.10 "Maverick "
19285 "Meerkat"</product_name>\n"
19286 " <major_version>10</major_version>\n"
19287 " <minor_version>10</minor_version>\n"
19288 " <format>installer</format>\n"
19294 #: ../inspector/virt-inspector.pod:330
19295 msgid "USING XPATH"
19299 #: ../inspector/virt-inspector.pod:332
19301 "You can use the XPath query language to select parts of the XML. We "
19302 "recommend using C<xmlstarlet> to perform XPath queries from the command "
19307 #: ../inspector/virt-inspector.pod:338
19310 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19312 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19313 " <type>ext4</type>\n"
19319 #: ../inspector/virt-inspector.pod:344
19322 " $ virt-inspector -d Guest | \\\n"
19323 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19329 #: ../inspector/virt-inspector.pod:348
19332 " $ virt-inspector -d Guest | \\\n"
19333 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19334 " [displays the guest icon, if there is one]\n"
19339 #: ../inspector/virt-inspector.pod:359
19340 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19344 #: ../inspector/virt-inspector.pod:361
19346 "Early versions of libguestfs shipped with a different virt-inspector program "
19347 "written in Perl (the current version is written in C). The XML output of "
19348 "the Perl virt-inspector was different and it could also output in other "
19349 "formats like text."
19353 #: ../inspector/virt-inspector.pod:366
19354 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19358 #: ../inspector/virt-inspector.pod:369
19360 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19361 "versions of virt-inspector with different names:"
19365 #: ../inspector/virt-inspector.pod:372
19368 " virt-inspector Old Perl version.\n"
19369 " virt-inspector2 New C version.\n"
19374 #: ../inspector/virt-inspector.pod:382
19376 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19377 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
19381 #: ../inspector/virt-inspector.pod:399
19382 msgid "Matthew Booth L<mbooth@redhat.com>"
19386 #: ../java/examples/guestfs-java.pod:5
19387 msgid "guestfs-java - How to use libguestfs from Java"
19391 #: ../java/examples/guestfs-java.pod:9
19394 " import com.redhat.et.libguestfs.*;\n"
19399 #: ../java/examples/guestfs-java.pod:11
19402 " GuestFS g = new GuestFS ();\n"
19403 " g.add_drive_opts (\"disk.img\", null);\n"
19409 #: ../java/examples/guestfs-java.pod:17
19411 "This manual page documents how to call libguestfs from the Java programming "
19412 "language. This page just documents the differences from the C API and gives "
19413 "some examples. If you are not familiar with using libguestfs, you also need "
19414 "to read L<guestfs(3)>."
19418 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19419 msgid "CLOSING THE HANDLE"
19423 #: ../java/examples/guestfs-java.pod:24
19425 "The handle is closed when it is reaped by the garbage collector. Because "
19426 "libguestfs handles include a lot of state, it is also possible to close (and "
19427 "hence free) them explicitly by calling the C<close> method."
19431 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19436 #: ../java/examples/guestfs-java.pod:31
19438 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19439 "exception. This has a single parameter which is the error message (a "
19444 #: ../java/examples/guestfs-java.pod:35
19445 msgid "Calling any method on a closed handle raises the same exception."
19449 #: ../java/examples/guestfs-java.pod:47
19451 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, "
19452 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19453 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19457 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
19458 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
19462 #: ../ocaml/examples/guestfs-ocaml.pod:5
19463 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19467 #: ../ocaml/examples/guestfs-ocaml.pod:9
19468 msgid "Module style:"
19472 #: ../ocaml/examples/guestfs-ocaml.pod:11
19475 " let g = Guestfs.create () in\n"
19476 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19477 " Guestfs.launch g;\n"
19482 #: ../ocaml/examples/guestfs-ocaml.pod:15
19483 msgid "Object-oriented style:"
19487 #: ../ocaml/examples/guestfs-ocaml.pod:17
19490 " let g = new Guestfs.guestfs () in\n"
19491 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19497 #: ../ocaml/examples/guestfs-ocaml.pod:21
19500 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19502 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19507 #: ../ocaml/examples/guestfs-ocaml.pod:27
19509 "This manual page documents how to call libguestfs from the OCaml programming "
19510 "language. This page just documents the differences from the C API and gives "
19511 "some examples. If you are not familiar with using libguestfs, you also need "
19512 "to read L<guestfs(3)>."
19516 #: ../ocaml/examples/guestfs-ocaml.pod:32
19517 msgid "PROGRAMMING STYLES"
19521 #: ../ocaml/examples/guestfs-ocaml.pod:34
19523 "There are two different programming styles supported by the OCaml bindings. "
19524 "You can use a module style, with each C function mapped to an OCaml "
19529 #: ../ocaml/examples/guestfs-ocaml.pod:38
19532 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19537 #: ../ocaml/examples/guestfs-ocaml.pod:40
19542 #: ../ocaml/examples/guestfs-ocaml.pod:42
19545 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19550 #: ../ocaml/examples/guestfs-ocaml.pod:44
19552 "Alternately you can use an object-oriented style, calling methods on the "
19553 "class C<Guestfs.guestfs>:"
19557 #: ../ocaml/examples/guestfs-ocaml.pod:47
19560 " method set_verbose : bool -> unit\n"
19565 #: ../ocaml/examples/guestfs-ocaml.pod:49
19567 "The object-oriented style is usually briefer, and the minor performance "
19568 "penalty isn't noticable in the general overhead of performing libguestfs "
19573 #: ../ocaml/examples/guestfs-ocaml.pod:55
19575 "The handle is closed when it is reaped by the garbage collector. Because "
19576 "libguestfs handles include a lot of state, it is also possible to close (and "
19577 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19582 #: ../ocaml/examples/guestfs-ocaml.pod:62
19584 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19585 "exception. This has a single parameter which is the error message (a "
19590 #: ../ocaml/examples/guestfs-ocaml.pod:66
19592 "Calling any function/method on a closed handle raises "
19593 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
19598 #: ../ocaml/examples/guestfs-ocaml.pod:80
19600 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19601 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19602 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19606 #: ../perl/examples/guestfs-perl.pod:5
19607 msgid "guestfs-perl - How to use libguestfs from Perl"
19611 #: ../perl/examples/guestfs-perl.pod:9
19614 " use Sys::Guestfs;\n"
19619 #: ../perl/examples/guestfs-perl.pod:11
19622 " my $h = Sys::Guestfs->new ();\n"
19623 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
19624 " $h->launch ();\n"
19625 " $h->mount_options ('', '/dev/sda1', '/');\n"
19626 " $h->touch ('/hello');\n"
19632 #: ../perl/examples/guestfs-perl.pod:20
19634 "This manual page documents how to call libguestfs from the Perl programming "
19635 "language. This page just documents the differences from the C API and gives "
19636 "some examples. If you are not familiar with using libguestfs, you also need "
19637 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
19641 #: ../perl/examples/guestfs-perl.pod:26
19646 #: ../perl/examples/guestfs-perl.pod:28
19648 "Errors from libguestfs functions turn into calls to C<croak> (see "
19653 #: ../perl/examples/guestfs-perl.pod:41
19655 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
19656 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
19657 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19661 #: ../python/examples/guestfs-python.pod:5
19662 msgid "guestfs-python - How to use libguestfs from Python"
19666 #: ../python/examples/guestfs-python.pod:9
19669 " import guestfs\n"
19670 " g = guestfs.GuestFS ()\n"
19671 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
19677 #: ../python/examples/guestfs-python.pod:16
19679 "This manual page documents how to call libguestfs from the Python "
19680 "programming language. This page just documents the differences from the C "
19681 "API and gives some examples. If you are not familiar with using libguestfs, "
19682 "you also need to read L<guestfs(3)>."
19686 #: ../python/examples/guestfs-python.pod:23
19688 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
19689 "single string argument which is the error message."
19693 #: ../python/examples/guestfs-python.pod:26
19694 msgid "MORE DOCUMENTATION"
19698 #: ../python/examples/guestfs-python.pod:28
19703 #: ../python/examples/guestfs-python.pod:30
19707 " >>> import guestfs\n"
19708 " >>> help (guestfs)\n"
19713 #: ../python/examples/guestfs-python.pod:44
19715 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19716 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
19717 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19721 #: ../rescue/virt-rescue.pod:5
19722 msgid "virt-rescue - Run a rescue shell on a virtual machine"
19726 #: ../rescue/virt-rescue.pod:9
19729 " virt-rescue [--options] -d domname\n"
19734 #: ../rescue/virt-rescue.pod:11
19737 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
19742 #: ../rescue/virt-rescue.pod:15
19745 " virt-rescue [--options] domname\n"
19750 #: ../rescue/virt-rescue.pod:17
19753 " virt-rescue [--options] disk.img [disk.img ...]\n"
19758 #: ../rescue/virt-rescue.pod:21
19760 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
19761 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
19762 "you from doing this, but doesn't catch all cases."
19766 #: ../rescue/virt-rescue.pod:25
19768 "However if you use the I<--ro> (read only) option, then you can attach a "
19769 "shell to a live virtual machine. The results might be strange or "
19770 "inconsistent at times but you won't get disk corruption."
19774 #: ../rescue/virt-rescue.pod:31
19776 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
19777 "need for a CD. virt-rescue gives you a rescue shell and some simple "
19778 "recovery tools which you can use to examine or rescue a virtual machine or "
19783 #: ../rescue/virt-rescue.pod:36
19785 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
19786 "on disk image(s):"
19790 #: ../rescue/virt-rescue.pod:39
19793 " virt-rescue -d GuestName\n"
19798 #: ../rescue/virt-rescue.pod:41
19801 " virt-rescue --ro -a /path/to/disk.img\n"
19806 #: ../rescue/virt-rescue.pod:43
19809 " virt-rescue -a /dev/sdc\n"
19814 #: ../rescue/virt-rescue.pod:45
19815 msgid "For live VMs you I<must> use the --ro option."
19819 #: ../rescue/virt-rescue.pod:47
19821 "When you run virt-rescue on a virtual machine or disk image, you are placed "
19822 "in an interactive bash shell where you can use many ordinary Linux "
19823 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
19824 "appliance. You must mount the virtual machine's filesystems by hand. There "
19825 "is an empty directory called C</sysroot> where you can mount filesystems."
19829 #: ../rescue/virt-rescue.pod:54
19831 "In the example below, we list logical volumes, then choose one to mount "
19832 "under C</sysroot>:"
19836 #: ../rescue/virt-rescue.pod:57
19840 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
19841 " lv_root vg_f11x64 -wi-a- 8.83G\n"
19842 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
19843 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
19844 " ><rescue> ls /sysroot\n"
19849 #: ../rescue/virt-rescue.pod:64
19851 "If you don't know what filesystems are available on the virtual machine then "
19852 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
19856 #: ../rescue/virt-rescue.pod:70
19858 "Virt-rescue can be used on I<any> disk image file or device, not just a "
19859 "virtual machine. For example you can use it on a blank file if you want to "
19860 "partition that file (although we would recommend using L<guestfish(1)> "
19861 "instead as it is more suitable for this purpose). You can even use "
19862 "virt-rescue on things like SD cards."
19866 #: ../rescue/virt-rescue.pod:76
19868 "Virt-rescue does not require root. You only need to run it as root if you "
19869 "need root to open the disk image."
19873 #: ../rescue/virt-rescue.pod:79
19875 "This tool is just designed for quick interactive hacking on a virtual "
19876 "machine. For more structured access to a virtual machine disk image, you "
19877 "should use L<guestfs(3)>. To get a structured shell that you can use to "
19878 "make scripted changes to guests, use L<guestfish(1)>."
19882 #: ../rescue/virt-rescue.pod:103
19883 msgid "B<--append kernelopts>"
19887 #: ../rescue/virt-rescue.pod:105
19888 msgid "Pass additional options to the rescue kernel."
19892 #: ../rescue/virt-rescue.pod:135
19895 " virt-rescue --format=raw -a disk.img\n"
19900 #: ../rescue/virt-rescue.pod:139
19903 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
19908 #: ../rescue/virt-rescue.pod:148
19913 #: ../rescue/virt-rescue.pod:150
19914 msgid "B<--memsize MB>"
19918 #: ../rescue/virt-rescue.pod:152
19920 "Change the amount of memory allocated to the rescue system. The default is "
19921 "set by libguestfs and is small but adequate for running system tools. The "
19922 "occasional program might need more memory. The parameter is specified in "
19927 #: ../rescue/virt-rescue.pod:157
19928 msgid "B<--network>"
19932 #: ../rescue/virt-rescue.pod:159
19933 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
19937 #: ../rescue/virt-rescue.pod:165
19938 msgid "Open the image read-only."
19942 #: ../rescue/virt-rescue.pod:175
19944 "Enable SELinux in the rescue appliance. You should read "
19945 "L<guestfs(3)/SELINUX> before using this option."
19949 #: ../rescue/virt-rescue.pod:194
19951 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
19952 "are done read-write."
19956 #: ../rescue/virt-rescue.pod:207
19957 msgid "Previous versions of virt-rescue allowed you to write either:"
19961 #: ../rescue/virt-rescue.pod:209
19964 " virt-rescue disk.img [disk.img ...]\n"
19969 #: ../rescue/virt-rescue.pod:213
19972 " virt-rescue guestname\n"
19977 #: ../rescue/virt-rescue.pod:221
19982 #: ../rescue/virt-rescue.pod:223
19984 "Adding the I<--network> option enables QEMU user networking in the rescue "
19985 "appliance. There are some differences between user networking and ordinary "
19990 #: ../rescue/virt-rescue.pod:229
19991 msgid "ping does not work"
19995 #: ../rescue/virt-rescue.pod:231
19997 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
19998 "send the ping packets, and because virt-rescue must be able to run as "
19999 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
20000 "command. The ping command will appear to resolve addresses but will not be "
20001 "able to send or receive any packets. This does not mean that the network is "
20006 #: ../rescue/virt-rescue.pod:238
20007 msgid "cannot receive connections"
20011 #: ../rescue/virt-rescue.pod:240
20012 msgid "QEMU user networking cannot receive incoming connections."
20016 #: ../rescue/virt-rescue.pod:242
20017 msgid "making TCP connections"
20021 #: ../rescue/virt-rescue.pod:244
20023 "The virt-rescue appliance needs to be small and so does not include many "
20024 "network tools. In particular there is no L<telnet(1)> command. You can "
20025 "make TCP connections from the shell using the magical "
20026 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20030 #: ../rescue/virt-rescue.pod:249
20033 " exec 3<>/dev/tcp/redhat.com/80\n"
20034 " echo \"GET /\" >&3\n"
20040 #: ../rescue/virt-rescue.pod:253
20041 msgid "See L<bash(1)> for more details."
20045 #: ../rescue/virt-rescue.pod:259
20047 "Several environment variables affect virt-rescue. See "
20048 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
20052 #: ../rescue/virt-rescue.pod:286
20054 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20055 "L<http://libguestfs.org/>."
20059 #: ../resize/virt-resize.pod:5
20060 msgid "virt-resize - Resize a virtual machine disk"
20064 #: ../resize/virt-resize.pod:9
20067 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20068 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20069 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20074 #: ../resize/virt-resize.pod:15
20076 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20077 "larger or smaller overall, and resizing or deleting any partitions contained "
20082 #: ../resize/virt-resize.pod:19
20084 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20085 "not> be used on live virtual machines - for consistent results, shut the "
20086 "virtual machine down before resizing it."
20090 #: ../resize/virt-resize.pod:23
20092 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20093 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20097 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2465
20102 #: ../resize/virt-resize.pod:33
20104 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20105 "fill the extra 5GB of space."
20109 #: ../resize/virt-resize.pod:36
20112 " virt-filesystems --long -h --all -a olddisk\n"
20117 #: ../resize/virt-resize.pod:38
20120 " truncate -r olddisk newdisk\n"
20121 " truncate -s +5G newdisk\n"
20126 #: ../resize/virt-resize.pod:41
20129 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20130 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20135 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2490
20140 #: ../resize/virt-resize.pod:46
20142 "As above, but make the /boot partition 200MB bigger, while giving the "
20143 "remaining space to /dev/sda2:"
20147 #: ../resize/virt-resize.pod:49
20150 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20151 " olddisk newdisk\n"
20156 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1405
20161 #: ../resize/virt-resize.pod:54
20163 "As in the first example, but expand a logical volume as the final step. "
20164 "This is what you would typically use for Linux guests that use LVM:"
20168 #: ../resize/virt-resize.pod:58
20171 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20172 " olddisk newdisk\n"
20177 #: ../resize/virt-resize.pod:61
20182 #: ../resize/virt-resize.pod:63
20184 "As in the first example, but the output format will be qcow2 instead of a "
20189 #: ../resize/virt-resize.pod:66
20192 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20193 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20198 #: ../resize/virt-resize.pod:71
20199 msgid "DETAILED USAGE"
20203 #: ../resize/virt-resize.pod:73
20204 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20208 #: ../resize/virt-resize.pod:77
20209 msgid "1. Shut down the virtual machine"
20213 #: ../resize/virt-resize.pod:79
20214 msgid "2. Locate input disk image"
20218 #: ../resize/virt-resize.pod:81
20220 "Locate the input disk image (ie. the file or device on the host containing "
20221 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20222 "dumpxml> like this to find the disk image name:"
20226 #: ../resize/virt-resize.pod:85
20229 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20230 " Found 1 nodes:\n"
20232 " <source dev=\"/dev/vg/lv_guest\" />\n"
20237 #: ../resize/virt-resize.pod:90
20238 msgid "3. Look at current sizing"
20242 #: ../resize/virt-resize.pod:92
20243 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20247 #: ../resize/virt-resize.pod:95
20250 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20251 " Name Type Size Parent\n"
20252 " /dev/sda1 partition 101M /dev/sda\n"
20253 " /dev/sda2 partition 7.9G /dev/sda\n"
20254 " /dev/sda device 8.0G -\n"
20259 #: ../resize/virt-resize.pod:101
20261 "(This example is a virtual machine with an 8 GB disk which we would like to "
20262 "expand up to 10 GB)."
20266 #: ../resize/virt-resize.pod:104
20267 msgid "4. Create output disk"
20271 #: ../resize/virt-resize.pod:106
20273 "Virt-resize cannot do in-place disk modifications. You have to have space "
20274 "to store the resized output disk."
20278 #: ../resize/virt-resize.pod:109
20279 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20283 #: ../resize/virt-resize.pod:112
20286 " # rm -f outdisk\n"
20287 " # truncate -s 10G outdisk\n"
20292 #: ../resize/virt-resize.pod:115
20293 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20297 #: ../resize/virt-resize.pod:117
20300 " # lvcreate -L 10G -n lv_name vg_name\n"
20305 #: ../resize/virt-resize.pod:119
20306 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20310 #: ../resize/virt-resize.pod:121
20313 " # virsh pool-list\n"
20314 " # virsh vol-create-as poolname newvol 10G\n"
20319 #: ../resize/virt-resize.pod:124
20324 #: ../resize/virt-resize.pod:126
20326 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20327 "file) and the output disk. The output disk is the one created in the "
20332 #: ../resize/virt-resize.pod:130
20335 " # virt-resize indisk outdisk\n"
20340 #: ../resize/virt-resize.pod:132
20342 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20343 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20344 "larger, then an extra, empty partition is created at the end of the disk "
20345 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20350 #: ../resize/virt-resize.pod:138
20352 "More realistically you'd want to expand existing partitions in the disk "
20353 "image by passing extra options (for the full list see the L</OPTIONS> "
20358 #: ../resize/virt-resize.pod:142
20360 "L</--expand> is the most useful option. It expands the named partition "
20361 "within the disk to fill any extra space:"
20365 #: ../resize/virt-resize.pod:145
20368 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20373 #: ../resize/virt-resize.pod:147
20375 "(In this case, an extra partition is I<not> created at the end of the disk, "
20376 "because there will be no unused space)."
20380 #: ../resize/virt-resize.pod:150
20382 "L</--resize> is the other commonly used option. The following would "
20383 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20384 "rest of the available space:"
20388 #: ../resize/virt-resize.pod:154
20391 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20392 " indisk outdisk\n"
20397 #: ../resize/virt-resize.pod:157
20399 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20400 "if virt-resize knows how, it will resize the contents, the equivalent of "
20401 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20402 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20403 "filesystems, so you would have to online resize them after booting the "
20408 #: ../resize/virt-resize.pod:164
20409 msgid "Other options are covered below."
20413 #: ../resize/virt-resize.pod:166
20418 #: ../resize/virt-resize.pod:168
20419 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20423 #: ../resize/virt-resize.pod:170
20424 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20428 #: ../resize/virt-resize.pod:172
20431 " # virsh edit guestname\n"
20436 #: ../resize/virt-resize.pod:174
20438 "Change E<lt>source ...E<gt>, see "
20439 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20443 #: ../resize/virt-resize.pod:177
20444 msgid "Then start up the domain with the new, resized disk:"
20448 #: ../resize/virt-resize.pod:179
20451 " # virsh start guestname\n"
20456 #: ../resize/virt-resize.pod:181
20458 "and check that it still works. See also the L</NOTES> section below for "
20459 "additional information."
20463 #: ../resize/virt-resize.pod:184
20464 msgid "7. Resize LVs etc inside the guest"
20468 #: ../resize/virt-resize.pod:186
20469 msgid "(This can also be done offline using L<guestfish(1)>)"
20473 #: ../resize/virt-resize.pod:188
20475 "Once the guest has booted you should see the new space available, at least "
20476 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20477 "may need to resize LVs inside PVs, and also resize filesystem types that "
20478 "virt-resize does not know how to expand."
20482 #: ../resize/virt-resize.pod:195
20483 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20487 #: ../resize/virt-resize.pod:197
20489 "Shrinking is somewhat more complex than expanding, and only an overview is "
20494 #: ../resize/virt-resize.pod:200
20496 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20497 "filesystems). The user has to shrink content before passing the disk image "
20498 "to virt-resize, and virt-resize will check that the content has been shrunk "
20503 #: ../resize/virt-resize.pod:205
20504 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20508 #: ../resize/virt-resize.pod:207
20510 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20511 "steps 3 and 4 above to allocate a new disk image."
20515 #: ../resize/virt-resize.pod:210
20516 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20520 #: ../resize/virt-resize.pod:213
20521 msgid "IGNORING OR DELETING PARTITIONS"
20525 #: ../resize/virt-resize.pod:215
20527 "virt-resize also gives a convenient way to ignore or delete partitions when "
20528 "copying from the input disk to the output disk. Ignoring a partition speeds "
20529 "up the copy where you don't care about the existing contents of a "
20530 "partition. Deleting a partition removes it completely, but note that it "
20531 "also renumbers any partitions after the one which is deleted, which can "
20532 "leave some guests unbootable."
20536 #: ../resize/virt-resize.pod:222
20537 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20541 #: ../resize/virt-resize.pod:224
20543 "If the input disk is in qcow2 format, then you may prefer that the output is "
20544 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
20545 "the fly. The output format is simply determined by the format of the empty "
20546 "output container that you provide. Thus to create qcow2 output, use:"
20550 #: ../resize/virt-resize.pod:230
20553 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20558 #: ../resize/virt-resize.pod:232
20559 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20563 #: ../resize/virt-resize.pod:234
20564 msgid "Similarly, to get non-sparse raw output use:"
20568 #: ../resize/virt-resize.pod:236
20571 " fallocate -l size outdisk\n"
20576 #: ../resize/virt-resize.pod:238
20578 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20579 "if=/dev/zero of=outdisk bs=1M count=..>)"
20583 #: ../resize/virt-resize.pod:247
20584 msgid "Display help."
20588 #: ../resize/virt-resize.pod:249
20593 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20598 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20599 msgid "Enable debugging messages."
20603 #: ../resize/virt-resize.pod:255
20604 msgid "B<--delete part>"
20608 #: ../resize/virt-resize.pod:257
20610 "Delete the named partition. It would be more accurate to describe this as "
20611 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
20612 "the original disk image is left intact."
20616 #: ../resize/virt-resize.pod:261
20618 "Note that when you delete a partition, then anything contained in the "
20619 "partition is also deleted. Furthermore, this causes any partitions that "
20620 "come after to be I<renumbered>, which can easily make your guest unbootable."
20624 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:454
20625 msgid "You can give this option multiple times."
20629 #: ../resize/virt-resize.pod:268
20630 msgid "B<--expand part>"
20634 #: ../resize/virt-resize.pod:270
20636 "Expand the named partition so it uses up all extra space (space left over "
20637 "after any other resize changes that you request have been done)."
20641 #: ../resize/virt-resize.pod:273
20643 "If virt-resize knows how, it will expand the direct content of the "
20644 "partition. For example, if the partition is an LVM PV, it will expand the "
20645 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
20646 "content it doesn't know about alone."
20650 #: ../resize/virt-resize.pod:278
20651 msgid "Currently virt-resize can resize:"
20655 #: ../resize/virt-resize.pod:284
20656 msgid "ext2, ext3 and ext4 filesystems."
20660 #: ../resize/virt-resize.pod:288
20661 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
20665 #: ../resize/virt-resize.pod:290
20667 "The filesystem must have been shut down consistently last time it was used. "
20668 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
20669 "consistency check, so at the first boot after resizing Windows will check "
20674 #: ../resize/virt-resize.pod:297
20676 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
20677 "inside the PV, but see the I<--LV-expand> option. The user could also "
20678 "resize LVs as desired after boot."
20682 #: ../resize/virt-resize.pod:303
20683 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
20687 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
20688 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
20692 #: ../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
20693 msgid "B<--format> raw"
20697 #: ../resize/virt-resize.pod:311
20699 "Specify the format of the input disk image. If this flag is not given then "
20700 "it is auto-detected from the image itself."
20704 #: ../resize/virt-resize.pod:317
20706 "Note that this option I<does not> affect the output format. See L</QCOW2 "
20707 "AND NON-SPARSE RAW FORMATS>."
20711 #: ../resize/virt-resize.pod:320
20712 msgid "B<--ignore part>"
20716 #: ../resize/virt-resize.pod:322
20718 "Ignore the named partition. Effectively this means the partition is "
20719 "allocated on the destination disk, but the content is not copied across from "
20720 "the source disk. The content of the partition will be blank (all zero "
20725 #: ../resize/virt-resize.pod:329
20726 msgid "B<--LV-expand logvol>"
20730 #: ../resize/virt-resize.pod:331
20732 "This takes the logical volume and, as a final step, expands it to fill all "
20733 "the space available in its volume group. A typical usage, assuming a Linux "
20734 "guest with a single PV C</dev/sda2> and a root device called "
20735 "C</dev/vg_guest/lv_root> would be:"
20739 #: ../resize/virt-resize.pod:336
20742 " virt-resize indisk outdisk \\\n"
20743 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
20748 #: ../resize/virt-resize.pod:339
20750 "This would first expand the partition (and PV), and then expand the root "
20751 "device to fill the extra space in the PV."
20755 #: ../resize/virt-resize.pod:342
20757 "The contents of the LV are also resized if virt-resize knows how to do "
20758 "that. You can stop virt-resize from trying to expand the content by using "
20759 "the option I<--no-expand-content>."
20763 #: ../resize/virt-resize.pod:346
20764 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
20768 #: ../resize/virt-resize.pod:348
20770 "You can give this option multiple times, I<but> it doesn't make sense to do "
20771 "this unless the logical volumes you specify are all in different volume "
20776 #: ../resize/virt-resize.pod:352
20777 msgid "B<--machine-readable>"
20781 #: ../resize/virt-resize.pod:354
20783 "This option is used to make the output more machine friendly when being "
20784 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
20788 #: ../resize/virt-resize.pod:360
20789 msgid "B<--dryrun>"
20793 #: ../resize/virt-resize.pod:362
20794 msgid "Print a summary of what would be done, but don't do anything."
20798 #: ../resize/virt-resize.pod:364
20799 msgid "B<--no-copy-boot-loader>"
20803 #: ../resize/virt-resize.pod:366
20805 "By default, virt-resize copies over some sectors at the start of the disk "
20806 "(up to the beginning of the first partition). Commonly these sectors "
20807 "contain the Master Boot Record (MBR) and the boot loader, and are required "
20808 "in order for the guest to boot correctly."
20812 #: ../resize/virt-resize.pod:371
20814 "If you specify this flag, then this initial copy is not done. You may need "
20815 "to reinstall the boot loader in this case."
20819 #: ../resize/virt-resize.pod:374
20820 msgid "B<--no-extra-partition>"
20824 #: ../resize/virt-resize.pod:376
20826 "By default, virt-resize creates an extra partition if there is any extra, "
20827 "unused space after all resizing has happened. Use this option to prevent "
20828 "the extra partition from being created. If you do this then the extra space "
20829 "will be inaccessible until you run fdisk, parted, or some other partitioning "
20830 "tool in the guest."
20834 #: ../resize/virt-resize.pod:382
20836 "Note that if the surplus space is smaller than 10 MB, no extra partition "
20841 #: ../resize/virt-resize.pod:385
20842 msgid "B<--no-expand-content>"
20846 #: ../resize/virt-resize.pod:387
20848 "By default, virt-resize will try to expand the direct contents of "
20849 "partitions, if it knows how (see I<--expand> option above)."
20853 #: ../resize/virt-resize.pod:390
20855 "If you give the I<--no-expand-content> option then virt-resize will not "
20860 #: ../resize/virt-resize.pod:393
20861 msgid "B<--ntfsresize-force>"
20865 #: ../resize/virt-resize.pod:395
20867 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
20868 "the NTFS disk is marked as needing a consistency check. You have to use "
20869 "this option if you want to resize a Windows guest multiple times without "
20870 "booting into Windows between each resize."
20874 #: ../resize/virt-resize.pod:401
20875 msgid "B<--output-format> raw"
20879 #: ../resize/virt-resize.pod:403
20881 "Specify the format of the output disk image. If this flag is not given then "
20882 "it is auto-detected from the image itself."
20886 #: ../resize/virt-resize.pod:409
20888 "Note that this option I<does not create> the output format. This option "
20889 "just tells libguestfs what it is so it doesn't try to guess it. You still "
20890 "need to create the output disk with the right format. See L</QCOW2 AND "
20891 "NON-SPARSE RAW FORMATS>."
20895 #: ../resize/virt-resize.pod:414
20900 #: ../resize/virt-resize.pod:416
20905 #: ../resize/virt-resize.pod:418
20906 msgid "Don't print the summary."
20910 #: ../resize/virt-resize.pod:420
20911 msgid "B<--resize part=size>"
20915 #: ../resize/virt-resize.pod:422
20917 "Resize the named partition (expanding or shrinking it) so that it has the "
20922 #: ../resize/virt-resize.pod:425
20924 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
20925 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
20926 "size; or as a relative number or percentage. For example:"
20930 #: ../resize/virt-resize.pod:431
20933 " --resize /dev/sda2=10G\n"
20938 #: ../resize/virt-resize.pod:433
20941 " --resize /dev/sda4=90%\n"
20946 #: ../resize/virt-resize.pod:435
20949 " --resize /dev/sda2=+1G\n"
20954 #: ../resize/virt-resize.pod:437
20957 " --resize /dev/sda2=-200M\n"
20962 #: ../resize/virt-resize.pod:439
20965 " --resize /dev/sda1=+128K\n"
20970 #: ../resize/virt-resize.pod:441
20973 " --resize /dev/sda1=+10%\n"
20978 #: ../resize/virt-resize.pod:443
20981 " --resize /dev/sda1=-10%\n"
20986 #: ../resize/virt-resize.pod:445
20988 "You can increase the size of any partition. Virt-resize will expand the "
20989 "direct content of the partition if it knows how (see I<--expand> below)."
20993 #: ../resize/virt-resize.pod:449
20995 "You can only I<decrease> the size of partitions that contain filesystems or "
20996 "PVs which have already been shrunk. Virt-resize will check this has been "
20997 "done before proceeding, or else will print an error (see also "
20998 "I<--resize-force>)."
21002 #: ../resize/virt-resize.pod:456
21003 msgid "B<--resize-force part=size>"
21007 #: ../resize/virt-resize.pod:458
21009 "This is the same as I<--resize> except that it will let you decrease the "
21010 "size of any partition. Generally this means you will lose any data which "
21011 "was at the end of the partition you shrink, but you may not care about that "
21012 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21013 "as a swap partition)."
21017 #: ../resize/virt-resize.pod:464
21018 msgid "See also the I<--ignore> option."
21022 #: ../resize/virt-resize.pod:466
21023 msgid "B<--shrink part>"
21027 #: ../resize/virt-resize.pod:468
21029 "Shrink the named partition until the overall disk image fits in the "
21030 "destination. The named partition B<must> contain a filesystem or PV which "
21031 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21032 "online tools). Virt-resize will check this and give an error if it has not "
21037 #: ../resize/virt-resize.pod:474
21039 "The amount by which the overall disk must be shrunk (after carrying out all "
21040 "other operations requested by the user) is called the \"deficit\". For "
21041 "example, a straight copy (assume no other operations) from a 5GB disk image "
21042 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21043 "would give an error unless the user specified a partition to shrink and that "
21044 "partition had more than a gigabyte of free space."
21048 #: ../resize/virt-resize.pod:492
21049 msgid "MACHINE READABLE OUTPUT"
21053 #: ../resize/virt-resize.pod:494
21055 "The I<--machine-readable> option can be used to make the output more machine "
21056 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21061 #: ../resize/virt-resize.pod:498
21063 "Use the option on its own to query the capabilities of the virt-resize "
21064 "binary. Typical output looks like this:"
21068 #: ../resize/virt-resize.pod:501
21071 " $ virt-resize --machine-readable\n"
21073 " ntfsresize-force\n"
21081 #: ../resize/virt-resize.pod:508
21083 "A list of features is printed, one per line, and the program exits with "
21088 #: ../resize/virt-resize.pod:513
21089 msgid "\"Partition 1 does not end on cylinder boundary.\""
21093 #: ../resize/virt-resize.pod:515
21095 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21096 "means the partitions will not be aligned to the ancient CHS geometry. "
21097 "However CHS geometry is meaningless for disks manufactured since the early "
21098 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21099 "cylinders is not required by any modern operating system."
21103 #: ../resize/virt-resize.pod:522
21104 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21108 #: ../resize/virt-resize.pod:524
21110 "In Windows Vista and later versions, Microsoft switched to using a separate "
21111 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21112 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21113 "the boot partition. Doing so seems to break the guest completely. However "
21114 "expanding the second partition (ie. C: drive) should work."
21118 #: ../resize/virt-resize.pod:531
21120 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21121 "NTFS partitions have been expanded. This is just a safety check and (unless "
21122 "it find errors) is nothing to worry about."
21126 #: ../resize/virt-resize.pod:535
21127 msgid "GUEST BOOT STUCK AT \"GRUB\""
21131 #: ../resize/virt-resize.pod:537
21133 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21134 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21135 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21136 "although we think is to do with partition alignment."
21140 #: ../resize/virt-resize.pod:542
21143 " guestfish -i -a newdisk\n"
21144 " ><fs> cat /boot/grub/device.map\n"
21145 " # check the contents of this file are sensible or\n"
21146 " # edit the file if necessary\n"
21147 " ><fs> grub-install / /dev/vda\n"
21153 #: ../resize/virt-resize.pod:549
21155 "For more flexible guest reconfiguration, including if you need to specify "
21156 "other parameters to grub-install, use L<virt-rescue(1)>."
21160 #: ../resize/virt-resize.pod:552
21161 msgid "ALTERNATIVE TOOLS"
21165 #: ../resize/virt-resize.pod:554
21167 "There are several proprietary tools for resizing partitions. We won't "
21168 "mention any here."
21172 #: ../resize/virt-resize.pod:557
21174 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21175 "operations on disk images. They can resize and move partitions, but I don't "
21176 "think they can do anything with the contents, and they certainly don't "
21181 #: ../resize/virt-resize.pod:562
21183 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21184 "but at a much lower level. You will probably end up hand-calculating sector "
21185 "offsets, which is something that virt-resize was designed to avoid. If you "
21186 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21191 #: ../resize/virt-resize.pod:582
21193 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21194 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21195 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21196 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21197 "L<http://libguestfs.org/>."
21201 #: ../ruby/examples/guestfs-ruby.pod:5
21202 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21206 #: ../ruby/examples/guestfs-ruby.pod:9
21209 " require 'guestfs'\n"
21210 " g = Guestfs::Guestfs.new()\n"
21211 " g.add_drive_opts(\"disk.img\",\n"
21212 " :readonly => 1, :format => \"raw\")\n"
21218 #: ../ruby/examples/guestfs-ruby.pod:17
21220 "This manual page documents how to call libguestfs from the Ruby programming "
21221 "language. This page just documents the differences from the C API and gives "
21222 "some examples. If you are not familiar with using libguestfs, you also need "
21223 "to read L<guestfs(3)>."
21227 #: ../ruby/examples/guestfs-ruby.pod:24
21229 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21230 "This has a single parameter which is the error message (a string)."
21234 #: ../ruby/examples/guestfs-ruby.pod:38
21236 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
21237 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21238 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21242 #: ../src/guestfs-actions.pod:1
21243 msgid "guestfs_add_cdrom"
21247 #: ../src/guestfs-actions.pod:3
21251 " guestfs_add_cdrom (guestfs_h *g,\n"
21252 " const char *filename);\n"
21257 #: ../src/guestfs-actions.pod:17
21259 "This call checks for the existence of C<filename>. This stops you from "
21260 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21261 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21266 #: ../src/guestfs-actions.pod:24
21268 "If you just want to add an ISO file (often you use this as an efficient way "
21269 "to transfer large files into the guest), then you should probably use "
21270 "C<guestfs_add_drive_ro> instead."
21274 #: ../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:7782 ../src/guestfs-actions.pod:7805 ../src/guestfs-actions.pod:7834
21275 msgid "This function returns 0 on success or -1 on error."
21279 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275
21281 "This function is deprecated. In new code, use the "
21282 "L</guestfs_add_drive_opts> call instead."
21286 #: ../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
21287 msgid "(Added in 0.3)"
21291 #: ../src/guestfs-actions.pod:41
21292 msgid "guestfs_add_domain"
21296 #: ../src/guestfs-actions.pod:43
21300 " guestfs_add_domain (guestfs_h *g,\n"
21301 " const char *dom,\n"
21307 #: ../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
21309 "You may supply a list of optional arguments to this call. Use zero or more "
21310 "of the following pairs of parameters, and terminate the list with C<-1> on "
21311 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21315 #: ../src/guestfs-actions.pod:53
21318 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21319 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21320 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21321 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21322 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21327 #: ../src/guestfs-actions.pod:59
21329 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21330 "It works by connecting to libvirt, requesting the domain and domain XML from "
21331 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21336 #: ../src/guestfs-actions.pod:94
21338 "The other optional parameters are passed directly through to "
21339 "C<guestfs_add_drive_opts>."
21343 #: ../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
21344 msgid "On error this function returns -1."
21348 #: ../src/guestfs-actions.pod:99
21349 msgid "(Added in 1.7.4)"
21353 #: ../src/guestfs-actions.pod:101
21354 msgid "guestfs_add_domain_va"
21358 #: ../src/guestfs-actions.pod:103
21362 " guestfs_add_domain_va (guestfs_h *g,\n"
21363 " const char *dom,\n"
21364 " va_list args);\n"
21369 #: ../src/guestfs-actions.pod:108
21370 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21374 #: ../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
21375 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21379 #: ../src/guestfs-actions.pod:112
21380 msgid "guestfs_add_domain_argv"
21384 #: ../src/guestfs-actions.pod:114
21388 " guestfs_add_domain_argv (guestfs_h *g,\n"
21389 " const char *dom,\n"
21390 " const struct guestfs_add_domain_argv *optargs);\n"
21395 #: ../src/guestfs-actions.pod:119
21396 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21400 #: ../src/guestfs-actions.pod:123
21401 msgid "guestfs_add_drive"
21405 #: ../src/guestfs-actions.pod:125
21409 " guestfs_add_drive (guestfs_h *g,\n"
21410 " const char *filename);\n"
21415 #: ../src/guestfs-actions.pod:129
21417 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21418 "optional parameters, so the disk is added writable, with the format being "
21419 "detected automatically."
21423 #: ../src/guestfs-actions.pod:133
21425 "Automatic detection of the format opens you up to a potential security hole "
21426 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21427 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21428 "you should think about replacing calls to this function with calls to "
21429 "C<guestfs_add_drive_opts>, and specifying the format."
21433 #: ../src/guestfs-actions.pod:144
21434 msgid "guestfs_add_drive_opts"
21438 #: ../src/guestfs-actions.pod:146
21442 " guestfs_add_drive_opts (guestfs_h *g,\n"
21443 " const char *filename,\n"
21449 #: ../src/guestfs-actions.pod:156
21452 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21453 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21454 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21459 #: ../src/guestfs-actions.pod:185
21461 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
21462 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
21463 "Possible formats include C<raw> and C<qcow2>."
21467 #: ../src/guestfs-actions.pod:196
21469 "This rarely-used option lets you emulate the behaviour of the deprecated "
21470 "C<guestfs_add_drive_with_if> call (q.v.)"
21474 #: ../src/guestfs-actions.pod:203
21475 msgid "(Added in 1.5.23)"
21479 #: ../src/guestfs-actions.pod:205
21480 msgid "guestfs_add_drive_opts_va"
21484 #: ../src/guestfs-actions.pod:207
21488 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21489 " const char *filename,\n"
21490 " va_list args);\n"
21495 #: ../src/guestfs-actions.pod:212
21496 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21500 #: ../src/guestfs-actions.pod:216
21501 msgid "guestfs_add_drive_opts_argv"
21505 #: ../src/guestfs-actions.pod:218
21509 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21510 " const char *filename,\n"
21511 " const struct guestfs_add_drive_opts_argv "
21517 #: ../src/guestfs-actions.pod:223
21518 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21522 #: ../src/guestfs-actions.pod:227
21523 msgid "guestfs_add_drive_ro"
21527 #: ../src/guestfs-actions.pod:229
21531 " guestfs_add_drive_ro (guestfs_h *g,\n"
21532 " const char *filename);\n"
21537 #: ../src/guestfs-actions.pod:233
21539 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21540 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21541 "disk is added read-only, with the format being detected automatically."
21545 #: ../src/guestfs-actions.pod:240
21546 msgid "(Added in 1.0.38)"
21550 #: ../src/guestfs-actions.pod:242
21551 msgid "guestfs_add_drive_ro_with_if"
21555 #: ../src/guestfs-actions.pod:244
21559 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
21560 " const char *filename,\n"
21561 " const char *iface);\n"
21566 #: ../src/guestfs-actions.pod:249
21568 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
21569 "QEMU interface emulation to use at run time."
21573 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2436
21574 msgid "(Added in 1.0.84)"
21578 #: ../src/guestfs-actions.pod:263
21579 msgid "guestfs_add_drive_with_if"
21583 #: ../src/guestfs-actions.pod:265
21587 " guestfs_add_drive_with_if (guestfs_h *g,\n"
21588 " const char *filename,\n"
21589 " const char *iface);\n"
21594 #: ../src/guestfs-actions.pod:270
21596 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
21597 "QEMU interface emulation to use at run time."
21601 #: ../src/guestfs-actions.pod:284
21602 msgid "guestfs_aug_clear"
21606 #: ../src/guestfs-actions.pod:286
21610 " guestfs_aug_clear (guestfs_h *g,\n"
21611 " const char *augpath);\n"
21616 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
21617 msgid "(Added in 1.3.4)"
21621 #: ../src/guestfs-actions.pod:297
21622 msgid "guestfs_aug_close"
21626 #: ../src/guestfs-actions.pod:299
21630 " guestfs_aug_close (guestfs_h *g);\n"
21635 #: ../src/guestfs-actions.pod:302
21637 "Close the current Augeas handle and free up any resources used by it. After "
21638 "calling this, you have to call C<guestfs_aug_init> again before you can use "
21639 "any other Augeas functions."
21643 #: ../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
21644 msgid "(Added in 0.7)"
21648 #: ../src/guestfs-actions.pod:311
21649 msgid "guestfs_aug_defnode"
21653 #: ../src/guestfs-actions.pod:313
21656 " struct guestfs_int_bool *\n"
21657 " guestfs_aug_defnode (guestfs_h *g,\n"
21658 " const char *name,\n"
21659 " const char *expr,\n"
21660 " const char *val);\n"
21665 #: ../src/guestfs-actions.pod:322
21667 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21668 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
21669 "containing that single node."
21673 #: ../src/guestfs-actions.pod:330
21675 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
21676 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
21680 #: ../src/guestfs-actions.pod:336
21681 msgid "guestfs_aug_defvar"
21685 #: ../src/guestfs-actions.pod:338
21689 " guestfs_aug_defvar (guestfs_h *g,\n"
21690 " const char *name,\n"
21691 " const char *expr);\n"
21696 #: ../src/guestfs-actions.pod:354
21697 msgid "guestfs_aug_get"
21701 #: ../src/guestfs-actions.pod:356
21705 " guestfs_aug_get (guestfs_h *g,\n"
21706 " const char *augpath);\n"
21711 #: ../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:7891
21713 "This function returns a string, or NULL on error. I<The caller must free "
21714 "the returned string after use>."
21718 #: ../src/guestfs-actions.pod:368
21719 msgid "guestfs_aug_init"
21723 #: ../src/guestfs-actions.pod:370
21727 " guestfs_aug_init (guestfs_h *g,\n"
21728 " const char *root,\n"
21734 #: ../src/guestfs-actions.pod:379
21735 msgid "You must call this before using any other C<guestfs_aug_*> commands."
21739 #: ../src/guestfs-actions.pod:404
21741 "This option is only useful when debugging Augeas lenses. Use of this option "
21742 "may require additional memory for the libguestfs appliance. You may need to "
21743 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
21744 "C<guestfs_set_memsize>."
21748 #: ../src/guestfs-actions.pod:419
21749 msgid "Do not load the tree in C<guestfs_aug_init>."
21753 #: ../src/guestfs-actions.pod:423
21754 msgid "To close the handle, you can call C<guestfs_aug_close>."
21758 #: ../src/guestfs-actions.pod:431
21759 msgid "guestfs_aug_insert"
21763 #: ../src/guestfs-actions.pod:433
21767 " guestfs_aug_insert (guestfs_h *g,\n"
21768 " const char *augpath,\n"
21769 " const char *label,\n"
21775 #: ../src/guestfs-actions.pod:451
21776 msgid "guestfs_aug_load"
21780 #: ../src/guestfs-actions.pod:453
21784 " guestfs_aug_load (guestfs_h *g);\n"
21789 #: ../src/guestfs-actions.pod:465
21790 msgid "guestfs_aug_ls"
21794 #: ../src/guestfs-actions.pod:467
21798 " guestfs_aug_ls (guestfs_h *g,\n"
21799 " const char *augpath);\n"
21804 #: ../src/guestfs-actions.pod:471
21806 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
21807 "sorting the resulting nodes into alphabetical order."
21811 #: ../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:7848 ../src/guestfs-actions.pod:7867 ../src/guestfs-actions.pod:7913 ../src/guestfs-actions.pod:7932
21813 "This function returns a NULL-terminated array of strings (like "
21814 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
21815 "strings and the array after use>."
21819 #: ../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
21820 msgid "(Added in 0.8)"
21824 #: ../src/guestfs-actions.pod:480
21825 msgid "guestfs_aug_match"
21829 #: ../src/guestfs-actions.pod:482
21833 " guestfs_aug_match (guestfs_h *g,\n"
21834 " const char *augpath);\n"
21839 #: ../src/guestfs-actions.pod:496
21840 msgid "guestfs_aug_mv"
21844 #: ../src/guestfs-actions.pod:498
21848 " guestfs_aug_mv (guestfs_h *g,\n"
21849 " const char *src,\n"
21850 " const char *dest);\n"
21855 #: ../src/guestfs-actions.pod:510
21856 msgid "guestfs_aug_rm"
21860 #: ../src/guestfs-actions.pod:512
21864 " guestfs_aug_rm (guestfs_h *g,\n"
21865 " const char *augpath);\n"
21870 #: ../src/guestfs-actions.pod:524
21871 msgid "guestfs_aug_save"
21875 #: ../src/guestfs-actions.pod:526
21879 " guestfs_aug_save (guestfs_h *g);\n"
21884 #: ../src/guestfs-actions.pod:531
21886 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
21891 #: ../src/guestfs-actions.pod:538
21892 msgid "guestfs_aug_set"
21896 #: ../src/guestfs-actions.pod:540
21900 " guestfs_aug_set (guestfs_h *g,\n"
21901 " const char *augpath,\n"
21902 " const char *val);\n"
21907 #: ../src/guestfs-actions.pod:547
21909 "In the Augeas API, it is possible to clear a node by setting the value to "
21910 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21911 "this call. Instead you must use the C<guestfs_aug_clear> call."
21915 #: ../src/guestfs-actions.pod:556
21916 msgid "guestfs_available"
21920 #: ../src/guestfs-actions.pod:558
21924 " guestfs_available (guestfs_h *g,\n"
21925 " char *const *groups);\n"
21930 #: ../src/guestfs-actions.pod:566
21932 "The libguestfs groups, and the functions that those groups correspond to, "
21933 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21934 "runtime by calling C<guestfs_available_all_groups>."
21938 #: ../src/guestfs-actions.pod:590
21939 msgid "You must call C<guestfs_launch> before calling this function."
21943 #: ../src/guestfs-actions.pod:612
21945 "This call was added in version C<1.0.80>. In previous versions of "
21946 "libguestfs all you could do would be to speculatively execute a command to "
21947 "find out if the daemon implemented it. See also C<guestfs_version>."
21951 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
21952 msgid "(Added in 1.0.80)"
21956 #: ../src/guestfs-actions.pod:623
21957 msgid "guestfs_available_all_groups"
21961 #: ../src/guestfs-actions.pod:625
21965 " guestfs_available_all_groups (guestfs_h *g);\n"
21970 #: ../src/guestfs-actions.pod:628
21972 "This command returns a list of all optional groups that this daemon knows "
21973 "about. Note this returns both supported and unsupported groups. To find "
21974 "out which ones the daemon can actually support you have to call "
21975 "C<guestfs_available> on each member of the returned list."
21979 #: ../src/guestfs-actions.pod:634
21980 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
21984 #: ../src/guestfs-actions.pod:640
21985 msgid "(Added in 1.3.15)"
21989 #: ../src/guestfs-actions.pod:642
21990 msgid "guestfs_base64_in"
21994 #: ../src/guestfs-actions.pod:644
21998 " guestfs_base64_in (guestfs_h *g,\n"
21999 " const char *base64file,\n"
22000 " const char *filename);\n"
22005 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22006 msgid "(Added in 1.3.5)"
22010 #: ../src/guestfs-actions.pod:656
22011 msgid "guestfs_base64_out"
22015 #: ../src/guestfs-actions.pod:658
22019 " guestfs_base64_out (guestfs_h *g,\n"
22020 " const char *filename,\n"
22021 " const char *base64file);\n"
22026 #: ../src/guestfs-actions.pod:670
22027 msgid "guestfs_blockdev_flushbufs"
22031 #: ../src/guestfs-actions.pod:672
22035 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22036 " const char *device);\n"
22041 #: ../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
22042 msgid "(Added in 0.9.3)"
22046 #: ../src/guestfs-actions.pod:685
22047 msgid "guestfs_blockdev_getbsz"
22051 #: ../src/guestfs-actions.pod:687
22055 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22056 " const char *device);\n"
22061 #: ../src/guestfs-actions.pod:702
22062 msgid "guestfs_blockdev_getro"
22066 #: ../src/guestfs-actions.pod:704
22070 " guestfs_blockdev_getro (guestfs_h *g,\n"
22071 " const char *device);\n"
22076 #: ../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
22077 msgid "This function returns a C truth value on success or -1 on error."
22081 #: ../src/guestfs-actions.pod:717
22082 msgid "guestfs_blockdev_getsize64"
22086 #: ../src/guestfs-actions.pod:719
22090 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22091 " const char *device);\n"
22096 #: ../src/guestfs-actions.pod:725
22097 msgid "See also C<guestfs_blockdev_getsz>."
22101 #: ../src/guestfs-actions.pod:733
22102 msgid "guestfs_blockdev_getss"
22106 #: ../src/guestfs-actions.pod:735
22110 " guestfs_blockdev_getss (guestfs_h *g,\n"
22111 " const char *device);\n"
22116 #: ../src/guestfs-actions.pod:742
22118 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22123 #: ../src/guestfs-actions.pod:751
22124 msgid "guestfs_blockdev_getsz"
22128 #: ../src/guestfs-actions.pod:753
22132 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22133 " const char *device);\n"
22138 #: ../src/guestfs-actions.pod:760
22140 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22141 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22145 #: ../src/guestfs-actions.pod:770
22146 msgid "guestfs_blockdev_rereadpt"
22150 #: ../src/guestfs-actions.pod:772
22154 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22155 " const char *device);\n"
22160 #: ../src/guestfs-actions.pod:784
22161 msgid "guestfs_blockdev_setbsz"
22165 #: ../src/guestfs-actions.pod:786
22169 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22170 " const char *device,\n"
22171 " int blocksize);\n"
22176 #: ../src/guestfs-actions.pod:802
22177 msgid "guestfs_blockdev_setro"
22181 #: ../src/guestfs-actions.pod:804
22185 " guestfs_blockdev_setro (guestfs_h *g,\n"
22186 " const char *device);\n"
22191 #: ../src/guestfs-actions.pod:816
22192 msgid "guestfs_blockdev_setrw"
22196 #: ../src/guestfs-actions.pod:818
22200 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22201 " const char *device);\n"
22206 #: ../src/guestfs-actions.pod:830
22207 msgid "guestfs_btrfs_filesystem_resize"
22211 #: ../src/guestfs-actions.pod:832
22215 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22216 " const char *mountpoint,\n"
22222 #: ../src/guestfs-actions.pod:842
22225 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22230 #: ../src/guestfs-actions.pod:865
22231 msgid "(Added in 1.11.17)"
22235 #: ../src/guestfs-actions.pod:867
22236 msgid "guestfs_btrfs_filesystem_resize_va"
22240 #: ../src/guestfs-actions.pod:869
22244 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22245 " const char *mountpoint,\n"
22246 " va_list args);\n"
22251 #: ../src/guestfs-actions.pod:874
22252 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22256 #: ../src/guestfs-actions.pod:878
22257 msgid "guestfs_btrfs_filesystem_resize_argv"
22261 #: ../src/guestfs-actions.pod:880
22265 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22266 " const char *mountpoint,\n"
22268 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22273 #: ../src/guestfs-actions.pod:885
22274 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22278 #: ../src/guestfs-actions.pod:889
22279 msgid "guestfs_case_sensitive_path"
22283 #: ../src/guestfs-actions.pod:891
22287 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22288 " const char *path);\n"
22293 #: ../src/guestfs-actions.pod:917
22295 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
22296 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22297 "how the directories were originally created under Windows)."
22301 #: ../src/guestfs-actions.pod:925
22302 msgid "See also C<guestfs_realpath>."
22306 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7392
22307 msgid "(Added in 1.0.75)"
22311 #: ../src/guestfs-actions.pod:932
22312 msgid "guestfs_cat"
22316 #: ../src/guestfs-actions.pod:934
22320 " guestfs_cat (guestfs_h *g,\n"
22321 " const char *path);\n"
22326 #: ../src/guestfs-actions.pod:940
22328 "Note that this function cannot correctly handle binary files (specifically, "
22329 "files containing C<\\0> character which is treated as end of string). For "
22330 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22331 "functions which have a more complex interface."
22335 #: ../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
22336 msgid "(Added in 0.4)"
22340 #: ../src/guestfs-actions.pod:953
22341 msgid "guestfs_checksum"
22345 #: ../src/guestfs-actions.pod:955
22349 " guestfs_checksum (guestfs_h *g,\n"
22350 " const char *csumtype,\n"
22351 " const char *path);\n"
22356 #: ../src/guestfs-actions.pod:1001
22357 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22361 #: ../src/guestfs-actions.pod:1003
22362 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22366 #: ../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
22367 msgid "(Added in 1.0.2)"
22371 #: ../src/guestfs-actions.pod:1010
22372 msgid "guestfs_checksum_device"
22376 #: ../src/guestfs-actions.pod:1012
22380 " guestfs_checksum_device (guestfs_h *g,\n"
22381 " const char *csumtype,\n"
22382 " const char *device);\n"
22387 #: ../src/guestfs-actions.pod:1017
22389 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22390 "device named C<device>. For the types of checksums supported see the "
22391 "C<guestfs_checksum> command."
22395 #: ../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
22396 msgid "(Added in 1.3.2)"
22400 #: ../src/guestfs-actions.pod:1026
22401 msgid "guestfs_checksums_out"
22405 #: ../src/guestfs-actions.pod:1028
22409 " guestfs_checksums_out (guestfs_h *g,\n"
22410 " const char *csumtype,\n"
22411 " const char *directory,\n"
22412 " const char *sumsfile);\n"
22417 #: ../src/guestfs-actions.pod:1048
22418 msgid "(Added in 1.3.7)"
22422 #: ../src/guestfs-actions.pod:1050
22423 msgid "guestfs_chmod"
22427 #: ../src/guestfs-actions.pod:1052
22431 " guestfs_chmod (guestfs_h *g,\n"
22433 " const char *path);\n"
22438 #: ../src/guestfs-actions.pod:1070
22439 msgid "guestfs_chown"
22443 #: ../src/guestfs-actions.pod:1072
22447 " guestfs_chown (guestfs_h *g,\n"
22450 " const char *path);\n"
22455 #: ../src/guestfs-actions.pod:1088
22456 msgid "guestfs_command"
22460 #: ../src/guestfs-actions.pod:1090
22464 " guestfs_command (guestfs_h *g,\n"
22465 " char *const *arguments);\n"
22470 #: ../src/guestfs-actions.pod:1099
22472 "The single parameter is an argv-style list of arguments. The first element "
22473 "is the name of the program to run. Subsequent elements are parameters. The "
22474 "list must be non-empty (ie. must contain a program name). Note that the "
22475 "command runs directly, and is I<not> invoked via the shell (see "
22480 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1615
22481 msgid "(Added in 0.9.1)"
22485 #: ../src/guestfs-actions.pod:1132
22486 msgid "guestfs_command_lines"
22490 #: ../src/guestfs-actions.pod:1134
22494 " guestfs_command_lines (guestfs_h *g,\n"
22495 " char *const *arguments);\n"
22500 #: ../src/guestfs-actions.pod:1138
22502 "This is the same as C<guestfs_command>, but splits the result into a list of "
22507 #: ../src/guestfs-actions.pod:1141
22508 msgid "See also: C<guestfs_sh_lines>"
22512 #: ../src/guestfs-actions.pod:1152
22513 msgid "guestfs_config"
22517 #: ../src/guestfs-actions.pod:1154
22521 " guestfs_config (guestfs_h *g,\n"
22522 " const char *qemuparam,\n"
22523 " const char *qemuvalue);\n"
22528 #: ../src/guestfs-actions.pod:1172
22529 msgid "guestfs_copy_size"
22533 #: ../src/guestfs-actions.pod:1174
22537 " guestfs_copy_size (guestfs_h *g,\n"
22538 " const char *src,\n"
22539 " const char *dest,\n"
22540 " int64_t size);\n"
22545 #: ../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:7784 ../src/guestfs-actions.pod:7807
22547 "This long-running command can generate progress notification messages so "
22548 "that the caller can display a progress bar or indicator. To receive these "
22549 "messages, the caller must register a progress event callback. See "
22550 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
22554 #: ../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
22555 msgid "(Added in 1.0.87)"
22559 #: ../src/guestfs-actions.pod:1195
22564 #: ../src/guestfs-actions.pod:1197
22568 " guestfs_cp (guestfs_h *g,\n"
22569 " const char *src,\n"
22570 " const char *dest);\n"
22575 #: ../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
22576 msgid "(Added in 1.0.18)"
22580 #: ../src/guestfs-actions.pod:1209
22581 msgid "guestfs_cp_a"
22585 #: ../src/guestfs-actions.pod:1211
22589 " guestfs_cp_a (guestfs_h *g,\n"
22590 " const char *src,\n"
22591 " const char *dest);\n"
22596 #: ../src/guestfs-actions.pod:1223
22601 #: ../src/guestfs-actions.pod:1225
22605 " guestfs_dd (guestfs_h *g,\n"
22606 " const char *src,\n"
22607 " const char *dest);\n"
22612 #: ../src/guestfs-actions.pod:1235
22614 "If the destination is a device, it must be as large or larger than the "
22615 "source file or device, otherwise the copy will fail. This command cannot do "
22616 "partial copies (see C<guestfs_copy_size>)."
22620 #: ../src/guestfs-actions.pod:1243
22625 #: ../src/guestfs-actions.pod:1245
22629 " guestfs_df (guestfs_h *g);\n"
22634 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
22636 "This command is mostly useful for interactive sessions. It is I<not> "
22637 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
22642 #: ../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
22643 msgid "(Added in 1.0.54)"
22647 #: ../src/guestfs-actions.pod:1259
22648 msgid "guestfs_df_h"
22652 #: ../src/guestfs-actions.pod:1261
22656 " guestfs_df_h (guestfs_h *g);\n"
22661 #: ../src/guestfs-actions.pod:1276
22662 msgid "guestfs_dmesg"
22666 #: ../src/guestfs-actions.pod:1278
22670 " guestfs_dmesg (guestfs_h *g);\n"
22675 #: ../src/guestfs-actions.pod:1285
22677 "Another way to get the same information is to enable verbose messages with "
22678 "C<guestfs_set_verbose> or by setting the environment variable "
22679 "C<LIBGUESTFS_DEBUG=1> before running the program."
22683 #: ../src/guestfs-actions.pod:1295
22684 msgid "guestfs_download"
22688 #: ../src/guestfs-actions.pod:1297
22692 " guestfs_download (guestfs_h *g,\n"
22693 " const char *remotefilename,\n"
22694 " const char *filename);\n"
22699 #: ../src/guestfs-actions.pod:1307
22700 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
22704 #: ../src/guestfs-actions.pod:1318
22705 msgid "guestfs_download_offset"
22709 #: ../src/guestfs-actions.pod:1320
22713 " guestfs_download_offset (guestfs_h *g,\n"
22714 " const char *remotefilename,\n"
22715 " const char *filename,\n"
22716 " int64_t offset,\n"
22717 " int64_t size);\n"
22722 #: ../src/guestfs-actions.pod:1333
22724 "Note that there is no limit on the amount of data that can be downloaded "
22725 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
22726 "full amount unless an error occurs."
22730 #: ../src/guestfs-actions.pod:1338
22731 msgid "See also C<guestfs_download>, C<guestfs_pread>."
22735 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7282
22736 msgid "(Added in 1.5.17)"
22740 #: ../src/guestfs-actions.pod:1349
22741 msgid "guestfs_drop_caches"
22745 #: ../src/guestfs-actions.pod:1351
22749 " guestfs_drop_caches (guestfs_h *g,\n"
22750 " int whattodrop);\n"
22755 #: ../src/guestfs-actions.pod:1369
22760 #: ../src/guestfs-actions.pod:1371
22764 " guestfs_du (guestfs_h *g,\n"
22765 " const char *path);\n"
22770 #: ../src/guestfs-actions.pod:1394
22771 msgid "guestfs_e2fsck_f"
22775 #: ../src/guestfs-actions.pod:1396
22779 " guestfs_e2fsck_f (guestfs_h *g,\n"
22780 " const char *device);\n"
22785 #: ../src/guestfs-actions.pod:1404
22787 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
22788 "Normally you should use C<guestfs_fsck>."
22792 #: ../src/guestfs-actions.pod:1409
22793 msgid "(Added in 1.0.29)"
22797 #: ../src/guestfs-actions.pod:1411
22798 msgid "guestfs_echo_daemon"
22802 #: ../src/guestfs-actions.pod:1413
22806 " guestfs_echo_daemon (guestfs_h *g,\n"
22807 " char *const *words);\n"
22812 #: ../src/guestfs-actions.pod:1422
22813 msgid "See also C<guestfs_ping_daemon>."
22817 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:6453
22818 msgid "(Added in 1.0.69)"
22822 #: ../src/guestfs-actions.pod:1429
22823 msgid "guestfs_egrep"
22827 #: ../src/guestfs-actions.pod:1431
22831 " guestfs_egrep (guestfs_h *g,\n"
22832 " const char *regex,\n"
22833 " const char *path);\n"
22838 #: ../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:7855 ../src/guestfs-actions.pod:7874 ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7939
22839 msgid "(Added in 1.0.66)"
22843 #: ../src/guestfs-actions.pod:1448
22844 msgid "guestfs_egrepi"
22848 #: ../src/guestfs-actions.pod:1450
22852 " guestfs_egrepi (guestfs_h *g,\n"
22853 " const char *regex,\n"
22854 " const char *path);\n"
22859 #: ../src/guestfs-actions.pod:1467
22860 msgid "guestfs_equal"
22864 #: ../src/guestfs-actions.pod:1469
22868 " guestfs_equal (guestfs_h *g,\n"
22869 " const char *file1,\n"
22870 " const char *file2);\n"
22875 #: ../src/guestfs-actions.pod:1483
22876 msgid "guestfs_exists"
22880 #: ../src/guestfs-actions.pod:1485
22884 " guestfs_exists (guestfs_h *g,\n"
22885 " const char *path);\n"
22890 #: ../src/guestfs-actions.pod:1492
22891 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
22895 #: ../src/guestfs-actions.pod:1498
22896 msgid "guestfs_fallocate"
22900 #: ../src/guestfs-actions.pod:1500
22904 " guestfs_fallocate (guestfs_h *g,\n"
22905 " const char *path,\n"
22911 #: ../src/guestfs-actions.pod:1515
22913 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
22918 #: ../src/guestfs-actions.pod:1524
22919 msgid "guestfs_fallocate64"
22923 #: ../src/guestfs-actions.pod:1526
22927 " guestfs_fallocate64 (guestfs_h *g,\n"
22928 " const char *path,\n"
22934 #: ../src/guestfs-actions.pod:1535
22936 "Note that this call allocates disk blocks for the file. To create a sparse "
22937 "file use C<guestfs_truncate_size> instead."
22941 #: ../src/guestfs-actions.pod:1538
22943 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
22944 "oversight it only allowed 30 bit lengths to be specified, effectively "
22945 "limiting the maximum size of files created through that call to 1GB."
22949 #: ../src/guestfs-actions.pod:1549
22950 msgid "(Added in 1.3.17)"
22954 #: ../src/guestfs-actions.pod:1551
22955 msgid "guestfs_fgrep"
22959 #: ../src/guestfs-actions.pod:1553
22963 " guestfs_fgrep (guestfs_h *g,\n"
22964 " const char *pattern,\n"
22965 " const char *path);\n"
22970 #: ../src/guestfs-actions.pod:1570
22971 msgid "guestfs_fgrepi"
22975 #: ../src/guestfs-actions.pod:1572
22979 " guestfs_fgrepi (guestfs_h *g,\n"
22980 " const char *pattern,\n"
22981 " const char *path);\n"
22986 #: ../src/guestfs-actions.pod:1589
22987 msgid "guestfs_file"
22991 #: ../src/guestfs-actions.pod:1591
22995 " guestfs_file (guestfs_h *g,\n"
22996 " const char *path);\n"
23001 #: ../src/guestfs-actions.pod:1609
23003 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23004 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23008 #: ../src/guestfs-actions.pod:1617
23009 msgid "guestfs_file_architecture"
23013 #: ../src/guestfs-actions.pod:1619
23017 " guestfs_file_architecture (guestfs_h *g,\n"
23018 " const char *filename);\n"
23023 #: ../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
23024 msgid "(Added in 1.5.3)"
23028 #: ../src/guestfs-actions.pod:1729
23029 msgid "guestfs_filesize"
23033 #: ../src/guestfs-actions.pod:1731
23037 " guestfs_filesize (guestfs_h *g,\n"
23038 " const char *file);\n"
23043 #: ../src/guestfs-actions.pod:1737
23045 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23046 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23047 "devices, use C<guestfs_blockdev_getsize64>."
23051 #: ../src/guestfs-actions.pod:1743
23052 msgid "(Added in 1.0.82)"
23056 #: ../src/guestfs-actions.pod:1745
23057 msgid "guestfs_fill"
23061 #: ../src/guestfs-actions.pod:1747
23065 " guestfs_fill (guestfs_h *g,\n"
23068 " const char *path);\n"
23073 #: ../src/guestfs-actions.pod:1757
23075 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23076 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23077 "bytes use C<guestfs_fill_pattern>."
23081 #: ../src/guestfs-actions.pod:1769
23082 msgid "(Added in 1.0.79)"
23086 #: ../src/guestfs-actions.pod:1771
23087 msgid "guestfs_fill_pattern"
23091 #: ../src/guestfs-actions.pod:1773
23095 " guestfs_fill_pattern (guestfs_h *g,\n"
23096 " const char *pattern,\n"
23098 " const char *path);\n"
23103 #: ../src/guestfs-actions.pod:1779
23105 "This function is like C<guestfs_fill> except that it creates a new file of "
23106 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23107 "pattern is truncated if necessary to ensure the length of the file is "
23108 "exactly C<len> bytes."
23112 #: ../src/guestfs-actions.pod:1791
23113 msgid "(Added in 1.3.12)"
23117 #: ../src/guestfs-actions.pod:1793
23118 msgid "guestfs_find"
23122 #: ../src/guestfs-actions.pod:1795
23126 " guestfs_find (guestfs_h *g,\n"
23127 " const char *directory);\n"
23132 #: ../src/guestfs-actions.pod:1811
23133 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23137 #: ../src/guestfs-actions.pod:1824
23138 msgid "See also C<guestfs_find0>."
23142 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:6014
23143 msgid "(Added in 1.0.27)"
23147 #: ../src/guestfs-actions.pod:1835
23148 msgid "guestfs_find0"
23152 #: ../src/guestfs-actions.pod:1837
23156 " guestfs_find0 (guestfs_h *g,\n"
23157 " const char *directory,\n"
23158 " const char *files);\n"
23163 #: ../src/guestfs-actions.pod:1846
23165 "This command works the same way as C<guestfs_find> with the following "
23170 #: ../src/guestfs-actions.pod:1873
23171 msgid "(Added in 1.0.74)"
23175 #: ../src/guestfs-actions.pod:1875
23176 msgid "guestfs_findfs_label"
23180 #: ../src/guestfs-actions.pod:1877
23184 " guestfs_findfs_label (guestfs_h *g,\n"
23185 " const char *label);\n"
23190 #: ../src/guestfs-actions.pod:1885
23191 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23195 #: ../src/guestfs-actions.pod:1892
23196 msgid "guestfs_findfs_uuid"
23200 #: ../src/guestfs-actions.pod:1894
23204 " guestfs_findfs_uuid (guestfs_h *g,\n"
23205 " const char *uuid);\n"
23210 #: ../src/guestfs-actions.pod:1902
23211 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23215 #: ../src/guestfs-actions.pod:1909
23216 msgid "guestfs_fsck"
23220 #: ../src/guestfs-actions.pod:1911
23224 " guestfs_fsck (guestfs_h *g,\n"
23225 " const char *fstype,\n"
23226 " const char *device);\n"
23231 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7789
23232 msgid "(Added in 1.0.16)"
23236 #: ../src/guestfs-actions.pod:1948
23237 msgid "guestfs_get_append"
23241 #: ../src/guestfs-actions.pod:1950
23245 " guestfs_get_append (guestfs_h *g);\n"
23250 #: ../src/guestfs-actions.pod:1958
23252 "This function returns a string which may be NULL. There is no way to return "
23253 "an error from this function. The string is owned by the guest handle and "
23254 "must I<not> be freed."
23258 #: ../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:7836
23259 msgid "(Added in 1.0.26)"
23263 #: ../src/guestfs-actions.pod:1964
23264 msgid "guestfs_get_attach_method"
23268 #: ../src/guestfs-actions.pod:1966
23272 " guestfs_get_attach_method (guestfs_h *g);\n"
23277 #: ../src/guestfs-actions.pod:1969
23278 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23282 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6204
23283 msgid "(Added in 1.9.8)"
23287 #: ../src/guestfs-actions.pod:1976
23288 msgid "guestfs_get_autosync"
23292 #: ../src/guestfs-actions.pod:1978
23296 " guestfs_get_autosync (guestfs_h *g);\n"
23301 #: ../src/guestfs-actions.pod:1987
23302 msgid "guestfs_get_direct"
23306 #: ../src/guestfs-actions.pod:1989
23310 " guestfs_get_direct (guestfs_h *g);\n"
23315 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6245
23316 msgid "(Added in 1.0.72)"
23320 #: ../src/guestfs-actions.pod:1998
23321 msgid "guestfs_get_e2label"
23325 #: ../src/guestfs-actions.pod:2000
23329 " guestfs_get_e2label (guestfs_h *g,\n"
23330 " const char *device);\n"
23335 #: ../src/guestfs-actions.pod:2010
23337 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
23342 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6282
23343 msgid "(Added in 1.0.15)"
23347 #: ../src/guestfs-actions.pod:2019
23348 msgid "guestfs_get_e2uuid"
23352 #: ../src/guestfs-actions.pod:2021
23356 " guestfs_get_e2uuid (guestfs_h *g,\n"
23357 " const char *device);\n"
23362 #: ../src/guestfs-actions.pod:2031
23364 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
23369 #: ../src/guestfs-actions.pod:2040
23370 msgid "guestfs_get_memsize"
23374 #: ../src/guestfs-actions.pod:2042
23378 " guestfs_get_memsize (guestfs_h *g);\n"
23383 #: ../src/guestfs-actions.pod:2048
23385 "If C<guestfs_set_memsize> was not called on this handle, and if "
23386 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23387 "value for memsize."
23391 #: ../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
23392 msgid "(Added in 1.0.55)"
23396 #: ../src/guestfs-actions.pod:2059
23397 msgid "guestfs_get_network"
23401 #: ../src/guestfs-actions.pod:2061
23405 " guestfs_get_network (guestfs_h *g);\n"
23410 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6322
23411 msgid "(Added in 1.5.4)"
23415 #: ../src/guestfs-actions.pod:2070
23416 msgid "guestfs_get_path"
23420 #: ../src/guestfs-actions.pod:2072
23424 " guestfs_get_path (guestfs_h *g);\n"
23429 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
23431 "This function returns a string, or NULL on error. The string is owned by "
23432 "the guest handle and must I<not> be freed."
23436 #: ../src/guestfs-actions.pod:2085
23437 msgid "guestfs_get_pgroup"
23441 #: ../src/guestfs-actions.pod:2087
23445 " guestfs_get_pgroup (guestfs_h *g);\n"
23450 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:7690
23451 msgid "(Added in 1.11.18)"
23455 #: ../src/guestfs-actions.pod:2096
23456 msgid "guestfs_get_pid"
23460 #: ../src/guestfs-actions.pod:2098
23464 " guestfs_get_pid (guestfs_h *g);\n"
23469 #: ../src/guestfs-actions.pod:2108
23470 msgid "(Added in 1.0.56)"
23474 #: ../src/guestfs-actions.pod:2110
23475 msgid "guestfs_get_qemu"
23479 #: ../src/guestfs-actions.pod:2112
23483 " guestfs_get_qemu (guestfs_h *g);\n"
23488 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6386
23489 msgid "(Added in 1.0.6)"
23493 #: ../src/guestfs-actions.pod:2125
23494 msgid "guestfs_get_recovery_proc"
23498 #: ../src/guestfs-actions.pod:2127
23502 " guestfs_get_recovery_proc (guestfs_h *g);\n"
23507 #: ../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
23508 msgid "(Added in 1.0.77)"
23512 #: ../src/guestfs-actions.pod:2136
23513 msgid "guestfs_get_selinux"
23517 #: ../src/guestfs-actions.pod:2138
23521 " guestfs_get_selinux (guestfs_h *g);\n"
23526 #: ../src/guestfs-actions.pod:2141
23528 "This returns the current setting of the selinux flag which is passed to the "
23529 "appliance at boot time. See C<guestfs_set_selinux>."
23533 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6487
23534 msgid "(Added in 1.0.67)"
23538 #: ../src/guestfs-actions.pod:2151
23539 msgid "guestfs_get_state"
23543 #: ../src/guestfs-actions.pod:2153
23547 " guestfs_get_state (guestfs_h *g);\n"
23552 #: ../src/guestfs-actions.pod:2165
23553 msgid "guestfs_get_trace"
23557 #: ../src/guestfs-actions.pod:2167
23561 " guestfs_get_trace (guestfs_h *g);\n"
23566 #: ../src/guestfs-actions.pod:2176
23567 msgid "guestfs_get_umask"
23571 #: ../src/guestfs-actions.pod:2178
23575 " guestfs_get_umask (guestfs_h *g);\n"
23580 #: ../src/guestfs-actions.pod:2181
23582 "Return the current umask. By default the umask is C<022> unless it has been "
23583 "set by calling C<guestfs_umask>."
23587 #: ../src/guestfs-actions.pod:2188
23588 msgid "guestfs_get_verbose"
23592 #: ../src/guestfs-actions.pod:2190
23596 " guestfs_get_verbose (guestfs_h *g);\n"
23601 #: ../src/guestfs-actions.pod:2199
23602 msgid "guestfs_getcon"
23606 #: ../src/guestfs-actions.pod:2201
23610 " guestfs_getcon (guestfs_h *g);\n"
23615 #: ../src/guestfs-actions.pod:2206
23616 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
23620 #: ../src/guestfs-actions.pod:2214
23621 msgid "guestfs_getxattr"
23625 #: ../src/guestfs-actions.pod:2216
23629 " guestfs_getxattr (guestfs_h *g,\n"
23630 " const char *path,\n"
23631 " const char *name,\n"
23632 " size_t *size_r);\n"
23637 #: ../src/guestfs-actions.pod:2222
23639 "Get a single extended attribute from file C<path> named C<name>. This call "
23640 "follows symlinks. If you want to lookup an extended attribute for the "
23641 "symlink itself, use C<guestfs_lgetxattr>."
23645 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
23647 "Normally it is better to get all extended attributes from a file in one go "
23648 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
23649 "implementations are buggy and do not provide a way to list out attributes. "
23650 "For these filesystems (notably ntfs-3g) you have to know the names of the "
23651 "extended attributes you want in advance and call this function."
23655 #: ../src/guestfs-actions.pod:2236
23656 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
23660 #: ../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
23662 "This function returns a buffer, or NULL on error. The size of the returned "
23663 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
23668 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3698
23669 msgid "(Added in 1.7.24)"
23673 #: ../src/guestfs-actions.pod:2244
23674 msgid "guestfs_getxattrs"
23678 #: ../src/guestfs-actions.pod:2246
23681 " struct guestfs_xattr_list *\n"
23682 " guestfs_getxattrs (guestfs_h *g,\n"
23683 " const char *path);\n"
23688 #: ../src/guestfs-actions.pod:2256
23689 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
23693 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:4398
23695 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
23696 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
23700 #: ../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:7901
23701 msgid "(Added in 1.0.59)"
23705 #: ../src/guestfs-actions.pod:2264
23706 msgid "guestfs_glob_expand"
23710 #: ../src/guestfs-actions.pod:2266
23714 " guestfs_glob_expand (guestfs_h *g,\n"
23715 " const char *pattern);\n"
23720 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:6716
23721 msgid "(Added in 1.0.50)"
23725 #: ../src/guestfs-actions.pod:2287
23726 msgid "guestfs_grep"
23730 #: ../src/guestfs-actions.pod:2289
23734 " guestfs_grep (guestfs_h *g,\n"
23735 " const char *regex,\n"
23736 " const char *path);\n"
23741 #: ../src/guestfs-actions.pod:2306
23742 msgid "guestfs_grepi"
23746 #: ../src/guestfs-actions.pod:2308
23750 " guestfs_grepi (guestfs_h *g,\n"
23751 " const char *regex,\n"
23752 " const char *path);\n"
23757 #: ../src/guestfs-actions.pod:2325
23758 msgid "guestfs_grub_install"
23762 #: ../src/guestfs-actions.pod:2327
23766 " guestfs_grub_install (guestfs_h *g,\n"
23767 " const char *root,\n"
23768 " const char *device);\n"
23773 #: ../src/guestfs-actions.pod:2348
23774 msgid "(Added in 1.0.17)"
23778 #: ../src/guestfs-actions.pod:2350
23779 msgid "guestfs_head"
23783 #: ../src/guestfs-actions.pod:2352
23787 " guestfs_head (guestfs_h *g,\n"
23788 " const char *path);\n"
23793 #: ../src/guestfs-actions.pod:2368
23794 msgid "guestfs_head_n"
23798 #: ../src/guestfs-actions.pod:2370
23802 " guestfs_head_n (guestfs_h *g,\n"
23804 " const char *path);\n"
23809 #: ../src/guestfs-actions.pod:2392
23810 msgid "guestfs_hexdump"
23814 #: ../src/guestfs-actions.pod:2394
23818 " guestfs_hexdump (guestfs_h *g,\n"
23819 " const char *path);\n"
23824 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6835
23825 msgid "(Added in 1.0.22)"
23829 #: ../src/guestfs-actions.pod:2409
23830 msgid "guestfs_initrd_cat"
23834 #: ../src/guestfs-actions.pod:2411
23838 " guestfs_initrd_cat (guestfs_h *g,\n"
23839 " const char *initrdpath,\n"
23840 " const char *filename,\n"
23841 " size_t *size_r);\n"
23846 #: ../src/guestfs-actions.pod:2427
23847 msgid "See also C<guestfs_initrd_list>."
23851 #: ../src/guestfs-actions.pod:2438
23852 msgid "guestfs_initrd_list"
23856 #: ../src/guestfs-actions.pod:2440
23860 " guestfs_initrd_list (guestfs_h *g,\n"
23861 " const char *path);\n"
23866 #: ../src/guestfs-actions.pod:2460
23867 msgid "guestfs_inotify_add_watch"
23871 #: ../src/guestfs-actions.pod:2462
23875 " guestfs_inotify_add_watch (guestfs_h *g,\n"
23876 " const char *path,\n"
23882 #: ../src/guestfs-actions.pod:2481
23883 msgid "guestfs_inotify_close"
23887 #: ../src/guestfs-actions.pod:2483
23891 " guestfs_inotify_close (guestfs_h *g);\n"
23896 #: ../src/guestfs-actions.pod:2494
23897 msgid "guestfs_inotify_files"
23901 #: ../src/guestfs-actions.pod:2496
23905 " guestfs_inotify_files (guestfs_h *g);\n"
23910 #: ../src/guestfs-actions.pod:2499
23912 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
23913 "returns a list of pathnames of objects that were touched. The returned "
23914 "pathnames are sorted and deduplicated."
23918 #: ../src/guestfs-actions.pod:2509
23919 msgid "guestfs_inotify_init"
23923 #: ../src/guestfs-actions.pod:2511
23927 " guestfs_inotify_init (guestfs_h *g,\n"
23928 " int maxevents);\n"
23933 #: ../src/guestfs-actions.pod:2519
23935 "C<maxevents> is the maximum number of events which will be queued up between "
23936 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
23937 "passed as C<0>, then the kernel (or previously set) default is used. For "
23938 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
23939 "throws away events, but records the fact that it threw them away by setting "
23940 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
23941 "C<guestfs_inotify_read>)."
23945 #: ../src/guestfs-actions.pod:2529
23947 "Before any events are generated, you have to add some watches to the "
23948 "internal watch list. See: C<guestfs_inotify_add_watch>, "
23949 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
23953 #: ../src/guestfs-actions.pod:2535
23955 "Queued up events should be read periodically by calling "
23956 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
23957 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
23958 "often enough then you risk the internal queue overflowing."
23962 #: ../src/guestfs-actions.pod:2542
23964 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
23965 "This also removes any watches automatically."
23969 #: ../src/guestfs-actions.pod:2555
23970 msgid "guestfs_inotify_read"
23974 #: ../src/guestfs-actions.pod:2557
23977 " struct guestfs_inotify_event_list *\n"
23978 " guestfs_inotify_read (guestfs_h *g);\n"
23983 #: ../src/guestfs-actions.pod:2571
23985 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
23986 "there was an error. I<The caller must call "
23987 "C<guestfs_free_inotify_event_list> after use>."
23991 #: ../src/guestfs-actions.pod:2577
23992 msgid "guestfs_inotify_rm_watch"
23996 #: ../src/guestfs-actions.pod:2579
24000 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24006 #: ../src/guestfs-actions.pod:2583
24008 "Remove a previously defined inotify watch. See "
24009 "C<guestfs_inotify_add_watch>."
24013 #: ../src/guestfs-actions.pod:2590
24014 msgid "guestfs_inspect_get_arch"
24018 #: ../src/guestfs-actions.pod:2592
24022 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24023 " const char *root);\n"
24028 #: ../src/guestfs-actions.pod:2596
24030 "This returns the architecture of the inspected operating system. The "
24031 "possible return values are listed under C<guestfs_file_architecture>."
24035 #: ../src/guestfs-actions.pod:2610
24036 msgid "guestfs_inspect_get_distro"
24040 #: ../src/guestfs-actions.pod:2612
24044 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24045 " const char *root);\n"
24050 #: ../src/guestfs-actions.pod:2700
24051 msgid "guestfs_inspect_get_drive_mappings"
24055 #: ../src/guestfs-actions.pod:2702
24059 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24060 " const char *root);\n"
24065 #: ../src/guestfs-actions.pod:2731
24067 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24068 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24072 #: ../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
24074 "This function returns a NULL-terminated array of strings, or NULL if there "
24075 "was an error. The array of strings will always have length C<2n+1>, where "
24076 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24077 "caller must free the strings and the array after use>."
24081 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:3197
24082 msgid "(Added in 1.9.17)"
24086 #: ../src/guestfs-actions.pod:2743
24087 msgid "guestfs_inspect_get_filesystems"
24091 #: ../src/guestfs-actions.pod:2745
24095 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24096 " const char *root);\n"
24101 #: ../src/guestfs-actions.pod:2757
24103 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24104 "C<guestfs_inspect_get_mountpoints>."
24108 #: ../src/guestfs-actions.pod:2766
24109 msgid "guestfs_inspect_get_format"
24113 #: ../src/guestfs-actions.pod:2768
24117 " guestfs_inspect_get_format (guestfs_h *g,\n"
24118 " const char *root);\n"
24123 #: ../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
24124 msgid "(Added in 1.9.4)"
24128 #: ../src/guestfs-actions.pod:2804
24129 msgid "guestfs_inspect_get_hostname"
24133 #: ../src/guestfs-actions.pod:2806
24137 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24138 " const char *root);\n"
24143 #: ../src/guestfs-actions.pod:2821
24144 msgid "(Added in 1.7.9)"
24148 #: ../src/guestfs-actions.pod:2823
24149 msgid "guestfs_inspect_get_icon"
24153 #: ../src/guestfs-actions.pod:2825
24157 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24158 " const char *root,\n"
24159 " size_t *size_r,\n"
24165 #: ../src/guestfs-actions.pod:2836
24168 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24169 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24174 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4982
24175 msgid "(Added in 1.11.12)"
24179 #: ../src/guestfs-actions.pod:2905
24180 msgid "guestfs_inspect_get_icon_va"
24184 #: ../src/guestfs-actions.pod:2907
24188 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24189 " const char *root,\n"
24190 " size_t *size_r,\n"
24191 " va_list args);\n"
24196 #: ../src/guestfs-actions.pod:2913
24197 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24201 #: ../src/guestfs-actions.pod:2917
24202 msgid "guestfs_inspect_get_icon_argv"
24206 #: ../src/guestfs-actions.pod:2919
24210 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24211 " const char *root,\n"
24212 " size_t *size_r,\n"
24213 " const struct guestfs_inspect_get_icon_argv "
24219 #: ../src/guestfs-actions.pod:2925
24220 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24224 #: ../src/guestfs-actions.pod:2929
24225 msgid "guestfs_inspect_get_major_version"
24229 #: ../src/guestfs-actions.pod:2931
24233 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24234 " const char *root);\n"
24239 #: ../src/guestfs-actions.pod:2953
24240 msgid "guestfs_inspect_get_minor_version"
24244 #: ../src/guestfs-actions.pod:2955
24248 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24249 " const char *root);\n"
24254 #: ../src/guestfs-actions.pod:2964
24256 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24257 "C<guestfs_inspect_get_major_version>."
24261 #: ../src/guestfs-actions.pod:2971
24262 msgid "guestfs_inspect_get_mountpoints"
24266 #: ../src/guestfs-actions.pod:2973
24270 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24271 " const char *root);\n"
24276 #: ../src/guestfs-actions.pod:2994
24278 "For operating systems like Windows which still use drive letters, this call "
24279 "will only return an entry for the first drive \"mounted on\" C</>. For "
24280 "information about the mapping of drive letters to partitions, see "
24281 "C<guestfs_inspect_get_drive_mappings>."
24285 #: ../src/guestfs-actions.pod:3000
24287 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24288 "C<guestfs_inspect_get_filesystems>."
24292 #: ../src/guestfs-actions.pod:3011
24293 msgid "guestfs_inspect_get_package_format"
24297 #: ../src/guestfs-actions.pod:3013
24301 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24302 " const char *root);\n"
24307 #: ../src/guestfs-actions.pod:3017
24309 "This function and C<guestfs_inspect_get_package_management> return the "
24310 "package format and package management tool used by the inspected operating "
24311 "system. For example for Fedora these functions would return C<rpm> (package "
24312 "format) and C<yum> (package management)."
24316 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3063
24317 msgid "(Added in 1.7.5)"
24321 #: ../src/guestfs-actions.pod:3037
24322 msgid "guestfs_inspect_get_package_management"
24326 #: ../src/guestfs-actions.pod:3039
24330 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24331 " const char *root);\n"
24336 #: ../src/guestfs-actions.pod:3043
24338 "C<guestfs_inspect_get_package_format> and this function return the package "
24339 "format and package management tool used by the inspected operating system. "
24340 "For example for Fedora these functions would return C<rpm> (package format) "
24341 "and C<yum> (package management)."
24345 #: ../src/guestfs-actions.pod:3065
24346 msgid "guestfs_inspect_get_product_name"
24350 #: ../src/guestfs-actions.pod:3067
24354 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24355 " const char *root);\n"
24360 #: ../src/guestfs-actions.pod:3086
24361 msgid "guestfs_inspect_get_product_variant"
24365 #: ../src/guestfs-actions.pod:3088
24369 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24370 " const char *root);\n"
24375 #: ../src/guestfs-actions.pod:3111
24377 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24378 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24382 #: ../src/guestfs-actions.pod:3118
24383 msgid "(Added in 1.9.13)"
24387 #: ../src/guestfs-actions.pod:3120
24388 msgid "guestfs_inspect_get_roots"
24392 #: ../src/guestfs-actions.pod:3122
24396 " guestfs_inspect_get_roots (guestfs_h *g);\n"
24401 #: ../src/guestfs-actions.pod:3125
24403 "This function is a convenient way to get the list of root devices, as "
24404 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
24405 "the whole inspection process."
24409 #: ../src/guestfs-actions.pod:3129
24411 "This returns an empty list if either no root devices were found or the "
24412 "caller has not called C<guestfs_inspect_os>."
24416 #: ../src/guestfs-actions.pod:3138
24417 msgid "(Added in 1.7.3)"
24421 #: ../src/guestfs-actions.pod:3140
24422 msgid "guestfs_inspect_get_type"
24426 #: ../src/guestfs-actions.pod:3142
24430 " guestfs_inspect_get_type (guestfs_h *g,\n"
24431 " const char *root);\n"
24436 #: ../src/guestfs-actions.pod:3179
24437 msgid "guestfs_inspect_get_windows_current_control_set"
24441 #: ../src/guestfs-actions.pod:3181
24445 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
24446 " const char *root);\n"
24451 #: ../src/guestfs-actions.pod:3199
24452 msgid "guestfs_inspect_get_windows_systemroot"
24456 #: ../src/guestfs-actions.pod:3201
24460 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
24461 " const char *root);\n"
24466 #: ../src/guestfs-actions.pod:3217
24467 msgid "(Added in 1.5.25)"
24471 #: ../src/guestfs-actions.pod:3219
24472 msgid "guestfs_inspect_is_live"
24476 #: ../src/guestfs-actions.pod:3221
24480 " guestfs_inspect_is_live (guestfs_h *g,\n"
24481 " const char *root);\n"
24486 #: ../src/guestfs-actions.pod:3225
24488 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24489 "disk), then this returns true if a live image was detected on the disk."
24493 #: ../src/guestfs-actions.pod:3235
24494 msgid "guestfs_inspect_is_multipart"
24498 #: ../src/guestfs-actions.pod:3237
24502 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
24503 " const char *root);\n"
24508 #: ../src/guestfs-actions.pod:3241
24510 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24511 "disk), then this returns true if the disk is part of a set."
24515 #: ../src/guestfs-actions.pod:3251
24516 msgid "guestfs_inspect_is_netinst"
24520 #: ../src/guestfs-actions.pod:3253
24524 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
24525 " const char *root);\n"
24530 #: ../src/guestfs-actions.pod:3257
24532 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24533 "disk), then this returns true if the disk is a network installer, ie. not a "
24534 "self-contained install CD but one which is likely to require network access "
24535 "to complete the install."
24539 #: ../src/guestfs-actions.pod:3269
24540 msgid "guestfs_inspect_list_applications"
24544 #: ../src/guestfs-actions.pod:3271
24547 " struct guestfs_application_list *\n"
24548 " guestfs_inspect_list_applications (guestfs_h *g,\n"
24549 " const char *root);\n"
24554 #: ../src/guestfs-actions.pod:3277
24556 "I<Note:> This call works differently from other parts of the inspection "
24557 "API. You have to call C<guestfs_inspect_os>, then "
24558 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
24559 "this. Listing applications is a significantly more difficult operation "
24560 "which requires access to the full filesystem. Also note that unlike the "
24561 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
24562 "the libguestfs handle, this call actually reads parts of the mounted "
24563 "filesystems during the call."
24567 #: ../src/guestfs-actions.pod:3367
24569 "This function returns a C<struct guestfs_application_list *>, or NULL if "
24570 "there was an error. I<The caller must call C<guestfs_free_application_list> "
24575 #: ../src/guestfs-actions.pod:3371
24576 msgid "(Added in 1.7.8)"
24580 #: ../src/guestfs-actions.pod:3373
24581 msgid "guestfs_inspect_os"
24585 #: ../src/guestfs-actions.pod:3375
24589 " guestfs_inspect_os (guestfs_h *g);\n"
24594 #: ../src/guestfs-actions.pod:3391
24596 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
24597 "functions in order to query further information about each operating system, "
24598 "such as the name and version."
24602 #: ../src/guestfs-actions.pod:3396
24604 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
24605 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
24606 "the contents. This should be called with no disks currently mounted. The "
24607 "function may also use Augeas, so any existing Augeas handle will be closed."
24611 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3739 ../src/guestfs-actions.pod:3821
24612 msgid "See also C<guestfs_list_filesystems>."
24616 #: ../src/guestfs-actions.pod:3416
24617 msgid "guestfs_is_blockdev"
24621 #: ../src/guestfs-actions.pod:3418
24625 " guestfs_is_blockdev (guestfs_h *g,\n"
24626 " const char *path);\n"
24631 #: ../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
24632 msgid "See also C<guestfs_stat>."
24636 #: ../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
24637 msgid "(Added in 1.5.10)"
24641 #: ../src/guestfs-actions.pod:3431
24642 msgid "guestfs_is_busy"
24646 #: ../src/guestfs-actions.pod:3433
24650 " guestfs_is_busy (guestfs_h *g);\n"
24655 #: ../src/guestfs-actions.pod:3445
24656 msgid "guestfs_is_chardev"
24660 #: ../src/guestfs-actions.pod:3447
24664 " guestfs_is_chardev (guestfs_h *g,\n"
24665 " const char *path);\n"
24670 #: ../src/guestfs-actions.pod:3460
24671 msgid "guestfs_is_config"
24675 #: ../src/guestfs-actions.pod:3462
24679 " guestfs_is_config (guestfs_h *g);\n"
24684 #: ../src/guestfs-actions.pod:3474
24685 msgid "guestfs_is_dir"
24689 #: ../src/guestfs-actions.pod:3476
24693 " guestfs_is_dir (guestfs_h *g,\n"
24694 " const char *path);\n"
24699 #: ../src/guestfs-actions.pod:3490
24700 msgid "guestfs_is_fifo"
24704 #: ../src/guestfs-actions.pod:3492
24708 " guestfs_is_fifo (guestfs_h *g,\n"
24709 " const char *path);\n"
24714 #: ../src/guestfs-actions.pod:3505
24715 msgid "guestfs_is_file"
24719 #: ../src/guestfs-actions.pod:3507
24723 " guestfs_is_file (guestfs_h *g,\n"
24724 " const char *path);\n"
24729 #: ../src/guestfs-actions.pod:3521
24730 msgid "guestfs_is_launching"
24734 #: ../src/guestfs-actions.pod:3523
24738 " guestfs_is_launching (guestfs_h *g);\n"
24743 #: ../src/guestfs-actions.pod:3535
24744 msgid "guestfs_is_lv"
24748 #: ../src/guestfs-actions.pod:3537
24752 " guestfs_is_lv (guestfs_h *g,\n"
24753 " const char *device);\n"
24758 #: ../src/guestfs-actions.pod:3548
24759 msgid "guestfs_is_ready"
24763 #: ../src/guestfs-actions.pod:3550
24767 " guestfs_is_ready (guestfs_h *g);\n"
24772 #: ../src/guestfs-actions.pod:3562
24773 msgid "guestfs_is_socket"
24777 #: ../src/guestfs-actions.pod:3564
24781 " guestfs_is_socket (guestfs_h *g,\n"
24782 " const char *path);\n"
24787 #: ../src/guestfs-actions.pod:3577
24788 msgid "guestfs_is_symlink"
24792 #: ../src/guestfs-actions.pod:3579
24796 " guestfs_is_symlink (guestfs_h *g,\n"
24797 " const char *path);\n"
24802 #: ../src/guestfs-actions.pod:3592
24803 msgid "guestfs_is_zero"
24807 #: ../src/guestfs-actions.pod:3594
24811 " guestfs_is_zero (guestfs_h *g,\n"
24812 " const char *path);\n"
24817 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3617
24818 msgid "(Added in 1.11.8)"
24822 #: ../src/guestfs-actions.pod:3605
24823 msgid "guestfs_is_zero_device"
24827 #: ../src/guestfs-actions.pod:3607
24831 " guestfs_is_zero_device (guestfs_h *g,\n"
24832 " const char *device);\n"
24837 #: ../src/guestfs-actions.pod:3619
24838 msgid "guestfs_kill_subprocess"
24842 #: ../src/guestfs-actions.pod:3621
24846 " guestfs_kill_subprocess (guestfs_h *g);\n"
24851 #: ../src/guestfs-actions.pod:3630
24852 msgid "guestfs_launch"
24856 #: ../src/guestfs-actions.pod:3632
24860 " guestfs_launch (guestfs_h *g);\n"
24865 #: ../src/guestfs-actions.pod:3650
24866 msgid "guestfs_lchown"
24870 #: ../src/guestfs-actions.pod:3652
24874 " guestfs_lchown (guestfs_h *g,\n"
24877 " const char *path);\n"
24882 #: ../src/guestfs-actions.pod:3658
24884 "Change the file owner to C<owner> and group to C<group>. This is like "
24885 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
24886 "changed, not the target."
24890 #: ../src/guestfs-actions.pod:3670
24891 msgid "guestfs_lgetxattr"
24895 #: ../src/guestfs-actions.pod:3672
24899 " guestfs_lgetxattr (guestfs_h *g,\n"
24900 " const char *path,\n"
24901 " const char *name,\n"
24902 " size_t *size_r);\n"
24907 #: ../src/guestfs-actions.pod:3692
24908 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
24912 #: ../src/guestfs-actions.pod:3700
24913 msgid "guestfs_lgetxattrs"
24917 #: ../src/guestfs-actions.pod:3702
24920 " struct guestfs_xattr_list *\n"
24921 " guestfs_lgetxattrs (guestfs_h *g,\n"
24922 " const char *path);\n"
24927 #: ../src/guestfs-actions.pod:3706
24929 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
24930 "then it returns the extended attributes of the link itself."
24934 #: ../src/guestfs-actions.pod:3716
24935 msgid "guestfs_list_9p"
24939 #: ../src/guestfs-actions.pod:3718
24943 " guestfs_list_9p (guestfs_h *g);\n"
24948 #: ../src/guestfs-actions.pod:3730
24949 msgid "guestfs_list_devices"
24953 #: ../src/guestfs-actions.pod:3732
24957 " guestfs_list_devices (guestfs_h *g);\n"
24962 #: ../src/guestfs-actions.pod:3747
24963 msgid "guestfs_list_dm_devices"
24967 #: ../src/guestfs-actions.pod:3749
24971 " guestfs_list_dm_devices (guestfs_h *g);\n"
24976 #: ../src/guestfs-actions.pod:3754
24978 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
24979 "previous call to C<guestfs_luks_open>."
24983 #: ../src/guestfs-actions.pod:3757
24985 "Device mapper devices which correspond to logical volumes are I<not> "
24986 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
24991 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:5221
24992 msgid "(Added in 1.11.15)"
24996 #: ../src/guestfs-actions.pod:3767
24997 msgid "guestfs_list_filesystems"
25001 #: ../src/guestfs-actions.pod:3769
25005 " guestfs_list_filesystems (guestfs_h *g);\n"
25010 #: ../src/guestfs-actions.pod:3789
25012 "This command runs other libguestfs commands, which might include "
25013 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25014 "soon after launch and only when nothing is mounted."
25018 #: ../src/guestfs-actions.pod:3793
25020 "Not all of the filesystems returned will be mountable. In particular, swap "
25021 "partitions are returned in the list. Also this command does not check that "
25022 "each filesystem found is valid and mountable, and some filesystems might be "
25023 "mountable but require special options. Filesystems may not all belong to a "
25024 "single logical operating system (use C<guestfs_inspect_os> to look for "
25029 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:5582
25030 msgid "(Added in 1.5.15)"
25034 #: ../src/guestfs-actions.pod:3809
25035 msgid "guestfs_list_partitions"
25039 #: ../src/guestfs-actions.pod:3811
25043 " guestfs_list_partitions (guestfs_h *g);\n"
25048 #: ../src/guestfs-actions.pod:3818
25050 "This does not return logical volumes. For that you will need to call "
25055 #: ../src/guestfs-actions.pod:3829
25060 #: ../src/guestfs-actions.pod:3831
25064 " guestfs_ll (guestfs_h *g,\n"
25065 " const char *directory);\n"
25070 #: ../src/guestfs-actions.pod:3846
25075 #: ../src/guestfs-actions.pod:3848
25079 " guestfs_ln (guestfs_h *g,\n"
25080 " const char *target,\n"
25081 " const char *linkname);\n"
25086 #: ../src/guestfs-actions.pod:3859
25087 msgid "guestfs_ln_f"
25091 #: ../src/guestfs-actions.pod:3861
25095 " guestfs_ln_f (guestfs_h *g,\n"
25096 " const char *target,\n"
25097 " const char *linkname);\n"
25102 #: ../src/guestfs-actions.pod:3873
25103 msgid "guestfs_ln_s"
25107 #: ../src/guestfs-actions.pod:3875
25111 " guestfs_ln_s (guestfs_h *g,\n"
25112 " const char *target,\n"
25113 " const char *linkname);\n"
25118 #: ../src/guestfs-actions.pod:3886
25119 msgid "guestfs_ln_sf"
25123 #: ../src/guestfs-actions.pod:3888
25127 " guestfs_ln_sf (guestfs_h *g,\n"
25128 " const char *target,\n"
25129 " const char *linkname);\n"
25134 #: ../src/guestfs-actions.pod:3900
25135 msgid "guestfs_lremovexattr"
25139 #: ../src/guestfs-actions.pod:3902
25143 " guestfs_lremovexattr (guestfs_h *g,\n"
25144 " const char *xattr,\n"
25145 " const char *path);\n"
25150 #: ../src/guestfs-actions.pod:3907
25152 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25153 "link, then it removes an extended attribute of the link itself."
25157 #: ../src/guestfs-actions.pod:3915
25162 #: ../src/guestfs-actions.pod:3917
25166 " guestfs_ls (guestfs_h *g,\n"
25167 " const char *directory);\n"
25172 #: ../src/guestfs-actions.pod:3925
25174 "This command is mostly useful for interactive sessions. Programs should "
25175 "probably use C<guestfs_readdir> instead."
25179 #: ../src/guestfs-actions.pod:3934
25180 msgid "guestfs_lsetxattr"
25184 #: ../src/guestfs-actions.pod:3936
25188 " guestfs_lsetxattr (guestfs_h *g,\n"
25189 " const char *xattr,\n"
25190 " const char *val,\n"
25192 " const char *path);\n"
25197 #: ../src/guestfs-actions.pod:3943
25199 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25200 "then it sets an extended attribute of the link itself."
25204 #: ../src/guestfs-actions.pod:3951
25205 msgid "guestfs_lstat"
25209 #: ../src/guestfs-actions.pod:3953
25212 " struct guestfs_stat *\n"
25213 " guestfs_lstat (guestfs_h *g,\n"
25214 " const char *path);\n"
25219 #: ../src/guestfs-actions.pod:3959
25221 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25222 "link, then the link is stat-ed, not the file it refers to."
25226 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:6740
25228 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25229 "error. I<The caller must call C<guestfs_free_stat> after use>."
25233 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:6744 ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7143
25234 msgid "(Added in 0.9.2)"
25238 #: ../src/guestfs-actions.pod:3971
25239 msgid "guestfs_lstatlist"
25243 #: ../src/guestfs-actions.pod:3973
25246 " struct guestfs_stat_list *\n"
25247 " guestfs_lstatlist (guestfs_h *g,\n"
25248 " const char *path,\n"
25249 " char *const *names);\n"
25254 #: ../src/guestfs-actions.pod:3978
25256 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25257 "files, where all files are in the directory C<path>. C<names> is the list "
25258 "of files from this directory."
25262 #: ../src/guestfs-actions.pod:3987
25264 "This call is intended for programs that want to efficiently list a directory "
25265 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25266 "for a similarly efficient call for getting extended attributes. Very long "
25267 "directory listings might cause the protocol message size to be exceeded, "
25268 "causing this call to fail. The caller must split up such requests into "
25269 "smaller groups of names."
25273 #: ../src/guestfs-actions.pod:3995
25275 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25276 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25280 #: ../src/guestfs-actions.pod:4001
25281 msgid "guestfs_luks_add_key"
25285 #: ../src/guestfs-actions.pod:4003
25289 " guestfs_luks_add_key (guestfs_h *g,\n"
25290 " const char *device,\n"
25291 " const char *key,\n"
25292 " const char *newkey,\n"
25298 #: ../src/guestfs-actions.pod:4015
25300 "Note that if C<keyslot> already contains a key, then this command will "
25301 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
25305 #: ../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
25307 "This function takes a key or passphrase parameter which could contain "
25308 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
25313 #: ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4108
25314 msgid "(Added in 1.5.2)"
25318 #: ../src/guestfs-actions.pod:4027
25319 msgid "guestfs_luks_close"
25323 #: ../src/guestfs-actions.pod:4029
25327 " guestfs_luks_close (guestfs_h *g,\n"
25328 " const char *device);\n"
25333 #: ../src/guestfs-actions.pod:4033
25335 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25336 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
25337 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25338 "underlying block device."
25342 #: ../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
25343 msgid "(Added in 1.5.1)"
25347 #: ../src/guestfs-actions.pod:4043
25348 msgid "guestfs_luks_format"
25352 #: ../src/guestfs-actions.pod:4045
25356 " guestfs_luks_format (guestfs_h *g,\n"
25357 " const char *device,\n"
25358 " const char *key,\n"
25364 #: ../src/guestfs-actions.pod:4067
25365 msgid "guestfs_luks_format_cipher"
25369 #: ../src/guestfs-actions.pod:4069
25373 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25374 " const char *device,\n"
25375 " const char *key,\n"
25377 " const char *cipher);\n"
25382 #: ../src/guestfs-actions.pod:4076
25384 "This command is the same as C<guestfs_luks_format> but it also allows you to "
25385 "set the C<cipher> used."
25389 #: ../src/guestfs-actions.pod:4090
25390 msgid "guestfs_luks_kill_slot"
25394 #: ../src/guestfs-actions.pod:4092
25398 " guestfs_luks_kill_slot (guestfs_h *g,\n"
25399 " const char *device,\n"
25400 " const char *key,\n"
25406 #: ../src/guestfs-actions.pod:4110
25407 msgid "guestfs_luks_open"
25411 #: ../src/guestfs-actions.pod:4112
25415 " guestfs_luks_open (guestfs_h *g,\n"
25416 " const char *device,\n"
25417 " const char *key,\n"
25418 " const char *mapname);\n"
25423 #: ../src/guestfs-actions.pod:4130
25425 "If this block device contains LVM volume groups, then calling "
25426 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
25431 #: ../src/guestfs-actions.pod:4134
25432 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
25436 #: ../src/guestfs-actions.pod:4145
25437 msgid "guestfs_luks_open_ro"
25441 #: ../src/guestfs-actions.pod:4147
25445 " guestfs_luks_open_ro (guestfs_h *g,\n"
25446 " const char *device,\n"
25447 " const char *key,\n"
25448 " const char *mapname);\n"
25453 #: ../src/guestfs-actions.pod:4153
25455 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
25460 #: ../src/guestfs-actions.pod:4164
25461 msgid "guestfs_lvcreate"
25465 #: ../src/guestfs-actions.pod:4166
25469 " guestfs_lvcreate (guestfs_h *g,\n"
25470 " const char *logvol,\n"
25471 " const char *volgroup,\n"
25477 #: ../src/guestfs-actions.pod:4179
25478 msgid "guestfs_lvm_canonical_lv_name"
25482 #: ../src/guestfs-actions.pod:4181
25486 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
25487 " const char *lvname);\n"
25492 #: ../src/guestfs-actions.pod:4192
25493 msgid "See also C<guestfs_is_lv>."
25497 #: ../src/guestfs-actions.pod:4197
25498 msgid "(Added in 1.5.24)"
25502 #: ../src/guestfs-actions.pod:4199
25503 msgid "guestfs_lvm_clear_filter"
25507 #: ../src/guestfs-actions.pod:4201
25511 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
25516 #: ../src/guestfs-actions.pod:4204
25518 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
25519 "see every block device."
25523 #: ../src/guestfs-actions.pod:4214
25524 msgid "guestfs_lvm_remove_all"
25528 #: ../src/guestfs-actions.pod:4216
25532 " guestfs_lvm_remove_all (guestfs_h *g);\n"
25537 #: ../src/guestfs-actions.pod:4229
25538 msgid "guestfs_lvm_set_filter"
25542 #: ../src/guestfs-actions.pod:4231
25546 " guestfs_lvm_set_filter (guestfs_h *g,\n"
25547 " char *const *devices);\n"
25552 #: ../src/guestfs-actions.pod:4262
25553 msgid "guestfs_lvremove"
25557 #: ../src/guestfs-actions.pod:4264
25561 " guestfs_lvremove (guestfs_h *g,\n"
25562 " const char *device);\n"
25567 #: ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:5679 ../src/guestfs-actions.pod:7513
25568 msgid "(Added in 1.0.13)"
25572 #: ../src/guestfs-actions.pod:4278
25573 msgid "guestfs_lvrename"
25577 #: ../src/guestfs-actions.pod:4280
25581 " guestfs_lvrename (guestfs_h *g,\n"
25582 " const char *logvol,\n"
25583 " const char *newlogvol);\n"
25588 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:7526
25589 msgid "(Added in 1.0.83)"
25593 #: ../src/guestfs-actions.pod:4291
25594 msgid "guestfs_lvresize"
25598 #: ../src/guestfs-actions.pod:4293
25602 " guestfs_lvresize (guestfs_h *g,\n"
25603 " const char *device,\n"
25609 #: ../src/guestfs-actions.pod:4306
25610 msgid "guestfs_lvresize_free"
25614 #: ../src/guestfs-actions.pod:4308
25618 " guestfs_lvresize_free (guestfs_h *g,\n"
25619 " const char *lv,\n"
25625 #: ../src/guestfs-actions.pod:4321
25626 msgid "(Added in 1.3.3)"
25630 #: ../src/guestfs-actions.pod:4323
25631 msgid "guestfs_lvs"
25635 #: ../src/guestfs-actions.pod:4325
25639 " guestfs_lvs (guestfs_h *g);\n"
25644 #: ../src/guestfs-actions.pod:4334
25645 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
25649 #: ../src/guestfs-actions.pod:4342
25650 msgid "guestfs_lvs_full"
25654 #: ../src/guestfs-actions.pod:4344
25657 " struct guestfs_lvm_lv_list *\n"
25658 " guestfs_lvs_full (guestfs_h *g);\n"
25663 #: ../src/guestfs-actions.pod:4350
25665 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
25666 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
25671 #: ../src/guestfs-actions.pod:4356
25672 msgid "guestfs_lvuuid"
25676 #: ../src/guestfs-actions.pod:4358
25680 " guestfs_lvuuid (guestfs_h *g,\n"
25681 " const char *device);\n"
25686 #: ../src/guestfs-actions.pod:4369
25687 msgid "guestfs_lxattrlist"
25691 #: ../src/guestfs-actions.pod:4371
25694 " struct guestfs_xattr_list *\n"
25695 " guestfs_lxattrlist (guestfs_h *g,\n"
25696 " const char *path,\n"
25697 " char *const *names);\n"
25702 #: ../src/guestfs-actions.pod:4390
25704 "This call is intended for programs that want to efficiently list a directory "
25705 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
25706 "a similarly efficient call for getting standard stats. Very long directory "
25707 "listings might cause the protocol message size to be exceeded, causing this "
25708 "call to fail. The caller must split up such requests into smaller groups of "
25713 #: ../src/guestfs-actions.pod:4404
25714 msgid "guestfs_mkdir"
25718 #: ../src/guestfs-actions.pod:4406
25722 " guestfs_mkdir (guestfs_h *g,\n"
25723 " const char *path);\n"
25728 #: ../src/guestfs-actions.pod:4416
25729 msgid "guestfs_mkdir_mode"
25733 #: ../src/guestfs-actions.pod:4418
25737 " guestfs_mkdir_mode (guestfs_h *g,\n"
25738 " const char *path,\n"
25744 #: ../src/guestfs-actions.pod:4430
25745 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
25749 #: ../src/guestfs-actions.pod:4436
25750 msgid "guestfs_mkdir_p"
25754 #: ../src/guestfs-actions.pod:4438
25758 " guestfs_mkdir_p (guestfs_h *g,\n"
25759 " const char *path);\n"
25764 #: ../src/guestfs-actions.pod:4449
25765 msgid "guestfs_mkdtemp"
25769 #: ../src/guestfs-actions.pod:4451
25773 " guestfs_mkdtemp (guestfs_h *g,\n"
25774 " const char *template);\n"
25779 #: ../src/guestfs-actions.pod:4479
25780 msgid "guestfs_mke2fs_J"
25784 #: ../src/guestfs-actions.pod:4481
25788 " guestfs_mke2fs_J (guestfs_h *g,\n"
25789 " const char *fstype,\n"
25790 " int blocksize,\n"
25791 " const char *device,\n"
25792 " const char *journal);\n"
25797 #: ../src/guestfs-actions.pod:4494
25798 msgid "See also C<guestfs_mke2journal>."
25802 #: ../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
25803 msgid "(Added in 1.0.68)"
25807 #: ../src/guestfs-actions.pod:4500
25808 msgid "guestfs_mke2fs_JL"
25812 #: ../src/guestfs-actions.pod:4502
25816 " guestfs_mke2fs_JL (guestfs_h *g,\n"
25817 " const char *fstype,\n"
25818 " int blocksize,\n"
25819 " const char *device,\n"
25820 " const char *label);\n"
25825 #: ../src/guestfs-actions.pod:4512
25826 msgid "See also C<guestfs_mke2journal_L>."
25830 #: ../src/guestfs-actions.pod:4518
25831 msgid "guestfs_mke2fs_JU"
25835 #: ../src/guestfs-actions.pod:4520
25839 " guestfs_mke2fs_JU (guestfs_h *g,\n"
25840 " const char *fstype,\n"
25841 " int blocksize,\n"
25842 " const char *device,\n"
25843 " const char *uuid);\n"
25848 #: ../src/guestfs-actions.pod:4530
25849 msgid "See also C<guestfs_mke2journal_U>."
25853 #: ../src/guestfs-actions.pod:4536
25854 msgid "guestfs_mke2journal"
25858 #: ../src/guestfs-actions.pod:4538
25862 " guestfs_mke2journal (guestfs_h *g,\n"
25863 " int blocksize,\n"
25864 " const char *device);\n"
25869 #: ../src/guestfs-actions.pod:4552
25870 msgid "guestfs_mke2journal_L"
25874 #: ../src/guestfs-actions.pod:4554
25878 " guestfs_mke2journal_L (guestfs_h *g,\n"
25879 " int blocksize,\n"
25880 " const char *label,\n"
25881 " const char *device);\n"
25886 #: ../src/guestfs-actions.pod:4566
25887 msgid "guestfs_mke2journal_U"
25891 #: ../src/guestfs-actions.pod:4568
25895 " guestfs_mke2journal_U (guestfs_h *g,\n"
25896 " int blocksize,\n"
25897 " const char *uuid,\n"
25898 " const char *device);\n"
25903 #: ../src/guestfs-actions.pod:4580
25904 msgid "guestfs_mkfifo"
25908 #: ../src/guestfs-actions.pod:4582
25912 " guestfs_mkfifo (guestfs_h *g,\n"
25914 " const char *path);\n"
25919 #: ../src/guestfs-actions.pod:4587
25921 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25922 "is just a convenient wrapper around C<guestfs_mknod>."
25926 #: ../src/guestfs-actions.pod:4597
25927 msgid "guestfs_mkfs"
25931 #: ../src/guestfs-actions.pod:4599
25935 " guestfs_mkfs (guestfs_h *g,\n"
25936 " const char *fstype,\n"
25937 " const char *device);\n"
25942 #: ../src/guestfs-actions.pod:4612
25943 msgid "guestfs_mkfs_b"
25947 #: ../src/guestfs-actions.pod:4614
25951 " guestfs_mkfs_b (guestfs_h *g,\n"
25952 " const char *fstype,\n"
25953 " int blocksize,\n"
25954 " const char *device);\n"
25959 #: ../src/guestfs-actions.pod:4620
25961 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
25962 "block size of the resulting filesystem. Supported block sizes depend on the "
25963 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25967 #: ../src/guestfs-actions.pod:4630
25969 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
25974 #: ../src/guestfs-actions.pod:4639
25975 msgid "guestfs_mkfs_opts"
25979 #: ../src/guestfs-actions.pod:4641
25983 " guestfs_mkfs_opts (guestfs_h *g,\n"
25984 " const char *fstype,\n"
25985 " const char *device,\n"
25991 #: ../src/guestfs-actions.pod:4652
25994 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
25995 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
25996 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
25997 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26002 #: ../src/guestfs-actions.pod:4700
26003 msgid "(Added in 1.7.19)"
26007 #: ../src/guestfs-actions.pod:4702
26008 msgid "guestfs_mkfs_opts_va"
26012 #: ../src/guestfs-actions.pod:4704
26016 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26017 " const char *fstype,\n"
26018 " const char *device,\n"
26019 " va_list args);\n"
26024 #: ../src/guestfs-actions.pod:4710
26025 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26029 #: ../src/guestfs-actions.pod:4714
26030 msgid "guestfs_mkfs_opts_argv"
26034 #: ../src/guestfs-actions.pod:4716
26038 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26039 " const char *fstype,\n"
26040 " const char *device,\n"
26041 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26046 #: ../src/guestfs-actions.pod:4722
26047 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26051 #: ../src/guestfs-actions.pod:4726
26052 msgid "guestfs_mkmountpoint"
26056 #: ../src/guestfs-actions.pod:4728
26060 " guestfs_mkmountpoint (guestfs_h *g,\n"
26061 " const char *exemptpath);\n"
26066 #: ../src/guestfs-actions.pod:4732
26068 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26069 "that can be used to create extra mountpoints before mounting the first "
26074 #: ../src/guestfs-actions.pod:4756
26076 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26077 "may get unexpected errors if you try to mix these calls. It is safest to "
26078 "manually unmount filesystems and remove mountpoints after use."
26082 #: ../src/guestfs-actions.pod:4760
26084 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26085 "first, so for this to work for manual mountpoints, you must ensure that the "
26086 "innermost mountpoints have the longest pathnames, as in the example code "
26091 #: ../src/guestfs-actions.pod:4767
26093 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26094 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26095 "can also trigger these issues."
26099 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:6099
26100 msgid "(Added in 1.0.62)"
26104 #: ../src/guestfs-actions.pod:4775
26105 msgid "guestfs_mknod"
26109 #: ../src/guestfs-actions.pod:4777
26113 " guestfs_mknod (guestfs_h *g,\n"
26117 " const char *path);\n"
26122 #: ../src/guestfs-actions.pod:4792
26124 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26125 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26126 "regular file). These constants are available in the standard Linux header "
26127 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26128 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26129 "the appropriate constant for you."
26133 #: ../src/guestfs-actions.pod:4806
26134 msgid "guestfs_mknod_b"
26138 #: ../src/guestfs-actions.pod:4808
26142 " guestfs_mknod_b (guestfs_h *g,\n"
26146 " const char *path);\n"
26151 #: ../src/guestfs-actions.pod:4815
26153 "This call creates a block device node called C<path> with mode C<mode> and "
26154 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26155 "wrapper around C<guestfs_mknod>."
26159 #: ../src/guestfs-actions.pod:4825
26160 msgid "guestfs_mknod_c"
26164 #: ../src/guestfs-actions.pod:4827
26168 " guestfs_mknod_c (guestfs_h *g,\n"
26172 " const char *path);\n"
26177 #: ../src/guestfs-actions.pod:4834
26179 "This call creates a char device node called C<path> with mode C<mode> and "
26180 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26181 "wrapper around C<guestfs_mknod>."
26185 #: ../src/guestfs-actions.pod:4844
26186 msgid "guestfs_mkswap"
26190 #: ../src/guestfs-actions.pod:4846
26194 " guestfs_mkswap (guestfs_h *g,\n"
26195 " const char *device);\n"
26200 #: ../src/guestfs-actions.pod:4856
26201 msgid "guestfs_mkswap_L"
26205 #: ../src/guestfs-actions.pod:4858
26209 " guestfs_mkswap_L (guestfs_h *g,\n"
26210 " const char *label,\n"
26211 " const char *device);\n"
26216 #: ../src/guestfs-actions.pod:4873
26217 msgid "guestfs_mkswap_U"
26221 #: ../src/guestfs-actions.pod:4875
26225 " guestfs_mkswap_U (guestfs_h *g,\n"
26226 " const char *uuid,\n"
26227 " const char *device);\n"
26232 #: ../src/guestfs-actions.pod:4886
26233 msgid "guestfs_mkswap_file"
26237 #: ../src/guestfs-actions.pod:4888
26241 " guestfs_mkswap_file (guestfs_h *g,\n"
26242 " const char *path);\n"
26247 #: ../src/guestfs-actions.pod:4894
26249 "This command just writes a swap file signature to an existing file. To "
26250 "create the file itself, use something like C<guestfs_fallocate>."
26254 #: ../src/guestfs-actions.pod:4901
26255 msgid "guestfs_modprobe"
26259 #: ../src/guestfs-actions.pod:4903
26263 " guestfs_modprobe (guestfs_h *g,\n"
26264 " const char *modulename);\n"
26269 #: ../src/guestfs-actions.pod:4916
26270 msgid "guestfs_mount"
26274 #: ../src/guestfs-actions.pod:4918
26278 " guestfs_mount (guestfs_h *g,\n"
26279 " const char *device,\n"
26280 " const char *mountpoint);\n"
26285 #: ../src/guestfs-actions.pod:4937
26287 "B<Important note:> When you use this call, the filesystem options C<sync> "
26288 "and C<noatime> are set implicitly. This was originally done because we "
26289 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26290 "very large negative performance impact and negligible effect on "
26291 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
26292 "in any code that needs performance, and instead use C<guestfs_mount_options> "
26293 "(use an empty string for the first parameter if you don't want any options)."
26297 #: ../src/guestfs-actions.pod:4949
26299 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
26304 #: ../src/guestfs-actions.pod:4958
26305 msgid "guestfs_mount_9p"
26309 #: ../src/guestfs-actions.pod:4960
26313 " guestfs_mount_9p (guestfs_h *g,\n"
26314 " const char *mounttag,\n"
26315 " const char *mountpoint,\n"
26321 #: ../src/guestfs-actions.pod:4971
26324 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26329 #: ../src/guestfs-actions.pod:4984
26330 msgid "guestfs_mount_9p_va"
26334 #: ../src/guestfs-actions.pod:4986
26338 " guestfs_mount_9p_va (guestfs_h *g,\n"
26339 " const char *mounttag,\n"
26340 " const char *mountpoint,\n"
26341 " va_list args);\n"
26346 #: ../src/guestfs-actions.pod:4992
26347 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26351 #: ../src/guestfs-actions.pod:4996
26352 msgid "guestfs_mount_9p_argv"
26356 #: ../src/guestfs-actions.pod:4998
26360 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26361 " const char *mounttag,\n"
26362 " const char *mountpoint,\n"
26363 " const struct guestfs_mount_9p_argv *optargs);\n"
26368 #: ../src/guestfs-actions.pod:5004
26369 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26373 #: ../src/guestfs-actions.pod:5008
26374 msgid "guestfs_mount_loop"
26378 #: ../src/guestfs-actions.pod:5010
26382 " guestfs_mount_loop (guestfs_h *g,\n"
26383 " const char *file,\n"
26384 " const char *mountpoint);\n"
26389 #: ../src/guestfs-actions.pod:5023
26390 msgid "guestfs_mount_options"
26394 #: ../src/guestfs-actions.pod:5025
26398 " guestfs_mount_options (guestfs_h *g,\n"
26399 " const char *options,\n"
26400 " const char *device,\n"
26401 " const char *mountpoint);\n"
26406 #: ../src/guestfs-actions.pod:5031
26408 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26409 "the mount options as for the L<mount(8)> I<-o> flag."
26413 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5055 ../src/guestfs-actions.pod:5072
26414 msgid "(Added in 1.0.10)"
26418 #: ../src/guestfs-actions.pod:5043
26419 msgid "guestfs_mount_ro"
26423 #: ../src/guestfs-actions.pod:5045
26427 " guestfs_mount_ro (guestfs_h *g,\n"
26428 " const char *device,\n"
26429 " const char *mountpoint);\n"
26434 #: ../src/guestfs-actions.pod:5050
26436 "This is the same as the C<guestfs_mount> command, but it mounts the "
26437 "filesystem with the read-only (I<-o ro>) flag."
26441 #: ../src/guestfs-actions.pod:5057
26442 msgid "guestfs_mount_vfs"
26446 #: ../src/guestfs-actions.pod:5059
26450 " guestfs_mount_vfs (guestfs_h *g,\n"
26451 " const char *options,\n"
26452 " const char *vfstype,\n"
26453 " const char *device,\n"
26454 " const char *mountpoint);\n"
26459 #: ../src/guestfs-actions.pod:5066
26461 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26462 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
26467 #: ../src/guestfs-actions.pod:5074
26468 msgid "guestfs_mountpoints"
26472 #: ../src/guestfs-actions.pod:5076
26476 " guestfs_mountpoints (guestfs_h *g);\n"
26481 #: ../src/guestfs-actions.pod:5079
26483 "This call is similar to C<guestfs_mounts>. That call returns a list of "
26484 "devices. This one returns a hash table (map) of device name to directory "
26485 "where the device is mounted."
26489 #: ../src/guestfs-actions.pod:5091
26490 msgid "guestfs_mounts"
26494 #: ../src/guestfs-actions.pod:5093
26498 " guestfs_mounts (guestfs_h *g);\n"
26503 #: ../src/guestfs-actions.pod:5101
26504 msgid "See also: C<guestfs_mountpoints>"
26508 #: ../src/guestfs-actions.pod:5109
26513 #: ../src/guestfs-actions.pod:5111
26517 " guestfs_mv (guestfs_h *g,\n"
26518 " const char *src,\n"
26519 " const char *dest);\n"
26524 #: ../src/guestfs-actions.pod:5123
26525 msgid "guestfs_ntfs_3g_probe"
26529 #: ../src/guestfs-actions.pod:5125
26533 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
26535 " const char *device);\n"
26540 #: ../src/guestfs-actions.pod:5144
26541 msgid "(Added in 1.0.43)"
26545 #: ../src/guestfs-actions.pod:5146
26546 msgid "guestfs_ntfsresize"
26550 #: ../src/guestfs-actions.pod:5148
26554 " guestfs_ntfsresize (guestfs_h *g,\n"
26555 " const char *device);\n"
26560 #: ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:5257
26562 "This function is deprecated. In new code, use the "
26563 "L</guestfs_ntfsresize_opts> call instead."
26567 #: ../src/guestfs-actions.pod:5176
26568 msgid "guestfs_ntfsresize_opts"
26572 #: ../src/guestfs-actions.pod:5178
26576 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
26577 " const char *device,\n"
26583 #: ../src/guestfs-actions.pod:5188
26586 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
26587 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
26592 #: ../src/guestfs-actions.pod:5208
26594 "After the resize operation, the filesystem is always marked as requiring a "
26595 "consistency check (for safety). You have to boot into Windows to perform "
26596 "this check and clear this condition. If you I<don't> set the C<force> "
26597 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
26598 "times on a single filesystem without booting into Windows between each "
26603 #: ../src/guestfs-actions.pod:5223
26604 msgid "guestfs_ntfsresize_opts_va"
26608 #: ../src/guestfs-actions.pod:5225
26612 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
26613 " const char *device,\n"
26614 " va_list args);\n"
26619 #: ../src/guestfs-actions.pod:5230
26620 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
26624 #: ../src/guestfs-actions.pod:5234
26625 msgid "guestfs_ntfsresize_opts_argv"
26629 #: ../src/guestfs-actions.pod:5236
26633 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
26634 " const char *device,\n"
26635 " const struct guestfs_ntfsresize_opts_argv "
26641 #: ../src/guestfs-actions.pod:5241
26642 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
26646 #: ../src/guestfs-actions.pod:5245
26647 msgid "guestfs_ntfsresize_size"
26651 #: ../src/guestfs-actions.pod:5247
26655 " guestfs_ntfsresize_size (guestfs_h *g,\n"
26656 " const char *device,\n"
26657 " int64_t size);\n"
26662 #: ../src/guestfs-actions.pod:5252
26664 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
26665 "to specify the new size (in bytes) explicitly."
26669 #: ../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
26670 msgid "(Added in 1.3.14)"
26674 #: ../src/guestfs-actions.pod:5266
26675 msgid "guestfs_part_add"
26679 #: ../src/guestfs-actions.pod:5268
26683 " guestfs_part_add (guestfs_h *g,\n"
26684 " const char *device,\n"
26685 " const char *prlogex,\n"
26686 " int64_t startsect,\n"
26687 " int64_t endsect);\n"
26692 #: ../src/guestfs-actions.pod:5275
26694 "This command adds a partition to C<device>. If there is no partition table "
26695 "on the device, call C<guestfs_part_init> first."
26699 #: ../src/guestfs-actions.pod:5287
26701 "Creating a partition which covers the whole disk is not so easy. Use "
26702 "C<guestfs_part_disk> to do that."
26706 #: ../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
26707 msgid "(Added in 1.0.78)"
26711 #: ../src/guestfs-actions.pod:5294
26712 msgid "guestfs_part_del"
26716 #: ../src/guestfs-actions.pod:5296
26720 " guestfs_part_del (guestfs_h *g,\n"
26721 " const char *device,\n"
26727 #: ../src/guestfs-actions.pod:5311
26728 msgid "guestfs_part_disk"
26732 #: ../src/guestfs-actions.pod:5313
26736 " guestfs_part_disk (guestfs_h *g,\n"
26737 " const char *device,\n"
26738 " const char *parttype);\n"
26743 #: ../src/guestfs-actions.pod:5318
26745 "This command is simply a combination of C<guestfs_part_init> followed by "
26746 "C<guestfs_part_add> to create a single primary partition covering the whole "
26751 #: ../src/guestfs-actions.pod:5322
26753 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26754 "possible values are described in C<guestfs_part_init>."
26758 #: ../src/guestfs-actions.pod:5332
26759 msgid "guestfs_part_get_bootable"
26763 #: ../src/guestfs-actions.pod:5334
26767 " guestfs_part_get_bootable (guestfs_h *g,\n"
26768 " const char *device,\n"
26774 #: ../src/guestfs-actions.pod:5342
26775 msgid "See also C<guestfs_part_set_bootable>."
26779 #: ../src/guestfs-actions.pod:5348
26780 msgid "guestfs_part_get_mbr_id"
26784 #: ../src/guestfs-actions.pod:5350
26788 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
26789 " const char *device,\n"
26795 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5540
26797 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26798 "undefined results for other partition table types (see "
26799 "C<guestfs_part_get_parttype>)."
26803 #: ../src/guestfs-actions.pod:5366
26804 msgid "guestfs_part_get_parttype"
26808 #: ../src/guestfs-actions.pod:5368
26812 " guestfs_part_get_parttype (guestfs_h *g,\n"
26813 " const char *device);\n"
26818 #: ../src/guestfs-actions.pod:5375
26820 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26821 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26822 "possible, although unusual. See C<guestfs_part_init> for a full list."
26826 #: ../src/guestfs-actions.pod:5385
26827 msgid "guestfs_part_init"
26831 #: ../src/guestfs-actions.pod:5387
26835 " guestfs_part_init (guestfs_h *g,\n"
26836 " const char *device,\n"
26837 " const char *parttype);\n"
26842 #: ../src/guestfs-actions.pod:5396
26844 "Initially there are no partitions. Following this, you should call "
26845 "C<guestfs_part_add> for each partition required."
26849 #: ../src/guestfs-actions.pod:5469
26850 msgid "guestfs_part_list"
26854 #: ../src/guestfs-actions.pod:5471
26857 " struct guestfs_partition_list *\n"
26858 " guestfs_part_list (guestfs_h *g,\n"
26859 " const char *device);\n"
26864 #: ../src/guestfs-actions.pod:5488
26866 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26867 "the device's sector size, see C<guestfs_blockdev_getss>."
26871 #: ../src/guestfs-actions.pod:5501
26873 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
26874 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
26879 #: ../src/guestfs-actions.pod:5507
26880 msgid "guestfs_part_set_bootable"
26884 #: ../src/guestfs-actions.pod:5509
26888 " guestfs_part_set_bootable (guestfs_h *g,\n"
26889 " const char *device,\n"
26891 " int bootable);\n"
26896 #: ../src/guestfs-actions.pod:5526
26897 msgid "guestfs_part_set_mbr_id"
26901 #: ../src/guestfs-actions.pod:5528
26905 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
26906 " const char *device,\n"
26913 #: ../src/guestfs-actions.pod:5548
26914 msgid "guestfs_part_set_name"
26918 #: ../src/guestfs-actions.pod:5550
26922 " guestfs_part_set_name (guestfs_h *g,\n"
26923 " const char *device,\n"
26925 " const char *name);\n"
26930 #: ../src/guestfs-actions.pod:5566
26931 msgid "guestfs_part_to_dev"
26935 #: ../src/guestfs-actions.pod:5568
26939 " guestfs_part_to_dev (guestfs_h *g,\n"
26940 " const char *partition);\n"
26945 #: ../src/guestfs-actions.pod:5576
26947 "The named partition must exist, for example as a string returned from "
26948 "C<guestfs_list_partitions>."
26952 #: ../src/guestfs-actions.pod:5584
26953 msgid "guestfs_ping_daemon"
26957 #: ../src/guestfs-actions.pod:5586
26961 " guestfs_ping_daemon (guestfs_h *g);\n"
26966 #: ../src/guestfs-actions.pod:5598
26967 msgid "guestfs_pread"
26971 #: ../src/guestfs-actions.pod:5600
26975 " guestfs_pread (guestfs_h *g,\n"
26976 " const char *path,\n"
26978 " int64_t offset,\n"
26979 " size_t *size_r);\n"
26984 #: ../src/guestfs-actions.pod:5613
26985 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
26989 #: ../src/guestfs-actions.pod:5624
26990 msgid "guestfs_pread_device"
26994 #: ../src/guestfs-actions.pod:5626
26998 " guestfs_pread_device (guestfs_h *g,\n"
26999 " const char *device,\n"
27001 " int64_t offset,\n"
27002 " size_t *size_r);\n"
27007 #: ../src/guestfs-actions.pod:5639
27008 msgid "See also C<guestfs_pread>."
27012 #: ../src/guestfs-actions.pod:5648
27013 msgid "(Added in 1.5.21)"
27017 #: ../src/guestfs-actions.pod:5650
27018 msgid "guestfs_pvcreate"
27022 #: ../src/guestfs-actions.pod:5652
27026 " guestfs_pvcreate (guestfs_h *g,\n"
27027 " const char *device);\n"
27032 #: ../src/guestfs-actions.pod:5664
27033 msgid "guestfs_pvremove"
27037 #: ../src/guestfs-actions.pod:5666
27041 " guestfs_pvremove (guestfs_h *g,\n"
27042 " const char *device);\n"
27047 #: ../src/guestfs-actions.pod:5681
27048 msgid "guestfs_pvresize"
27052 #: ../src/guestfs-actions.pod:5683
27056 " guestfs_pvresize (guestfs_h *g,\n"
27057 " const char *device);\n"
27062 #: ../src/guestfs-actions.pod:5694
27063 msgid "guestfs_pvresize_size"
27067 #: ../src/guestfs-actions.pod:5696
27071 " guestfs_pvresize_size (guestfs_h *g,\n"
27072 " const char *device,\n"
27073 " int64_t size);\n"
27078 #: ../src/guestfs-actions.pod:5701
27080 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27081 "specify the new size (in bytes) explicitly."
27085 #: ../src/guestfs-actions.pod:5708
27086 msgid "guestfs_pvs"
27090 #: ../src/guestfs-actions.pod:5710
27094 " guestfs_pvs (guestfs_h *g);\n"
27099 #: ../src/guestfs-actions.pod:5719
27100 msgid "See also C<guestfs_pvs_full>."
27104 #: ../src/guestfs-actions.pod:5727
27105 msgid "guestfs_pvs_full"
27109 #: ../src/guestfs-actions.pod:5729
27112 " struct guestfs_lvm_pv_list *\n"
27113 " guestfs_pvs_full (guestfs_h *g);\n"
27118 #: ../src/guestfs-actions.pod:5735
27120 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27121 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
27126 #: ../src/guestfs-actions.pod:5741
27127 msgid "guestfs_pvuuid"
27131 #: ../src/guestfs-actions.pod:5743
27135 " guestfs_pvuuid (guestfs_h *g,\n"
27136 " const char *device);\n"
27141 #: ../src/guestfs-actions.pod:5754
27142 msgid "guestfs_pwrite"
27146 #: ../src/guestfs-actions.pod:5756
27150 " guestfs_pwrite (guestfs_h *g,\n"
27151 " const char *path,\n"
27152 " const char *content,\n"
27153 " size_t content_size,\n"
27154 " int64_t offset);\n"
27159 #: ../src/guestfs-actions.pod:5772
27160 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27164 #: ../src/guestfs-actions.pod:5781
27165 msgid "guestfs_pwrite_device"
27169 #: ../src/guestfs-actions.pod:5783
27173 " guestfs_pwrite_device (guestfs_h *g,\n"
27174 " const char *device,\n"
27175 " const char *content,\n"
27176 " size_t content_size,\n"
27177 " int64_t offset);\n"
27182 #: ../src/guestfs-actions.pod:5798
27183 msgid "See also C<guestfs_pwrite>."
27187 #: ../src/guestfs-actions.pod:5805
27188 msgid "(Added in 1.5.20)"
27192 #: ../src/guestfs-actions.pod:5807
27193 msgid "guestfs_read_file"
27197 #: ../src/guestfs-actions.pod:5809
27201 " guestfs_read_file (guestfs_h *g,\n"
27202 " const char *path,\n"
27203 " size_t *size_r);\n"
27208 #: ../src/guestfs-actions.pod:5817
27210 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27211 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27212 "function is limited in the total size of file that can be handled."
27216 #: ../src/guestfs-actions.pod:5829
27217 msgid "(Added in 1.0.63)"
27221 #: ../src/guestfs-actions.pod:5831
27222 msgid "guestfs_read_lines"
27226 #: ../src/guestfs-actions.pod:5833
27230 " guestfs_read_lines (guestfs_h *g,\n"
27231 " const char *path);\n"
27236 #: ../src/guestfs-actions.pod:5842
27238 "Note that this function cannot correctly handle binary files (specifically, "
27239 "files containing C<\\0> character which is treated as end of line). For "
27240 "those you need to use the C<guestfs_read_file> function which has a more "
27241 "complex interface."
27245 #: ../src/guestfs-actions.pod:5853
27246 msgid "guestfs_readdir"
27250 #: ../src/guestfs-actions.pod:5855
27253 " struct guestfs_dirent_list *\n"
27254 " guestfs_readdir (guestfs_h *g,\n"
27255 " const char *dir);\n"
27260 #: ../src/guestfs-actions.pod:5909
27262 "This function is primarily intended for use by programs. To get a simple "
27263 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27264 "consumption, use C<guestfs_ll>."
27268 #: ../src/guestfs-actions.pod:5913
27270 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27271 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
27276 #: ../src/guestfs-actions.pod:5919
27277 msgid "guestfs_readlink"
27281 #: ../src/guestfs-actions.pod:5921
27285 " guestfs_readlink (guestfs_h *g,\n"
27286 " const char *path);\n"
27291 #: ../src/guestfs-actions.pod:5932
27292 msgid "guestfs_readlinklist"
27296 #: ../src/guestfs-actions.pod:5934
27300 " guestfs_readlinklist (guestfs_h *g,\n"
27301 " const char *path,\n"
27302 " char *const *names);\n"
27307 #: ../src/guestfs-actions.pod:5967
27308 msgid "guestfs_realpath"
27312 #: ../src/guestfs-actions.pod:5969
27316 " guestfs_realpath (guestfs_h *g,\n"
27317 " const char *path);\n"
27322 #: ../src/guestfs-actions.pod:5981
27323 msgid "guestfs_removexattr"
27327 #: ../src/guestfs-actions.pod:5983
27331 " guestfs_removexattr (guestfs_h *g,\n"
27332 " const char *xattr,\n"
27333 " const char *path);\n"
27338 #: ../src/guestfs-actions.pod:5991
27339 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27343 #: ../src/guestfs-actions.pod:5997
27344 msgid "guestfs_resize2fs"
27348 #: ../src/guestfs-actions.pod:5999
27352 " guestfs_resize2fs (guestfs_h *g,\n"
27353 " const char *device);\n"
27358 #: ../src/guestfs-actions.pod:6006
27360 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27361 "C<device> before calling this command. For unknown reasons C<resize2fs> "
27362 "sometimes gives an error about this and sometimes not. In any case, it is "
27363 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27367 #: ../src/guestfs-actions.pod:6016
27368 msgid "guestfs_resize2fs_M"
27372 #: ../src/guestfs-actions.pod:6018
27376 " guestfs_resize2fs_M (guestfs_h *g,\n"
27377 " const char *device);\n"
27382 #: ../src/guestfs-actions.pod:6022
27384 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
27385 "resized to its minimum size. This works like the I<-M> option to the "
27386 "C<resize2fs> command."
27390 #: ../src/guestfs-actions.pod:6026
27392 "To get the resulting size of the filesystem you should call "
27393 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
27394 "These two numbers, multiplied together, give the resulting size of the "
27395 "minimal filesystem in bytes."
27399 #: ../src/guestfs-actions.pod:6035
27400 msgid "guestfs_resize2fs_size"
27404 #: ../src/guestfs-actions.pod:6037
27408 " guestfs_resize2fs_size (guestfs_h *g,\n"
27409 " const char *device,\n"
27410 " int64_t size);\n"
27415 #: ../src/guestfs-actions.pod:6042
27417 "This command is the same as C<guestfs_resize2fs> except that it allows you "
27418 "to specify the new size (in bytes) explicitly."
27422 #: ../src/guestfs-actions.pod:6049
27427 #: ../src/guestfs-actions.pod:6051
27431 " guestfs_rm (guestfs_h *g,\n"
27432 " const char *path);\n"
27437 #: ../src/guestfs-actions.pod:6061
27438 msgid "guestfs_rm_rf"
27442 #: ../src/guestfs-actions.pod:6063
27446 " guestfs_rm_rf (guestfs_h *g,\n"
27447 " const char *path);\n"
27452 #: ../src/guestfs-actions.pod:6075
27453 msgid "guestfs_rmdir"
27457 #: ../src/guestfs-actions.pod:6077
27461 " guestfs_rmdir (guestfs_h *g,\n"
27462 " const char *path);\n"
27467 #: ../src/guestfs-actions.pod:6087
27468 msgid "guestfs_rmmountpoint"
27472 #: ../src/guestfs-actions.pod:6089
27476 " guestfs_rmmountpoint (guestfs_h *g,\n"
27477 " const char *exemptpath);\n"
27482 #: ../src/guestfs-actions.pod:6093
27484 "This calls removes a mountpoint that was previously created with "
27485 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
27489 #: ../src/guestfs-actions.pod:6101
27490 msgid "guestfs_scrub_device"
27494 #: ../src/guestfs-actions.pod:6103
27498 " guestfs_scrub_device (guestfs_h *g,\n"
27499 " const char *device);\n"
27504 #: ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6136 ../src/guestfs-actions.pod:6155
27505 msgid "(Added in 1.0.52)"
27509 #: ../src/guestfs-actions.pod:6120
27510 msgid "guestfs_scrub_file"
27514 #: ../src/guestfs-actions.pod:6122
27518 " guestfs_scrub_file (guestfs_h *g,\n"
27519 " const char *file);\n"
27524 #: ../src/guestfs-actions.pod:6138
27525 msgid "guestfs_scrub_freespace"
27529 #: ../src/guestfs-actions.pod:6140
27533 " guestfs_scrub_freespace (guestfs_h *g,\n"
27534 " const char *dir);\n"
27539 #: ../src/guestfs-actions.pod:6144
27541 "This command creates the directory C<dir> and then fills it with files until "
27542 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
27543 "and deletes them. The intention is to scrub any free space on the partition "
27544 "containing C<dir>."
27548 #: ../src/guestfs-actions.pod:6157
27549 msgid "guestfs_set_append"
27553 #: ../src/guestfs-actions.pod:6159
27557 " guestfs_set_append (guestfs_h *g,\n"
27558 " const char *append);\n"
27563 #: ../src/guestfs-actions.pod:6176
27564 msgid "guestfs_set_attach_method"
27568 #: ../src/guestfs-actions.pod:6178
27572 " guestfs_set_attach_method (guestfs_h *g,\n"
27573 " const char *attachmethod);\n"
27578 #: ../src/guestfs-actions.pod:6206
27579 msgid "guestfs_set_autosync"
27583 #: ../src/guestfs-actions.pod:6208
27587 " guestfs_set_autosync (guestfs_h *g,\n"
27588 " int autosync);\n"
27593 #: ../src/guestfs-actions.pod:6224
27594 msgid "guestfs_set_direct"
27598 #: ../src/guestfs-actions.pod:6226
27602 " guestfs_set_direct (guestfs_h *g,\n"
27608 #: ../src/guestfs-actions.pod:6234
27610 "One consequence of this is that log messages aren't caught by the library "
27611 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
27616 #: ../src/guestfs-actions.pod:6247
27617 msgid "guestfs_set_e2label"
27621 #: ../src/guestfs-actions.pod:6249
27625 " guestfs_set_e2label (guestfs_h *g,\n"
27626 " const char *device,\n"
27627 " const char *label);\n"
27632 #: ../src/guestfs-actions.pod:6258
27634 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
27635 "the existing label on a filesystem."
27639 #: ../src/guestfs-actions.pod:6265
27640 msgid "guestfs_set_e2uuid"
27644 #: ../src/guestfs-actions.pod:6267
27648 " guestfs_set_e2uuid (guestfs_h *g,\n"
27649 " const char *device,\n"
27650 " const char *uuid);\n"
27655 #: ../src/guestfs-actions.pod:6277
27657 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
27658 "the existing UUID of a filesystem."
27662 #: ../src/guestfs-actions.pod:6284
27663 msgid "guestfs_set_memsize"
27667 #: ../src/guestfs-actions.pod:6286
27671 " guestfs_set_memsize (guestfs_h *g,\n"
27677 #: ../src/guestfs-actions.pod:6290
27679 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27680 "This only has any effect if called before C<guestfs_launch>."
27684 #: ../src/guestfs-actions.pod:6305
27685 msgid "guestfs_set_network"
27689 #: ../src/guestfs-actions.pod:6307
27693 " guestfs_set_network (guestfs_h *g,\n"
27699 #: ../src/guestfs-actions.pod:6317
27701 "You must call this before calling C<guestfs_launch>, otherwise it has no "
27706 #: ../src/guestfs-actions.pod:6324
27707 msgid "guestfs_set_path"
27711 #: ../src/guestfs-actions.pod:6326
27715 " guestfs_set_path (guestfs_h *g,\n"
27716 " const char *searchpath);\n"
27721 #: ../src/guestfs-actions.pod:6341
27722 msgid "guestfs_set_pgroup"
27726 #: ../src/guestfs-actions.pod:6343
27730 " guestfs_set_pgroup (guestfs_h *g,\n"
27736 #: ../src/guestfs-actions.pod:6360
27737 msgid "guestfs_set_qemu"
27741 #: ../src/guestfs-actions.pod:6362
27745 " guestfs_set_qemu (guestfs_h *g,\n"
27746 " const char *qemu);\n"
27751 #: ../src/guestfs-actions.pod:6388
27752 msgid "guestfs_set_recovery_proc"
27756 #: ../src/guestfs-actions.pod:6390
27760 " guestfs_set_recovery_proc (guestfs_h *g,\n"
27761 " int recoveryproc);\n"
27766 #: ../src/guestfs-actions.pod:6394
27768 "If this is called with the parameter C<false> then C<guestfs_launch> does "
27769 "not create a recovery process. The purpose of the recovery process is to "
27770 "stop runaway qemu processes in the case where the main program aborts "
27775 #: ../src/guestfs-actions.pod:6399
27777 "This only has any effect if called before C<guestfs_launch>, and the default "
27782 #: ../src/guestfs-actions.pod:6412
27783 msgid "guestfs_set_selinux"
27787 #: ../src/guestfs-actions.pod:6414
27791 " guestfs_set_selinux (guestfs_h *g,\n"
27797 #: ../src/guestfs-actions.pod:6431
27798 msgid "guestfs_set_trace"
27802 #: ../src/guestfs-actions.pod:6433
27806 " guestfs_set_trace (guestfs_h *g,\n"
27812 #: ../src/guestfs-actions.pod:6447
27814 "Trace messages are normally sent to C<stderr>, unless you register a "
27815 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27819 #: ../src/guestfs-actions.pod:6455
27820 msgid "guestfs_set_verbose"
27824 #: ../src/guestfs-actions.pod:6457
27828 " guestfs_set_verbose (guestfs_h *g,\n"
27834 #: ../src/guestfs-actions.pod:6466
27836 "Verbose messages are normally sent to C<stderr>, unless you register a "
27837 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27841 #: ../src/guestfs-actions.pod:6474
27842 msgid "guestfs_setcon"
27846 #: ../src/guestfs-actions.pod:6476
27850 " guestfs_setcon (guestfs_h *g,\n"
27851 " const char *context);\n"
27856 #: ../src/guestfs-actions.pod:6489
27857 msgid "guestfs_setxattr"
27861 #: ../src/guestfs-actions.pod:6491
27865 " guestfs_setxattr (guestfs_h *g,\n"
27866 " const char *xattr,\n"
27867 " const char *val,\n"
27869 " const char *path);\n"
27874 #: ../src/guestfs-actions.pod:6502
27875 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
27879 #: ../src/guestfs-actions.pod:6508
27880 msgid "guestfs_sfdisk"
27884 #: ../src/guestfs-actions.pod:6510
27888 " guestfs_sfdisk (guestfs_h *g,\n"
27889 " const char *device,\n"
27893 " char *const *lines);\n"
27898 #: ../src/guestfs-actions.pod:6538
27899 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
27903 #: ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6576 ../src/guestfs-actions.pod:6609
27905 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
27910 #: ../src/guestfs-actions.pod:6555
27911 msgid "guestfs_sfdiskM"
27915 #: ../src/guestfs-actions.pod:6557
27919 " guestfs_sfdiskM (guestfs_h *g,\n"
27920 " const char *device,\n"
27921 " char *const *lines);\n"
27926 #: ../src/guestfs-actions.pod:6562
27928 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
27929 "partition sizes are specified in megabytes only (rounded to the nearest "
27930 "cylinder) and you don't need to specify the cyls, heads and sectors "
27931 "parameters which were rarely if ever used anyway."
27935 #: ../src/guestfs-actions.pod:6568
27937 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
27938 "C<guestfs_part_disk>"
27942 #: ../src/guestfs-actions.pod:6585
27943 msgid "guestfs_sfdisk_N"
27947 #: ../src/guestfs-actions.pod:6587
27951 " guestfs_sfdisk_N (guestfs_h *g,\n"
27952 " const char *device,\n"
27957 " const char *line);\n"
27962 #: ../src/guestfs-actions.pod:6599
27964 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
27965 "for the cyls/heads/sectors parameters."
27969 #: ../src/guestfs-actions.pod:6602
27970 msgid "See also: C<guestfs_part_add>"
27974 #: ../src/guestfs-actions.pod:6618
27975 msgid "guestfs_sfdisk_disk_geometry"
27979 #: ../src/guestfs-actions.pod:6620
27983 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
27984 " const char *device);\n"
27989 #: ../src/guestfs-actions.pod:6624
27991 "This displays the disk geometry of C<device> read from the partition table. "
27992 "Especially in the case where the underlying block device has been resized, "
27993 "this can be different from the kernel's idea of the geometry (see "
27994 "C<guestfs_sfdisk_kernel_geometry>)."
27998 #: ../src/guestfs-actions.pod:6637
27999 msgid "guestfs_sfdisk_kernel_geometry"
28003 #: ../src/guestfs-actions.pod:6639
28007 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28008 " const char *device);\n"
28013 #: ../src/guestfs-actions.pod:6653
28014 msgid "guestfs_sfdisk_l"
28018 #: ../src/guestfs-actions.pod:6655
28022 " guestfs_sfdisk_l (guestfs_h *g,\n"
28023 " const char *device);\n"
28028 #: ../src/guestfs-actions.pod:6663
28029 msgid "See also: C<guestfs_part_list>"
28033 #: ../src/guestfs-actions.pod:6668
28035 "This function is deprecated. In new code, use the L</guestfs_part_list> "
28040 #: ../src/guestfs-actions.pod:6677
28045 #: ../src/guestfs-actions.pod:6679
28049 " guestfs_sh (guestfs_h *g,\n"
28050 " const char *command);\n"
28055 #: ../src/guestfs-actions.pod:6686
28056 msgid "This is like C<guestfs_command>, but passes the command to:"
28060 #: ../src/guestfs-actions.pod:6694
28061 msgid "All the provisos about C<guestfs_command> apply to this call."
28065 #: ../src/guestfs-actions.pod:6701
28066 msgid "guestfs_sh_lines"
28070 #: ../src/guestfs-actions.pod:6703
28074 " guestfs_sh_lines (guestfs_h *g,\n"
28075 " const char *command);\n"
28080 #: ../src/guestfs-actions.pod:6707
28082 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28087 #: ../src/guestfs-actions.pod:6710
28088 msgid "See also: C<guestfs_command_lines>"
28092 #: ../src/guestfs-actions.pod:6718
28093 msgid "guestfs_sleep"
28097 #: ../src/guestfs-actions.pod:6720
28101 " guestfs_sleep (guestfs_h *g,\n"
28107 #: ../src/guestfs-actions.pod:6728
28108 msgid "(Added in 1.0.41)"
28112 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-structs.pod:109
28113 msgid "guestfs_stat"
28117 #: ../src/guestfs-actions.pod:6732
28120 " struct guestfs_stat *\n"
28121 " guestfs_stat (guestfs_h *g,\n"
28122 " const char *path);\n"
28127 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-structs.pod:135
28128 msgid "guestfs_statvfs"
28132 #: ../src/guestfs-actions.pod:6748
28135 " struct guestfs_statvfs *\n"
28136 " guestfs_statvfs (guestfs_h *g,\n"
28137 " const char *path);\n"
28142 #: ../src/guestfs-actions.pod:6758
28144 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28145 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28149 #: ../src/guestfs-actions.pod:6764
28150 msgid "guestfs_strings"
28154 #: ../src/guestfs-actions.pod:6766
28158 " guestfs_strings (guestfs_h *g,\n"
28159 " const char *path);\n"
28164 #: ../src/guestfs-actions.pod:6782
28165 msgid "guestfs_strings_e"
28169 #: ../src/guestfs-actions.pod:6784
28173 " guestfs_strings_e (guestfs_h *g,\n"
28174 " const char *encoding,\n"
28175 " const char *path);\n"
28180 #: ../src/guestfs-actions.pod:6789
28182 "This is like the C<guestfs_strings> command, but allows you to specify the "
28183 "encoding of strings that are looked for in the source file C<path>."
28187 #: ../src/guestfs-actions.pod:6799
28189 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28190 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28194 #: ../src/guestfs-actions.pod:6837
28195 msgid "guestfs_swapoff_device"
28199 #: ../src/guestfs-actions.pod:6839
28203 " guestfs_swapoff_device (guestfs_h *g,\n"
28204 " const char *device);\n"
28209 #: ../src/guestfs-actions.pod:6843
28211 "This command disables the libguestfs appliance swap device or partition "
28212 "named C<device>. See C<guestfs_swapon_device>."
28216 #: ../src/guestfs-actions.pod:6851
28217 msgid "guestfs_swapoff_file"
28221 #: ../src/guestfs-actions.pod:6853
28225 " guestfs_swapoff_file (guestfs_h *g,\n"
28226 " const char *file);\n"
28231 #: ../src/guestfs-actions.pod:6863
28232 msgid "guestfs_swapoff_label"
28236 #: ../src/guestfs-actions.pod:6865
28240 " guestfs_swapoff_label (guestfs_h *g,\n"
28241 " const char *label);\n"
28246 #: ../src/guestfs-actions.pod:6876
28247 msgid "guestfs_swapoff_uuid"
28251 #: ../src/guestfs-actions.pod:6878
28255 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28256 " const char *uuid);\n"
28261 #: ../src/guestfs-actions.pod:6889
28262 msgid "guestfs_swapon_device"
28266 #: ../src/guestfs-actions.pod:6891
28270 " guestfs_swapon_device (guestfs_h *g,\n"
28271 " const char *device);\n"
28276 #: ../src/guestfs-actions.pod:6895
28278 "This command enables the libguestfs appliance to use the swap device or "
28279 "partition named C<device>. The increased memory is made available for all "
28280 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28284 #: ../src/guestfs-actions.pod:6911
28285 msgid "guestfs_swapon_file"
28289 #: ../src/guestfs-actions.pod:6913
28293 " guestfs_swapon_file (guestfs_h *g,\n"
28294 " const char *file);\n"
28299 #: ../src/guestfs-actions.pod:6917
28301 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28306 #: ../src/guestfs-actions.pod:6924
28307 msgid "guestfs_swapon_label"
28311 #: ../src/guestfs-actions.pod:6926
28315 " guestfs_swapon_label (guestfs_h *g,\n"
28316 " const char *label);\n"
28321 #: ../src/guestfs-actions.pod:6930
28323 "This command enables swap to a labeled swap partition. See "
28324 "C<guestfs_swapon_device> for other notes."
28328 #: ../src/guestfs-actions.pod:6937
28329 msgid "guestfs_swapon_uuid"
28333 #: ../src/guestfs-actions.pod:6939
28337 " guestfs_swapon_uuid (guestfs_h *g,\n"
28338 " const char *uuid);\n"
28343 #: ../src/guestfs-actions.pod:6943
28345 "This command enables swap to a swap partition with the given UUID. See "
28346 "C<guestfs_swapon_device> for other notes."
28350 #: ../src/guestfs-actions.pod:6950
28351 msgid "guestfs_sync"
28355 #: ../src/guestfs-actions.pod:6952
28359 " guestfs_sync (guestfs_h *g);\n"
28364 #: ../src/guestfs-actions.pod:6965
28365 msgid "guestfs_tail"
28369 #: ../src/guestfs-actions.pod:6967
28373 " guestfs_tail (guestfs_h *g,\n"
28374 " const char *path);\n"
28379 #: ../src/guestfs-actions.pod:6983
28380 msgid "guestfs_tail_n"
28384 #: ../src/guestfs-actions.pod:6985
28388 " guestfs_tail_n (guestfs_h *g,\n"
28390 " const char *path);\n"
28395 #: ../src/guestfs-actions.pod:7007
28396 msgid "guestfs_tar_in"
28400 #: ../src/guestfs-actions.pod:7009
28404 " guestfs_tar_in (guestfs_h *g,\n"
28405 " const char *tarfile,\n"
28406 " const char *directory);\n"
28411 #: ../src/guestfs-actions.pod:7017
28412 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
28416 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7039 ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7071
28417 msgid "(Added in 1.0.3)"
28421 #: ../src/guestfs-actions.pod:7024
28422 msgid "guestfs_tar_out"
28426 #: ../src/guestfs-actions.pod:7026
28430 " guestfs_tar_out (guestfs_h *g,\n"
28431 " const char *directory,\n"
28432 " const char *tarfile);\n"
28437 #: ../src/guestfs-actions.pod:7034
28439 "To download a compressed tarball, use C<guestfs_tgz_out> or "
28440 "C<guestfs_txz_out>."
28444 #: ../src/guestfs-actions.pod:7041
28445 msgid "guestfs_tgz_in"
28449 #: ../src/guestfs-actions.pod:7043
28453 " guestfs_tgz_in (guestfs_h *g,\n"
28454 " const char *tarball,\n"
28455 " const char *directory);\n"
28460 #: ../src/guestfs-actions.pod:7051
28461 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
28465 #: ../src/guestfs-actions.pod:7057
28466 msgid "guestfs_tgz_out"
28470 #: ../src/guestfs-actions.pod:7059
28474 " guestfs_tgz_out (guestfs_h *g,\n"
28475 " const char *directory,\n"
28476 " const char *tarball);\n"
28481 #: ../src/guestfs-actions.pod:7067
28482 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
28486 #: ../src/guestfs-actions.pod:7073
28487 msgid "guestfs_touch"
28491 #: ../src/guestfs-actions.pod:7075
28495 " guestfs_touch (guestfs_h *g,\n"
28496 " const char *path);\n"
28501 #: ../src/guestfs-actions.pod:7090
28502 msgid "guestfs_truncate"
28506 #: ../src/guestfs-actions.pod:7092
28510 " guestfs_truncate (guestfs_h *g,\n"
28511 " const char *path);\n"
28516 #: ../src/guestfs-actions.pod:7103
28517 msgid "guestfs_truncate_size"
28521 #: ../src/guestfs-actions.pod:7105
28525 " guestfs_truncate_size (guestfs_h *g,\n"
28526 " const char *path,\n"
28527 " int64_t size);\n"
28532 #: ../src/guestfs-actions.pod:7113
28534 "If the current file size is less than C<size> then the file is extended to "
28535 "the required size with zero bytes. This creates a sparse file (ie. disk "
28536 "blocks are not allocated for the file until you write to it). To create a "
28537 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
28541 #: ../src/guestfs-actions.pod:7123
28542 msgid "guestfs_tune2fs_l"
28546 #: ../src/guestfs-actions.pod:7125
28550 " guestfs_tune2fs_l (guestfs_h *g,\n"
28551 " const char *device);\n"
28556 #: ../src/guestfs-actions.pod:7145
28557 msgid "guestfs_txz_in"
28561 #: ../src/guestfs-actions.pod:7147
28565 " guestfs_txz_in (guestfs_h *g,\n"
28566 " const char *tarball,\n"
28567 " const char *directory);\n"
28572 #: ../src/guestfs-actions.pod:7159
28573 msgid "guestfs_txz_out"
28577 #: ../src/guestfs-actions.pod:7161
28581 " guestfs_txz_out (guestfs_h *g,\n"
28582 " const char *directory,\n"
28583 " const char *tarball);\n"
28588 #: ../src/guestfs-actions.pod:7173
28589 msgid "guestfs_umask"
28593 #: ../src/guestfs-actions.pod:7175
28597 " guestfs_umask (guestfs_h *g,\n"
28603 #: ../src/guestfs-actions.pod:7191
28605 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
28606 "C<guestfs_mkdir>."
28610 #: ../src/guestfs-actions.pod:7200
28611 msgid "guestfs_umount"
28615 #: ../src/guestfs-actions.pod:7202
28619 " guestfs_umount (guestfs_h *g,\n"
28620 " const char *pathordevice);\n"
28625 #: ../src/guestfs-actions.pod:7214
28626 msgid "guestfs_umount_all"
28630 #: ../src/guestfs-actions.pod:7216
28634 " guestfs_umount_all (guestfs_h *g);\n"
28639 #: ../src/guestfs-actions.pod:7227
28640 msgid "guestfs_upload"
28644 #: ../src/guestfs-actions.pod:7229
28648 " guestfs_upload (guestfs_h *g,\n"
28649 " const char *filename,\n"
28650 " const char *remotefilename);\n"
28655 #: ../src/guestfs-actions.pod:7239
28656 msgid "See also C<guestfs_download>."
28660 #: ../src/guestfs-actions.pod:7250
28661 msgid "guestfs_upload_offset"
28665 #: ../src/guestfs-actions.pod:7252
28669 " guestfs_upload_offset (guestfs_h *g,\n"
28670 " const char *filename,\n"
28671 " const char *remotefilename,\n"
28672 " int64_t offset);\n"
28677 #: ../src/guestfs-actions.pod:7268
28679 "Note that there is no limit on the amount of data that can be uploaded with "
28680 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
28681 "full amount unless an error occurs."
28685 #: ../src/guestfs-actions.pod:7273
28686 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
28690 #: ../src/guestfs-actions.pod:7284
28691 msgid "guestfs_utimens"
28695 #: ../src/guestfs-actions.pod:7286
28699 " guestfs_utimens (guestfs_h *g,\n"
28700 " const char *path,\n"
28701 " int64_t atsecs,\n"
28702 " int64_t atnsecs,\n"
28703 " int64_t mtsecs,\n"
28704 " int64_t mtnsecs);\n"
28709 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-structs.pod:175
28710 msgid "guestfs_version"
28714 #: ../src/guestfs-actions.pod:7317
28717 " struct guestfs_version *\n"
28718 " guestfs_version (guestfs_h *g);\n"
28723 #: ../src/guestfs-actions.pod:7345
28725 "I<Note:> Don't use this call to test for availability of features. In "
28726 "enterprise distributions we backport features from later versions into "
28727 "earlier versions, making this an unreliable way to test for features. Use "
28728 "C<guestfs_available> instead."
28732 #: ../src/guestfs-actions.pod:7351
28734 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
28735 "error. I<The caller must call C<guestfs_free_version> after use>."
28739 #: ../src/guestfs-actions.pod:7355
28740 msgid "(Added in 1.0.58)"
28744 #: ../src/guestfs-actions.pod:7357
28745 msgid "guestfs_vfs_label"
28749 #: ../src/guestfs-actions.pod:7359
28753 " guestfs_vfs_label (guestfs_h *g,\n"
28754 " const char *device);\n"
28759 #: ../src/guestfs-actions.pod:7368
28760 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
28764 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7410
28765 msgid "(Added in 1.3.18)"
28769 #: ../src/guestfs-actions.pod:7375
28770 msgid "guestfs_vfs_type"
28774 #: ../src/guestfs-actions.pod:7377
28778 " guestfs_vfs_type (guestfs_h *g,\n"
28779 " const char *device);\n"
28784 #: ../src/guestfs-actions.pod:7394
28785 msgid "guestfs_vfs_uuid"
28789 #: ../src/guestfs-actions.pod:7396
28793 " guestfs_vfs_uuid (guestfs_h *g,\n"
28794 " const char *device);\n"
28799 #: ../src/guestfs-actions.pod:7405
28800 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
28804 #: ../src/guestfs-actions.pod:7412
28805 msgid "guestfs_vg_activate"
28809 #: ../src/guestfs-actions.pod:7414
28813 " guestfs_vg_activate (guestfs_h *g,\n"
28815 " char *const *volgroups);\n"
28820 #: ../src/guestfs-actions.pod:7431
28821 msgid "guestfs_vg_activate_all"
28825 #: ../src/guestfs-actions.pod:7433
28829 " guestfs_vg_activate_all (guestfs_h *g,\n"
28830 " int activate);\n"
28835 #: ../src/guestfs-actions.pod:7446
28836 msgid "guestfs_vgcreate"
28840 #: ../src/guestfs-actions.pod:7448
28844 " guestfs_vgcreate (guestfs_h *g,\n"
28845 " const char *volgroup,\n"
28846 " char *const *physvols);\n"
28851 #: ../src/guestfs-actions.pod:7460
28852 msgid "guestfs_vglvuuids"
28856 #: ../src/guestfs-actions.pod:7462
28860 " guestfs_vglvuuids (guestfs_h *g,\n"
28861 " const char *vgname);\n"
28866 #: ../src/guestfs-actions.pod:7469
28868 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
28869 "associate logical volumes and volume groups."
28873 #: ../src/guestfs-actions.pod:7472
28874 msgid "See also C<guestfs_vgpvuuids>."
28878 #: ../src/guestfs-actions.pod:7480
28879 msgid "guestfs_vgpvuuids"
28883 #: ../src/guestfs-actions.pod:7482
28887 " guestfs_vgpvuuids (guestfs_h *g,\n"
28888 " const char *vgname);\n"
28893 #: ../src/guestfs-actions.pod:7489
28895 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
28896 "associate physical volumes and volume groups."
28900 #: ../src/guestfs-actions.pod:7492
28901 msgid "See also C<guestfs_vglvuuids>."
28905 #: ../src/guestfs-actions.pod:7500
28906 msgid "guestfs_vgremove"
28910 #: ../src/guestfs-actions.pod:7502
28914 " guestfs_vgremove (guestfs_h *g,\n"
28915 " const char *vgname);\n"
28920 #: ../src/guestfs-actions.pod:7515
28921 msgid "guestfs_vgrename"
28925 #: ../src/guestfs-actions.pod:7517
28929 " guestfs_vgrename (guestfs_h *g,\n"
28930 " const char *volgroup,\n"
28931 " const char *newvolgroup);\n"
28936 #: ../src/guestfs-actions.pod:7528
28937 msgid "guestfs_vgs"
28941 #: ../src/guestfs-actions.pod:7530
28945 " guestfs_vgs (guestfs_h *g);\n"
28950 #: ../src/guestfs-actions.pod:7539
28951 msgid "See also C<guestfs_vgs_full>."
28955 #: ../src/guestfs-actions.pod:7547
28956 msgid "guestfs_vgs_full"
28960 #: ../src/guestfs-actions.pod:7549
28963 " struct guestfs_lvm_vg_list *\n"
28964 " guestfs_vgs_full (guestfs_h *g);\n"
28969 #: ../src/guestfs-actions.pod:7555
28971 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
28972 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
28977 #: ../src/guestfs-actions.pod:7561
28978 msgid "guestfs_vgscan"
28982 #: ../src/guestfs-actions.pod:7563
28986 " guestfs_vgscan (guestfs_h *g);\n"
28991 #: ../src/guestfs-actions.pod:7573
28992 msgid "guestfs_vguuid"
28996 #: ../src/guestfs-actions.pod:7575
29000 " guestfs_vguuid (guestfs_h *g,\n"
29001 " const char *vgname);\n"
29006 #: ../src/guestfs-actions.pod:7586
29007 msgid "guestfs_wait_ready"
29011 #: ../src/guestfs-actions.pod:7588
29015 " guestfs_wait_ready (guestfs_h *g);\n"
29020 #: ../src/guestfs-actions.pod:7591
29021 msgid "This function is a no op."
29025 #: ../src/guestfs-actions.pod:7593
29027 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29028 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29029 "is no longer necessary because C<guestfs_launch> now does the waiting."
29033 #: ../src/guestfs-actions.pod:7598
29035 "If you see any calls to this function in code then you can just remove them, "
29036 "unless you want to retain compatibility with older versions of the API."
29040 #: ../src/guestfs-actions.pod:7604
29042 "This function is deprecated. In new code, use the L</guestfs_launch> call "
29047 #: ../src/guestfs-actions.pod:7613
29048 msgid "guestfs_wc_c"
29052 #: ../src/guestfs-actions.pod:7615
29056 " guestfs_wc_c (guestfs_h *g,\n"
29057 " const char *path);\n"
29062 #: ../src/guestfs-actions.pod:7626
29063 msgid "guestfs_wc_l"
29067 #: ../src/guestfs-actions.pod:7628
29071 " guestfs_wc_l (guestfs_h *g,\n"
29072 " const char *path);\n"
29077 #: ../src/guestfs-actions.pod:7639
29078 msgid "guestfs_wc_w"
29082 #: ../src/guestfs-actions.pod:7641
29086 " guestfs_wc_w (guestfs_h *g,\n"
29087 " const char *path);\n"
29092 #: ../src/guestfs-actions.pod:7652
29093 msgid "guestfs_write"
29097 #: ../src/guestfs-actions.pod:7654
29101 " guestfs_write (guestfs_h *g,\n"
29102 " const char *path,\n"
29103 " const char *content,\n"
29104 " size_t content_size);\n"
29109 #: ../src/guestfs-actions.pod:7663
29110 msgid "See also C<guestfs_write_append>."
29114 #: ../src/guestfs-actions.pod:7672
29115 msgid "guestfs_write_append"
29119 #: ../src/guestfs-actions.pod:7674
29123 " guestfs_write_append (guestfs_h *g,\n"
29124 " const char *path,\n"
29125 " const char *content,\n"
29126 " size_t content_size);\n"
29131 #: ../src/guestfs-actions.pod:7683
29132 msgid "See also C<guestfs_write>."
29136 #: ../src/guestfs-actions.pod:7692
29137 msgid "guestfs_write_file"
29141 #: ../src/guestfs-actions.pod:7694
29145 " guestfs_write_file (guestfs_h *g,\n"
29146 " const char *path,\n"
29147 " const char *content,\n"
29153 #: ../src/guestfs-actions.pod:7716
29155 "This function is deprecated. In new code, use the L</guestfs_write> call "
29160 #: ../src/guestfs-actions.pod:7725
29161 msgid "guestfs_zegrep"
29165 #: ../src/guestfs-actions.pod:7727
29169 " guestfs_zegrep (guestfs_h *g,\n"
29170 " const char *regex,\n"
29171 " const char *path);\n"
29176 #: ../src/guestfs-actions.pod:7744
29177 msgid "guestfs_zegrepi"
29181 #: ../src/guestfs-actions.pod:7746
29185 " guestfs_zegrepi (guestfs_h *g,\n"
29186 " const char *regex,\n"
29187 " const char *path);\n"
29192 #: ../src/guestfs-actions.pod:7763
29193 msgid "guestfs_zero"
29197 #: ../src/guestfs-actions.pod:7765
29201 " guestfs_zero (guestfs_h *g,\n"
29202 " const char *device);\n"
29207 #: ../src/guestfs-actions.pod:7779
29209 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29210 "C<guestfs_is_zero_device>"
29214 #: ../src/guestfs-actions.pod:7791
29215 msgid "guestfs_zero_device"
29219 #: ../src/guestfs-actions.pod:7793
29223 " guestfs_zero_device (guestfs_h *g,\n"
29224 " const char *device);\n"
29229 #: ../src/guestfs-actions.pod:7797
29231 "This command writes zeroes over the entire C<device>. Compare with "
29232 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29236 #: ../src/guestfs-actions.pod:7815
29237 msgid "(Added in 1.3.1)"
29241 #: ../src/guestfs-actions.pod:7817
29242 msgid "guestfs_zerofree"
29246 #: ../src/guestfs-actions.pod:7819
29250 " guestfs_zerofree (guestfs_h *g,\n"
29251 " const char *device);\n"
29256 #: ../src/guestfs-actions.pod:7838
29257 msgid "guestfs_zfgrep"
29261 #: ../src/guestfs-actions.pod:7840
29265 " guestfs_zfgrep (guestfs_h *g,\n"
29266 " const char *pattern,\n"
29267 " const char *path);\n"
29272 #: ../src/guestfs-actions.pod:7857
29273 msgid "guestfs_zfgrepi"
29277 #: ../src/guestfs-actions.pod:7859
29281 " guestfs_zfgrepi (guestfs_h *g,\n"
29282 " const char *pattern,\n"
29283 " const char *path);\n"
29288 #: ../src/guestfs-actions.pod:7876
29289 msgid "guestfs_zfile"
29293 #: ../src/guestfs-actions.pod:7878
29297 " guestfs_zfile (guestfs_h *g,\n"
29298 " const char *meth,\n"
29299 " const char *path);\n"
29304 #: ../src/guestfs-actions.pod:7888
29306 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29311 #: ../src/guestfs-actions.pod:7894
29313 "This function is deprecated. In new code, use the L</guestfs_file> call "
29318 #: ../src/guestfs-actions.pod:7903
29319 msgid "guestfs_zgrep"
29323 #: ../src/guestfs-actions.pod:7905
29327 " guestfs_zgrep (guestfs_h *g,\n"
29328 " const char *regex,\n"
29329 " const char *path);\n"
29334 #: ../src/guestfs-actions.pod:7922
29335 msgid "guestfs_zgrepi"
29339 #: ../src/guestfs-actions.pod:7924
29343 " guestfs_zgrepi (guestfs_h *g,\n"
29344 " const char *regex,\n"
29345 " const char *path);\n"
29350 #: ../src/guestfs-availability.pod:3
29355 #: ../src/guestfs-availability.pod:5
29357 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29358 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29359 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29360 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29361 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29365 #: ../src/guestfs-availability.pod:21
29370 #: ../src/guestfs-availability.pod:23
29371 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
29375 #: ../src/guestfs-availability.pod:26
29380 #: ../src/guestfs-availability.pod:28
29382 "The following functions: L</guestfs_inotify_add_watch> "
29383 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
29384 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
29388 #: ../src/guestfs-availability.pod:36
29389 msgid "B<linuxfsuuid>"
29393 #: ../src/guestfs-availability.pod:38
29395 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
29396 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
29400 #: ../src/guestfs-availability.pod:45
29401 msgid "B<linuxmodules>"
29405 #: ../src/guestfs-availability.pod:47
29406 msgid "The following functions: L</guestfs_modprobe>"
29410 #: ../src/guestfs-availability.pod:50
29411 msgid "B<linuxxattrs>"
29415 #: ../src/guestfs-availability.pod:52
29417 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
29418 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
29419 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
29420 "L</guestfs_setxattr>"
29424 #: ../src/guestfs-availability.pod:63
29429 #: ../src/guestfs-availability.pod:65
29431 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
29432 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
29433 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
29437 #: ../src/guestfs-availability.pod:74
29442 #: ../src/guestfs-availability.pod:76
29444 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
29445 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
29446 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
29447 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
29448 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
29449 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
29450 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
29451 "L</guestfs_vgs_full>"
29455 #: ../src/guestfs-availability.pod:99
29460 #: ../src/guestfs-availability.pod:101
29462 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
29463 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
29467 #: ../src/guestfs-availability.pod:107
29472 #: ../src/guestfs-availability.pod:109
29473 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
29477 #: ../src/guestfs-availability.pod:112
29478 msgid "B<ntfsprogs>"
29482 #: ../src/guestfs-availability.pod:114
29484 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
29485 "L</guestfs_ntfsresize_size>"
29489 #: ../src/guestfs-availability.pod:119
29490 msgid "B<realpath>"
29494 #: ../src/guestfs-availability.pod:121
29495 msgid "The following functions: L</guestfs_realpath>"
29499 #: ../src/guestfs-availability.pod:124
29504 #: ../src/guestfs-availability.pod:126
29506 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
29507 "L</guestfs_scrub_freespace>"
29511 #: ../src/guestfs-availability.pod:131
29516 #: ../src/guestfs-availability.pod:133
29517 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
29521 #: ../src/guestfs-availability.pod:137
29526 #: ../src/guestfs-availability.pod:139
29527 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
29531 #: ../src/guestfs-availability.pod:143
29532 msgid "B<zerofree>"
29536 #: ../src/guestfs-availability.pod:145
29537 msgid "The following functions: L</guestfs_zerofree>"
29541 #: ../src/guestfs-structs.pod:1
29542 msgid "guestfs_int_bool"
29546 #: ../src/guestfs-structs.pod:3
29549 " struct guestfs_int_bool {\n"
29557 #: ../src/guestfs-structs.pod:8
29560 " struct guestfs_int_bool_list {\n"
29561 " uint32_t len; /* Number of elements in list. */\n"
29562 " struct guestfs_int_bool *val; /* Elements. */\n"
29568 #: ../src/guestfs-structs.pod:13
29571 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
29572 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
29577 #: ../src/guestfs-structs.pod:16
29578 msgid "guestfs_lvm_pv"
29582 #: ../src/guestfs-structs.pod:18
29585 " struct guestfs_lvm_pv {\n"
29586 " char *pv_name;\n"
29587 " /* The next field is NOT nul-terminated, be careful when printing it: "
29589 " char pv_uuid[32];\n"
29591 " uint64_t pv_size;\n"
29592 " uint64_t dev_size;\n"
29593 " uint64_t pv_free;\n"
29594 " uint64_t pv_used;\n"
29595 " char *pv_attr;\n"
29596 " int64_t pv_pe_count;\n"
29597 " int64_t pv_pe_alloc_count;\n"
29598 " char *pv_tags;\n"
29599 " uint64_t pe_start;\n"
29600 " int64_t pv_mda_count;\n"
29601 " uint64_t pv_mda_free;\n"
29607 #: ../src/guestfs-structs.pod:36
29610 " struct guestfs_lvm_pv_list {\n"
29611 " uint32_t len; /* Number of elements in list. */\n"
29612 " struct guestfs_lvm_pv *val; /* Elements. */\n"
29618 #: ../src/guestfs-structs.pod:41
29621 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
29622 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
29627 #: ../src/guestfs-structs.pod:44
29628 msgid "guestfs_lvm_vg"
29632 #: ../src/guestfs-structs.pod:46
29635 " struct guestfs_lvm_vg {\n"
29636 " char *vg_name;\n"
29637 " /* The next field is NOT nul-terminated, be careful when printing it: "
29639 " char vg_uuid[32];\n"
29641 " char *vg_attr;\n"
29642 " uint64_t vg_size;\n"
29643 " uint64_t vg_free;\n"
29644 " char *vg_sysid;\n"
29645 " uint64_t vg_extent_size;\n"
29646 " int64_t vg_extent_count;\n"
29647 " int64_t vg_free_count;\n"
29648 " int64_t max_lv;\n"
29649 " int64_t max_pv;\n"
29650 " int64_t pv_count;\n"
29651 " int64_t lv_count;\n"
29652 " int64_t snap_count;\n"
29653 " int64_t vg_seqno;\n"
29654 " char *vg_tags;\n"
29655 " int64_t vg_mda_count;\n"
29656 " uint64_t vg_mda_free;\n"
29662 #: ../src/guestfs-structs.pod:69
29665 " struct guestfs_lvm_vg_list {\n"
29666 " uint32_t len; /* Number of elements in list. */\n"
29667 " struct guestfs_lvm_vg *val; /* Elements. */\n"
29673 #: ../src/guestfs-structs.pod:74
29676 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
29677 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
29682 #: ../src/guestfs-structs.pod:77
29683 msgid "guestfs_lvm_lv"
29687 #: ../src/guestfs-structs.pod:79
29690 " struct guestfs_lvm_lv {\n"
29691 " char *lv_name;\n"
29692 " /* The next field is NOT nul-terminated, be careful when printing it: "
29694 " char lv_uuid[32];\n"
29695 " char *lv_attr;\n"
29696 " int64_t lv_major;\n"
29697 " int64_t lv_minor;\n"
29698 " int64_t lv_kernel_major;\n"
29699 " int64_t lv_kernel_minor;\n"
29700 " uint64_t lv_size;\n"
29701 " int64_t seg_count;\n"
29703 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29704 " float snap_percent;\n"
29705 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29706 " float copy_percent;\n"
29707 " char *move_pv;\n"
29708 " char *lv_tags;\n"
29709 " char *mirror_log;\n"
29710 " char *modules;\n"
29716 #: ../src/guestfs-structs.pod:101
29719 " struct guestfs_lvm_lv_list {\n"
29720 " uint32_t len; /* Number of elements in list. */\n"
29721 " struct guestfs_lvm_lv *val; /* Elements. */\n"
29727 #: ../src/guestfs-structs.pod:106
29730 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
29731 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
29736 #: ../src/guestfs-structs.pod:111
29739 " struct guestfs_stat {\n"
29743 " int64_t nlink;\n"
29748 " int64_t blksize;\n"
29749 " int64_t blocks;\n"
29750 " int64_t atime;\n"
29751 " int64_t mtime;\n"
29752 " int64_t ctime;\n"
29758 #: ../src/guestfs-structs.pod:127
29761 " struct guestfs_stat_list {\n"
29762 " uint32_t len; /* Number of elements in list. */\n"
29763 " struct guestfs_stat *val; /* Elements. */\n"
29769 #: ../src/guestfs-structs.pod:132
29772 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
29773 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
29778 #: ../src/guestfs-structs.pod:137
29781 " struct guestfs_statvfs {\n"
29782 " int64_t bsize;\n"
29783 " int64_t frsize;\n"
29784 " int64_t blocks;\n"
29785 " int64_t bfree;\n"
29786 " int64_t bavail;\n"
29787 " int64_t files;\n"
29788 " int64_t ffree;\n"
29789 " int64_t favail;\n"
29792 " int64_t namemax;\n"
29798 #: ../src/guestfs-structs.pod:151
29801 " struct guestfs_statvfs_list {\n"
29802 " uint32_t len; /* Number of elements in list. */\n"
29803 " struct guestfs_statvfs *val; /* Elements. */\n"
29809 #: ../src/guestfs-structs.pod:156
29812 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
29813 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
29818 #: ../src/guestfs-structs.pod:159
29819 msgid "guestfs_dirent"
29823 #: ../src/guestfs-structs.pod:161
29826 " struct guestfs_dirent {\n"
29835 #: ../src/guestfs-structs.pod:167
29838 " struct guestfs_dirent_list {\n"
29839 " uint32_t len; /* Number of elements in list. */\n"
29840 " struct guestfs_dirent *val; /* Elements. */\n"
29846 #: ../src/guestfs-structs.pod:172
29849 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
29850 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
29855 #: ../src/guestfs-structs.pod:177
29858 " struct guestfs_version {\n"
29859 " int64_t major;\n"
29860 " int64_t minor;\n"
29861 " int64_t release;\n"
29868 #: ../src/guestfs-structs.pod:184
29871 " struct guestfs_version_list {\n"
29872 " uint32_t len; /* Number of elements in list. */\n"
29873 " struct guestfs_version *val; /* Elements. */\n"
29879 #: ../src/guestfs-structs.pod:189
29882 " void guestfs_free_version (struct guestfs_free_version *);\n"
29883 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
29888 #: ../src/guestfs-structs.pod:192
29889 msgid "guestfs_xattr"
29893 #: ../src/guestfs-structs.pod:194
29896 " struct guestfs_xattr {\n"
29897 " char *attrname;\n"
29898 " /* The next two fields describe a byte array. */\n"
29899 " uint32_t attrval_len;\n"
29900 " char *attrval;\n"
29906 #: ../src/guestfs-structs.pod:201
29909 " struct guestfs_xattr_list {\n"
29910 " uint32_t len; /* Number of elements in list. */\n"
29911 " struct guestfs_xattr *val; /* Elements. */\n"
29917 #: ../src/guestfs-structs.pod:206
29920 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
29921 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
29926 #: ../src/guestfs-structs.pod:209
29927 msgid "guestfs_inotify_event"
29931 #: ../src/guestfs-structs.pod:211
29934 " struct guestfs_inotify_event {\n"
29935 " int64_t in_wd;\n"
29936 " uint32_t in_mask;\n"
29937 " uint32_t in_cookie;\n"
29938 " char *in_name;\n"
29944 #: ../src/guestfs-structs.pod:218
29947 " struct guestfs_inotify_event_list {\n"
29948 " uint32_t len; /* Number of elements in list. */\n"
29949 " struct guestfs_inotify_event *val; /* Elements. */\n"
29955 #: ../src/guestfs-structs.pod:223
29958 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
29959 " void guestfs_free_inotify_event_list (struct "
29960 "guestfs_free_inotify_event_list *);\n"
29965 #: ../src/guestfs-structs.pod:226
29966 msgid "guestfs_partition"
29970 #: ../src/guestfs-structs.pod:228
29973 " struct guestfs_partition {\n"
29974 " int32_t part_num;\n"
29975 " uint64_t part_start;\n"
29976 " uint64_t part_end;\n"
29977 " uint64_t part_size;\n"
29983 #: ../src/guestfs-structs.pod:235
29986 " struct guestfs_partition_list {\n"
29987 " uint32_t len; /* Number of elements in list. */\n"
29988 " struct guestfs_partition *val; /* Elements. */\n"
29994 #: ../src/guestfs-structs.pod:240
29997 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
29998 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30003 #: ../src/guestfs-structs.pod:243
30004 msgid "guestfs_application"
30008 #: ../src/guestfs-structs.pod:245
30011 " struct guestfs_application {\n"
30012 " char *app_name;\n"
30013 " char *app_display_name;\n"
30014 " int32_t app_epoch;\n"
30015 " char *app_version;\n"
30016 " char *app_release;\n"
30017 " char *app_install_path;\n"
30018 " char *app_trans_path;\n"
30019 " char *app_publisher;\n"
30020 " char *app_url;\n"
30021 " char *app_source_package;\n"
30022 " char *app_summary;\n"
30023 " char *app_description;\n"
30029 #: ../src/guestfs-structs.pod:260
30032 " struct guestfs_application_list {\n"
30033 " uint32_t len; /* Number of elements in list. */\n"
30034 " struct guestfs_application *val; /* Elements. */\n"
30040 #: ../src/guestfs-structs.pod:265
30043 " void guestfs_free_application (struct guestfs_free_application *);\n"
30044 " void guestfs_free_application_list (struct guestfs_free_application_list "
30050 #: ../src/guestfs.pod:5
30051 msgid "guestfs - Library for accessing and modifying virtual machine images"
30055 #: ../src/guestfs.pod:11
30058 " guestfs_h *g = guestfs_create ();\n"
30059 " guestfs_add_drive (g, \"guest.img\");\n"
30060 " guestfs_launch (g);\n"
30061 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30062 " guestfs_touch (g, \"/hello\");\n"
30063 " guestfs_umount (g, \"/\");\n"
30064 " guestfs_close (g);\n"
30069 #: ../src/guestfs.pod:25
30071 "Libguestfs is a library for accessing and modifying guest disk images. "
30072 "Amongst the things this is good for: making batch configuration changes to "
30073 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30074 "between virtualization systems (see also: virt-p2v), performing partial "
30075 "backups, performing partial guest clones, cloning guests and changing "
30076 "registry/UUID/hostname info, and much else besides."
30080 #: ../src/guestfs.pod:33
30082 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30083 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30084 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30089 #: ../src/guestfs.pod:38
30091 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30092 "what filesystem is in each LV, etc.). It can also run commands in the "
30093 "context of the guest. Also you can access filesystems over FUSE."
30097 #: ../src/guestfs.pod:43
30099 "Libguestfs is a library that can be linked with C and C++ management "
30100 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30101 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
30106 #: ../src/guestfs.pod:48
30108 "You don't need to be root to use libguestfs, although obviously you do need "
30109 "enough permissions to access the disk images."
30113 #: ../src/guestfs.pod:51
30115 "Libguestfs is a large API because it can do many things. For a gentle "
30116 "introduction, please read the L</API OVERVIEW> section next."
30120 #: ../src/guestfs.pod:54
30122 "There are also some example programs in the L<guestfs-examples(3)> manual "
30127 #: ../src/guestfs.pod:57
30128 msgid "API OVERVIEW"
30132 #: ../src/guestfs.pod:59
30134 "This section provides a gentler overview of the libguestfs API. We also try "
30135 "to group API calls together, where that may not be obvious from reading "
30136 "about the individual calls in the main section of this manual."
30140 #: ../src/guestfs.pod:64
30145 #: ../src/guestfs.pod:66
30147 "Before you can use libguestfs calls, you have to create a handle. Then you "
30148 "must add at least one disk image to the handle, followed by launching the "
30149 "handle, then performing whatever operations you want, and finally closing "
30150 "the handle. By convention we use the single letter C<g> for the name of the "
30151 "handle variable, although of course you can use any name you want."
30155 #: ../src/guestfs.pod:73
30156 msgid "The general structure of all libguestfs-using programs looks like this:"
30160 #: ../src/guestfs.pod:76
30163 " guestfs_h *g = guestfs_create ();\n"
30168 #: ../src/guestfs.pod:78
30171 " /* Call guestfs_add_drive additional times if there are\n"
30172 " * multiple disk images.\n"
30174 " guestfs_add_drive (g, \"guest.img\");\n"
30179 #: ../src/guestfs.pod:83
30182 " /* Most manipulation calls won't work until you've launched\n"
30183 " * the handle 'g'. You have to do this _after_ adding drives\n"
30184 " * and _before_ other commands.\n"
30186 " guestfs_launch (g);\n"
30191 #: ../src/guestfs.pod:89
30194 " /* Now you can examine what partitions, LVs etc are available.\n"
30196 " char **partitions = guestfs_list_partitions (g);\n"
30197 " char **logvols = guestfs_lvs (g);\n"
30202 #: ../src/guestfs.pod:94
30205 " /* To access a filesystem in the image, you must mount it.\n"
30207 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30212 #: ../src/guestfs.pod:98
30215 " /* Now you can perform filesystem actions on the guest\n"
30218 " guestfs_touch (g, \"/hello\");\n"
30223 #: ../src/guestfs.pod:103
30226 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30227 " * it is done automatically when you close the handle. See\n"
30228 " * discussion of autosync in this page.\n"
30230 " guestfs_sync (g);\n"
30235 #: ../src/guestfs.pod:109
30238 " /* Close the handle 'g'. */\n"
30239 " guestfs_close (g);\n"
30244 #: ../src/guestfs.pod:112
30246 "The code above doesn't include any error checking. In real code you should "
30247 "check return values carefully for errors. In general all functions that "
30248 "return integers return C<-1> on error, and all functions that return "
30249 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30250 "how to handle errors, and consult the documentation for each function call "
30251 "below to see precisely how they return error indications. See "
30252 "L<guestfs-examples(3)> for fully worked examples."
30256 #: ../src/guestfs.pod:121
30257 msgid "DISK IMAGES"
30261 #: ../src/guestfs.pod:123
30263 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30264 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30265 "actual block device, or simply an empty file of zeroes that you have created "
30266 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30271 #: ../src/guestfs.pod:129
30273 "The call you should use in modern code for adding drives is "
30274 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30275 "specifying that the format is raw, do:"
30279 #: ../src/guestfs.pod:133
30282 " guestfs_add_drive_opts (g, filename,\n"
30283 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30289 #: ../src/guestfs.pod:137
30290 msgid "You can add a disk read-only using:"
30294 #: ../src/guestfs.pod:139
30297 " guestfs_add_drive_opts (g, filename,\n"
30298 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30299 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30305 #: ../src/guestfs.pod:144
30307 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30308 "libguestfs won't modify the file."
30312 #: ../src/guestfs.pod:147
30314 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30315 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30316 "corruption, but adding it read-only is safe."
30320 #: ../src/guestfs.pod:151
30322 "You must add at least one disk image, and you may add multiple disk images. "
30323 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30324 "first one you added), C</dev/sdb> (for the second one you added), etc."
30328 #: ../src/guestfs.pod:156
30330 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30331 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30332 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
30336 #: ../src/guestfs.pod:161
30341 #: ../src/guestfs.pod:163
30343 "Before you can read or write files, create directories and so on in a disk "
30344 "image that contains filesystems, you have to mount those filesystems using "
30345 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
30346 "a disk image contains (for example) one partition with a filesystem on that "
30347 "partition, then you can mount it directly:"
30351 #: ../src/guestfs.pod:170
30354 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
30359 #: ../src/guestfs.pod:172
30361 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
30362 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
30363 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
30364 "that these are libguestfs virtual devices, and are nothing to do with host "
30369 #: ../src/guestfs.pod:178
30371 "If you are given a disk image and you don't know what it contains then you "
30372 "have to find out. Libguestfs can do that too: use "
30373 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
30374 "and LVs, and either try mounting each to see what is mountable, or else "
30375 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
30376 "filesystems, use L</guestfs_list_filesystems>."
30380 #: ../src/guestfs.pod:186
30382 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
30383 "L</INSPECTION> below). But you might find it easier to look at higher level "
30384 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
30388 #: ../src/guestfs.pod:191
30390 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
30391 "several other variations of the C<guestfs_mount_*> call."
30395 #: ../src/guestfs.pod:194
30396 msgid "FILESYSTEM ACCESS AND MODIFICATION"
30400 #: ../src/guestfs.pod:196
30402 "The majority of the libguestfs API consists of fairly low-level calls for "
30403 "accessing and modifying the files, directories, symlinks etc on mounted "
30404 "filesystems. There are over a hundred such calls which you can find listed "
30405 "in detail below in this man page, and we don't even pretend to cover them "
30406 "all in this overview."
30410 #: ../src/guestfs.pod:202
30412 "Specify filenames as full paths, starting with C<\"/\"> and including the "
30417 #: ../src/guestfs.pod:205
30419 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
30420 "the file called C<\"etc/passwd\"> then you could do:"
30424 #: ../src/guestfs.pod:208
30427 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
30432 #: ../src/guestfs.pod:210
30434 "This would return C<data> as a newly allocated buffer containing the full "
30435 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
30436 "or C<NULL> if there was an error."
30440 #: ../src/guestfs.pod:214
30442 "As another example, to create a top-level directory on that filesystem "
30443 "called C<\"var\"> you would do:"
30447 #: ../src/guestfs.pod:217
30450 " guestfs_mkdir (g, \"/var\");\n"
30455 #: ../src/guestfs.pod:219
30456 msgid "To create a symlink you could do:"
30460 #: ../src/guestfs.pod:221
30463 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
30464 " \"/etc/rc3.d/S30portmap\");\n"
30469 #: ../src/guestfs.pod:224
30471 "Libguestfs will reject attempts to use relative paths and there is no "
30472 "concept of a current working directory."
30476 #: ../src/guestfs.pod:227
30478 "Libguestfs can return errors in many situations: for example if the "
30479 "filesystem isn't writable, or if a file or directory that you requested "
30480 "doesn't exist. If you are using the C API (documented here) you have to "
30481 "check for those error conditions after each call. (Other language bindings "
30482 "turn these errors into exceptions)."
30486 #: ../src/guestfs.pod:233
30488 "File writes are affected by the per-handle umask, set by calling "
30489 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
30493 #: ../src/guestfs.pod:236
30494 msgid "PARTITIONING"
30498 #: ../src/guestfs.pod:238
30500 "Libguestfs contains API calls to read, create and modify partition tables on "
30505 #: ../src/guestfs.pod:241
30507 "In the common case where you want to create a single partition covering the "
30508 "whole disk, you should use the L</guestfs_part_disk> call:"
30512 #: ../src/guestfs.pod:245
30515 " const char *parttype = \"mbr\";\n"
30516 " if (disk_is_larger_than_2TB)\n"
30517 " parttype = \"gpt\";\n"
30518 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
30523 #: ../src/guestfs.pod:250
30525 "Obviously this effectively wipes anything that was on that disk image "
30530 #: ../src/guestfs.pod:253
30535 #: ../src/guestfs.pod:255
30537 "Libguestfs provides access to a large part of the LVM2 API, such as "
30538 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
30539 "unless you familiarize yourself with the concepts of physical volumes, "
30540 "volume groups and logical volumes."
30544 #: ../src/guestfs.pod:260
30546 "This author strongly recommends reading the LVM HOWTO, online at "
30547 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
30551 #: ../src/guestfs.pod:263
30552 msgid "DOWNLOADING"
30556 #: ../src/guestfs.pod:265
30558 "Use L</guestfs_cat> to download small, text only files. This call is "
30559 "limited to files which are less than 2 MB and which cannot contain any ASCII "
30560 "NUL (C<\\0>) characters. However the API is very simple to use."
30564 #: ../src/guestfs.pod:269
30566 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
30567 "bit data, since it returns a (pointer, size) pair. However it is still "
30568 "limited to \"small\" files, less than 2 MB."
30572 #: ../src/guestfs.pod:273
30574 "L</guestfs_download> can be used to download any file, with no limits on "
30575 "content or size (even files larger than 4 GB)."
30579 #: ../src/guestfs.pod:276
30580 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
30584 #: ../src/guestfs.pod:279
30589 #: ../src/guestfs.pod:281
30591 "It's often the case that you want to write a file or files to the disk "
30596 #: ../src/guestfs.pod:284
30598 "To write a small file with fixed content, use L</guestfs_write>. To create "
30599 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
30600 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
30601 "variety of other functions for creating test files, for example "
30602 "L</guestfs_fill> and L</guestfs_fill_pattern>."
30606 #: ../src/guestfs.pod:290
30608 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
30609 "file content or size (even files larger than 4 GB)."
30613 #: ../src/guestfs.pod:293
30614 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
30618 #: ../src/guestfs.pod:295
30620 "However the fastest way to upload I<large numbers of arbitrary files> is to "
30621 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
30622 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
30623 "the drive in a predictable way (eg. adding it last after all other drives) "
30624 "then you can get the device name from L</guestfs_list_devices> and mount it "
30625 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
30626 "sometimes non-portable between kernel versions, and they don't support "
30627 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
30628 "using a label or UUID, use an ISO image instead."
30632 #: ../src/guestfs.pod:306
30637 #: ../src/guestfs.pod:308
30639 "There are various different commands for copying between files and devices "
30640 "and in and out of the guest filesystem. These are summarised in the table "
30645 #: ../src/guestfs.pod:314
30646 msgid "B<file> to B<file>"
30650 #: ../src/guestfs.pod:316
30652 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
30653 "directories recursively."
30657 #: ../src/guestfs.pod:319
30658 msgid "B<file or device> to B<file or device>"
30662 #: ../src/guestfs.pod:321
30664 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
30665 "devices in the guest."
30669 #: ../src/guestfs.pod:324
30670 msgid "Example: duplicate the contents of an LV:"
30674 #: ../src/guestfs.pod:326
30677 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
30682 #: ../src/guestfs.pod:328
30684 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
30685 "(C</dev/VG/Original>). To copy less than the whole source device, use "
30686 "L</guestfs_copy_size>."
30690 #: ../src/guestfs.pod:332
30691 msgid "B<file on the host> to B<file or device>"
30695 #: ../src/guestfs.pod:334
30696 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
30700 #: ../src/guestfs.pod:336
30701 msgid "B<file or device> to B<file on the host>"
30705 #: ../src/guestfs.pod:338
30706 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
30710 #: ../src/guestfs.pod:342
30711 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
30715 #: ../src/guestfs.pod:344
30717 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
30718 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
30719 "appears you can only upload and download to files. However many Un*x-like "
30720 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
30721 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
30722 "stderr, and arbitrary file descriptor N."
30726 #: ../src/guestfs.pod:352
30727 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
30731 #: ../src/guestfs.pod:355
30734 " guestfs_download (g, filename, \"/dev/stdout\");\n"
30739 #: ../src/guestfs.pod:357
30740 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
30744 #: ../src/guestfs.pod:359
30747 " char devfd[64];\n"
30748 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
30749 " guestfs_tar_out (g, \"/\", devfd);\n"
30754 #: ../src/guestfs.pod:363
30755 msgid "LISTING FILES"
30759 #: ../src/guestfs.pod:365
30761 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
30762 "L<guestfish(1)>-equivalent command C<ll>)."
30766 #: ../src/guestfs.pod:368
30768 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
30769 "programs, as a flat list of strings."
30773 #: ../src/guestfs.pod:371
30775 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
30776 "directory, plus additional information about each one. It is more "
30777 "equivalent to using the L<readdir(3)> call on a local filesystem."
30781 #: ../src/guestfs.pod:375
30783 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
30788 #: ../src/guestfs.pod:378
30789 msgid "RUNNING COMMANDS"
30793 #: ../src/guestfs.pod:380
30795 "Although libguestfs is primarily an API for manipulating files inside guest "
30796 "images, we also provide some limited facilities for running commands inside "
30801 #: ../src/guestfs.pod:384
30802 msgid "There are many limitations to this:"
30806 #: ../src/guestfs.pod:390
30808 "The kernel version that the command runs under will be different from what "
30813 #: ../src/guestfs.pod:395
30815 "If the command needs to communicate with daemons, then most likely they "
30816 "won't be running."
30820 #: ../src/guestfs.pod:400
30821 msgid "The command will be running in limited memory."
30825 #: ../src/guestfs.pod:404
30827 "The network may not be available unless you enable it (see "
30828 "L</guestfs_set_network>)."
30832 #: ../src/guestfs.pod:409
30833 msgid "Only supports Linux guests (not Windows, BSD, etc)."
30837 #: ../src/guestfs.pod:413
30838 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
30842 #: ../src/guestfs.pod:418
30844 "For SELinux guests, you may need to enable SELinux and load policy first. "
30845 "See L</SELINUX> in this manpage."
30849 #: ../src/guestfs.pod:423
30851 "I<Security:> It is not safe to run commands from untrusted, possibly "
30852 "malicious guests. These commands may attempt to exploit your program by "
30853 "sending unexpected output. They could also try to exploit the Linux kernel "
30854 "or qemu provided by the libguestfs appliance. They could use the network "
30855 "provided by the libguestfs appliance to bypass ordinary network partitions "
30856 "and firewalls. They could use the elevated privileges or different SELinux "
30857 "context of your program to their advantage."
30861 #: ../src/guestfs.pod:432
30863 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
30864 "(a script which runs when the guest next boots normally), and to have this "
30865 "script run the commands you want in the normal context of the running guest, "
30866 "network security and so on. For information about other security issues, "
30867 "see L</SECURITY>."
30871 #: ../src/guestfs.pod:440
30873 "The two main API calls to run commands are L</guestfs_command> and "
30874 "L</guestfs_sh> (there are also variations)."
30878 #: ../src/guestfs.pod:443
30880 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
30881 "shell globs, redirections, etc will work."
30885 #: ../src/guestfs.pod:446
30886 msgid "CONFIGURATION FILES"
30890 #: ../src/guestfs.pod:448
30892 "To read and write configuration files in Linux guest filesystems, we "
30893 "strongly recommend using Augeas. For example, Augeas understands how to "
30894 "read and write, say, a Linux shadow password file or X.org configuration "
30895 "file, and so avoids you having to write that code."
30899 #: ../src/guestfs.pod:453
30901 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
30902 "document Augeas itself here because there is excellent documentation on the "
30903 "L<http://augeas.net/> website."
30907 #: ../src/guestfs.pod:457
30909 "If you don't want to use Augeas (you fool!) then try calling "
30910 "L</guestfs_read_lines> to get the file as a list of lines which you can "
30915 #: ../src/guestfs.pod:461
30920 #: ../src/guestfs.pod:463
30922 "We support SELinux guests. To ensure that labeling happens correctly in "
30923 "SELinux guests, you need to enable SELinux and load the guest's policy:"
30927 #: ../src/guestfs.pod:471
30928 msgid "Before launching, do:"
30932 #: ../src/guestfs.pod:473
30935 " guestfs_set_selinux (g, 1);\n"
30940 #: ../src/guestfs.pod:477
30942 "After mounting the guest's filesystem(s), load the policy. This is best "
30943 "done by running the L<load_policy(8)> command in the guest itself:"
30947 #: ../src/guestfs.pod:481
30950 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
30955 #: ../src/guestfs.pod:483
30957 "(Older versions of C<load_policy> require you to specify the name of the "
30962 #: ../src/guestfs.pod:488
30964 "Optionally, set the security context for the API. The correct security "
30965 "context to use can only be known by inspecting the guest. As an example:"
30969 #: ../src/guestfs.pod:492
30972 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
30977 #: ../src/guestfs.pod:496
30978 msgid "This will work for running commands and editing existing files."
30982 #: ../src/guestfs.pod:498
30984 "When new files are created, you may need to label them explicitly, for "
30985 "example by running the external command C<restorecon pathname>."
30989 #: ../src/guestfs.pod:502
30994 #: ../src/guestfs.pod:504
30996 "Certain calls are affected by the current file mode creation mask (the "
30997 "\"umask\"). In particular ones which create files or directories, such as "
30998 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
30999 "either the default mode that the file is created with or modifies the mode "
31004 #: ../src/guestfs.pod:510
31006 "The default umask is C<022>, so files are created with modes such as C<0644> "
31007 "and directories with C<0755>."
31011 #: ../src/guestfs.pod:513
31013 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31014 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
31015 "L</guestfs_chmod> after creating each file or directory."
31019 #: ../src/guestfs.pod:517
31020 msgid "For more information about umask, see L<umask(2)>."
31024 #: ../src/guestfs.pod:521
31026 "Libguestfs allows you to access Linux guests which have been encrypted using "
31027 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31028 "standard. This includes nearly all whole disk encryption systems used by "
31029 "modern Linux guests."
31033 #: ../src/guestfs.pod:527
31035 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31036 "returns the string C<crypto_LUKS>)."
31040 #: ../src/guestfs.pod:530
31042 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31043 "will require the passphrase!"
31047 #: ../src/guestfs.pod:533
31049 "Opening a LUKS device creates a new device mapper device called "
31050 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
31051 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
31052 "decrypted from and encrypted to the underlying block device respectively."
31056 #: ../src/guestfs.pod:539
31058 "LVM volume groups on the device can be made visible by calling "
31059 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
31060 "volume(s) can now be mounted in the usual way."
31064 #: ../src/guestfs.pod:543
31066 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31067 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31068 "[\"/dev/VG\"])>. Then close the mapper device by calling "
31069 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31070 "underlying encrypted block device)."
31074 #: ../src/guestfs.pod:550
31079 #: ../src/guestfs.pod:552
31081 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31082 "contains operating systems, an install CD or a live CD. (These APIs used to "
31083 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31084 "version 1.5.3 the most frequently used part of this library has been "
31085 "rewritten in C and moved into the core code)."
31089 #: ../src/guestfs.pod:559
31091 "Add all disks belonging to the unknown virtual machine and call "
31092 "L</guestfs_launch> in the usual way."
31096 #: ../src/guestfs.pod:562
31098 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31099 "and certain heuristics, and returns a list of operating systems that were "
31100 "found. An empty list means none were found. A single element is the root "
31101 "filesystem of the operating system. For dual- or multi-boot guests, "
31102 "multiple roots can be returned, each one corresponding to a separate "
31103 "operating system. (Multi-boot virtual machines are extremely rare in the "
31104 "world of virtualization, but since this scenario can happen, we have built "
31105 "libguestfs to deal with it.)"
31109 #: ../src/guestfs.pod:571
31111 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31112 "to get additional details about that operating system. For example, call "
31113 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31114 "Windows and Linux-based operating systems respectively."
31118 #: ../src/guestfs.pod:577
31120 "Un*x-like and Linux-based operating systems usually consist of several "
31121 "filesystems which are mounted at boot time (for example, a separate boot "
31122 "partition mounted on C</boot>). The inspection rules are able to detect how "
31123 "filesystems correspond to mount points. Call "
31124 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31125 "hash table like this example:"
31129 #: ../src/guestfs.pod:584
31132 " /boot => /dev/sda1\n"
31133 " / => /dev/vg_guest/lv_root\n"
31134 " /usr => /dev/vg_guest/lv_usr\n"
31139 #: ../src/guestfs.pod:588
31141 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31142 "filesystems as suggested."
31146 #: ../src/guestfs.pod:591
31148 "Be careful to mount filesystems in the right order (eg. C</> before "
31149 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
31154 #: ../src/guestfs.pod:595
31156 "Inspection currently only works for some common operating systems. "
31157 "Contributors are welcome to send patches for other operating systems that we "
31158 "currently cannot detect."
31162 #: ../src/guestfs.pod:599
31164 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31165 "for more details. The L</guestfs_inspect_os> function just ignores any "
31166 "encrypted devices."
31170 #: ../src/guestfs.pod:603
31172 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31173 "inspection and caches the results in the guest handle. Subsequent calls to "
31174 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31175 "re-read the disks. If you change the content of the guest disks, you can "
31176 "redo inspection by calling L</guestfs_inspect_os> again. "
31177 "(L</guestfs_inspect_list_applications> works a little differently from the "
31178 "other calls and does read the disks. See documentation for that function "
31183 #: ../src/guestfs.pod:612
31184 msgid "INSPECTING INSTALL DISKS"
31188 #: ../src/guestfs.pod:614
31190 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31195 #: ../src/guestfs.pod:617
31197 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31198 "system, which currently can be C<installed> (a regular operating system) or "
31199 "C<installer> (some sort of install disk)."
31203 #: ../src/guestfs.pod:621
31205 "Further information is available about the operating system that can be "
31206 "installed using the regular inspection APIs like "
31207 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31212 #: ../src/guestfs.pod:626
31214 "Some additional information specific to installer disks is also available "
31215 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31216 "L</guestfs_inspect_is_multipart> calls."
31220 #: ../src/guestfs.pod:631
31221 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31225 #: ../src/guestfs.pod:633
31227 "Libguestfs can mount NTFS partitions. It does this using the "
31228 "L<http://www.ntfs-3g.org/> driver."
31232 #: ../src/guestfs.pod:636
31233 msgid "DRIVE LETTERS AND PATHS"
31237 #: ../src/guestfs.pod:638
31239 "DOS and Windows still use drive letters, and the filesystems are always "
31240 "treated as case insensitive by Windows itself, and therefore you might find "
31241 "a Windows configuration file referring to a path like "
31242 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
31243 "that directory might be referred to as C</WINDOWS/System32>."
31247 #: ../src/guestfs.pod:644
31249 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31250 "L</guestfs_inspect_get_drive_mappings>)"
31254 #: ../src/guestfs.pod:647
31256 "Dealing with separator characters (backslash vs forward slash) is outside "
31257 "the scope of libguestfs, but usually a simple character replacement will "
31262 #: ../src/guestfs.pod:651
31264 "To resolve the case insensitivity of paths, call "
31265 "L</guestfs_case_sensitive_path>."
31269 #: ../src/guestfs.pod:654
31270 msgid "ACCESSING THE WINDOWS REGISTRY"
31274 #: ../src/guestfs.pod:656
31276 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31277 "files, through the library C<hivex> which is part of the libguestfs project "
31278 "although ships as a separate tarball. You have to locate and download the "
31279 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31280 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31281 "L<virt-win-reg(1)> for more help on this issue."
31285 #: ../src/guestfs.pod:664
31286 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31290 #: ../src/guestfs.pod:666
31292 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31293 "provide something which looks like a Linux symlink. The way it tries to do "
31294 "the rewriting is described here:"
31298 #: ../src/guestfs.pod:670
31299 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31303 #: ../src/guestfs.pod:672
31305 "The essential problem is that ntfs-3g simply does not have enough "
31306 "information to do a correct job. NTFS links can contain drive letters and "
31307 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31308 "It is almost certainly the case that libguestfs callers should ignore what "
31309 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31313 #: ../src/guestfs.pod:679
31315 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31316 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31317 "attribute, and read the raw reparse data from that (you can find the format "
31318 "documented in various places around the web)."
31322 #: ../src/guestfs.pod:684
31323 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31327 #: ../src/guestfs.pod:686
31329 "There are other useful extended attributes that can be read from ntfs-3g "
31330 "filesystems (using L</guestfs_getxattr>). See:"
31334 #: ../src/guestfs.pod:689
31335 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31339 #: ../src/guestfs.pod:691
31340 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31344 #: ../src/guestfs.pod:693
31346 "Although we don't want to discourage you from using the C API, we will "
31347 "mention here that the same API is also available in other languages."
31351 #: ../src/guestfs.pod:696
31353 "The API is broadly identical in all supported languages. This means that "
31354 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
31355 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
31356 "OCaml. In other words, a straightforward, predictable isomorphism between "
31361 #: ../src/guestfs.pod:702
31363 "Error messages are automatically transformed into exceptions if the language "
31368 #: ../src/guestfs.pod:705
31370 "We don't try to \"object orientify\" parts of the API in OO languages, "
31371 "although contributors are welcome to write higher level APIs above what we "
31372 "provide in their favourite languages if they wish."
31376 #: ../src/guestfs.pod:711
31381 #: ../src/guestfs.pod:713
31383 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
31384 "identical to the C API. C++ classes and exceptions are not used."
31388 #: ../src/guestfs.pod:717
31393 #: ../src/guestfs.pod:719
31395 "The C# bindings are highly experimental. Please read the warnings at the "
31396 "top of C<csharp/Libguestfs.cs>."
31400 #: ../src/guestfs.pod:722
31405 #: ../src/guestfs.pod:724
31407 "This is the only language binding that is working but incomplete. Only "
31408 "calls which return simple integers have been bound in Haskell, and we are "
31409 "looking for help to complete this binding."
31413 #: ../src/guestfs.pod:728
31418 #: ../src/guestfs.pod:730
31420 "Full documentation is contained in the Javadoc which is distributed with "
31421 "libguestfs. For examples, see L<guestfs-java(3)>."
31425 #: ../src/guestfs.pod:733
31430 #: ../src/guestfs.pod:735
31431 msgid "See L<guestfs-ocaml(3)>."
31435 #: ../src/guestfs.pod:737
31440 #: ../src/guestfs.pod:739
31441 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
31445 #: ../src/guestfs.pod:741
31450 #: ../src/guestfs.pod:743
31452 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
31453 "the php-libguestfs package for your distribution."
31457 #: ../src/guestfs.pod:746
31458 msgid "The PHP binding only works correctly on 64 bit machines."
31462 #: ../src/guestfs.pod:748
31467 #: ../src/guestfs.pod:750
31468 msgid "See L<guestfs-python(3)>."
31472 #: ../src/guestfs.pod:752
31477 #: ../src/guestfs.pod:754
31478 msgid "See L<guestfs-ruby(3)>."
31482 #: ../src/guestfs.pod:756
31483 msgid "B<shell scripts>"
31487 #: ../src/guestfs.pod:758
31488 msgid "See L<guestfish(1)>."
31492 #: ../src/guestfs.pod:762
31493 msgid "LIBGUESTFS GOTCHAS"
31497 #: ../src/guestfs.pod:764
31499 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
31500 "system [...] that works in the way it is documented but is counterintuitive "
31501 "and almost invites mistakes.\""
31505 #: ../src/guestfs.pod:768
31507 "Since we developed libguestfs and the associated tools, there are several "
31508 "things we would have designed differently, but are now stuck with for "
31509 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
31510 "release, you can expect these to change. Beware of them."
31514 #: ../src/guestfs.pod:776
31515 msgid "Autosync / forgetting to sync."
31519 #: ../src/guestfs.pod:778
31521 "I<Update:> Autosync is enabled by default for all API users starting from "
31522 "libguestfs 1.5.24. This section only applies to older versions."
31526 #: ../src/guestfs.pod:781
31528 "When modifying a filesystem from C or another language, you B<must> unmount "
31529 "all filesystems and call L</guestfs_sync> explicitly before you close the "
31530 "libguestfs handle. You can also call:"
31534 #: ../src/guestfs.pod:785
31537 " guestfs_set_autosync (g, 1);\n"
31542 #: ../src/guestfs.pod:787
31544 "to have the unmount/sync done automatically for you when the handle 'g' is "
31545 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
31550 #: ../src/guestfs.pod:791
31552 "If you forget to do this, then it is entirely possible that your changes "
31553 "won't be written out, or will be partially written, or (very rarely) that "
31554 "you'll get disk corruption."
31558 #: ../src/guestfs.pod:795
31560 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
31561 "guestfish scripts that forget to sync will work just fine, which can make "
31562 "this very puzzling if you are trying to debug a problem."
31566 #: ../src/guestfs.pod:799
31567 msgid "Mount option C<-o sync> should not be the default."
31571 #: ../src/guestfs.pod:801
31573 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
31574 "However C<-o sync> does not add any reliability benefit, but does have a "
31575 "very large performance impact."
31579 #: ../src/guestfs.pod:805
31581 "The work around is to use L</guestfs_mount_options> and set the mount "
31582 "options that you actually want to use."
31586 #: ../src/guestfs.pod:808
31587 msgid "Read-only should be the default."
31591 #: ../src/guestfs.pod:810
31593 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
31594 "specify I<--rw> if you want to make changes to the image."
31598 #: ../src/guestfs.pod:813
31599 msgid "This would reduce the potential to corrupt live VM images."
31603 #: ../src/guestfs.pod:815
31605 "Note that many filesystems change the disk when you just mount and unmount, "
31606 "even if you didn't perform any writes. You need to use "
31607 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
31611 #: ../src/guestfs.pod:819
31612 msgid "guestfish command line is hard to use."
31616 #: ../src/guestfs.pod:821
31618 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
31619 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
31620 "exist, so it fails. In earlier versions of guestfish the error message was "
31621 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
31622 "we should have used C<guestfish -c command> to run commands."
31626 #: ../src/guestfs.pod:828
31627 msgid "guestfish megabyte modifiers don't work right on all commands"
31631 #: ../src/guestfs.pod:830
31633 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
31634 "other modifiers). What guestfish actually does is to multiply the number "
31635 "part by the modifier part and pass the result to the C API. However this "
31636 "doesn't work for a few APIs which aren't expecting bytes, but are already "
31637 "expecting some other unit (eg. megabytes)."
31641 #: ../src/guestfs.pod:837
31642 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
31646 #: ../src/guestfs.pod:839
31649 " lvcreate LV VG 100M\n"
31654 #: ../src/guestfs.pod:841
31656 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
31657 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
31658 "megabytes * megabytes) logical volume. The error message you get from this "
31659 "is also a little obscure."
31663 #: ../src/guestfs.pod:846
31665 "This could be fixed in the generator by specially marking parameters and "
31666 "return values which take bytes or other units."
31670 #: ../src/guestfs.pod:849
31671 msgid "Ambiguity between devices and paths"
31675 #: ../src/guestfs.pod:851
31677 "There is a subtle ambiguity in the API between a device name "
31678 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
31679 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
31683 #: ../src/guestfs.pod:856
31685 "In the current API we usually resolve this ambiguity by having two separate "
31686 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
31687 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
31688 "detecting if the path supplied begins with C</dev/>."
31692 #: ../src/guestfs.pod:862
31694 "To avoid both the ambiguity and the need to duplicate some calls, we could "
31695 "make paths/devices into structured names. One way to do this would be to "
31696 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
31697 "aspect of grub. Another way would be to use a structured type, equivalent "
31698 "to this OCaml type:"
31702 #: ../src/guestfs.pod:868
31705 " type path = Path of string | Device of int | Partition of int * int\n"
31710 #: ../src/guestfs.pod:870
31711 msgid "which would allow you to pass arguments like:"
31715 #: ../src/guestfs.pod:872
31718 " Path \"/foo/bar\"\n"
31719 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
31720 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
31721 " Path \"/dev/sdb2\" (* not a device *)\n"
31726 #: ../src/guestfs.pod:877
31728 "As you can see there are still problems to resolve even with this "
31729 "representation. Also consider how it might work in guestfish."
31733 #: ../src/guestfs.pod:882
31734 msgid "KEYS AND PASSPHRASES"
31738 #: ../src/guestfs.pod:884
31740 "Certain libguestfs calls take a parameter that contains sensitive key "
31741 "material, passed in as a C string."
31745 #: ../src/guestfs.pod:887
31747 "In the future we would hope to change the libguestfs implementation so that "
31748 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
31749 "swap. However this is I<not> done at the moment, because of the complexity "
31750 "of such an implementation."
31754 #: ../src/guestfs.pod:892
31756 "Therefore you should be aware that any key parameter you pass to libguestfs "
31757 "might end up being written out to the swap partition. If this is a concern, "
31758 "scrub the swap partition or don't use libguestfs on encrypted devices."
31762 #: ../src/guestfs.pod:897
31763 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
31767 #: ../src/guestfs.pod:899
31769 "All high-level libguestfs actions are synchronous. If you want to use "
31770 "libguestfs asynchronously then you must create a thread."
31774 #: ../src/guestfs.pod:902
31776 "Only use the handle from a single thread. Either use the handle exclusively "
31777 "from one thread, or provide your own mutex so that two threads cannot issue "
31778 "calls on the same handle at the same time."
31782 #: ../src/guestfs.pod:906
31784 "See the graphical program guestfs-browser for one possible architecture for "
31785 "multithreaded programs using libvirt and libguestfs."
31789 #: ../src/guestfs.pod:909
31794 #: ../src/guestfs.pod:911
31796 "Libguestfs needs a supermin appliance, which it finds by looking along an "
31801 #: ../src/guestfs.pod:914
31803 "By default it looks for these in the directory C<$libdir/guestfs> "
31804 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
31808 #: ../src/guestfs.pod:917
31810 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
31811 "to change the directories that libguestfs will search in. The value is a "
31812 "colon-separated list of paths. The current directory is I<not> searched "
31813 "unless the path contains an empty element or C<.>. For example "
31814 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
31815 "then C</usr/lib/guestfs>."
31819 #: ../src/guestfs.pod:924
31820 msgid "QEMU WRAPPERS"
31824 #: ../src/guestfs.pod:926
31826 "If you want to compile your own qemu, run qemu from a non-standard location, "
31827 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
31832 #: ../src/guestfs.pod:930
31834 "There is one important rule to remember: you I<must C<exec qemu>> as the "
31835 "last command in the shell script (so that qemu replaces the shell and "
31836 "becomes the direct child of the libguestfs-using program). If you don't do "
31837 "this, then the qemu process won't be cleaned up correctly."
31841 #: ../src/guestfs.pod:935
31843 "Here is an example of a wrapper, where I have built my own copy of qemu from "
31848 #: ../src/guestfs.pod:938
31852 " qemudir=/home/rjones/d/qemu\n"
31853 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
31859 #: ../src/guestfs.pod:942
31861 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
31862 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
31867 #: ../src/guestfs.pod:946
31870 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
31875 #: ../src/guestfs.pod:948
31877 "Note that libguestfs also calls qemu with the -help and -version options in "
31878 "order to determine features."
31882 #: ../src/guestfs.pod:951
31883 msgid "ATTACHING TO RUNNING DAEMONS"
31887 #: ../src/guestfs.pod:953
31889 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
31890 "babies. Use with caution."
31894 #: ../src/guestfs.pod:956
31896 "I<Note (2):> This section explains how to attach to a running daemon from a "
31897 "low level perspective. For most users, simply using virt tools such as "
31898 "L<guestfish(1)> with the I<--live> option will \"just work\"."
31902 #: ../src/guestfs.pod:960
31903 msgid "Using guestfs_set_attach_method"
31907 #: ../src/guestfs.pod:962
31909 "By calling L</guestfs_set_attach_method> you can change how the library "
31910 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
31911 "L</ARCHITECTURE> for some background)."
31915 #: ../src/guestfs.pod:966
31917 "The normal attach method is C<appliance>, where a small appliance is created "
31918 "containing the daemon, and then the library connects to this."
31922 #: ../src/guestfs.pod:969
31924 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
31925 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
31926 "daemon over the Unix domain socket."
31930 #: ../src/guestfs.pod:973
31932 "The normal use for this is to connect to a running virtual machine that "
31933 "contains a C<guestfsd> daemon, and send commands so you can read and write "
31934 "files inside the live virtual machine."
31938 #: ../src/guestfs.pod:977
31939 msgid "Using guestfs_add_domain with live flag"
31943 #: ../src/guestfs.pod:979
31945 "L</guestfs_add_domain> provides some help for getting the correct attach "
31946 "method. If you pass the C<live> option to this function, then (if the "
31947 "virtual machine is running) it will examine the libvirt XML looking for a "
31948 "virtio-serial channel to connect to:"
31952 #: ../src/guestfs.pod:985
31959 " <channel type='unix'>\n"
31960 " <source mode='bind' path='/path/to/socket'/>\n"
31961 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
31970 #: ../src/guestfs.pod:997
31972 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
31973 "method to C<unix:/path/to/socket>."
31977 #: ../src/guestfs.pod:1000
31979 "Some of the libguestfs tools (including guestfish) support a I<--live> "
31980 "option which is passed through to L</guestfs_add_domain> thus allowing you "
31981 "to attach to and modify live virtual machines."
31985 #: ../src/guestfs.pod:1004
31987 "The virtual machine needs to have been set up beforehand so that it has the "
31988 "virtio-serial channel and so that guestfsd is running inside it."
31992 #: ../src/guestfs.pod:1008
31993 msgid "ABI GUARANTEE"
31997 #: ../src/guestfs.pod:1010
31999 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32000 "actions as outlined in this section. Although we will deprecate some "
32001 "actions, for example if they get replaced by newer calls, we will keep the "
32002 "old actions forever. This allows you the developer to program in confidence "
32003 "against the libguestfs API."
32007 #: ../src/guestfs.pod:1016
32008 msgid "BLOCK DEVICE NAMING"
32012 #: ../src/guestfs.pod:1018
32014 "In the kernel there is now quite a profusion of schemata for naming block "
32015 "devices (in this context, by I<block device> I mean a physical or virtual "
32016 "hard drive). The original Linux IDE driver used names starting with "
32017 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
32018 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
32019 "replacement for the old IDE driver (particularly for SATA devices) those "
32020 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
32021 "machines with paravirtualized drivers. This has created several different "
32022 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
32027 #: ../src/guestfs.pod:1030
32029 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32030 "Linux kernel to access block devices. We can run a variety of appliances "
32031 "based on a variety of Linux kernels."
32035 #: ../src/guestfs.pod:1034
32037 "This causes a problem for libguestfs because many API calls use device or "
32038 "partition names. Working scripts and the recipe (example) scripts that we "
32039 "make available over the internet could fail if the naming scheme changes."
32043 #: ../src/guestfs.pod:1039
32045 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32046 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32047 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32048 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32052 #: ../src/guestfs.pod:1045
32054 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32055 "L</guestfs_list_partitions> and similar calls return the true names of the "
32056 "devices and partitions as known to the appliance."
32060 #: ../src/guestfs.pod:1050
32061 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32065 #: ../src/guestfs.pod:1052
32067 "Usually this translation is transparent. However in some (very rare) cases "
32068 "you may need to know the exact algorithm. Such cases include where you use "
32069 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
32070 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
32075 #: ../src/guestfs.pod:1058
32077 "The algorithm is applied only to I<parameters> which are known to be either "
32078 "device or partition names. Return values from functions such as "
32079 "L</guestfs_list_devices> are never changed."
32083 #: ../src/guestfs.pod:1066
32084 msgid "Is the string a parameter which is a device or partition name?"
32088 #: ../src/guestfs.pod:1070
32089 msgid "Does the string begin with C</dev/sd>?"
32093 #: ../src/guestfs.pod:1074
32095 "Does the named device exist? If so, we use that device. However if I<not> "
32096 "then we continue with this algorithm."
32100 #: ../src/guestfs.pod:1079
32101 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32105 #: ../src/guestfs.pod:1081
32106 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32110 #: ../src/guestfs.pod:1083
32111 msgid "If that named device exists, use it. If not, continue."
32115 #: ../src/guestfs.pod:1087
32116 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32120 #: ../src/guestfs.pod:1089
32121 msgid "If that named device exists, use it. If not, return an error."
32125 #: ../src/guestfs.pod:1093
32126 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32130 #: ../src/guestfs.pod:1095
32132 "Although the standard naming scheme and automatic translation is useful for "
32133 "simple programs and guestfish scripts, for larger programs it is best not to "
32134 "rely on this mechanism."
32138 #: ../src/guestfs.pod:1099
32140 "Where possible for maximum future portability programs using libguestfs "
32141 "should use these future-proof techniques:"
32145 #: ../src/guestfs.pod:1106
32147 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32148 "device names, and then use those names directly."
32152 #: ../src/guestfs.pod:1109
32153 msgid "Since those device names exist by definition, they will never be translated."
32157 #: ../src/guestfs.pod:1114
32159 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32160 "filesystem labels."
32164 #: ../src/guestfs.pod:1119
32169 #: ../src/guestfs.pod:1121
32171 "This section discusses security implications of using libguestfs, "
32172 "particularly with untrusted or malicious guests or disk images."
32176 #: ../src/guestfs.pod:1124
32177 msgid "GENERAL SECURITY CONSIDERATIONS"
32181 #: ../src/guestfs.pod:1126
32183 "Be careful with any files or data that you download from a guest (by "
32184 "\"download\" we mean not just the L</guestfs_download> command but any "
32185 "command that reads files, filenames, directories or anything else from a "
32186 "disk image). An attacker could manipulate the data to fool your program "
32187 "into doing the wrong thing. Consider cases such as:"
32191 #: ../src/guestfs.pod:1136
32192 msgid "the data (file etc) not being present"
32196 #: ../src/guestfs.pod:1140
32197 msgid "being present but empty"
32201 #: ../src/guestfs.pod:1144
32202 msgid "being much larger than normal"
32206 #: ../src/guestfs.pod:1148
32207 msgid "containing arbitrary 8 bit data"
32211 #: ../src/guestfs.pod:1152
32212 msgid "being in an unexpected character encoding"
32216 #: ../src/guestfs.pod:1156
32217 msgid "containing homoglyphs."
32221 #: ../src/guestfs.pod:1160
32222 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32226 #: ../src/guestfs.pod:1162
32228 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32229 "(VFS) module can sometimes be escalated into exploits by deliberately "
32230 "creating a malicious, malformed filesystem. These exploits are very severe "
32231 "for two reasons. Firstly there are very many filesystem drivers in the "
32232 "kernel, and many of them are infrequently used and not much developer "
32233 "attention has been paid to the code. Linux userspace helps potential "
32234 "crackers by detecting the filesystem type and automatically choosing the "
32235 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32236 "the administrator. Secondly, a kernel-level exploit is like a local root "
32237 "exploit (worse in some ways), giving immediate and total access to the "
32238 "system right down to the hardware level."
32242 #: ../src/guestfs.pod:1175
32244 "That explains why you should never mount a filesystem from an untrusted "
32245 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32246 "inside a qemu virtual machine, usually running as a non-root user. The "
32247 "attacker would need to write a filesystem which first exploited the kernel, "
32248 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32249 "the libguestfs protocol, and finally to be as serious as the host kernel "
32250 "exploit it would need to escalate its privileges to root. This multi-step "
32251 "escalation, performed by a static piece of data, is thought to be extremely "
32252 "hard to do, although we never say 'never' about security issues."
32256 #: ../src/guestfs.pod:1186
32258 "In any case callers can reduce the attack surface by forcing the filesystem "
32259 "type when mounting (use L</guestfs_mount_vfs>)."
32263 #: ../src/guestfs.pod:1189
32264 msgid "PROTOCOL SECURITY"
32268 #: ../src/guestfs.pod:1191
32270 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32271 "defined upper message size. However a program that uses libguestfs must "
32272 "also take care - for example you can write a program that downloads a binary "
32273 "from a disk image and executes it locally, and no amount of protocol "
32274 "security will save you from the consequences."
32278 #: ../src/guestfs.pod:1197
32279 msgid "INSPECTION SECURITY"
32283 #: ../src/guestfs.pod:1199
32285 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32286 "directly from the guest, and these could contain any 8 bit data. Callers "
32287 "should be careful to escape these before printing them to a structured file "
32288 "(for example, use HTML escaping if creating a web page)."
32292 #: ../src/guestfs.pod:1205
32294 "Guest configuration may be altered in unusual ways by the administrator of "
32295 "the virtual machine, and may not reflect reality (particularly for untrusted "
32296 "or actively malicious guests). For example we parse the hostname from "
32297 "configuration files like C</etc/sysconfig/network> that we find in the "
32298 "guest, but the guest administrator can easily manipulate these files to "
32299 "provide the wrong hostname."
32303 #: ../src/guestfs.pod:1213
32305 "The inspection API parses guest configuration using two external libraries: "
32306 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32307 "designed to be robust in the face of malicious data, although denial of "
32308 "service attacks are still possible, for example with oversized configuration "
32313 #: ../src/guestfs.pod:1219
32314 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
32318 #: ../src/guestfs.pod:1221
32320 "Be very cautious about running commands from the guest. By running a "
32321 "command in the guest, you are giving CPU time to a binary that you do not "
32322 "control, under the same user account as the library, albeit wrapped in qemu "
32323 "virtualization. More information and alternatives can be found in the "
32324 "section L</RUNNING COMMANDS>."
32328 #: ../src/guestfs.pod:1227
32329 msgid "CVE-2010-3851"
32333 #: ../src/guestfs.pod:1229
32334 msgid "https://bugzilla.redhat.com/642934"
32338 #: ../src/guestfs.pod:1231
32340 "This security bug concerns the automatic disk format detection that qemu "
32341 "does on disk images."
32345 #: ../src/guestfs.pod:1234
32347 "A raw disk image is just the raw bytes, there is no header. Other disk "
32348 "images like qcow2 contain a special header. Qemu deals with this by looking "
32349 "for one of the known headers, and if none is found then assuming the disk "
32350 "image must be raw."
32354 #: ../src/guestfs.pod:1239
32356 "This allows a guest which has been given a raw disk image to write some "
32357 "other header. At next boot (or when the disk image is accessed by "
32358 "libguestfs) qemu would do autodetection and think the disk image format was, "
32359 "say, qcow2 based on the header written by the guest."
32363 #: ../src/guestfs.pod:1244
32365 "This in itself would not be a problem, but qcow2 offers many features, one "
32366 "of which is to allow a disk image to refer to another image (called the "
32367 "\"backing disk\"). It does this by placing the path to the backing disk "
32368 "into the qcow2 header. This path is not validated and could point to any "
32369 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
32370 "\"holes\" in the qcow2 disk image, which of course is completely under the "
32371 "control of the attacker."
32375 #: ../src/guestfs.pod:1252
32376 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
32380 #: ../src/guestfs.pod:1259
32381 msgid "You have enabled the network or have opened the disk in write mode."
32385 #: ../src/guestfs.pod:1263
32387 "You are also running untrusted code from the guest (see L</RUNNING "
32392 #: ../src/guestfs.pod:1268
32394 "The way to avoid this is to specify the expected disk format when adding "
32395 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
32396 "should always do this if the disk is raw format, and it's a good idea for "
32401 #: ../src/guestfs.pod:1273
32403 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
32404 "format is fetched from libvirt and passed through."
32408 #: ../src/guestfs.pod:1276
32410 "For libguestfs tools, use the I<--format> command line parameter as "
32415 #: ../src/guestfs.pod:1279
32416 msgid "CONNECTION MANAGEMENT"
32420 #: ../src/guestfs.pod:1281
32421 msgid "guestfs_h *"
32425 #: ../src/guestfs.pod:1283
32427 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
32428 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
32429 "handle and release all resources used."
32433 #: ../src/guestfs.pod:1287
32435 "For information on using multiple handles and threads, see the section "
32436 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
32440 #: ../src/guestfs.pod:1290
32441 msgid "guestfs_create"
32445 #: ../src/guestfs.pod:1292
32448 " guestfs_h *guestfs_create (void);\n"
32453 #: ../src/guestfs.pod:1294
32454 msgid "Create a connection handle."
32458 #: ../src/guestfs.pod:1296
32460 "On success this returns a non-NULL pointer to a handle. On error it returns "
32465 #: ../src/guestfs.pod:1299
32467 "You have to \"configure\" the handle after creating it. This includes "
32468 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
32469 "handle at least once."
32473 #: ../src/guestfs.pod:1303
32474 msgid "After configuring the handle, you have to call L</guestfs_launch>."
32478 #: ../src/guestfs.pod:1305
32480 "You may also want to configure error handling for the handle. See the "
32481 "L</ERROR HANDLING> section below."
32485 #: ../src/guestfs.pod:1308
32486 msgid "guestfs_close"
32490 #: ../src/guestfs.pod:1310
32493 " void guestfs_close (guestfs_h *g);\n"
32498 #: ../src/guestfs.pod:1312
32499 msgid "This closes the connection handle and frees up all resources used."
32503 #: ../src/guestfs.pod:1314
32505 "If autosync was set on the handle and the handle was launched, then this "
32506 "implicitly calls various functions to unmount filesystems and sync the "
32507 "disk. See L</guestfs_set_autosync> for more details."
32511 #: ../src/guestfs.pod:1318
32512 msgid "If a close callback was set on the handle, then it is called."
32516 #: ../src/guestfs.pod:1320
32517 msgid "ERROR HANDLING"
32521 #: ../src/guestfs.pod:1322
32523 "API functions can return errors. For example, almost all functions that "
32524 "return C<int> will return C<-1> to indicate an error."
32528 #: ../src/guestfs.pod:1325
32530 "Additional information is available for errors: an error message string and "
32531 "optionally an error number (errno) if the thing that failed was a system "
32536 #: ../src/guestfs.pod:1329
32538 "You can get at the additional information about the last error on the handle "
32539 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
32540 "up an error handler with L</guestfs_set_error_handler>."
32544 #: ../src/guestfs.pod:1334
32546 "When the handle is created, a default error handler is installed which "
32547 "prints the error message string to C<stderr>. For small short-running "
32548 "command line programs it is sufficient to do:"
32552 #: ../src/guestfs.pod:1338
32555 " if (guestfs_launch (g) == -1)\n"
32556 " exit (EXIT_FAILURE);\n"
32561 #: ../src/guestfs.pod:1341
32563 "since the default error handler will ensure that an error message has been "
32564 "printed to C<stderr> before the program exits."
32568 #: ../src/guestfs.pod:1344
32570 "For other programs the caller will almost certainly want to install an "
32571 "alternate error handler or do error handling in-line like this:"
32575 #: ../src/guestfs.pod:1347
32578 " g = guestfs_create ();\n"
32583 #: ../src/guestfs.pod:1349
32586 " /* This disables the default behaviour of printing errors\n"
32588 " guestfs_set_error_handler (g, NULL, NULL);\n"
32593 #: ../src/guestfs.pod:1353
32596 " if (guestfs_launch (g) == -1) {\n"
32597 " /* Examine the error message and print it etc. */\n"
32598 " char *msg = guestfs_last_error (g);\n"
32599 " int errnum = guestfs_last_errno (g);\n"
32600 " fprintf (stderr, \"%s\\n\", msg);\n"
32607 #: ../src/guestfs.pod:1361
32609 "Out of memory errors are handled differently. The default action is to call "
32610 "L<abort(3)>. If this is undesirable, then you can set a handler using "
32611 "L</guestfs_set_out_of_memory_handler>."
32615 #: ../src/guestfs.pod:1365
32617 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
32618 "because there is no handle if this happens there is no way to get additional "
32619 "error information. However L</guestfs_create> is supposed to be a "
32620 "lightweight operation which can only fail because of insufficient memory (it "
32621 "returns NULL in this case)."
32625 #: ../src/guestfs.pod:1371
32626 msgid "guestfs_last_error"
32630 #: ../src/guestfs.pod:1373
32633 " const char *guestfs_last_error (guestfs_h *g);\n"
32638 #: ../src/guestfs.pod:1375
32640 "This returns the last error message that happened on C<g>. If there has not "
32641 "been an error since the handle was created, then this returns C<NULL>."
32645 #: ../src/guestfs.pod:1379
32647 "The lifetime of the returned string is until the next error occurs, or "
32648 "L</guestfs_close> is called."
32652 #: ../src/guestfs.pod:1382
32653 msgid "guestfs_last_errno"
32657 #: ../src/guestfs.pod:1384
32660 " int guestfs_last_errno (guestfs_h *g);\n"
32665 #: ../src/guestfs.pod:1386
32666 msgid "This returns the last error number (errno) that happened on C<g>."
32670 #: ../src/guestfs.pod:1388
32671 msgid "If successful, an errno integer not equal to zero is returned."
32675 #: ../src/guestfs.pod:1390
32676 msgid "If no error, this returns 0. This call can return 0 in three situations:"
32680 #: ../src/guestfs.pod:1397
32681 msgid "There has not been any error on the handle."
32685 #: ../src/guestfs.pod:1401
32687 "There has been an error but the errno was meaningless. This corresponds to "
32688 "the case where the error did not come from a failed system call, but for "
32689 "some other reason."
32693 #: ../src/guestfs.pod:1407
32695 "There was an error from a failed system call, but for some reason the errno "
32696 "was not captured and returned. This usually indicates a bug in libguestfs."
32700 #: ../src/guestfs.pod:1413
32702 "Libguestfs tries to convert the errno from inside the applicance into a "
32703 "corresponding errno for the caller (not entirely trivial: the appliance "
32704 "might be running a completely different operating system from the library "
32705 "and error numbers are not standardized across Un*xen). If this could not be "
32706 "done, then the error is translated to C<EINVAL>. In practice this should "
32707 "only happen in very rare circumstances."
32711 #: ../src/guestfs.pod:1421
32712 msgid "guestfs_set_error_handler"
32716 #: ../src/guestfs.pod:1423
32719 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
32721 " const char *msg);\n"
32722 " void guestfs_set_error_handler (guestfs_h *g,\n"
32723 " guestfs_error_handler_cb cb,\n"
32724 " void *opaque);\n"
32729 #: ../src/guestfs.pod:1430
32731 "The callback C<cb> will be called if there is an error. The parameters "
32732 "passed to the callback are an opaque data pointer and the error message "
32737 #: ../src/guestfs.pod:1434
32739 "C<errno> is not passed to the callback. To get that the callback must call "
32740 "L</guestfs_last_errno>."
32744 #: ../src/guestfs.pod:1437
32746 "Note that the message string C<msg> is freed as soon as the callback "
32747 "function returns, so if you want to stash it somewhere you must make your "
32752 #: ../src/guestfs.pod:1441
32753 msgid "The default handler prints messages on C<stderr>."
32757 #: ../src/guestfs.pod:1443
32758 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
32762 #: ../src/guestfs.pod:1445
32763 msgid "guestfs_get_error_handler"
32767 #: ../src/guestfs.pod:1447
32770 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
32771 " void **opaque_rtn);\n"
32776 #: ../src/guestfs.pod:1450
32777 msgid "Returns the current error handler callback."
32781 #: ../src/guestfs.pod:1452
32782 msgid "guestfs_set_out_of_memory_handler"
32786 #: ../src/guestfs.pod:1454
32789 " typedef void (*guestfs_abort_cb) (void);\n"
32790 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
32791 " guestfs_abort_cb);\n"
32796 #: ../src/guestfs.pod:1458
32798 "The callback C<cb> will be called if there is an out of memory situation. "
32799 "I<Note this callback must not return>."
32803 #: ../src/guestfs.pod:1461
32804 msgid "The default is to call L<abort(3)>."
32808 #: ../src/guestfs.pod:1463
32809 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
32813 #: ../src/guestfs.pod:1466
32814 msgid "guestfs_get_out_of_memory_handler"
32818 #: ../src/guestfs.pod:1468
32821 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
32826 #: ../src/guestfs.pod:1470
32827 msgid "This returns the current out of memory handler."
32831 #: ../src/guestfs.pod:1472
32836 #: ../src/guestfs.pod:1476
32841 #: ../src/guestfs.pod:1478
32846 #: ../src/guestfs.pod:1480
32847 msgid "AVAILABILITY"
32851 #: ../src/guestfs.pod:1482
32852 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
32856 #: ../src/guestfs.pod:1484
32858 "Using L</guestfs_available> you can test availability of the following "
32859 "groups of functions. This test queries the appliance to see if the "
32860 "appliance you are currently using supports the functionality."
32864 #: ../src/guestfs.pod:1489
32865 msgid "@AVAILABILITY@"
32869 #: ../src/guestfs.pod:1491
32870 msgid "GUESTFISH supported COMMAND"
32874 #: ../src/guestfs.pod:1493
32876 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
32877 "prints out the available groups and whether they are supported by this build "
32878 "of libguestfs. Note however that you have to do C<run> first."
32882 #: ../src/guestfs.pod:1498
32883 msgid "SINGLE CALLS AT COMPILE TIME"
32887 #: ../src/guestfs.pod:1500
32889 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
32890 "function, such as:"
32894 #: ../src/guestfs.pod:1503
32897 " #define LIBGUESTFS_HAVE_DD 1\n"
32902 #: ../src/guestfs.pod:1505
32903 msgid "if L</guestfs_dd> is available."
32907 #: ../src/guestfs.pod:1507
32909 "Before version 1.5.8, if you needed to test whether a single libguestfs "
32910 "function is available at compile time, we recommended using build tools such "
32911 "as autoconf or cmake. For example in autotools you could use:"
32915 #: ../src/guestfs.pod:1512
32918 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
32919 " AC_CHECK_FUNCS([guestfs_dd])\n"
32924 #: ../src/guestfs.pod:1515
32926 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
32931 #: ../src/guestfs.pod:1518
32932 msgid "SINGLE CALLS AT RUN TIME"
32936 #: ../src/guestfs.pod:1520
32938 "Testing at compile time doesn't guarantee that a function really exists in "
32939 "the library. The reason is that you might be dynamically linked against a "
32940 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
32941 "This situation unfortunately results in a segmentation fault, which is a "
32942 "shortcoming of the C dynamic linking system itself."
32946 #: ../src/guestfs.pod:1527
32948 "You can use L<dlopen(3)> to test if a function is available at run time, as "
32949 "in this example program (note that you still need the compile time check as "
32954 #: ../src/guestfs.pod:1531
32957 " #include <stdio.h>\n"
32958 " #include <stdlib.h>\n"
32959 " #include <unistd.h>\n"
32960 " #include <dlfcn.h>\n"
32961 " #include <guestfs.h>\n"
32966 #: ../src/guestfs.pod:1537
32971 " #ifdef LIBGUESTFS_HAVE_DD\n"
32973 " int has_function;\n"
32978 #: ../src/guestfs.pod:1543
32981 " /* Test if the function guestfs_dd is really available. */\n"
32982 " dl = dlopen (NULL, RTLD_LAZY);\n"
32984 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
32985 " exit (EXIT_FAILURE);\n"
32987 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
32993 #: ../src/guestfs.pod:1552
32996 " if (!has_function)\n"
32997 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
32999 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33000 " /* Now it's safe to call\n"
33001 " guestfs_dd (g, \"foo\", \"bar\");\n"
33005 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33012 #: ../src/guestfs.pod:1565
33014 "You may think the above is an awful lot of hassle, and it is. There are "
33015 "other ways outside of the C linking system to ensure that this kind of "
33016 "incompatibility never arises, such as using package versioning:"
33020 #: ../src/guestfs.pod:1570
33023 " Requires: libguestfs >= 1.0.80\n"
33028 #: ../src/guestfs.pod:1572
33029 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33033 #: ../src/guestfs.pod:1574
33035 "A recent feature of the API is the introduction of calls which take optional "
33036 "arguments. In C these are declared 3 ways. The main way is as a call which "
33037 "takes variable arguments (ie. C<...>), as in this example:"
33041 #: ../src/guestfs.pod:1579
33044 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33049 #: ../src/guestfs.pod:1581
33051 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33052 "call with no optional arguments specified:"
33056 #: ../src/guestfs.pod:1584
33059 " guestfs_add_drive_opts (g, filename, -1);\n"
33064 #: ../src/guestfs.pod:1586
33065 msgid "With a single optional argument:"
33069 #: ../src/guestfs.pod:1588
33072 " guestfs_add_drive_opts (g, filename,\n"
33073 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33079 #: ../src/guestfs.pod:1592
33084 #: ../src/guestfs.pod:1594
33087 " guestfs_add_drive_opts (g, filename,\n"
33088 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33089 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33095 #: ../src/guestfs.pod:1599
33097 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33102 #: ../src/guestfs.pod:1602
33103 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33107 #: ../src/guestfs.pod:1604
33109 "The second variant has the same name with the suffix C<_va>, which works the "
33110 "same way but takes a C<va_list>. See the C manual for details. For the "
33111 "example function, this is declared:"
33115 #: ../src/guestfs.pod:1608
33118 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33119 " va_list args);\n"
33124 #: ../src/guestfs.pod:1611
33125 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33129 #: ../src/guestfs.pod:1613
33131 "The third variant is useful where you need to construct these calls. You "
33132 "pass in a structure where you fill in the optional fields. The structure "
33133 "has a bitmask as the first element which you must set to indicate which "
33134 "fields you have filled in. For our example function the structure and call "
33139 #: ../src/guestfs.pod:1619
33142 " struct guestfs_add_drive_opts_argv {\n"
33143 " uint64_t bitmask;\n"
33145 " const char *format;\n"
33148 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33149 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33154 #: ../src/guestfs.pod:1628
33155 msgid "You could call it like this:"
33159 #: ../src/guestfs.pod:1630
33162 " struct guestfs_add_drive_opts_argv optargs = {\n"
33163 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33164 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33165 " .readonly = 1,\n"
33166 " .format = \"qcow2\"\n"
33172 #: ../src/guestfs.pod:1637
33175 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33180 #: ../src/guestfs.pod:1645
33181 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33185 #: ../src/guestfs.pod:1650
33186 msgid "You do not need to fill in all fields of the structure."
33190 #: ../src/guestfs.pod:1654
33192 "There must be a one-to-one correspondence between fields of the structure "
33193 "that are filled in, and bits set in the bitmask."
33197 #: ../src/guestfs.pod:1659
33198 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33202 #: ../src/guestfs.pod:1661
33204 "In other languages, optional arguments are expressed in the way that is "
33205 "natural for that language. We refer you to the language-specific "
33206 "documentation for more details on that."
33210 #: ../src/guestfs.pod:1665
33211 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33215 #: ../src/guestfs.pod:1667
33216 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33220 #: ../src/guestfs.pod:1669
33222 "B<Note:> This section documents the generic event mechanism introduced in "
33223 "libguestfs 1.10, which you should use in new code if possible. The old "
33224 "functions C<guestfs_set_log_message_callback>, "
33225 "C<guestfs_set_subprocess_quit_callback>, "
33226 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33227 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33228 "page. Because of the ABI guarantee, the old functions continue to work."
33232 #: ../src/guestfs.pod:1678
33234 "Handles generate events when certain things happen, such as log messages "
33235 "being generated, progress messages during long-running operations, or the "
33236 "handle being closed. The API calls described below let you register a "
33237 "callback to be called when events happen. You can register multiple "
33238 "callbacks (for the same, different or overlapping sets of events), and "
33239 "individually remove callbacks. If callbacks are not removed, then they "
33240 "remain in force until the handle is closed."
33244 #: ../src/guestfs.pod:1686
33246 "In the current implementation, events are only generated synchronously: that "
33247 "means that events (and hence callbacks) can only happen while you are in the "
33248 "middle of making another libguestfs call. The callback is called in the "
33253 #: ../src/guestfs.pod:1691
33255 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33256 "unsigned integers, or a message buffer. Payloads are discussed later on."
33260 #: ../src/guestfs.pod:1695
33261 msgid "CLASSES OF EVENTS"
33265 #: ../src/guestfs.pod:1699
33266 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33270 #: ../src/guestfs.pod:1702
33272 "The callback function will be called while the handle is being closed "
33273 "(synchronously from L</guestfs_close>)."
33277 #: ../src/guestfs.pod:1705
33279 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33280 "handles that are open when the program exits. This means that this callback "
33281 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33282 "problems in higher-level languages (eg. if your HLL interpreter has already "
33283 "been cleaned up by the time this is called, and if your callback then jumps "
33284 "into some HLL function)."
33288 #: ../src/guestfs.pod:1712
33290 "If no callback is registered: the handle is closed without any callback "
33295 #: ../src/guestfs.pod:1715
33296 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33300 #: ../src/guestfs.pod:1718
33302 "The callback function will be called when the child process quits, either "
33303 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33304 "corresponds to a transition from any state to the CONFIG state)."
33308 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
33309 msgid "If no callback is registered: the event is ignored."
33313 #: ../src/guestfs.pod:1724
33314 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
33318 #: ../src/guestfs.pod:1727
33320 "The callback function will be called when the child process becomes ready "
33321 "first time after it has been launched. (This corresponds to a transition "
33322 "from LAUNCHING to the READY state)."
33326 #: ../src/guestfs.pod:1733
33327 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
33331 #: ../src/guestfs.pod:1736
33333 "Some long-running operations can generate progress messages. If this "
33334 "callback is registered, then it will be called each time a progress message "
33335 "is generated (usually two seconds after the operation started, and three "
33336 "times per second thereafter until it completes, although the frequency may "
33337 "change in future versions)."
33341 #: ../src/guestfs.pod:1742
33343 "The callback receives in the payload four unsigned 64 bit numbers which are "
33344 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
33348 #: ../src/guestfs.pod:1745
33350 "The units of C<total> are not defined, although for some operations C<total> "
33351 "may relate in some way to the amount of data to be transferred (eg. in bytes "
33352 "or megabytes), and C<position> may be the portion which has been "
33357 #: ../src/guestfs.pod:1750
33358 msgid "The only defined and stable parts of the API are:"
33362 #: ../src/guestfs.pod:1756
33364 "The callback can display to the user some type of progress bar or indicator "
33365 "which shows the ratio of C<position>:C<total>."
33369 #: ../src/guestfs.pod:1761
33370 msgid "0 E<lt>= C<position> E<lt>= C<total>"
33374 #: ../src/guestfs.pod:1765
33376 "If any progress notification is sent during a call, then a final progress "
33377 "notification is always sent when C<position> = C<total> (I<unless> the call "
33378 "fails with an error)."
33382 #: ../src/guestfs.pod:1769
33384 "This is to simplify caller code, so callers can easily set the progress "
33385 "indicator to \"100%\" at the end of the operation, without requiring special "
33386 "code to detect this case."
33390 #: ../src/guestfs.pod:1775
33392 "For some calls we are unable to estimate the progress of the call, but we "
33393 "can still generate progress messages to indicate activity. This is known as "
33394 "\"pulse mode\", and is directly supported by certain progress bar "
33395 "implementations (eg. GtkProgressBar)."
33399 #: ../src/guestfs.pod:1780
33401 "For these calls, zero or more progress messages are generated with "
33402 "C<position = 0> and C<total = 1>, followed by a final message with "
33403 "C<position = total = 1>."
33407 #: ../src/guestfs.pod:1784
33409 "As noted above, if the call fails with an error then the final message may "
33410 "not be generated."
33414 #: ../src/guestfs.pod:1789
33416 "The callback also receives the procedure number (C<proc_nr>) and serial "
33417 "number (C<serial>) of the call. These are only useful for debugging "
33418 "protocol issues, and the callback can normally ignore them. The callback "
33419 "may want to print these numbers in error messages or debugging messages."
33423 #: ../src/guestfs.pod:1795
33424 msgid "If no callback is registered: progress messages are discarded."
33428 #: ../src/guestfs.pod:1797
33429 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
33433 #: ../src/guestfs.pod:1800
33435 "The callback function is called whenever a log message is generated by qemu, "
33436 "the appliance kernel, guestfsd (daemon), or utility programs."
33440 #: ../src/guestfs.pod:1803
33442 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
33443 "(L</guestfs_launch>) then additional debug messages are generated."
33447 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
33449 "If no callback is registered: the messages are discarded unless the verbose "
33450 "flag is set in which case they are sent to stderr. You can override the "
33451 "printing of verbose messages to stderr by setting up a callback."
33455 #: ../src/guestfs.pod:1811
33456 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
33460 #: ../src/guestfs.pod:1814
33462 "The callback function is called whenever a log message is generated by the "
33463 "library part of libguestfs."
33467 #: ../src/guestfs.pod:1817
33469 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
33470 "messages are generated."
33474 #: ../src/guestfs.pod:1825
33475 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
33479 #: ../src/guestfs.pod:1828
33481 "The callback function is called whenever a trace message is generated. This "
33482 "only applies if the trace flag (L</guestfs_set_trace>) is set."
33486 #: ../src/guestfs.pod:1831
33488 "If no callback is registered: the messages are sent to stderr. You can "
33489 "override the printing of trace messages to stderr by setting up a callback."
33493 #: ../src/guestfs.pod:1837
33494 msgid "guestfs_set_event_callback"
33498 #: ../src/guestfs.pod:1839
33501 " int guestfs_set_event_callback (guestfs_h *g,\n"
33502 " guestfs_event_callback cb,\n"
33503 " uint64_t event_bitmask,\n"
33505 " void *opaque);\n"
33510 #: ../src/guestfs.pod:1845
33512 "This function registers a callback (C<cb>) for all event classes in the "
33513 "C<event_bitmask>."
33517 #: ../src/guestfs.pod:1848
33519 "For example, to register for all log message events, you could call this "
33520 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
33521 "To register a single callback for all possible classes of events, use "
33522 "C<GUESTFS_EVENT_ALL>."
33526 #: ../src/guestfs.pod:1854
33527 msgid "C<flags> should always be passed as 0."
33531 #: ../src/guestfs.pod:1856
33533 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
33534 "it for any purpose."
33538 #: ../src/guestfs.pod:1859
33540 "The return value is the event handle (an integer) which you can use to "
33541 "delete the callback (see below)."
33545 #: ../src/guestfs.pod:1862
33547 "If there is an error, this function returns C<-1>, and sets the error in the "
33548 "handle in the usual way (see L</guestfs_last_error> etc.)"
33552 #: ../src/guestfs.pod:1865
33554 "Callbacks remain in effect until they are deleted, or until the handle is "
33559 #: ../src/guestfs.pod:1868
33561 "In the case where multiple callbacks are registered for a particular event "
33562 "class, all of the callbacks are called. The order in which multiple "
33563 "callbacks are called is not defined."
33567 #: ../src/guestfs.pod:1872
33568 msgid "guestfs_delete_event_callback"
33572 #: ../src/guestfs.pod:1874
33575 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
33580 #: ../src/guestfs.pod:1876
33582 "Delete a callback that was previously registered. C<event_handle> should be "
33583 "the integer that was returned by a previous call to "
33584 "C<guestfs_set_event_callback> on the same handle."
33588 #: ../src/guestfs.pod:1880
33589 msgid "guestfs_event_callback"
33593 #: ../src/guestfs.pod:1882
33596 " typedef void (*guestfs_event_callback) (\n"
33599 " uint64_t event,\n"
33600 " int event_handle,\n"
33602 " const char *buf, size_t buf_len,\n"
33603 " const uint64_t *array, size_t array_len);\n"
33608 #: ../src/guestfs.pod:1891
33609 msgid "This is the type of the event callback function that you have to provide."
33613 #: ../src/guestfs.pod:1894
33615 "The basic parameters are: the handle (C<g>), the opaque user pointer "
33616 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
33617 "handle, and C<flags> which in the current API you should ignore."
33621 #: ../src/guestfs.pod:1898
33623 "The remaining parameters contain the event payload (if any). Each event may "
33624 "contain a payload, which usually relates to the event class, but for future "
33625 "proofing your code should be written to handle any payload for any event "
33630 #: ../src/guestfs.pod:1903
33632 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
33633 "there is no message buffer). Note that this message buffer can contain "
33634 "arbitrary 8 bit data, including NUL bytes."
33638 #: ../src/guestfs.pod:1907
33640 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
33641 "moment this is only used for progress messages."
33645 #: ../src/guestfs.pod:1910
33646 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
33650 #: ../src/guestfs.pod:1912
33652 "One motivation for the generic event API was to allow GUI programs to "
33653 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
33654 "unconditionally to C<stderr>."
33658 #: ../src/guestfs.pod:1916
33660 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
33661 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
33662 "messages are not events; you must capture error messages separately)."
33666 #: ../src/guestfs.pod:1921
33668 "Programs have to set up a callback to capture the classes of events of "
33673 #: ../src/guestfs.pod:1924
33677 " guestfs_set_event_callback\n"
33678 " (g, message_callback,\n"
33679 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
33680 " GUESTFS_EVENT_TRACE,\n"
33681 " 0, NULL) == -1)\n"
33682 " if (eh == -1) {\n"
33683 " // handle error in the usual way\n"
33689 #: ../src/guestfs.pod:1934
33691 "The callback can then direct messages to the appropriate place. In this "
33692 "example, messages are directed to syslog:"
33696 #: ../src/guestfs.pod:1937
33700 " message_callback (\n"
33703 " uint64_t event,\n"
33704 " int event_handle,\n"
33706 " const char *buf, size_t buf_len,\n"
33707 " const uint64_t *array, size_t array_len)\n"
33709 " const int priority = LOG_USER|LOG_INFO;\n"
33710 " if (buf_len > 0)\n"
33711 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
33717 #: ../src/guestfs.pod:1952
33718 msgid "CANCELLING LONG TRANSFERS"
33722 #: ../src/guestfs.pod:1954
33724 "Some operations can be cancelled by the caller while they are in progress. "
33725 "Currently only operations that involve uploading or downloading data can be "
33726 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
33727 "parameters in the generator)."
33731 #: ../src/guestfs.pod:1959
33732 msgid "guestfs_user_cancel"
33736 #: ../src/guestfs.pod:1961
33739 " void guestfs_user_cancel (guestfs_h *g);\n"
33744 #: ../src/guestfs.pod:1963
33745 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
33749 #: ../src/guestfs.pod:1966
33751 "Unlike most other libguestfs calls, this function is signal safe and thread "
33752 "safe. You can call it from a signal handler or from another thread, without "
33753 "needing to do any locking."
33757 #: ../src/guestfs.pod:1970
33759 "The transfer that was in progress (if there is one) will stop shortly "
33760 "afterwards, and will return an error. The errno (see "
33761 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
33762 "out if the operation was cancelled or failed because of another error."
33766 #: ../src/guestfs.pod:1976
33768 "No cleanup is performed: for example, if a file was being uploaded then "
33769 "after cancellation there may be a partially uploaded file. It is the "
33770 "caller's responsibility to clean up if necessary."
33774 #: ../src/guestfs.pod:1980
33775 msgid "There are two common places that you might call C<guestfs_user_cancel>."
33779 #: ../src/guestfs.pod:1982
33781 "In an interactive text-based program, you might call it from a C<SIGINT> "
33782 "signal handler so that pressing C<^C> cancels the current operation. (You "
33783 "also need to call L</guestfs_set_pgroup> so that child processes don't "
33784 "receive the C<^C> signal)."
33788 #: ../src/guestfs.pod:1987
33790 "In a graphical program, when the main thread is displaying a progress bar "
33791 "with a cancel button, wire up the cancel button to call this function."
33795 #: ../src/guestfs.pod:1991
33796 msgid "PRIVATE DATA AREA"
33800 #: ../src/guestfs.pod:1993
33802 "You can attach named pieces of private data to the libguestfs handle, fetch "
33803 "them by name, and walk over them, for the lifetime of the handle. This is "
33804 "called the private data area and is only available from the C API."
33808 #: ../src/guestfs.pod:1998
33809 msgid "To attach a named piece of data, use the following call:"
33813 #: ../src/guestfs.pod:2000
33816 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
33821 #: ../src/guestfs.pod:2002
33823 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
33824 "pointer (which can be C<NULL>). Any previous item with the same key is "
33829 #: ../src/guestfs.pod:2006
33831 "You can use any C<key> you want, but your key should I<not> start with an "
33832 "underscore character. Keys beginning with an underscore character are "
33833 "reserved for internal libguestfs purposes (eg. for implementing language "
33834 "bindings). It is recommended that you prefix the key with some unique "
33835 "string to avoid collisions with other users."
33839 #: ../src/guestfs.pod:2012
33840 msgid "To retrieve the pointer, use:"
33844 #: ../src/guestfs.pod:2014
33847 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
33852 #: ../src/guestfs.pod:2016
33854 "This function returns C<NULL> if either no data is found associated with "
33855 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
33860 #: ../src/guestfs.pod:2020
33862 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
33863 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
33864 "all. In particular, libguestfs does I<not> try to free the data when the "
33865 "handle is closed. If the data must be freed, then the caller must either "
33866 "free it before calling L</guestfs_close> or must set up a close callback to "
33867 "do it (see L</GUESTFS_EVENT_CLOSE>)."
33871 #: ../src/guestfs.pod:2027
33872 msgid "To walk over all entries, use these two functions:"
33876 #: ../src/guestfs.pod:2029
33879 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
33884 #: ../src/guestfs.pod:2031
33887 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
33892 #: ../src/guestfs.pod:2033
33894 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
33895 "not have any particular meaning -- keys are not returned in any defined "
33896 "order). A pointer to the key is returned in C<*key_rtn> and the "
33897 "corresponding data pointer is returned from the function. C<NULL> is "
33898 "returned if there are no keys stored in the handle."
33902 #: ../src/guestfs.pod:2039
33904 "C<guestfs_next_private> returns the next key, pointer pair. The return "
33905 "value of this function is also C<NULL> is there are no further entries to "
33910 #: ../src/guestfs.pod:2043
33911 msgid "Notes about walking over entries:"
33915 #: ../src/guestfs.pod:2049
33916 msgid "You must not call C<guestfs_set_private> while walking over the entries."
33920 #: ../src/guestfs.pod:2054
33922 "The handle maintains an internal iterator which is reset when you call "
33923 "C<guestfs_first_private>. This internal iterator is invalidated when you "
33924 "call C<guestfs_set_private>."
33928 #: ../src/guestfs.pod:2060
33929 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
33933 #: ../src/guestfs.pod:2062
33936 " guestfs_set_private (g, key, NULL);\n"
33941 #: ../src/guestfs.pod:2064
33942 msgid "then that C<key> is not returned when walking."
33946 #: ../src/guestfs.pod:2068
33948 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
33949 "C<guestfs_next_private> or C<guestfs_set_private>."
33953 #: ../src/guestfs.pod:2074
33955 "The following example code shows how to print all keys and data pointers "
33956 "that are associated with the handle C<g>:"
33960 #: ../src/guestfs.pod:2077
33963 " const char *key;\n"
33964 " void *data = guestfs_first_private (g, &key);\n"
33965 " while (data != NULL)\n"
33967 " printf (\"key = %s, data = %p\\n\", key, data);\n"
33968 " data = guestfs_next_private (g, &key);\n"
33974 #: ../src/guestfs.pod:2085
33976 "More commonly you are only interested in keys that begin with an "
33977 "application-specific prefix C<foo_>. Modify the loop like so:"
33981 #: ../src/guestfs.pod:2088
33984 " const char *key;\n"
33985 " void *data = guestfs_first_private (g, &key);\n"
33986 " while (data != NULL)\n"
33988 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
33989 " printf (\"key = %s, data = %p\\n\", key, data);\n"
33990 " data = guestfs_next_private (g, &key);\n"
33996 #: ../src/guestfs.pod:2097
33998 "If you need to modify keys while walking, then you have to jump back to the "
33999 "beginning of the loop. For example, to delete all keys prefixed with "
34004 #: ../src/guestfs.pod:2101
34007 " const char *key;\n"
34010 " data = guestfs_first_private (g, &key);\n"
34011 " while (data != NULL)\n"
34013 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34015 " guestfs_set_private (g, key, NULL);\n"
34016 " /* note that 'key' pointer is now invalid, and so is\n"
34017 " the internal iterator */\n"
34020 " data = guestfs_next_private (g, &key);\n"
34026 #: ../src/guestfs.pod:2117
34028 "Note that the above loop is guaranteed to terminate because the keys are "
34029 "being deleted, but other manipulations of keys within the loop might not "
34030 "terminate unless you also maintain an indication of which keys have been "
34035 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
34040 #: ../src/guestfs.pod:2124
34042 "<!-- old anchor for the next section --> <a "
34043 "name=\"state_machine_and_low_level_event_api\"/>"
34047 #: ../src/guestfs.pod:2129
34048 msgid "ARCHITECTURE"
34052 #: ../src/guestfs.pod:2131
34054 "Internally, libguestfs is implemented by running an appliance (a special "
34055 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34056 "process of the main program."
34060 #: ../src/guestfs.pod:2135
34063 " ___________________\n"
34065 " | main program |\n"
34067 " | | child process / appliance\n"
34068 " | | __________________________\n"
34070 " +-------------------+ RPC | +-----------------+ |\n"
34071 " | libguestfs <--------------------> guestfsd | |\n"
34072 " | | | +-----------------+ |\n"
34073 " \\___________________/ | | Linux kernel | |\n"
34074 " | +--^--------------+ |\n"
34075 " \\_________|________________/\n"
34077 " _______v______\n"
34080 " | disk image |\n"
34081 " \\______________/\n"
34086 #: ../src/guestfs.pod:2155
34088 "The library, linked to the main program, creates the child process and hence "
34089 "the appliance in the L</guestfs_launch> function."
34093 #: ../src/guestfs.pod:2158
34095 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34096 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34097 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34098 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34099 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34100 "attached to the qemu process which translates device access by the "
34101 "appliance's Linux kernel into accesses to the image."
34105 #: ../src/guestfs.pod:2167
34107 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34108 "Although the disk image you are attached to might also be used by some "
34109 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34110 "care if both libguestfs's qemu process and your virtual machine are trying "
34111 "to update the disk image at the same time, since these usually results in "
34112 "massive disk corruption)."
34116 #: ../src/guestfs.pod:2174
34117 msgid "STATE MACHINE"
34121 #: ../src/guestfs.pod:2176
34122 msgid "libguestfs uses a state machine to model the child process:"
34126 #: ../src/guestfs.pod:2178
34130 " guestfs_create\n"
34138 " / | \\ \\ guestfs_launch\n"
34139 " / | _\\__V______\n"
34141 " / | | LAUNCHING |\n"
34142 " / | \\___________/\n"
34144 " / | guestfs_launch\n"
34146 " ______ / __|____V\n"
34147 " / \\ ------> / \\\n"
34148 " | BUSY | | READY |\n"
34149 " \\______/ <------ \\________/\n"
34154 #: ../src/guestfs.pod:2200
34156 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34157 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34158 "(3) alternating between READY and BUSY as commands are issued to, and "
34159 "carried out by, the child process."
34163 #: ../src/guestfs.pod:2205
34165 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34166 "asynchronously at any time (eg. due to some internal error), and that causes "
34167 "the state to transition back to CONFIG."
34171 #: ../src/guestfs.pod:2209
34173 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34174 "issued when in the CONFIG state."
34178 #: ../src/guestfs.pod:2212
34180 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34181 "L</guestfs_launch> blocks until the child process is READY to accept "
34182 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34183 "moves the state from CONFIG to LAUNCHING while it is running."
34187 #: ../src/guestfs.pod:2218
34189 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34190 "state. These API calls block waiting for the command to be carried out "
34191 "(ie. the state to transition to BUSY and then back to READY). There are no "
34192 "non-blocking versions, and no way to issue more than one command per handle "
34193 "at the same time."
34197 #: ../src/guestfs.pod:2224
34199 "Finally, the child process sends asynchronous messages back to the main "
34200 "program, such as kernel log messages. You can register a callback to "
34201 "receive these messages."
34205 #: ../src/guestfs.pod:2228
34210 #: ../src/guestfs.pod:2230
34211 msgid "COMMUNICATION PROTOCOL"
34215 #: ../src/guestfs.pod:2232
34217 "Don't rely on using this protocol directly. This section documents how it "
34218 "currently works, but it may change at any time."
34222 #: ../src/guestfs.pod:2235
34224 "The protocol used to talk between the library and the daemon running inside "
34225 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
34226 "1014, RFC 1832, RFC 4506)."
34230 #: ../src/guestfs.pod:2239
34232 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
34233 "this file is automatically generated)."
34237 #: ../src/guestfs.pod:2242
34239 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
34240 "and C<FileOut> parameters, which are handled with very simple request/reply "
34241 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
34242 "parameters, which use the same request and reply messages, but they may also "
34243 "be followed by files sent using a chunked encoding."
34247 #: ../src/guestfs.pod:2249
34248 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
34252 #: ../src/guestfs.pod:2251
34253 msgid "For ordinary functions, the request message is:"
34257 #: ../src/guestfs.pod:2253
34260 " total length (header + arguments,\n"
34261 " but not including the length word itself)\n"
34262 " struct guestfs_message_header (encoded as XDR)\n"
34263 " struct guestfs_<foo>_args (encoded as XDR)\n"
34268 #: ../src/guestfs.pod:2258
34270 "The total length field allows the daemon to allocate a fixed size buffer "
34271 "into which it slurps the rest of the message. As a result, the total length "
34272 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
34273 "effective size of any request is limited to somewhere under this size."
34277 #: ../src/guestfs.pod:2264
34279 "Note also that many functions don't take any arguments, in which case the "
34280 "C<guestfs_I<foo>_args> is completely omitted."
34284 #: ../src/guestfs.pod:2267
34286 "The header contains the procedure number (C<guestfs_proc>) which is how the "
34287 "receiver knows what type of args structure to expect, or none at all."
34291 #: ../src/guestfs.pod:2271
34293 "For functions that take optional arguments, the optional arguments are "
34294 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
34295 "arguments. A bitmask in the header indicates which optional arguments are "
34296 "meaningful. The bitmask is also checked to see if it contains bits set "
34297 "which the daemon does not know about (eg. if more optional arguments were "
34298 "added in a later version of the library), and this causes the call to be "
34303 #: ../src/guestfs.pod:2279
34304 msgid "The reply message for ordinary functions is:"
34308 #: ../src/guestfs.pod:2281
34311 " total length (header + ret,\n"
34312 " but not including the length word itself)\n"
34313 " struct guestfs_message_header (encoded as XDR)\n"
34314 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34319 #: ../src/guestfs.pod:2286
34321 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
34322 "functions that return no formal return values."
34326 #: ../src/guestfs.pod:2289
34327 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
34331 #: ../src/guestfs.pod:2292
34333 "In the case of an error, a flag is set in the header, and the reply message "
34334 "is slightly changed:"
34338 #: ../src/guestfs.pod:2295
34341 " total length (header + error,\n"
34342 " but not including the length word itself)\n"
34343 " struct guestfs_message_header (encoded as XDR)\n"
34344 " struct guestfs_message_error (encoded as XDR)\n"
34349 #: ../src/guestfs.pod:2300
34351 "The C<guestfs_message_error> structure contains the error message as a "
34356 #: ../src/guestfs.pod:2303
34357 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
34361 #: ../src/guestfs.pod:2305
34363 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
34364 "The normal request message is sent (see above). However this is followed by "
34365 "a sequence of file chunks."
34369 #: ../src/guestfs.pod:2309
34372 " total length (header + arguments,\n"
34373 " but not including the length word itself,\n"
34374 " and not including the chunks)\n"
34375 " struct guestfs_message_header (encoded as XDR)\n"
34376 " struct guestfs_<foo>_args (encoded as XDR)\n"
34377 " sequence of chunks for FileIn param #0\n"
34378 " sequence of chunks for FileIn param #1 etc.\n"
34383 #: ../src/guestfs.pod:2317
34384 msgid "The \"sequence of chunks\" is:"
34388 #: ../src/guestfs.pod:2319
34391 " length of chunk (not including length word itself)\n"
34392 " struct guestfs_chunk (encoded as XDR)\n"
34393 " length of chunk\n"
34394 " struct guestfs_chunk (encoded as XDR)\n"
34396 " length of chunk\n"
34397 " struct guestfs_chunk (with data.data_len == 0)\n"
34402 #: ../src/guestfs.pod:2327
34404 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
34405 "is set in the final chunk to indicate either successful completion or early "
34410 #: ../src/guestfs.pod:2331
34412 "At time of writing there are no functions that have more than one FileIn "
34413 "parameter. However this is (theoretically) supported, by sending the "
34414 "sequence of chunks for each FileIn parameter one after another (from left to "
34419 #: ../src/guestfs.pod:2336
34421 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
34422 "transfer. The library does this by sending a chunk with a special flag set "
34423 "to indicate cancellation. When the daemon sees this, it cancels the whole "
34424 "RPC, does I<not> send any reply, and goes back to reading the next request."
34428 #: ../src/guestfs.pod:2342
34430 "The daemon may also cancel. It does this by writing a special word "
34431 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
34432 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
34433 "cancel chunk). The special word is chosen so that even if cancellation "
34434 "happens right at the end of the transfer (after the library has finished "
34435 "writing and has started listening for the reply), the \"spurious\" cancel "
34436 "flag will not be confused with the reply message."
34440 #: ../src/guestfs.pod:2351
34442 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
34443 "limit), and also files where the size is not known in advance (eg. from "
34444 "pipes or sockets). However the chunks are rather small "
34445 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
34446 "to keep much in memory."
34450 #: ../src/guestfs.pod:2357
34451 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
34455 #: ../src/guestfs.pod:2359
34457 "The protocol for FileOut parameters is exactly the same as for FileIn "
34458 "parameters, but with the roles of daemon and library reversed."
34462 #: ../src/guestfs.pod:2362
34465 " total length (header + ret,\n"
34466 " but not including the length word itself,\n"
34467 " and not including the chunks)\n"
34468 " struct guestfs_message_header (encoded as XDR)\n"
34469 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34470 " sequence of chunks for FileOut param #0\n"
34471 " sequence of chunks for FileOut param #1 etc.\n"
34476 #: ../src/guestfs.pod:2370
34477 msgid "INITIAL MESSAGE"
34481 #: ../src/guestfs.pod:2372
34483 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
34484 "which indicates that the guest and daemon is alive. This is what "
34485 "L</guestfs_launch> waits for."
34489 #: ../src/guestfs.pod:2376
34490 msgid "PROGRESS NOTIFICATION MESSAGES"
34494 #: ../src/guestfs.pod:2378
34496 "The daemon may send progress notification messages at any time. These are "
34497 "distinguished by the normal length word being replaced by "
34498 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
34502 #: ../src/guestfs.pod:2382
34504 "The library turns them into progress callbacks (see "
34505 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
34510 #: ../src/guestfs.pod:2386
34512 "The daemon self-limits the frequency of progress messages it sends (see "
34513 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
34518 #: ../src/guestfs.pod:2390
34519 msgid "LIBGUESTFS VERSION NUMBERS"
34523 #: ../src/guestfs.pod:2392
34525 "Since April 2010, libguestfs has started to make separate development and "
34526 "stable releases, along with corresponding branches in our git repository. "
34527 "These separate releases can be identified by version number:"
34531 #: ../src/guestfs.pod:2397
34534 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
34535 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
34541 " | `-------- sub-version\n"
34543 " `------ always '1' because we don't change the ABI\n"
34548 #: ../src/guestfs.pod:2408
34549 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
34553 #: ../src/guestfs.pod:2410
34555 "As time passes we cherry pick fixes from the development branch and backport "
34556 "those into the stable branch, the effect being that the stable branch should "
34557 "get more stable and less buggy over time. So the stable releases are ideal "
34558 "for people who don't need new features but would just like the software to "
34563 #: ../src/guestfs.pod:2416
34564 msgid "Our criteria for backporting changes are:"
34568 #: ../src/guestfs.pod:2422
34570 "Documentation changes which don't affect any code are backported unless the "
34571 "documentation refers to a future feature which is not in stable."
34575 #: ../src/guestfs.pod:2428
34577 "Bug fixes which are not controversial, fix obvious problems, and have been "
34578 "well tested are backported."
34582 #: ../src/guestfs.pod:2433
34584 "Simple rearrangements of code which shouldn't affect how it works get "
34585 "backported. This is so that the code in the two branches doesn't get too "
34586 "far out of step, allowing us to backport future fixes more easily."
34590 #: ../src/guestfs.pod:2439
34592 "We I<don't> backport new features, new APIs, new tools etc, except in one "
34593 "exceptional case: the new feature is required in order to implement an "
34594 "important bug fix."
34598 #: ../src/guestfs.pod:2445
34600 "A new stable branch starts when we think the new features in development are "
34601 "substantial and compelling enough over the current stable branch to warrant "
34602 "it. When that happens we create new stable and development versions 1.N.0 "
34603 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
34604 "stable at this point, but by backporting fixes from development, that branch "
34605 "will stabilize over time."
34609 #: ../src/guestfs.pod:2453
34610 msgid "EXTENDING LIBGUESTFS"
34614 #: ../src/guestfs.pod:2455
34615 msgid "ADDING A NEW API ACTION"
34619 #: ../src/guestfs.pod:2457
34621 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
34622 "documentation) are generated, and this makes it easy to extend the "
34627 #: ../src/guestfs.pod:2461
34628 msgid "To add a new API action there are two changes:"
34632 #: ../src/guestfs.pod:2467
34634 "You need to add a description of the call (name, parameters, return type, "
34635 "tests, documentation) to C<generator/generator_actions.ml>."
34639 #: ../src/guestfs.pod:2470
34641 "There are two sorts of API action, depending on whether the call goes "
34642 "through to the daemon in the appliance, or is serviced entirely by the "
34643 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
34644 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
34645 "an example of the latter, since a trace flag is maintained in the handle and "
34646 "all tracing is done on the library side."
34650 #: ../src/guestfs.pod:2478
34652 "Most new actions are of the first type, and get added to the "
34653 "C<daemon_functions> list. Each function has a unique procedure number used "
34654 "in the RPC protocol which is assigned to that action when we publish "
34655 "libguestfs and cannot be reused. Take the latest procedure number and "
34660 #: ../src/guestfs.pod:2484
34662 "For library-only actions of the second type, add to the "
34663 "C<non_daemon_functions> list. Since these functions are serviced by the "
34664 "library and do not travel over the RPC mechanism to the daemon, these "
34665 "functions do not need a procedure number, and so the procedure number is set "
34670 #: ../src/guestfs.pod:2492
34671 msgid "Implement the action (in C):"
34675 #: ../src/guestfs.pod:2494
34677 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
34678 "C<daemon/> directory."
34682 #: ../src/guestfs.pod:2497
34684 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
34685 "(note: double underscore) in the C<src/> directory."
34689 #: ../src/guestfs.pod:2500
34690 msgid "In either case, use another function as an example of what to do."
34694 #: ../src/guestfs.pod:2504
34695 msgid "After making these changes, use C<make> to compile."
34699 #: ../src/guestfs.pod:2506
34701 "Note that you don't need to implement the RPC, language bindings, manual "
34702 "pages or anything else. It's all automatically generated from the OCaml "
34707 #: ../src/guestfs.pod:2510
34708 msgid "ADDING TESTS FOR AN API ACTION"
34712 #: ../src/guestfs.pod:2512
34714 "You can supply zero or as many tests as you want per API call. The tests "
34715 "can either be added as part of the API description "
34716 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
34717 "drop a script into C<regressions/>. Note that adding a script to "
34718 "C<regressions/> is slower, so if possible use the first method."
34722 #: ../src/guestfs.pod:2518
34724 "The following describes the test environment used when you add an API test "
34725 "in C<generator_actions.ml>."
34729 #: ../src/guestfs.pod:2521
34730 msgid "The test environment has 4 block devices:"
34734 #: ../src/guestfs.pod:2525
34735 msgid "C</dev/sda> 500MB"
34739 #: ../src/guestfs.pod:2527
34740 msgid "General block device for testing."
34744 #: ../src/guestfs.pod:2529
34745 msgid "C</dev/sdb> 50MB"
34749 #: ../src/guestfs.pod:2531
34751 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
34756 #: ../src/guestfs.pod:2534
34757 msgid "C</dev/sdc> 10MB"
34761 #: ../src/guestfs.pod:2536
34762 msgid "Used in a few tests where two block devices are needed."
34766 #: ../src/guestfs.pod:2538
34767 msgid "C</dev/sdd>"
34771 #: ../src/guestfs.pod:2540
34772 msgid "ISO with fixed content (see C<images/test.iso>)."
34776 #: ../src/guestfs.pod:2544
34778 "To be able to run the tests in a reasonable amount of time, the libguestfs "
34779 "appliance and block devices are reused between tests. So don't try testing "
34780 "L</guestfs_kill_subprocess> :-x"
34784 #: ../src/guestfs.pod:2548
34786 "Each test starts with an initial scenario, selected using one of the "
34787 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
34788 "initialize the disks mentioned above in a particular way as documented in "
34789 "C<generator_types.ml>. You should not assume anything about the previous "
34790 "contents of other disks that are not initialized."
34794 #: ../src/guestfs.pod:2554
34796 "You can add a prerequisite clause to any individual test. This is a "
34797 "run-time check, which, if it fails, causes the test to be skipped. Useful "
34798 "if testing a command which might not work on all variations of libguestfs "
34799 "builds. A test that has prerequisite of C<Always> means to run "
34804 #: ../src/guestfs.pod:2560
34806 "In addition, packagers can skip individual tests by setting environment "
34807 "variables before running C<make check>."
34811 #: ../src/guestfs.pod:2563
34814 " SKIP_TEST_<CMD>_<NUM>=1\n"
34819 #: ../src/guestfs.pod:2565
34820 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
34824 #: ../src/guestfs.pod:2567
34829 #: ../src/guestfs.pod:2569
34832 " SKIP_TEST_<CMD>=1\n"
34837 #: ../src/guestfs.pod:2571
34838 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
34842 #: ../src/guestfs.pod:2573
34843 msgid "Packagers can run only certain tests by setting for example:"
34847 #: ../src/guestfs.pod:2575
34850 " TEST_ONLY=\"vfs_type zerofree\"\n"
34855 #: ../src/guestfs.pod:2577
34857 "See C<capitests/tests.c> for more details of how these environment variables "
34862 #: ../src/guestfs.pod:2580
34863 msgid "DEBUGGING NEW API ACTIONS"
34867 #: ../src/guestfs.pod:2582
34868 msgid "Test new actions work before submitting them."
34872 #: ../src/guestfs.pod:2584
34873 msgid "You can use guestfish to try out new commands."
34877 #: ../src/guestfs.pod:2586
34879 "Debugging the daemon is a problem because it runs inside a minimal "
34880 "environment. However you can fprintf messages in the daemon to stderr, and "
34881 "they will show up if you use C<guestfish -v>."
34885 #: ../src/guestfs.pod:2590
34886 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
34890 #: ../src/guestfs.pod:2592
34892 "Our C source code generally adheres to some basic code-formatting "
34893 "conventions. The existing code base is not totally consistent on this "
34894 "front, but we do prefer that contributed code be formatted similarly. In "
34895 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
34896 "indentation level, and other than that, follow the K&R style."
34900 #: ../src/guestfs.pod:2598
34902 "If you use Emacs, add the following to one of one of your start-up files "
34903 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
34907 #: ../src/guestfs.pod:2601
34910 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
34911 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
34912 " (add-hook 'find-file-hook\n"
34913 " '(lambda () (if (and buffer-file-name\n"
34914 " (string-match \"/libguestfs\\\\>\"\n"
34915 " (buffer-file-name))\n"
34916 " (not (string-equal mode-name \"Change Log\"))\n"
34917 " (not (string-equal mode-name \"Makefile\")))\n"
34918 " (setq indent-tabs-mode nil))))\n"
34923 #: ../src/guestfs.pod:2611
34926 " ;;; When editing C sources in libguestfs, use this style.\n"
34927 " (defun libguestfs-c-mode ()\n"
34928 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
34930 " (c-set-style \"K&R\")\n"
34931 " (setq c-indent-level 2)\n"
34932 " (setq c-basic-offset 2))\n"
34933 " (add-hook 'c-mode-hook\n"
34934 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
34935 " (buffer-file-name))\n"
34936 " (libguestfs-c-mode))))\n"
34941 #: ../src/guestfs.pod:2623
34942 msgid "Enable warnings when compiling (and fix any problems this finds):"
34946 #: ../src/guestfs.pod:2626
34949 " ./configure --enable-gcc-warnings\n"
34954 #: ../src/guestfs.pod:2628
34955 msgid "Useful targets are:"
34959 #: ../src/guestfs.pod:2630
34962 " make syntax-check # checks the syntax of the C code\n"
34963 " make check # runs the test suite\n"
34968 #: ../src/guestfs.pod:2633
34969 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
34973 #: ../src/guestfs.pod:2635
34975 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
34976 "which are used to do shell quoting."
34980 #: ../src/guestfs.pod:2640
34985 #: ../src/guestfs.pod:2642
34987 "Simple shell quoted string. Any spaces or other shell characters are "
34992 #: ../src/guestfs.pod:2645
34997 #: ../src/guestfs.pod:2647
34999 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35004 #: ../src/guestfs.pod:2654
35007 " asprintf (&cmd, \"cat %R\", path);\n"
35012 #: ../src/guestfs.pod:2656
35013 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35017 #: ../src/guestfs.pod:2658
35019 "I<Note:> Do I<not> use these when you are passing parameters to the "
35020 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
35021 "because they are not passed via the shell (instead, straight to exec). You "
35022 "probably want to use the C<sysroot_path()> function however."
35026 #: ../src/guestfs.pod:2664
35027 msgid "SUBMITTING YOUR NEW API ACTIONS"
35031 #: ../src/guestfs.pod:2666
35033 "Submit patches to the mailing list: "
35034 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
35035 "L<rjones@redhat.com>."
35039 #: ../src/guestfs.pod:2670
35040 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35044 #: ../src/guestfs.pod:2672
35045 msgid "We support i18n (gettext anyhow) in the library."
35049 #: ../src/guestfs.pod:2674
35051 "However many messages come from the daemon, and we don't translate those at "
35052 "the moment. One reason is that the appliance generally has all locale files "
35053 "removed from it, because they take up a lot of space. So we'd have to readd "
35054 "some of those, as well as copying our PO files into the appliance."
35058 #: ../src/guestfs.pod:2680
35060 "Debugging messages are never translated, since they are intended for the "
35065 #: ../src/guestfs.pod:2683
35066 msgid "SOURCE CODE SUBDIRECTORIES"
35070 #: ../src/guestfs.pod:2689
35071 msgid "The libguestfs appliance, build scripts and so on."
35075 #: ../src/guestfs.pod:2691
35076 msgid "C<capitests>"
35080 #: ../src/guestfs.pod:2693
35081 msgid "Automated tests of the C API."
35085 #: ../src/guestfs.pod:2695
35090 #: ../src/guestfs.pod:2697
35092 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35097 #: ../src/guestfs.pod:2700
35102 #: ../src/guestfs.pod:2702
35104 "Safety and liveness tests of components that libguestfs depends upon (not of "
35105 "libguestfs itself). Mainly this is for qemu and the kernel."
35109 #: ../src/guestfs.pod:2705
35114 #: ../src/guestfs.pod:2707
35115 msgid "Outside contributions, experimental parts."
35119 #: ../src/guestfs.pod:2709
35124 #: ../src/guestfs.pod:2711
35126 "The daemon that runs inside the libguestfs appliance and carries out "
35131 #: ../src/guestfs.pod:2714
35136 #: ../src/guestfs.pod:2716
35137 msgid "L<virt-df(1)> command and documentation."
35141 #: ../src/guestfs.pod:2718
35146 #: ../src/guestfs.pod:2720
35147 msgid "L<virt-edit(1)> command and documentation."
35151 #: ../src/guestfs.pod:2722
35152 msgid "C<examples>"
35156 #: ../src/guestfs.pod:2724
35157 msgid "C API example code."
35161 #: ../src/guestfs.pod:2726
35166 #: ../src/guestfs.pod:2728
35168 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
35169 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
35170 "L<virt-tar-out(1)>."
35174 #: ../src/guestfs.pod:2732
35179 #: ../src/guestfs.pod:2734
35180 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
35184 #: ../src/guestfs.pod:2736
35185 msgid "C<generator>"
35189 #: ../src/guestfs.pod:2738
35191 "The crucially important generator, used to automatically generate large "
35192 "amounts of boilerplate C code for things like RPC and bindings."
35196 #: ../src/guestfs.pod:2741
35201 #: ../src/guestfs.pod:2743
35202 msgid "Files used by the test suite."
35206 #: ../src/guestfs.pod:2745
35207 msgid "Some \"phony\" guest images which we test against."
35211 #: ../src/guestfs.pod:2747
35212 msgid "C<inspector>"
35216 #: ../src/guestfs.pod:2749
35217 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
35221 #: ../src/guestfs.pod:2751
35226 #: ../src/guestfs.pod:2753
35227 msgid "Logo used on the website. The fish is called Arthur by the way."
35231 #: ../src/guestfs.pod:2755
35236 #: ../src/guestfs.pod:2757
35237 msgid "M4 macros used by autoconf."
35241 #: ../src/guestfs.pod:2759
35246 #: ../src/guestfs.pod:2761
35247 msgid "Translations of simple gettext strings."
35251 #: ../src/guestfs.pod:2763
35256 #: ../src/guestfs.pod:2765
35258 "The build infrastructure and PO files for translations of manpages and POD "
35259 "files. Eventually this will be combined with the C<po> directory, but that "
35260 "is rather complicated."
35264 #: ../src/guestfs.pod:2769
35265 msgid "C<regressions>"
35269 #: ../src/guestfs.pod:2771
35270 msgid "Regression tests."
35274 #: ../src/guestfs.pod:2773
35279 #: ../src/guestfs.pod:2775
35280 msgid "L<virt-rescue(1)> command and documentation."
35284 #: ../src/guestfs.pod:2777
35289 #: ../src/guestfs.pod:2779
35290 msgid "Source code to the C library."
35294 #: ../src/guestfs.pod:2781
35299 #: ../src/guestfs.pod:2783
35300 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
35304 #: ../src/guestfs.pod:2785
35305 msgid "C<test-tool>"
35309 #: ../src/guestfs.pod:2787
35311 "Test tool for end users to test if their qemu/kernel combination will work "
35316 #: ../src/guestfs.pod:2790
35321 #: ../src/guestfs.pod:2792
35326 #: ../src/guestfs.pod:2794
35331 #: ../src/guestfs.pod:2796
35336 #: ../src/guestfs.pod:2798
35341 #: ../src/guestfs.pod:2800
35346 #: ../src/guestfs.pod:2802
35351 #: ../src/guestfs.pod:2804
35356 #: ../src/guestfs.pod:2806
35357 msgid "Language bindings."
35361 #: ../src/guestfs.pod:2810
35362 msgid "MAKING A STABLE RELEASE"
35366 #: ../src/guestfs.pod:2812
35368 "When we make a stable release, there are several steps documented here. See "
35369 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
35374 #: ../src/guestfs.pod:2820
35375 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
35379 #: ../src/guestfs.pod:2825
35380 msgid "Finalize RELEASE-NOTES."
35384 #: ../src/guestfs.pod:2829
35385 msgid "Update ROADMAP."
35389 #: ../src/guestfs.pod:2833
35390 msgid "Run C<src/api-support/update-from-tarballs.sh>."
35394 #: ../src/guestfs.pod:2837
35395 msgid "Push and pull from Transifex."
35399 #: ../src/guestfs.pod:2839
35404 #: ../src/guestfs.pod:2841
35412 #: ../src/guestfs.pod:2843
35413 msgid "to push the latest POT files to Transifex. Then run:"
35417 #: ../src/guestfs.pod:2845
35425 #: ../src/guestfs.pod:2847
35426 msgid "which is a wrapper to pull the latest translated C<*.po> files."
35430 #: ../src/guestfs.pod:2851
35432 "Create new stable and development directories under "
35433 "L<http://libguestfs.org/download>."
35437 #: ../src/guestfs.pod:2856
35438 msgid "Create the branch in git:"
35442 #: ../src/guestfs.pod:2858
35445 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
35446 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
35447 " git branch stable-1.XX\n"
35448 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
35453 #: ../src/guestfs.pod:2865
35458 #: ../src/guestfs.pod:2867
35459 msgid "PROTOCOL LIMITS"
35463 #: ../src/guestfs.pod:2869
35465 "Internally libguestfs uses a message-based protocol to pass API calls and "
35466 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
35467 "plenty more detail about this). The maximum message size used by the "
35468 "protocol is slightly less than 4 MB. For some API calls you may need to be "
35469 "aware of this limit. The API calls which may be affected are individually "
35470 "documented, with a link back to this section of the documentation."
35474 #: ../src/guestfs.pod:2877
35476 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
35477 "a simple string. Because this string is at some point internally encoded as "
35478 "a message, the maximum size that it can return is slightly under 4 MB. If "
35479 "the requested file is larger than this then you will get an error."
35483 #: ../src/guestfs.pod:2883
35485 "In order to transfer large files into and out of the guest filesystem, you "
35486 "need to use particular calls that support this. The sections L</UPLOADING> "
35487 "and L</DOWNLOADING> document how to do this."
35491 #: ../src/guestfs.pod:2887
35493 "You might also consider mounting the disk image using our FUSE filesystem "
35494 "support (L<guestmount(1)>)."
35498 #: ../src/guestfs.pod:2890
35499 msgid "MAXIMUM NUMBER OF DISKS"
35503 #: ../src/guestfs.pod:2892
35504 msgid "When using virtio disks (the default) the current limit is B<25> disks."
35508 #: ../src/guestfs.pod:2895
35510 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
35511 "slots. However febootstrap only understands disks with names C</dev/vda> "
35512 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
35517 #: ../src/guestfs.pod:2900
35519 "We are working to substantially raise this limit in future versions but it "
35520 "requires complex changes to qemu."
35524 #: ../src/guestfs.pod:2903
35526 "In future versions of libguestfs it should also be possible to \"hot plug\" "
35527 "disks (add and remove disks after calling L</guestfs_launch>). This also "
35528 "requires changes to qemu."
35532 #: ../src/guestfs.pod:2907
35533 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
35537 #: ../src/guestfs.pod:2909
35538 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
35542 #: ../src/guestfs.pod:2911
35544 "This is because it reserves 4 bits for the minor device number (thus "
35545 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
35549 #: ../src/guestfs.pod:2914
35551 "If you attach a disk with more than 15 partitions, the extra partitions are "
35552 "ignored by libguestfs."
35556 #: ../src/guestfs.pod:2917
35557 msgid "MAXIMUM SIZE OF A DISK"
35561 #: ../src/guestfs.pod:2919
35562 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
35566 #: ../src/guestfs.pod:2921
35568 "We have tested block devices up to 1 exabyte (2**60 or "
35569 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
35574 #: ../src/guestfs.pod:2925
35576 "Although libguestfs probably does not impose any limit, the underlying host "
35577 "storage will. If you store disk images on a host ext4 filesystem, then the "
35578 "maximum size will be limited by the maximum ext4 file size (currently 16 "
35579 "TB). If you store disk images as host logical volumes then you are limited "
35580 "by the maximum size of an LV."
35584 #: ../src/guestfs.pod:2931
35586 "For the hugest disk image files, we recommend using XFS on the host for "
35591 #: ../src/guestfs.pod:2934
35592 msgid "MAXIMUM SIZE OF A PARTITION"
35596 #: ../src/guestfs.pod:2936
35598 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
35599 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
35600 "address a partition located beyond 2 TB on the disk."
35604 #: ../src/guestfs.pod:2940
35606 "It is recommended that you use GPT partitions on disks which are larger than "
35607 "this size. GPT uses 64 bit sector numbers and so can address partitions "
35608 "which are theoretically larger than the largest disk we could support."
35612 #: ../src/guestfs.pod:2945
35613 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
35617 #: ../src/guestfs.pod:2947
35619 "This depends on the filesystem type. libguestfs itself does not impose any "
35620 "known limit. Consult Wikipedia or the filesystem documentation to find out "
35621 "what these limits are."
35625 #: ../src/guestfs.pod:2951
35626 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
35630 #: ../src/guestfs.pod:2953
35632 "The API functions L</guestfs_upload>, L</guestfs_download>, "
35633 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
35634 "uploads and downloads."
35638 #: ../src/guestfs.pod:2957
35639 msgid "INSPECTION LIMITS"
35643 #: ../src/guestfs.pod:2959
35645 "The inspection code has several arbitrary limits on things like the size of "
35646 "Windows Registry hive it will read, and the length of product name. These "
35647 "are intended to stop a malicious guest from consuming arbitrary amounts of "
35648 "memory and disk space on the host, and should not be reached in practice. "
35649 "See the source code for more information."
35653 #: ../src/guestfs.pod:2985
35655 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
35656 "effect as calling C<guestfs_set_verbose (g, 1)>."
35660 #: ../src/guestfs.pod:2997
35662 "Set the path that libguestfs uses to search for a supermin appliance. See "
35663 "the discussion of paths in section L</PATH> above."
35667 #: ../src/guestfs.pod:3006
35668 msgid "See also L</QEMU WRAPPERS> above."
35672 #: ../src/guestfs.pod:3010
35674 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
35675 "effect as calling C<guestfs_set_trace (g, 1)>."
35679 #: ../src/guestfs.pod:3028
35681 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
35682 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
35683 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
35684 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
35685 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
35686 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
35687 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
35688 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
35689 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
35693 #: ../src/guestfs.pod:3058
35695 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
35696 "L<lvm(8)>, L<disktype(1)>."
35700 #: ../src/guestfs.pod:3065 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
35705 #: ../src/guestfs.pod:3067
35706 msgid "To get a list of bugs against libguestfs use this link:"
35710 #: ../src/guestfs.pod:3069
35711 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
35715 #: ../src/guestfs.pod:3071
35716 msgid "To report a new bug against libguestfs use this link:"
35720 #: ../src/guestfs.pod:3073
35721 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
35725 #: ../src/guestfs.pod:3075
35726 msgid "When reporting a bug, please check:"
35730 #: ../src/guestfs.pod:3081
35731 msgid "That the bug hasn't been reported already."
35735 #: ../src/guestfs.pod:3085
35736 msgid "That you are testing a recent version."
35740 #: ../src/guestfs.pod:3089
35741 msgid "Describe the bug accurately, and give a way to reproduce it."
35745 #: ../src/guestfs.pod:3093
35747 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
35752 #: ../test-tool/libguestfs-test-tool.pod:5
35753 msgid "libguestfs-test-tool - End user tests for libguestfs"
35757 #: ../test-tool/libguestfs-test-tool.pod:9
35760 " libguestfs-test-tool [--options]\n"
35765 #: ../test-tool/libguestfs-test-tool.pod:13
35767 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
35768 "and developers, to allow them to check basic libguestfs functionality is "
35769 "working. This is needed because libguestfs occasionally breaks for reasons "
35770 "beyond our control: usually because of changes in the underlying qemu or "
35771 "kernel packages, or the host environment."
35775 #: ../test-tool/libguestfs-test-tool.pod:20
35776 msgid "If you suspect a problem in libguestfs, then just run:"
35780 #: ../test-tool/libguestfs-test-tool.pod:22
35783 " libguestfs-test-tool\n"
35788 #: ../test-tool/libguestfs-test-tool.pod:24
35789 msgid "It will print lots of diagnostic messages."
35793 #: ../test-tool/libguestfs-test-tool.pod:26
35794 msgid "If it runs to completion successfully, you will see this near the end:"
35798 #: ../test-tool/libguestfs-test-tool.pod:28
35801 " ===== TEST FINISHED OK =====\n"
35806 #: ../test-tool/libguestfs-test-tool.pod:30
35807 msgid "and the test tool will exit with code 0."
35811 #: ../test-tool/libguestfs-test-tool.pod:32
35813 "If it fails (and/or exits with non-zero error code), please paste the "
35814 "B<complete, unedited> output of the test tool into a bug report. More "
35815 "information about reporting bugs can be found on the "
35816 "L<http://libguestfs.org/> website."
35820 #: ../test-tool/libguestfs-test-tool.pod:41
35825 #: ../test-tool/libguestfs-test-tool.pod:43
35826 msgid "Display short usage information and exit."
35830 #: ../test-tool/libguestfs-test-tool.pod:45
35831 msgid "I<--qemu qemu_binary>"
35835 #: ../test-tool/libguestfs-test-tool.pod:47
35837 "If you have downloaded another qemu binary, point this option at the full "
35838 "path of the binary to try it."
35842 #: ../test-tool/libguestfs-test-tool.pod:50
35843 msgid "I<--qemudir qemu_source_dir>"
35847 #: ../test-tool/libguestfs-test-tool.pod:52
35849 "If you have compiled qemu from source, point this option at the source "
35850 "directory to try it."
35854 #: ../test-tool/libguestfs-test-tool.pod:55
35855 msgid "I<--timeout N>"
35859 #: ../test-tool/libguestfs-test-tool.pod:57
35861 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
35862 "does not usually need to be adjusted unless your machine is very slow."
35866 #: ../test-tool/libguestfs-test-tool.pod:63
35867 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
35871 #: ../test-tool/libguestfs-test-tool.pod:65
35873 "If you have compiled another version of qemu from source and would like to "
35874 "try that, then you can use the I<--qemudir> option to point to the qemu "
35875 "source directory."
35879 #: ../test-tool/libguestfs-test-tool.pod:69
35881 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
35882 "option to point to the binary."
35886 #: ../test-tool/libguestfs-test-tool.pod:72
35888 "When using an alternate qemu with libguestfs, usually you would need to "
35889 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
35890 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
35891 "when you use either of the I<--qemudir> or I<--qemu> options."
35895 #: ../test-tool/libguestfs-test-tool.pod:79
35897 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
35898 "I<1> if there was an error."
35902 #: ../test-tool/libguestfs-test-tool.pod:84
35904 "For the full list of environment variables which may affect libguestfs, "
35905 "please see the L<guestfs(3)> manual page."
35909 #: ../test-tool/libguestfs-test-tool.pod:89
35910 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
35914 #: ../tools/virt-list-filesystems.pl:32
35915 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
35919 #: ../tools/virt-list-filesystems.pl:36
35922 " virt-list-filesystems [--options] domname\n"
35927 #: ../tools/virt-list-filesystems.pl:38
35930 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
35935 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
35937 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
35942 #: ../tools/virt-list-filesystems.pl:45
35944 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
35945 "are contained in a virtual machine or disk image."
35949 #: ../tools/virt-list-filesystems.pl:49
35951 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
35952 "functionality. For more complex cases you should look at the "
35953 "L<guestfish(1)> tool."
35957 #: ../tools/virt-list-filesystems.pl:112
35959 "With this option, C<virt-list-filesystems> displays the type of each "
35960 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
35964 #: ../tools/virt-list-filesystems.pl:119
35969 #: ../tools/virt-list-filesystems.pl:123
35971 "Normally we only show mountable filesystems. If this option is given then "
35972 "swap devices are shown too."
35976 #: ../tools/virt-list-filesystems.pl:197
35978 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
35979 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
35980 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35984 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
35985 msgid "Copyright (C) 2009 Red Hat Inc."
35989 #: ../tools/virt-list-partitions.pl:32
35990 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
35994 #: ../tools/virt-list-partitions.pl:36
35997 " virt-list-partitions [--options] domname\n"
36002 #: ../tools/virt-list-partitions.pl:38
36005 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36010 #: ../tools/virt-list-partitions.pl:45
36012 "C<virt-list-partitions> is a command line tool to list the partitions that "
36013 "are contained in a virtual machine or disk image. It is mainly useful as a "
36014 "first step to using L<virt-resize(1)>."
36018 #: ../tools/virt-list-partitions.pl:50
36020 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36021 "functionality. For more complex cases you should look at the "
36022 "L<guestfish(1)> tool."
36026 #: ../tools/virt-list-partitions.pl:113
36027 msgid "Show sizes in human-readable form (eg. \"1G\")."
36031 #: ../tools/virt-list-partitions.pl:123
36033 "With this option, C<virt-list-partitions> displays the type and size of each "
36034 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36038 #: ../tools/virt-list-partitions.pl:130
36043 #: ../tools/virt-list-partitions.pl:132
36048 #: ../tools/virt-list-partitions.pl:134
36049 msgid "Display the total size of each block device (as a separate row or rows)."
36053 #: ../tools/virt-list-partitions.pl:267
36055 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
36056 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
36057 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36061 #: ../tools/virt-list-partitions.pl:283
36062 msgid "Copyright (C) 2009-2010 Red Hat Inc."
36066 #: ../tools/virt-make-fs.pl:37
36067 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
36071 #: ../tools/virt-make-fs.pl:41
36074 " virt-make-fs [--options] input.tar output.img\n"
36079 #: ../tools/virt-make-fs.pl:43
36082 " virt-make-fs [--options] input.tar.gz output.img\n"
36087 #: ../tools/virt-make-fs.pl:45
36090 " virt-make-fs [--options] directory output.img\n"
36095 #: ../tools/virt-make-fs.pl:49
36097 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
36098 "archive or some files in a directory. It is similar to tools like "
36099 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
36100 "it can create common filesystem types like ext2/3 or NTFS, which can be "
36101 "useful if you want to attach these filesystems to existing virtual machines "
36102 "(eg. to import large amounts of read-only data to a VM)."
36106 #: ../tools/virt-make-fs.pl:57
36107 msgid "Basic usage is:"
36111 #: ../tools/virt-make-fs.pl:59
36114 " virt-make-fs input output\n"
36119 #: ../tools/virt-make-fs.pl:61
36121 "where C<input> is either a directory containing files that you want to add, "
36122 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
36123 "C<output> is a disk image. The input type is detected automatically. The "
36124 "output disk image defaults to a raw ext2 image unless you specify extra "
36125 "flags (see L</OPTIONS> below)."
36129 #: ../tools/virt-make-fs.pl:67
36130 msgid "EXTRA SPACE"
36134 #: ../tools/virt-make-fs.pl:69
36136 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
36137 "the files that it contains, but might have extra space. Depending on how "
36138 "you are going to use the output, you might think this extra space is wasted "
36139 "and want to minimize it, or you might want to leave space so that more files "
36140 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
36141 "but you can use the I<--size> flag to leave space in the filesystem if you "
36146 #: ../tools/virt-make-fs.pl:77
36148 "An alternative way to leave extra space but not make the output image any "
36149 "bigger is to use an alternative disk image format (instead of the default "
36150 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
36151 "image format (check your hypervisor supports this before using it). This "
36152 "allows you to choose a large I<--size> but the extra space won't actually be "
36153 "allocated in the image until you try to store something in it."
36157 #: ../tools/virt-make-fs.pl:85
36159 "Don't forget that you can also use local commands including L<resize2fs(8)> "
36160 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
36161 "to build another image from scratch."
36165 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
36170 #: ../tools/virt-make-fs.pl:91
36173 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
36178 #: ../tools/virt-make-fs.pl:93
36179 msgid "FILESYSTEM TYPE"
36183 #: ../tools/virt-make-fs.pl:95
36185 "The default filesystem type is C<ext2>. Just about any filesystem type that "
36186 "libguestfs supports can be used (but I<not> read-only formats like "
36187 "ISO9660). Here are some of the more common choices:"
36191 #: ../tools/virt-make-fs.pl:101
36196 #: ../tools/virt-make-fs.pl:103
36198 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
36199 "you are not going to use the filesystem in a way that requires the journal, "
36200 "then this is just wasted overhead."
36204 #: ../tools/virt-make-fs.pl:107
36205 msgid "I<ntfs> or I<vfat>"
36209 #: ../tools/virt-make-fs.pl:109
36210 msgid "Useful if exporting data to a Windows guest."
36214 #: ../tools/virt-make-fs.pl:111
36216 "I<Note for vfat>: The tar archive or local directory must only contain files "
36217 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
36218 "program running within libguestfs is unable to change the ownership of "
36219 "non-root files, since vfat itself does not support this."
36223 #: ../tools/virt-make-fs.pl:116
36228 #: ../tools/virt-make-fs.pl:118
36230 "Lower overhead than C<ext2>, but certain limitations on filename length and "
36231 "total filesystem size."
36235 #: ../tools/virt-make-fs.pl:125
36238 " virt-make-fs --type=minix input minixfs.img\n"
36243 #: ../tools/virt-make-fs.pl:127
36244 msgid "TO PARTITION OR NOT TO PARTITION"
36248 #: ../tools/virt-make-fs.pl:129
36249 msgid "Optionally virt-make-fs can add a partition table to the output disk."
36253 #: ../tools/virt-make-fs.pl:131
36255 "Adding a partition can make the disk image more compatible with certain "
36256 "virtualized operating systems which don't expect to see a filesystem "
36257 "directly located on a block device (Linux doesn't care and will happily "
36258 "handle both types)."
36262 #: ../tools/virt-make-fs.pl:136
36264 "On the other hand, if you have a partition table then the output image is no "
36265 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
36266 "directly on a partitioned disk image. (However libguestfs tools such as "
36267 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
36271 #: ../tools/virt-make-fs.pl:144
36272 msgid "Add an MBR partition:"
36276 #: ../tools/virt-make-fs.pl:146
36279 " virt-make-fs --partition -- input disk.img\n"
36284 #: ../tools/virt-make-fs.pl:148
36286 "If the output disk image could be terabyte-sized or larger, it's better to "
36287 "use an EFI/GPT-compatible partition table:"
36291 #: ../tools/virt-make-fs.pl:151
36294 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
36299 #: ../tools/virt-make-fs.pl:179
36300 msgid "Enable debugging information."
36304 #: ../tools/virt-make-fs.pl:185
36305 msgid "B<--size=E<lt>NE<gt>>"
36309 #: ../tools/virt-make-fs.pl:187
36310 msgid "B<--size=+E<lt>NE<gt>>"
36314 #: ../tools/virt-make-fs.pl:189
36315 msgid "B<-s E<lt>NE<gt>>"
36319 #: ../tools/virt-make-fs.pl:191
36320 msgid "B<-s +E<lt>NE<gt>>"
36324 #: ../tools/virt-make-fs.pl:193
36325 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
36329 #: ../tools/virt-make-fs.pl:196
36331 "If this option is I<not> given, then the output image will be just large "
36332 "enough to contain all the files, with not much wasted space."
36336 #: ../tools/virt-make-fs.pl:199
36338 "To choose a fixed size output disk, specify an absolute number followed by "
36339 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36340 "Petabytes or Exabytes. This must be large enough to contain all the input "
36341 "files, else you will get an error."
36345 #: ../tools/virt-make-fs.pl:204
36347 "To leave extra space, specify C<+> (plus sign) and a number followed by "
36348 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36349 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
36350 "the input files, and (approximately) an extra 200 MB free space."
36354 #: ../tools/virt-make-fs.pl:210
36356 "Note that virt-make-fs estimates free space, and therefore will not produce "
36357 "filesystems containing precisely the free space requested. (It is much more "
36358 "expensive and time-consuming to produce a filesystem which has precisely the "
36359 "desired free space)."
36363 #: ../tools/virt-make-fs.pl:219
36364 msgid "B<--format=E<lt>fmtE<gt>>"
36368 #: ../tools/virt-make-fs.pl:221
36369 msgid "B<-F E<lt>fmtE<gt>>"
36373 #: ../tools/virt-make-fs.pl:223
36374 msgid "Choose the output disk image format."
36378 #: ../tools/virt-make-fs.pl:225
36379 msgid "The default is C<raw> (raw disk image)."
36383 #: ../tools/virt-make-fs.pl:227
36385 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
36386 "that would really make sense here is C<qcow2>."
36390 #: ../tools/virt-make-fs.pl:234
36391 msgid "B<--type=E<lt>fsE<gt>>"
36395 #: ../tools/virt-make-fs.pl:236
36396 msgid "B<-t E<lt>fsE<gt>>"
36400 #: ../tools/virt-make-fs.pl:238
36401 msgid "Choose the output filesystem type."
36405 #: ../tools/virt-make-fs.pl:240
36406 msgid "The default is C<ext2>."
36410 #: ../tools/virt-make-fs.pl:242
36411 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
36415 #: ../tools/virt-make-fs.pl:249
36416 msgid "B<--partition>"
36420 #: ../tools/virt-make-fs.pl:251
36421 msgid "B<--partition=E<lt>parttypeE<gt>>"
36425 #: ../tools/virt-make-fs.pl:253
36427 "If specified, this flag adds an MBR partition table to the output disk "
36432 #: ../tools/virt-make-fs.pl:256
36434 "You can change the partition table type, eg. I<--partition=gpt> for large "
36439 #: ../tools/virt-make-fs.pl:259
36441 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
36442 "might consider the next parameter to be the partition type. For example:"
36446 #: ../tools/virt-make-fs.pl:263
36449 " virt-make-fs --partition input.tar ...\n"
36454 #: ../tools/virt-make-fs.pl:265
36456 "would cause virt-make-fs to think you wanted to use a partition type of "
36457 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
36458 "dash) between options and the input file argument:"
36462 #: ../tools/virt-make-fs.pl:269
36465 " virt-make-fs --partition -- input.tar ...\n"
36470 #: ../tools/virt-make-fs.pl:541
36472 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
36473 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
36474 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
36478 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
36480 "When reporting bugs, please enable debugging and capture the I<complete> "
36485 #: ../tools/virt-make-fs.pl:558
36488 " export LIBGUESTFS_DEBUG=1\n"
36489 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
36494 #: ../tools/virt-make-fs.pl:561
36496 "Attach /tmp/virt-make-fs.log to a new bug report at "
36497 "L<https://bugzilla.redhat.com/>"
36501 #: ../tools/virt-tar.pl:33
36502 msgid "virt-tar - Extract or upload files to a virtual machine"
36506 #: ../tools/virt-tar.pl:37
36509 " virt-tar [--options] -x domname directory tarball\n"
36514 #: ../tools/virt-tar.pl:39
36517 " virt-tar [--options] -u domname tarball directory\n"
36522 #: ../tools/virt-tar.pl:41
36525 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
36530 #: ../tools/virt-tar.pl:43
36533 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
36538 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
36543 #: ../tools/virt-tar.pl:47
36545 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36546 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
36550 #: ../tools/virt-tar.pl:52
36551 msgid "Download C</home> from the VM into a local tarball:"
36555 #: ../tools/virt-tar.pl:54
36558 " virt-tar -x domname /home home.tar\n"
36563 #: ../tools/virt-tar.pl:56
36566 " virt-tar -zx domname /home home.tar.gz\n"
36571 #: ../tools/virt-tar.pl:58
36572 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
36576 #: ../tools/virt-tar.pl:60
36579 " virt-tar -u domname uploadstuff.tar /tmp\n"
36584 #: ../tools/virt-tar.pl:62
36587 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
36592 #: ../tools/virt-tar.pl:66
36594 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
36595 "virtual machines. If you do this, you risk disk corruption in the VM. "
36596 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
36600 #: ../tools/virt-tar.pl:71
36602 "You can use I<-x> (extract) on live virtual machines, but you might get "
36603 "inconsistent results or errors if there is filesystem activity inside the "
36604 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
36605 "work, but the only way to guarantee consistent results is if the virtual "
36606 "machine is shut down."
36610 #: ../tools/virt-tar.pl:79
36612 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
36613 "parts of a guest filesystem. There are many possibilities: making backups, "
36614 "uploading data files, snooping on guest activity, fixing or customizing "
36619 #: ../tools/virt-tar.pl:84
36621 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
36622 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
36623 "should look at the L<guestfish(1)> tool."
36627 #: ../tools/virt-tar.pl:88
36629 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
36630 "its contents (recursively) from the virtual machine into a local tarball. "
36631 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
36632 "virtual machine. You cannot use these two options together."
36636 #: ../tools/virt-tar.pl:94
36638 "In addition, you may need to use the I<-z> (gZip) option to enable "
36639 "compression. When uploading, you have to specify I<-z> if the upload file "
36640 "is compressed because virt-tar won't detect this on its own."
36644 #: ../tools/virt-tar.pl:98
36646 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
36647 "example it cannot do PKZip files or bzip2 compression. If you want that "
36648 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
36649 "the L<libguestfs(3)> API)."
36653 #: ../tools/virt-tar.pl:160
36654 msgid "B<--extract>"
36658 #: ../tools/virt-tar.pl:162
36659 msgid "B<--download>"
36663 #: ../tools/virt-tar.pl:164
36668 #: ../tools/virt-tar.pl:166
36669 msgid "B<--upload>"
36673 #: ../tools/virt-tar.pl:168
36675 "Use I<-x> to extract (download) a directory from a virtual machine to a "
36680 #: ../tools/virt-tar.pl:171
36682 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
36683 "Please read the L</WARNING> section above before using this option."
36687 #: ../tools/virt-tar.pl:175
36688 msgid "You must specify exactly one of these options."
36692 #: ../tools/virt-tar.pl:181
36697 #: ../tools/virt-tar.pl:183
36702 #: ../tools/virt-tar.pl:185
36703 msgid "Specify that the input or output tarball is gzip-compressed."
36707 #: ../tools/virt-tar.pl:298
36709 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
36710 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36711 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
36712 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36716 #: ../tools/virt-win-reg.pl:37
36718 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
36723 #: ../tools/virt-win-reg.pl:41
36726 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
36731 #: ../tools/virt-win-reg.pl:43
36734 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
36739 #: ../tools/virt-win-reg.pl:45
36742 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
36747 #: ../tools/virt-win-reg.pl:47
36750 " virt-win-reg --merge domname [input.reg ...]\n"
36755 #: ../tools/virt-win-reg.pl:49
36758 " virt-win-reg [--options] disk.img ... # instead of domname\n"
36763 #: ../tools/virt-win-reg.pl:53
36765 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
36766 "virtual machines. If you do this, you I<will> get irreversible disk "
36767 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
36768 "but doesn't catch all cases."
36772 #: ../tools/virt-win-reg.pl:58
36774 "Modifying the Windows Registry is an inherently risky operation. The format "
36775 "is deliberately obscure and undocumented, and Registry changes can leave the "
36776 "system unbootable. Therefore when using the I<--merge> option, make sure "
36777 "you have a reliable backup first."
36781 #: ../tools/virt-win-reg.pl:65
36783 "This program can export and merge Windows Registry entries from a Windows "
36788 #: ../tools/virt-win-reg.pl:68
36790 "The first parameter is the libvirt guest name or the raw disk image of a "
36795 #: ../tools/virt-win-reg.pl:71
36797 "If I<--merge> is I<not> specified, then the chosen registry key is "
36798 "displayed/exported (recursively). For example:"
36802 #: ../tools/virt-win-reg.pl:74
36805 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
36810 #: ../tools/virt-win-reg.pl:76
36811 msgid "You can also display single values from within registry keys, for example:"
36815 #: ../tools/virt-win-reg.pl:79
36818 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
36819 " $ virt-win-reg Windows7 $cvkey ProductName\n"
36820 " Windows 7 Enterprise\n"
36825 #: ../tools/virt-win-reg.pl:83
36827 "With I<--merge>, you can merge a textual regedit file into the Windows "
36832 #: ../tools/virt-win-reg.pl:86
36835 " $ virt-win-reg --merge Windows7 changes.reg\n"
36840 #: ../tools/virt-win-reg.pl:90
36842 "This program is only meant for simple access to the registry. If you want "
36843 "to do complicated things with the registry, we suggest you download the "
36844 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
36845 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
36846 "L<hivexregedit(1)>."
36850 #: ../tools/virt-win-reg.pl:159
36855 #: ../tools/virt-win-reg.pl:161
36857 "In merge mode, this merges a textual regedit file into the Windows Registry "
36858 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
36859 "displays or exports Registry entries instead."
36863 #: ../tools/virt-win-reg.pl:165
36865 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
36866 "result in disk corruption. However exporting (without this flag) is always "
36871 #: ../tools/virt-win-reg.pl:173
36872 msgid "B<--encoding> UTF-16LE|ASCII"
36876 #: ../tools/virt-win-reg.pl:175
36878 "When merging (only), you may need to specify the encoding for strings to be "
36879 "used in the hive file. This is explained in detail in "
36880 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
36884 #: ../tools/virt-win-reg.pl:179
36886 "The default is to use UTF-16LE, which should work with recent versions of "
36891 #: ../tools/virt-win-reg.pl:186
36892 msgid "B<--unsafe-printable-strings>"
36896 #: ../tools/virt-win-reg.pl:188
36898 "When exporting (only), assume strings are UTF-16LE and print them as strings "
36899 "instead of hex sequences. Remove the final zero codepoint from strings if "
36904 #: ../tools/virt-win-reg.pl:192
36906 "This is unsafe and does not preserve the fidelity of strings in the original "
36907 "Registry for various reasons:"
36911 #: ../tools/virt-win-reg.pl:199
36913 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
36914 "other encodings will be corrupted by this transformation."
36918 #: ../tools/virt-win-reg.pl:204
36920 "Assumes that everything which has type 1 or 2 is really a string and that "
36921 "everything else is not a string, but the type field in real Registries is "
36926 #: ../tools/virt-win-reg.pl:210
36928 "Loses information about whether a zero codepoint followed the string in the "
36933 #: ../tools/virt-win-reg.pl:215
36935 "This all happens because the Registry itself contains no information about "
36936 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
36940 #: ../tools/virt-win-reg.pl:219
36942 "You should only use this option for quick hacking and debugging of the "
36943 "Registry contents, and I<never> use it if the output is going to be passed "
36944 "into another program or stored in another Registry."
36948 #: ../tools/virt-win-reg.pl:556
36949 msgid "SUPPORTED SYSTEMS"
36953 #: ../tools/virt-win-reg.pl:558
36955 "The program currently supports Windows NT-derived guests starting with "
36956 "Windows XP through to at least Windows 7."
36960 #: ../tools/virt-win-reg.pl:561
36961 msgid "The following Registry keys are supported:"
36965 #: ../tools/virt-win-reg.pl:565
36966 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
36970 #: ../tools/virt-win-reg.pl:567
36971 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
36975 #: ../tools/virt-win-reg.pl:569
36976 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
36980 #: ../tools/virt-win-reg.pl:571
36981 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
36985 #: ../tools/virt-win-reg.pl:573
36986 msgid "C<HKEY_USERS\\.DEFAULT>"
36990 #: ../tools/virt-win-reg.pl:575
36991 msgid "C<HKEY_USERS\\I<SID>>"
36995 #: ../tools/virt-win-reg.pl:577
36996 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37000 #: ../tools/virt-win-reg.pl:579
37001 msgid "C<HKEY_USERS\\I<username>>"
37005 #: ../tools/virt-win-reg.pl:581
37006 msgid "where I<username> is a local user name (this is a libguestfs extension)."
37010 #: ../tools/virt-win-reg.pl:585
37012 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37017 #: ../tools/virt-win-reg.pl:588
37019 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37020 "supported (there is no \"current user\")."
37024 #: ../tools/virt-win-reg.pl:591
37029 #: ../tools/virt-win-reg.pl:593
37031 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37032 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
37033 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
37034 "with Windows-style line endings, you may need to reencode the whole file "
37035 "before or after processing."
37039 #: ../tools/virt-win-reg.pl:599
37041 "To reencode a file from Windows format to Linux (before processing it with "
37042 "the I<--merge> option), you would do something like this:"
37046 #: ../tools/virt-win-reg.pl:602
37049 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
37054 #: ../tools/virt-win-reg.pl:604
37056 "To go in the opposite direction, after exporting and before sending the file "
37057 "to a Windows user, do something like this:"
37061 #: ../tools/virt-win-reg.pl:607
37064 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
37069 #: ../tools/virt-win-reg.pl:609
37070 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37074 #: ../tools/virt-win-reg.pl:611
37076 "If you are unsure about the current encoding, use the L<file(1)> command. "
37077 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
37078 "Windows-style (CRLF) line endings, like this:"
37082 #: ../tools/virt-win-reg.pl:615
37085 " $ file software.reg\n"
37086 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37087 " with CRLF line terminators\n"
37092 #: ../tools/virt-win-reg.pl:619
37093 msgid "This file would need conversion before you could I<--merge> it."
37097 #: ../tools/virt-win-reg.pl:621
37098 msgid "CurrentControlSet etc."
37102 #: ../tools/virt-win-reg.pl:623
37104 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
37105 "Registry at the level of the hive file, and therefore you cannot modify "
37110 #: ../tools/virt-win-reg.pl:627
37112 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
37113 "circumstances it might refer to another control set. The way to find out is "
37114 "to look at the C<HKLM\\SYSTEM\\Select> key:"
37118 #: ../tools/virt-win-reg.pl:631
37121 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
37122 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
37123 " \"Current\"=dword:00000001\n"
37124 " \"Default\"=dword:00000001\n"
37125 " \"Failed\"=dword:00000000\n"
37126 " \"LastKnownGood\"=dword:00000002\n"
37131 #: ../tools/virt-win-reg.pl:638
37132 msgid "\"Current\" is the one which Windows will choose when it boots."
37136 #: ../tools/virt-win-reg.pl:640
37137 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
37141 #: ../tools/virt-win-reg.pl:643
37142 msgid "WINDOWS TIPS"
37146 #: ../tools/virt-win-reg.pl:645
37148 "Note that some of these tips modify the guest disk image. The guest I<must> "
37149 "be shut off, else you will get disk corruption."
37153 #: ../tools/virt-win-reg.pl:648
37154 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
37158 #: ../tools/virt-win-reg.pl:650
37160 "Prepare a DOS batch script, VBScript or executable. Upload this using "
37161 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
37162 "is uploaded into C<C:\\>:"
37166 #: ../tools/virt-win-reg.pl:654
37169 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
37174 #: ../tools/virt-win-reg.pl:656
37175 msgid "Prepare a regedit file containing the registry change:"
37179 #: ../tools/virt-win-reg.pl:658
37182 " cat > test.reg <<'EOF'\n"
37183 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
37184 " \"Test\"=\"c:\\\\test.bat\"\n"
37190 #: ../tools/virt-win-reg.pl:663
37192 "In this example we use the key C<RunOnce> which means that the script will "
37193 "run precisely once when the first user logs in. If you want it to run every "
37194 "time a user logs in, replace C<RunOnce> with C<Run>."
37198 #: ../tools/virt-win-reg.pl:667
37199 msgid "Now update the registry:"
37203 #: ../tools/virt-win-reg.pl:669
37206 " virt-win-reg --merge WindowsGuest test.reg\n"
37211 #: ../tools/virt-win-reg.pl:671
37212 msgid "INSTALLING A SERVICE"
37216 #: ../tools/virt-win-reg.pl:673
37218 "This section assumes you are familiar with Windows services, and you either "
37219 "have a program which handles the Windows Service Control Protocol directly "
37220 "or you want to run any program using a service wrapper like SrvAny or the "
37225 #: ../tools/virt-win-reg.pl:678
37227 "First upload the program and optionally the service wrapper. In this case "
37228 "the test program is called C<test.exe> and we are using the RHSrvAny "
37233 #: ../tools/virt-win-reg.pl:682
37236 " guestfish -i -d WindowsGuest <<EOF\n"
37237 " upload rhsrvany.exe /rhsrvany.exe\n"
37238 " upload test.exe /test.exe\n"
37244 #: ../tools/virt-win-reg.pl:687
37246 "Prepare a regedit file containing the registry changes. In this example, "
37247 "the first registry change is needed for the service itself or the service "
37248 "wrapper (if used). The second registry change is only needed because I am "
37249 "using the RHSrvAny service wrapper."
37253 #: ../tools/virt-win-reg.pl:692
37256 " cat > service.reg <<'EOF'\n"
37257 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
37258 " \"Type\"=dword:00000010\n"
37259 " \"Start\"=dword:00000002\n"
37260 " \"ErrorControl\"=dword:00000001\n"
37261 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
37262 " \"DisplayName\"=\"RHSrvAny\"\n"
37263 " \"ObjectName\"=\"NetworkService\"\n"
37268 #: ../tools/virt-win-reg.pl:701
37271 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
37272 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
37273 " \"PWD\"=\"c:\\\\Temp\"\n"
37279 #: ../tools/virt-win-reg.pl:712
37281 "For use of C<ControlSet001> see the section above in this manual page. You "
37282 "may need to adjust this according to the control set that is in use by the "
37287 #: ../tools/virt-win-reg.pl:718
37289 "C<\"ObjectName\"> controls the privileges that the service will have. An "
37290 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
37291 "privileged account."
37295 #: ../tools/virt-win-reg.pl:724
37297 "For the meaning of the magic numbers, see this Microsoft KB article: "
37298 "L<http://support.microsoft.com/kb/103000>."
37302 #: ../tools/virt-win-reg.pl:729
37303 msgid "Update the registry:"
37307 #: ../tools/virt-win-reg.pl:731
37310 " virt-win-reg --merge WindowsGuest service.reg\n"
37315 #: ../tools/virt-win-reg.pl:735
37317 "Be careful when passing parameters containing C<\\> (backslash) in the "
37318 "shell. Usually you will have to use 'single quotes' or double backslashes "
37319 "(but not both) to protect them from the shell."
37323 #: ../tools/virt-win-reg.pl:739
37324 msgid "Paths and value names are case-insensitive."
37328 #: ../tools/virt-win-reg.pl:748
37330 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
37331 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
37332 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
37333 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37337 #: ../tools/virt-win-reg.pl:766
37340 " export LIBGUESTFS_DEBUG=1\n"
37341 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
37346 #: ../tools/virt-win-reg.pl:769
37348 "Attach /tmp/virt-win-reg.log to a new bug report at "
37349 "L<https://bugzilla.redhat.com/>"