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.3\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-08-07 23:14+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:1007 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
106 #: ../cat/virt-cat.pod:34
107 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
111 #: ../cat/virt-cat.pod:37
114 " virt-cat -d mydomain /etc/fstab\n"
119 #: ../cat/virt-cat.pod:39
120 msgid "List syslog messages from a VM disk image file:"
124 #: ../cat/virt-cat.pod:41
127 " virt-cat -a disk.img /var/log/messages | tail\n"
132 #: ../cat/virt-cat.pod:43
133 msgid "Find out what DHCP IP address a VM acquired:"
137 #: ../cat/virt-cat.pod:45
140 " virt-cat -d mydomain /var/log/messages | \\\n"
141 " grep 'dhclient: bound to' | tail\n"
146 #: ../cat/virt-cat.pod:48
147 msgid "Find out what packages were recently installed:"
151 #: ../cat/virt-cat.pod:50
154 " virt-cat -d mydomain /var/log/yum.log | tail\n"
159 #: ../cat/virt-cat.pod:52
160 msgid "Find out who is logged on inside a virtual machine:"
164 #: ../cat/virt-cat.pod:54
167 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
173 #: ../cat/virt-cat.pod:57
174 msgid "or who was logged on:"
178 #: ../cat/virt-cat.pod:59
181 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
182 " last -f /tmp/wtmp\n"
187 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:37 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
192 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
197 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
198 msgid "Display brief help."
202 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
207 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
208 msgid "B<--add> file"
212 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
214 "Add I<file> which should be a disk image from a virtual machine. If the "
215 "virtual machine has multiple block devices, you must supply all of them with "
216 "separate I<-a> options."
220 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
222 "The format of the disk image is auto-detected. To override this and force a "
223 "particular format use the I<--format=..> option."
227 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
232 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
233 msgid "B<--connect> URI"
237 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
239 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
240 "to the default libvirt hypervisor."
244 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
246 "If you specify guest block devices directly (I<-a>), then libvirt is not "
251 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
256 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
257 msgid "B<--domain> guest"
261 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
263 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
268 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
269 msgid "B<--echo-keys>"
273 #: ../cat/virt-cat.pod:100
275 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
276 "so you cannot see what you are typing. If you are not worried about Tempest "
277 "attacks and there is no one else in the room you can specify this flag to "
278 "see what you are typing."
282 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
283 msgid "B<--format=raw|qcow2|..>"
287 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
292 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137 ../rescue/virt-rescue.pod:128
294 "The default for the I<-a> option is to auto-detect the format of the disk "
295 "image. Using this forces the disk format for I<-a> options which follow on "
296 "the command line. Using I<--format> with no argument switches back to "
297 "auto-detection for subsequent I<-a> options."
301 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:335 ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2652
306 #: ../cat/virt-cat.pod:116
309 " virt-cat --format=raw -a disk.img file\n"
314 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
315 msgid "forces raw format (no auto-detection) for C<disk.img>."
319 #: ../cat/virt-cat.pod:120
322 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
327 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
329 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
330 "auto-detection for C<another.img>."
334 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
336 "If you have untrusted raw-format guest disk images, you should use this "
337 "option to specify the disk format. This avoids a possible security problem "
338 "with malicious guests (CVE-2010-3851)."
342 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
343 msgid "B<--keys-from-stdin>"
347 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
349 "Read key or passphrase parameters from stdin. The default is to try to read "
350 "passphrases from the user by opening C</dev/tty>."
354 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:178
359 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:180
364 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:182
365 msgid "Enable verbose messages for debugging."
369 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184 ../resize/virt-resize.pod:478
374 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186 ../resize/virt-resize.pod:480 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
379 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:482 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
380 msgid "Display version number and exit."
384 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:199 ../tools/virt-tar.pl:158
389 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:201
390 msgid "Enable tracing of libguestfs API calls."
394 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:205
395 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
399 #: ../cat/virt-cat.pod:154
400 msgid "Previous versions of virt-cat allowed you to write either:"
404 #: ../cat/virt-cat.pod:156
407 " virt-cat disk.img [disk.img ...] file\n"
412 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:211
417 #: ../cat/virt-cat.pod:160
420 " virt-cat guestname file\n"
425 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:215
427 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
428 "the confusing case where a disk image might have the same name as a guest."
432 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:219
433 msgid "For compatibility the old style is still supported."
437 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
438 msgid "USING GUESTFISH"
442 #: ../cat/virt-cat.pod:170
444 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
445 "C<virt-cat> doesn't work."
449 #: ../cat/virt-cat.pod:173
450 msgid "Using C<virt-cat> is approximately equivalent to doing:"
454 #: ../cat/virt-cat.pod:175
457 " guestfish --ro -i -d domname download file -\n"
462 #: ../cat/virt-cat.pod:177
464 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
465 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
469 #: ../cat/virt-cat.pod:181
471 "The command above uses libguestfs's guest inspection feature and so does not "
472 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
473 "disk images that don't contain guests. To display a file from a disk image "
478 #: ../cat/virt-cat.pod:186
481 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
486 #: ../cat/virt-cat.pod:188
488 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
489 "the disk image to edit, and C<file> is the full path to the file."
493 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:349 ../rescue/virt-rescue.pod:262 ../resize/virt-resize.pod:543 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
494 msgid "SHELL QUOTING"
498 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:264 ../resize/virt-resize.pod:545 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
500 "Libvirt guest names can contain arbitrary characters, some of which have "
501 "meaning to the shell such as C<#> and space. You may need to quote or "
502 "escape these characters on the command line. See the shell manual page "
503 "L<sh(1)> for details."
507 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1224 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:372 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284 ../resize/virt-resize.pod:550 ../ruby/examples/guestfs-ruby.pod:36 ../src/guestfs.pod:3026 ../test-tool/libguestfs-test-tool.pod:87 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:746
512 #: ../cat/virt-cat.pod:201
514 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
515 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
519 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383 ../cat/virt-ls.pod:502 ../df/virt-df.pod:230 ../edit/virt-edit.pod:363 ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:772
524 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:504 ../df/virt-df.pod:232 ../edit/virt-edit.pod:365 ../inspector/virt-inspector.pod:386 ../rescue/virt-rescue.pod:294 ../resize/virt-resize.pod:573 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
525 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
529 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387 ../cat/virt-ls.pod:506 ../df/virt-df.pod:234 ../edit/virt-edit.pod:367 ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400 ../fish/guestfish.pod:1253 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318 ../inspector/virt-inspector.pod:394 ../java/examples/guestfs-java.pod:61 ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55 ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:575 ../ruby/examples/guestfs-ruby.pod:51 ../src/guestfs.pod:3102 ../test-tool/libguestfs-test-tool.pod:97 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:776
534 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396 ../resize/virt-resize.pod:577
535 msgid "Copyright (C) 2010-2011 Red Hat Inc."
539 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391 ../cat/virt-ls.pod:510 ../df/virt-df.pod:238 ../edit/virt-edit.pod:371 ../fish/guestfish.pod:1258 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323 ../inspector/virt-inspector.pod:398 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:579 ../test-tool/libguestfs-test-tool.pod:102 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:780
541 "This program is free software; you can redistribute it and/or modify it "
542 "under the terms of the GNU General Public License as published by the Free "
543 "Software Foundation; either version 2 of the License, or (at your option) "
548 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1263 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:403 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:584 ../test-tool/libguestfs-test-tool.pod:107 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:785
550 "This program is distributed in the hope that it will be useful, but WITHOUT "
551 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
552 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
557 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1268 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333 ../inspector/virt-inspector.pod:408 ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:589 ../test-tool/libguestfs-test-tool.pod:112 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:790
559 "You should have received a copy of the GNU General Public License along with "
560 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
561 "Ave, Cambridge, MA 02139, USA."
565 #: ../cat/virt-filesystems.pod:5
567 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
568 "virtual machine or disk image"
572 #: ../cat/virt-filesystems.pod:9
575 " virt-filesystems [--options] -d domname\n"
580 #: ../cat/virt-filesystems.pod:11
583 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
588 #: ../cat/virt-filesystems.pod:15
590 "This tool allows you to discover filesystems, partitions, logical volumes, "
591 "and their sizes in a disk image or virtual machine. It is a replacement for "
592 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
596 #: ../cat/virt-filesystems.pod:20
598 "One use for this tool is from shell scripts to iterate over all filesystems "
603 #: ../cat/virt-filesystems.pod:23
606 " for fs in $(virt-filesystems -a disk.img); do\n"
613 #: ../cat/virt-filesystems.pod:27
615 "Another use is to list partitions before using another tool to modify those "
616 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
617 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
621 #: ../cat/virt-filesystems.pod:32
623 "Various command line options control what this program displays. You need "
624 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
625 "guest respectively. If you just specify that then the program shows "
626 "filesystems found, one per line, like this:"
630 #: ../cat/virt-filesystems.pod:37
633 " $ virt-filesystems -a disk.img\n"
635 " /dev/vg_guest/lv_root\n"
640 #: ../cat/virt-filesystems.pod:41
641 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
645 #: ../cat/virt-filesystems.pod:44
648 " $ virt-filesystems -a disk.img -l\n"
649 " Name Type VFS Label Size\n"
650 " /dev/sda1 filesystem ext4 boot 524288000\n"
651 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
656 #: ../cat/virt-filesystems.pod:49
658 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
663 #: ../cat/virt-filesystems.pod:52
666 " $ virt-filesystems -a disk.img --extra\n"
668 " /dev/vg_guest/lv_root\n"
669 " /dev/vg_guest/lv_swap\n"
670 " /dev/vg_guest/lv_data\n"
675 #: ../cat/virt-filesystems.pod:58
676 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
680 #: ../cat/virt-filesystems.pod:60
683 " $ virt-filesystems -a disk.img --partitions\n"
690 #: ../cat/virt-filesystems.pod:64
692 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
693 "I<--physical-volumes>, I<--block-devices> to list those items."
697 #: ../cat/virt-filesystems.pod:67
699 "You can use these options in combination as well (if you want a combination "
700 "including filesystems, you have to add I<--filesystems>). Notice that some "
701 "items fall into several categories (eg. C</dev/sda1> might be both a "
702 "partition and a filesystem). These items are listed several times. To get "
703 "a list which includes absolutely everything that virt-filesystems knows "
704 "about, use the I<--all> option."
708 #: ../cat/virt-filesystems.pod:74
710 "UUIDs (because they are quite long) are not shown by default. Add the "
711 "I<--uuid> option to display device and filesystem UUIDs in the long output."
715 #: ../cat/virt-filesystems.pod:78
717 "I<--all --long --uuid> is a useful combination to display all possible "
718 "information about everything."
722 #: ../cat/virt-filesystems.pod:81
725 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
726 " Name Type VFS Label Size Parent UUID\n"
727 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
728 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
729 " /dev/sda1 partition - - 100M /dev/sda -\n"
730 " /dev/sda2 partition - - 20G /dev/sda -\n"
731 " /dev/sda device - - 20G - -\n"
736 #: ../cat/virt-filesystems.pod:89
737 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
741 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
746 #: ../cat/virt-filesystems.pod:112
748 "Display everything. This is currently the same as specifying these options: "
749 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
750 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may "
751 "be added to this list in future)."
755 #: ../cat/virt-filesystems.pod:117
756 msgid "See also I<--long>."
760 #: ../cat/virt-filesystems.pod:119
765 #: ../cat/virt-filesystems.pod:121
766 msgid "B<--block-devices>"
770 #: ../cat/virt-filesystems.pod:123
771 msgid "Display block devices."
775 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
780 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
782 "Write out the results in CSV format (comma-separated values). This format "
783 "can be imported easily into databases and spreadsheets, but read L</NOTE "
784 "ABOUT CSV FORMAT> below."
788 #: ../cat/virt-filesystems.pod:150
790 "When prompting for keys and passphrases, virt-filesystems normally turns "
791 "echoing off so you cannot see what you are typing. If you are not worried "
792 "about Tempest attacks and there is no one else in the room you can specify "
793 "this flag to see what you are typing."
797 #: ../cat/virt-filesystems.pod:155
802 #: ../cat/virt-filesystems.pod:157
804 "This causes filesystems that are not ordinary, mountable filesystems to be "
805 "displayed. This category includes swapspace, and filesystems that are empty "
806 "or contain unknown data."
810 #: ../cat/virt-filesystems.pod:161
811 msgid "This option implies I<--filesystems>."
815 #: ../cat/virt-filesystems.pod:163
816 msgid "B<--filesystems>"
820 #: ../cat/virt-filesystems.pod:165
822 "Display mountable filesystems. If no display option was selected then this "
827 #: ../cat/virt-filesystems.pod:168
828 msgid "With I<--extra>, non-mountable filesystems are shown too."
832 #: ../cat/virt-filesystems.pod:181
835 " virt-filesystems --format=raw -a disk.img\n"
840 #: ../cat/virt-filesystems.pod:185
843 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
848 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
853 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
854 msgid "B<--human-readable>"
858 #: ../cat/virt-filesystems.pod:198
859 msgid "In I<--long> mode, display sizes in human-readable format."
863 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
868 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
873 #: ../cat/virt-filesystems.pod:209
874 msgid "Display extra columns of data (\"long format\")."
878 #: ../cat/virt-filesystems.pod:211
879 msgid "A title row is added unless you also specify I<--no-title>."
883 #: ../cat/virt-filesystems.pod:213
885 "The extra columns displayed depend on what output you select, and the "
886 "ordering of columns may change in future versions. Use the title row, "
887 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
892 #: ../cat/virt-filesystems.pod:218
894 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
895 "default is to show raw numbers of I<bytes>."
899 #: ../cat/virt-filesystems.pod:221
900 msgid "Use I<--uuid> to display UUIDs too."
904 #: ../cat/virt-filesystems.pod:223
909 #: ../cat/virt-filesystems.pod:225
914 #: ../cat/virt-filesystems.pod:227
915 msgid "B<--logical-volumes>"
919 #: ../cat/virt-filesystems.pod:229
921 "Display LVM logical volumes. In this mode, these are displayed irrespective "
922 "of whether the LVs contain filesystems."
926 #: ../cat/virt-filesystems.pod:232
927 msgid "B<--no-title>"
931 #: ../cat/virt-filesystems.pod:234
932 msgid "In I<--long> mode, don't add a title row."
936 #: ../cat/virt-filesystems.pod:236
938 "Note that the order of the columns is not fixed, and may change in future "
939 "versions of virt-filesystems, so using this option may give you unexpected "
944 #: ../cat/virt-filesystems.pod:240
949 #: ../cat/virt-filesystems.pod:242
950 msgid "B<--partitions>"
954 #: ../cat/virt-filesystems.pod:244
956 "Display partitions. In this mode, these are displayed irrespective of "
957 "whether the partitions contain filesystems."
961 #: ../cat/virt-filesystems.pod:247
966 #: ../cat/virt-filesystems.pod:249
967 msgid "B<--physvols>"
971 #: ../cat/virt-filesystems.pod:251
972 msgid "B<--physical-volumes>"
976 #: ../cat/virt-filesystems.pod:253
977 msgid "Display LVM physical volumes."
981 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
986 #: ../cat/virt-filesystems.pod:257
991 #: ../cat/virt-filesystems.pod:259
992 msgid "In I<--long> mode, display UUIDs as well."
996 #: ../cat/virt-filesystems.pod:273
1001 #: ../cat/virt-filesystems.pod:275
1002 msgid "B<--volgroups>"
1006 #: ../cat/virt-filesystems.pod:277
1007 msgid "B<--volume-groups>"
1011 #: ../cat/virt-filesystems.pod:279
1012 msgid "Display LVM volume groups."
1016 #: ../cat/virt-filesystems.pod:287
1021 #: ../cat/virt-filesystems.pod:289
1023 "Note that columns in the output are subject to reordering and change in "
1024 "future versions of this tool."
1028 #: ../cat/virt-filesystems.pod:294
1033 #: ../cat/virt-filesystems.pod:296
1034 msgid "The filesystem, partition, block device or LVM name."
1038 #: ../cat/virt-filesystems.pod:298
1040 "For device and partition names these are displayed as canonical libguestfs "
1041 "names, so that for example C</dev/sda2> is the second partition on the first "
1046 #: ../cat/virt-filesystems.pod:302
1048 "If the I<--long> option is B<not> specified, then only the name column is "
1049 "shown in the output."
1053 #: ../cat/virt-filesystems.pod:305
1058 #: ../cat/virt-filesystems.pod:307
1059 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1063 #: ../cat/virt-filesystems.pod:309
1068 #: ../cat/virt-filesystems.pod:311
1070 "If there is a filesystem, then this column displays the filesystem type if "
1071 "one could be detected, eg. C<ext4>."
1075 #: ../cat/virt-filesystems.pod:314
1080 #: ../cat/virt-filesystems.pod:316
1082 "If the object has a label (used for identifying and mounting filesystems) "
1083 "then this column contains the label."
1087 #: ../cat/virt-filesystems.pod:319
1092 #: ../cat/virt-filesystems.pod:321
1094 "The size of the object in bytes. If the I<--human> option is used then the "
1095 "size is displayed in a human-readable form."
1099 #: ../cat/virt-filesystems.pod:324
1104 #: ../cat/virt-filesystems.pod:326
1106 "The parent column records the parent relationship between objects. For "
1107 "example, if the object is a partition, then this column contains the name of "
1108 "the containing device. If the object is a logical volume, then this column "
1109 "is the name of the volume group."
1113 #: ../cat/virt-filesystems.pod:331
1118 #: ../cat/virt-filesystems.pod:333
1120 "If the object has a UUID (used for identifying and mounting filesystems and "
1121 "block devices) then this column contains the UUID as a string."
1125 #: ../cat/virt-filesystems.pod:337
1126 msgid "The UUID is only displayed if the I<--uuid> option is given."
1130 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1131 msgid "NOTE ABOUT CSV FORMAT"
1135 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1137 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1138 "should be easy to parse, but it is definitely not easy to parse."
1142 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1144 "Myth: Just split fields at commas. Reality: This does I<not> work "
1145 "reliably. This example has two columns:"
1149 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1152 " \"foo,bar\",baz\n"
1157 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1159 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1160 "reliably. This example has one row:"
1164 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1173 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1175 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1176 "packaged in major Linux distributions)."
1180 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1182 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1183 "or Python's built-in csv library)."
1187 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1188 msgid "Most spreadsheets and databases can import CSV directly."
1192 #: ../cat/virt-filesystems.pod:374
1194 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1195 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1196 "L<http://libguestfs.org/>."
1200 #: ../cat/virt-filesystems.pod:389 ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
1201 msgid "Copyright (C) 2010 Red Hat Inc."
1205 #: ../cat/virt-ls.pod:5
1206 msgid "virt-ls - List files in a virtual machine"
1210 #: ../cat/virt-ls.pod:9
1213 " virt-ls [--options] -d domname directory [directory ...]\n"
1218 #: ../cat/virt-ls.pod:11
1221 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1227 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1232 #: ../cat/virt-ls.pod:15
1235 " virt-ls [--options] domname directory\n"
1240 #: ../cat/virt-ls.pod:17
1243 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1248 #: ../cat/virt-ls.pod:21
1250 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1251 "more from a virtual machine or disk image."
1255 #: ../cat/virt-ls.pod:24
1257 "Multiple directory names can be given, in which case the output from each is "
1262 #: ../cat/virt-ls.pod:27
1264 "To list directories from a libvirt guest use the I<-d> option to specify the "
1265 "name of the guest. For a disk image, use the I<-a> option."
1269 #: ../cat/virt-ls.pod:31
1271 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1272 "may need to use L<guestfish(1)>, or write a program directly to the "
1273 "L<guestfs(3)> API."
1277 #: ../cat/virt-ls.pod:37
1278 msgid "Get a list of all files and directories in a virtual machine:"
1282 #: ../cat/virt-ls.pod:39
1285 " virt-ls -R -d guest /\n"
1290 #: ../cat/virt-ls.pod:41
1291 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1295 #: ../cat/virt-ls.pod:43
1298 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1303 #: ../cat/virt-ls.pod:45
1304 msgid "List all public-writable directories in a Linux virtual machine:"
1308 #: ../cat/virt-ls.pod:47
1311 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1316 #: ../cat/virt-ls.pod:49
1317 msgid "List all Unix domain sockets in a Linux virtual machine:"
1321 #: ../cat/virt-ls.pod:51
1324 " virt-ls -lR -d guest / | grep '^s'\n"
1329 #: ../cat/virt-ls.pod:53
1330 msgid "List all regular files with filenames ending in '.png':"
1334 #: ../cat/virt-ls.pod:55
1337 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1342 #: ../cat/virt-ls.pod:57
1343 msgid "To display files larger than 10MB in home directories:"
1347 #: ../cat/virt-ls.pod:59
1350 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1355 #: ../cat/virt-ls.pod:61
1356 msgid "Find everything modified in the last 7 days:"
1360 #: ../cat/virt-ls.pod:63
1363 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1368 #: ../cat/virt-ls.pod:65
1369 msgid "Find regular files modified in the last 24 hours:"
1373 #: ../cat/virt-ls.pod:67
1376 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1381 #: ../cat/virt-ls.pod:69
1382 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1386 #: ../cat/virt-ls.pod:71
1388 "Find the differences between files in a guest and an earlier snapshot of the "
1393 #: ../cat/virt-ls.pod:74
1396 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1397 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1398 " diff -u old new | less\n"
1403 #: ../cat/virt-ls.pod:78
1405 "The commands above won't find files where the content has changed but the "
1406 "metadata (eg. file size and modification date) is the same. To do that, you "
1407 "need to add the I<--checksum> parameter to both C<virt-ls> commands. "
1408 "I<--checksum> can be quite slow since it has to read and compute a checksum "
1409 "of every regular file in the virtual machine."
1413 #: ../cat/virt-ls.pod:84
1414 msgid "OUTPUT MODES"
1418 #: ../cat/virt-ls.pod:86
1420 "C<virt-ls> has four output modes, controlled by different combinations of "
1421 "the I<-l> and I<-R> options."
1425 #: ../cat/virt-ls.pod:89
1426 msgid "SIMPLE LISTING"
1430 #: ../cat/virt-ls.pod:91
1431 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1435 #: ../cat/virt-ls.pod:93
1438 " $ virt-ls -d guest /\n"
1446 #: ../cat/virt-ls.pod:98
1447 msgid "LONG LISTING"
1451 #: ../cat/virt-ls.pod:100
1453 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1454 "(more specifically, like the C<guestfs_ll> function)."
1458 #: ../cat/virt-ls.pod:103
1461 " $ virt-ls -l -d guest /\n"
1463 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1464 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1470 #: ../cat/virt-ls.pod:109
1472 "Note that while this is useful for displaying a directory, do not try "
1473 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1478 #: ../cat/virt-ls.pod:113
1479 msgid "RECURSIVE LISTING"
1483 #: ../cat/virt-ls.pod:115
1485 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1486 "and directories recursively:"
1490 #: ../cat/virt-ls.pod:118
1493 " $ virt-ls -R -d guest /tmp\n"
1501 #: ../cat/virt-ls.pod:123
1503 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1504 "converts C<\\0> characters to C<\\n>."
1508 #: ../cat/virt-ls.pod:126
1509 msgid "RECURSIVE LONG LISTING"
1513 #: ../cat/virt-ls.pod:128
1515 "Using I<-lR> options together changes the output to display directories "
1516 "recursively, with file stats, and optionally other features such as "
1517 "checksums and extended attributes."
1521 #: ../cat/virt-ls.pod:132
1523 "Most of the interesting features of C<virt-ls> are only available when using "
1528 #: ../cat/virt-ls.pod:135
1530 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1531 "you cannot use the output in another program (because filenames can contain "
1532 "spaces and other unsafe characters). If the guest was untrusted and someone "
1533 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1534 "on you by creating filenames with embedded newline characters. To B<safely> "
1535 "parse the output in another program, use the I<--csv> (Comma-Separated "
1540 #: ../cat/virt-ls.pod:143
1542 "Note that this output format is completely unrelated to the C<ls -lR> "
1547 #: ../cat/virt-ls.pod:146
1550 " $ virt-ls -lR -d guest /bin\n"
1551 " d 0555 4096 /bin\n"
1552 " - 0755 123 /bin/alsaunmute\n"
1553 " - 0755 28328 /bin/arch\n"
1554 " l 0777 4 /bin/awk -> gawk\n"
1555 " - 0755 27216 /bin/basename\n"
1556 " - 0755 943360 /bin/bash\n"
1562 #: ../cat/virt-ls.pod:155
1563 msgid "These basic fields are always shown:"
1567 #: ../cat/virt-ls.pod:159
1572 #: ../cat/virt-ls.pod:161
1574 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1575 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1576 "link), C<s> (socket) or C<u> (unknown)."
1580 #: ../cat/virt-ls.pod:171
1585 #: ../cat/virt-ls.pod:173
1586 msgid "The Unix permissions, displayed as a 4 digit octal number."
1590 #: ../cat/virt-ls.pod:175
1595 #: ../cat/virt-ls.pod:177
1597 "The size of the file. This is shown in bytes unless I<-h> or "
1598 "I<--human-readable> option is given, in which case this is shown as a "
1599 "human-readable number."
1603 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4183
1608 #: ../cat/virt-ls.pod:183
1609 msgid "The full path of the file or directory."
1613 #: ../cat/virt-ls.pod:185
1618 #: ../cat/virt-ls.pod:187
1619 msgid "For symbolic links only, the link target."
1623 #: ../cat/virt-ls.pod:191
1625 "In I<-lR> mode, additional command line options enable the display of more "
1630 #: ../cat/virt-ls.pod:194
1632 "With the I<--uids> flag, these additional fields are displayed before the "
1637 #: ../cat/virt-ls.pod:199
1642 #: ../cat/virt-ls.pod:201
1647 #: ../cat/virt-ls.pod:203
1649 "The UID and GID of the owner of the file (displayed numerically). Note "
1650 "these only make sense in the context of a Unix-like guest."
1654 #: ../cat/virt-ls.pod:208
1655 msgid "With the I<--times> flag, these additional fields are displayed:"
1659 #: ../cat/virt-ls.pod:212
1664 #: ../cat/virt-ls.pod:214
1665 msgid "The time of last access."
1669 #: ../cat/virt-ls.pod:216
1674 #: ../cat/virt-ls.pod:218
1675 msgid "The time of last modification."
1679 #: ../cat/virt-ls.pod:220
1684 #: ../cat/virt-ls.pod:222
1685 msgid "The time of last status change."
1689 #: ../cat/virt-ls.pod:226
1691 "The time fields are displayed as string dates and times, unless one of the "
1692 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1696 #: ../cat/virt-ls.pod:229
1697 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1701 #: ../cat/virt-ls.pod:233
1706 #: ../cat/virt-ls.pod:235
1708 "The device containing the file (displayed as major:minor). This may not "
1709 "match devices as known to the guest."
1713 #: ../cat/virt-ls.pod:238
1718 #: ../cat/virt-ls.pod:240
1719 msgid "The inode number."
1723 #: ../cat/virt-ls.pod:242
1728 #: ../cat/virt-ls.pod:244
1729 msgid "The number of hard links."
1733 #: ../cat/virt-ls.pod:246
1738 #: ../cat/virt-ls.pod:248
1739 msgid "For block and char special files, the device (displayed as major:minor)."
1743 #: ../cat/virt-ls.pod:251
1748 #: ../cat/virt-ls.pod:253
1749 msgid "The number of 512 byte blocks allocated to the file."
1753 #: ../cat/virt-ls.pod:257
1755 "With the I<--checksum> flag, the checksum of the file contents is shown "
1756 "(only for regular files). Computing file checksums can take a considerable "
1761 #: ../cat/virt-ls.pod:280
1762 msgid "B<--checksum>"
1766 #: ../cat/virt-ls.pod:282
1767 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
1771 #: ../cat/virt-ls.pod:284
1773 "Display checksum over file contents for regular files. With no argument, "
1774 "this defaults to using I<md5>. Using an argument, you can select the "
1775 "checksum type to use."
1779 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
1781 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
1786 #: ../cat/virt-ls.pod:316
1788 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
1789 "so you cannot see what you are typing. If you are not worried about Tempest "
1790 "attacks and there is no one else in the room you can specify this flag to "
1791 "see what you are typing."
1795 #: ../cat/virt-ls.pod:321
1796 msgid "B<--extra-stats>"
1800 #: ../cat/virt-ls.pod:323
1801 msgid "Display extra stats."
1805 #: ../cat/virt-ls.pod:339
1808 " virt-ls --format=raw -a disk.img /dir\n"
1813 #: ../cat/virt-ls.pod:343
1816 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
1821 #: ../cat/virt-ls.pod:356
1822 msgid "Display file sizes in human-readable format."
1826 #: ../cat/virt-ls.pod:370
1831 #: ../cat/virt-ls.pod:372
1832 msgid "B<--recursive>"
1836 #: ../cat/virt-ls.pod:374
1838 "Select the mode. With neither of these options, C<virt-ls> produces a "
1839 "simple, flat list of the files in the named directory. See L</SIMPLE "
1844 #: ../cat/virt-ls.pod:378
1846 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See "
1851 #: ../cat/virt-ls.pod:381
1853 "C<virt-ls -R> produces a recursive list of files starting at the named "
1854 "directory. See L</RECURSIVE LISTING>."
1858 #: ../cat/virt-ls.pod:384
1860 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
1861 "parsed. See L</RECURSIVE LONG LISTING>."
1865 #: ../cat/virt-ls.pod:387
1870 #: ../cat/virt-ls.pod:389
1871 msgid "Display time fields."
1875 #: ../cat/virt-ls.pod:394
1876 msgid "B<--time-days>"
1880 #: ../cat/virt-ls.pod:396
1881 msgid "Display time fields as days before now (negative if in the future)."
1885 #: ../cat/virt-ls.pod:398
1887 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
1888 "of the file is between 0 and 86399 seconds."
1892 #: ../cat/virt-ls.pod:404
1893 msgid "B<--time-relative>"
1897 #: ../cat/virt-ls.pod:406
1898 msgid "Display time fields as seconds before now (negative if in the future)."
1902 #: ../cat/virt-ls.pod:411
1907 #: ../cat/virt-ls.pod:413
1908 msgid "Display time fields as seconds since the Unix epoch."
1912 #: ../cat/virt-ls.pod:418
1917 #: ../cat/virt-ls.pod:420
1918 msgid "Display UID and GID fields."
1922 #: ../cat/virt-ls.pod:445
1923 msgid "Previous versions of virt-ls allowed you to write either:"
1927 #: ../cat/virt-ls.pod:447
1930 " virt-ls disk.img [disk.img ...] /dir\n"
1935 #: ../cat/virt-ls.pod:451
1938 " virt-ls guestname /dir\n"
1943 #: ../cat/virt-ls.pod:492
1945 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
1946 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
1947 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
1951 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:236 ../edit/virt-edit.pod:369 ../rescue/virt-rescue.pod:298
1952 msgid "Copyright (C) 2009-2011 Red Hat Inc."
1956 #: ../df/virt-df.pod:5
1957 msgid "virt-df - Display free space on virtual filesystems"
1961 #: ../df/virt-df.pod:9
1964 " virt-df [--options]\n"
1969 #: ../df/virt-df.pod:11
1972 " virt-df [--options] -d domname\n"
1977 #: ../df/virt-df.pod:13
1980 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
1985 #: ../df/virt-df.pod:17
1988 " virt-df [--options] domname\n"
1993 #: ../df/virt-df.pod:19
1996 " virt-df [--options] disk.img [disk.img ...]\n"
2001 #: ../df/virt-df.pod:23
2003 "C<virt-df> is a command line tool to display free space on virtual machine "
2004 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2005 "allocated to a virtual machine, but can look inside disk images to see how "
2006 "much space is really being used."
2010 #: ../df/virt-df.pod:28
2012 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2013 "to get a list of all active and inactive guests, and performs a C<df>-type "
2014 "operation on each one in turn, printing out the results."
2018 #: ../df/virt-df.pod:32
2020 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
2021 "C<df>-type operation on either the single named libvirt domain, or on the "
2022 "disk image(s) listed on the command line (which must all belong to a single "
2023 "VM). In this mode (with arguments), C<virt-df> will I<only work for a "
2024 "single guest>. If you want to run on multiple guests, then you have to "
2025 "invoke C<virt-df> multiple times."
2029 #: ../df/virt-df.pod:39
2031 "Use the I<--csv> option to get a format which can be easily parsed by other "
2032 "programs. Other options are similar to the standard L<df(1)> command."
2036 #: ../df/virt-df.pod:45
2038 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2039 "output human-readable:"
2043 #: ../df/virt-df.pod:48
2046 " # virt-df -d F14x64 -h\n"
2047 " Filesystem Size Used Available Use%\n"
2048 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2049 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2054 #: ../df/virt-df.pod:53
2055 msgid "Show disk usage for a disk image file called C<test.img>:"
2059 #: ../df/virt-df.pod:55
2062 " $ virt-df -a test1.img\n"
2063 " Filesystem 1K-blocks Used Available Use%\n"
2064 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2069 #: ../df/virt-df.pod:112
2072 " virt-df --format=raw -a disk.img\n"
2077 #: ../df/virt-df.pod:116
2080 " virt-df --format=raw -a disk.img --format -a another.img\n"
2085 #: ../df/virt-df.pod:129
2086 msgid "Print sizes in human-readable format."
2090 #: ../df/virt-df.pod:131
2091 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2095 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2100 #: ../df/virt-df.pod:135
2105 #: ../df/virt-df.pod:137
2106 msgid "Print inodes instead of blocks."
2110 #: ../df/virt-df.pod:139
2111 msgid "B<--one-per-guest>"
2115 #: ../df/virt-df.pod:141
2117 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2118 "disks from several guests to a single libguestfs appliance."
2122 #: ../df/virt-df.pod:144
2123 msgid "You might use this option in the following circumstances:"
2127 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1947 ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1961 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388 ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670 ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2859 ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2887 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052 ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420 ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437 ../src/guestfs.pod:2818 ../src/guestfs.pod:2823 ../src/guestfs.pod:2827 ../src/guestfs.pod:2831 ../src/guestfs.pod:2835 ../src/guestfs.pod:2849 ../src/guestfs.pod:2854 ../src/guestfs.pod:3079 ../src/guestfs.pod:3083 ../src/guestfs.pod:3087 ../src/guestfs.pod:3091 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710 ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2132 #: ../df/virt-df.pod:150
2134 "If you think an untrusted guest might actively try to exploit the libguestfs "
2135 "appliance kernel, then this prevents one guest from interfering with the "
2136 "stats printed for another guest."
2140 #: ../df/virt-df.pod:156
2142 "If the kernel has a bug which stops it from accessing a filesystem in one "
2143 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2144 "and report stats for further guests."
2148 #: ../df/virt-df.pod:165
2150 "Print UUIDs instead of names. This is useful for following a guest even "
2151 "when the guest is migrated or renamed, or when two guests happen to have the "
2156 #: ../df/virt-df.pod:169
2158 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2159 "images, we still print the disk image name even when this option is "
2164 #: ../df/virt-df.pod:224
2166 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
2167 "L<http://libguestfs.org/>."
2171 #: ../edit/virt-edit.pod:5
2172 msgid "virt-edit - Edit a file in a virtual machine"
2176 #: ../edit/virt-edit.pod:9
2179 " virt-edit [--options] -d domname file [file ...]\n"
2184 #: ../edit/virt-edit.pod:11
2187 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2192 #: ../edit/virt-edit.pod:13
2195 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2200 #: ../edit/virt-edit.pod:17
2203 " virt-edit domname file\n"
2208 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2211 " virt-edit disk.img [disk.img ...] file\n"
2216 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2221 #: ../edit/virt-edit.pod:23
2223 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2224 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2225 "doing this, but doesn't catch all cases."
2229 #: ../edit/virt-edit.pod:29
2231 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2232 "exists in the named virtual machine (or disk image)."
2236 #: ../edit/virt-edit.pod:32
2238 "Multiple filenames can be given, in which case they are each edited in "
2239 "turn. Each filename must be a full path, starting at the root directory "
2240 "(starting with '/')."
2244 #: ../edit/virt-edit.pod:36
2245 msgid "If you want to just view a file, use L<virt-cat(1)>."
2249 #: ../edit/virt-edit.pod:38
2251 "For more complex cases you should look at the L<guestfish(1)> tool (see "
2252 "L</USING GUESTFISH> below)."
2256 #: ../edit/virt-edit.pod:41
2258 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2259 "that and much more."
2263 #: ../edit/virt-edit.pod:46
2264 msgid "Edit the named files interactively:"
2268 #: ../edit/virt-edit.pod:48
2271 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2276 #: ../edit/virt-edit.pod:50
2279 " virt-edit -d mydomain /etc/passwd\n"
2284 #: ../edit/virt-edit.pod:52
2285 msgid "For Windows guests, some Windows paths are understood:"
2289 #: ../edit/virt-edit.pod:54
2292 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2297 #: ../edit/virt-edit.pod:56
2299 "If Perl is installed, you can also edit files non-interactively (see "
2300 "L</NON-INTERACTIVE EDITING> below). To change the init default level to 5:"
2304 #: ../edit/virt-edit.pod:60
2307 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2312 #: ../edit/virt-edit.pod:81
2313 msgid "B<-b> extension"
2317 #: ../edit/virt-edit.pod:83
2318 msgid "B<--backup> extension"
2322 #: ../edit/virt-edit.pod:85
2324 "Create a backup of the original file I<in the guest disk image>. The backup "
2325 "has the original filename with C<extension> added."
2329 #: ../edit/virt-edit.pod:88
2331 "Usually the first character of C<extension> would be a dot C<.> so you would "
2336 #: ../edit/virt-edit.pod:91
2339 " virt-edit -b .orig [etc]\n"
2344 #: ../edit/virt-edit.pod:93
2345 msgid "By default, no backup file is made."
2349 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2354 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2355 msgid "B<--connect URI>"
2359 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
2361 "If you specify guest block devices directly, then libvirt is not used at "
2366 #: ../edit/virt-edit.pod:114
2368 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2369 "off so you cannot see what you are typing. If you are not worried about "
2370 "Tempest attacks and there is no one else in the room you can specify this "
2371 "flag to see what you are typing."
2375 #: ../edit/virt-edit.pod:119
2380 #: ../edit/virt-edit.pod:121
2381 msgid "B<--expr> EXPR"
2385 #: ../edit/virt-edit.pod:123
2387 "Instead of launching the external editor, non-interactively apply the Perl "
2388 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2393 #: ../edit/virt-edit.pod:127
2395 "Be careful to properly quote the expression to prevent it from being altered "
2400 #: ../edit/virt-edit.pod:130
2401 msgid "Note that this option is only available when Perl 5 is installed."
2405 #: ../edit/virt-edit.pod:132
2406 msgid "B<--format> raw|qcow2|..."
2410 #: ../edit/virt-edit.pod:143
2413 " virt-edit --format=raw -a disk.img file\n"
2418 #: ../edit/virt-edit.pod:147
2421 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2426 #: ../edit/virt-edit.pod:181
2427 msgid "Previous versions of virt-edit allowed you to write either:"
2431 #: ../edit/virt-edit.pod:187
2434 " virt-edit guestname file\n"
2439 #: ../edit/virt-edit.pod:195
2440 msgid "NON-INTERACTIVE EDITING"
2444 #: ../edit/virt-edit.pod:197
2446 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2447 "administrator can interactively edit the file."
2451 #: ../edit/virt-edit.pod:200
2453 "There are two ways also to use C<virt-edit> from scripts in order to make "
2454 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2455 "like this, it's less error-prone to write scripts directly using the "
2456 "libguestfs API and Augeas for configuration file editing.)"
2460 #: ../edit/virt-edit.pod:206
2462 "The first method is to temporarily set C<$EDITOR> to any script or program "
2463 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2464 "update C<tmpfile> in place however it likes."
2468 #: ../edit/virt-edit.pod:210
2470 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2471 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2472 "instances of C<foo> with C<bar> in a file:"
2476 #: ../edit/virt-edit.pod:214
2479 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2484 #: ../edit/virt-edit.pod:216
2486 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2487 "For example to delete root's password you could do:"
2491 #: ../edit/virt-edit.pod:219
2494 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2499 #: ../edit/virt-edit.pod:221
2501 "What really happens is that the snippet is evaluated as a Perl expression "
2502 "for each line of the file. The line, including the final C<\\n>, is passed "
2503 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2507 #: ../edit/virt-edit.pod:226
2509 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2510 "C<apache> user account from the password file you can do:"
2514 #: ../edit/virt-edit.pod:229
2517 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2522 #: ../edit/virt-edit.pod:231
2524 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2525 "the end of the file is rather difficult this way since there is no concept "
2526 "of \"last line of the file\" - your expression just doesn't get called "
2527 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2532 #: ../edit/virt-edit.pod:237
2534 "The variable C<$lineno> contains the current line number. As is "
2535 "traditional, the first line in the file is number C<1>."
2539 #: ../edit/virt-edit.pod:240
2541 "The return value from the expression is ignored, but the expression may call "
2542 "C<die> in order to abort the whole program, leaving the original file "
2547 #: ../edit/virt-edit.pod:244
2549 "Remember when matching the end of a line that C<$_> may contain the final "
2550 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2551 "newline then neither of these. Thus to match or substitute some text at the "
2552 "end of a line, use this regular expression:"
2556 #: ../edit/virt-edit.pod:249
2559 " /some text(\\r?\\n)?$/\n"
2564 #: ../edit/virt-edit.pod:251
2566 "Alternately, use the perl C<chomp> function, being careful not to chomp "
2567 "C<$_> itself (since that would remove all newlines from the file):"
2571 #: ../edit/virt-edit.pod:255
2574 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2579 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2580 msgid "WINDOWS PATHS"
2584 #: ../edit/virt-edit.pod:259
2586 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2587 "paths (eg. C<E:\\foo\\bar.txt>)."
2591 #: ../edit/virt-edit.pod:262
2592 msgid "If and only if the guest is running Windows then:"
2596 #: ../edit/virt-edit.pod:268
2598 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2599 "to the correct filesystem."
2603 #: ../edit/virt-edit.pod:273
2605 "Any backslash (C<\\>) characters in the path are replaced with forward "
2606 "slashes so that libguestfs can process it."
2610 #: ../edit/virt-edit.pod:278
2612 "The path is resolved case insensitively to locate the file that should be "
2617 #: ../edit/virt-edit.pod:283
2618 msgid "There are some known shortcomings:"
2622 #: ../edit/virt-edit.pod:289
2623 msgid "Some NTFS symbolic links may not be followed correctly."
2627 #: ../edit/virt-edit.pod:293
2628 msgid "NTFS junction points that cross filesystems are not followed."
2632 #: ../edit/virt-edit.pod:299
2634 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2635 "C<virt-edit> doesn't work."
2639 #: ../edit/virt-edit.pod:302
2640 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2644 #: ../edit/virt-edit.pod:304
2647 " guestfish --rw -i -d domname edit /file\n"
2652 #: ../edit/virt-edit.pod:306
2654 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2659 #: ../edit/virt-edit.pod:309
2661 "The command above uses libguestfs's guest inspection feature and so does not "
2662 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2663 "disk images that don't contain guests. To edit a file on a disk image "
2668 #: ../edit/virt-edit.pod:314
2671 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2676 #: ../edit/virt-edit.pod:316
2678 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2679 "the disk image to edit, and C</file> is the full path to the file."
2683 #: ../edit/virt-edit.pod:320
2685 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2686 "C<write> or C<upload> instead:"
2690 #: ../edit/virt-edit.pod:323
2693 " guestfish --rw -i -d domname touch /newfile\n"
2698 #: ../edit/virt-edit.pod:325
2701 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
2706 #: ../edit/virt-edit.pod:327
2709 " guestfish --rw -i -d domname upload localfile /newfile\n"
2714 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1075 ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2965 ../test-tool/libguestfs-test-tool.pod:82
2715 msgid "ENVIRONMENT VARIABLES"
2719 #: ../edit/virt-edit.pod:333
2724 #: ../edit/virt-edit.pod:335
2726 "If set, this string is used as the editor. It may contain arguments, "
2727 "eg. C<\"emacs -nw\">"
2731 #: ../edit/virt-edit.pod:338
2732 msgid "If not set, C<vi> is used."
2736 #: ../edit/virt-edit.pod:351
2738 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
2739 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2740 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
2744 #: ../examples/guestfs-examples.pod:5
2745 msgid "guestfs-examples - Examples of using libguestfs from C"
2749 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
2752 " #include <guestfs.h>\n"
2757 #: ../examples/guestfs-examples.pod:11
2760 " guestfs_h *g = guestfs_create ();\n"
2761 " guestfs_add_drive_ro (g, \"disk.img\");\n"
2762 " guestfs_launch (g);\n"
2767 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
2770 " cc prog.c -o prog -lguestfs\n"
2772 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
2777 #: ../examples/guestfs-examples.pod:21
2779 "This manual page contains examples of calling libguestfs from the C "
2780 "programming language. If you are not familiar with using libguestfs, you "
2781 "also need to read L<guestfs(3)>."
2785 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
2786 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2790 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
2795 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
2796 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2800 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
2805 #: ../examples/guestfs-examples.pod:35
2807 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
2808 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
2809 "L<http://libguestfs.org/>."
2813 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396 ../fish/guestfish.pod:1249 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:57 ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51 ../python/examples/guestfs-python.pod:53 ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3098 ../test-tool/libguestfs-test-tool.pod:93
2818 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398 ../fish/guestfish.pod:1251 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316 ../java/examples/guestfs-java.pod:59 ../ocaml/examples/guestfs-ocaml.pod:92 ../perl/examples/guestfs-perl.pod:53 ../python/examples/guestfs-python.pod:55 ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3100 ../test-tool/libguestfs-test-tool.pod:95
2819 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2823 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96 ../python/examples/guestfs-python.pod:59 ../ruby/examples/guestfs-ruby.pod:53
2824 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
2828 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404 ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98 ../perl/examples/guestfs-perl.pod:59 ../python/examples/guestfs-python.pod:61 ../ruby/examples/guestfs-ruby.pod:55
2830 "The examples in this manual page may be freely copied, modified and "
2831 "distributed without any restrictions."
2835 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407 ../java/examples/guestfs-java.pod:68 ../ocaml/examples/guestfs-ocaml.pod:101 ../perl/examples/guestfs-perl.pod:62 ../python/examples/guestfs-python.pod:64 ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3107
2837 "This library is free software; you can redistribute it and/or modify it "
2838 "under the terms of the GNU Lesser General Public License as published by the "
2839 "Free Software Foundation; either version 2 of the License, or (at your "
2840 "option) any later version."
2844 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412 ../java/examples/guestfs-java.pod:73 ../ocaml/examples/guestfs-ocaml.pod:106 ../perl/examples/guestfs-perl.pod:67 ../python/examples/guestfs-python.pod:69 ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3112
2846 "This library is distributed in the hope that it will be useful, but WITHOUT "
2847 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
2848 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
2853 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417 ../java/examples/guestfs-java.pod:78 ../ocaml/examples/guestfs-ocaml.pod:111 ../perl/examples/guestfs-perl.pod:72 ../python/examples/guestfs-python.pod:74 ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3117
2855 "You should have received a copy of the GNU Lesser General Public License "
2856 "along with this library; if not, write to the Free Software Foundation, "
2857 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
2861 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
2866 #: ../examples/guestfs-recipes.pod:5
2868 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
2869 "here. The only way which works for both sorts of output is to just write "
2870 "the URL directly. Do NOT use L<...> for URLs."
2874 #: ../examples/guestfs-recipes.pod:9
2876 "We break with tradition here and don't use ALL CAPS for the section "
2877 "headings, as this makes them much easier to read."
2881 #: ../examples/guestfs-recipes.pod:16
2882 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
2886 #: ../examples/guestfs-recipes.pod:20
2888 "This page contains recipes for and links to things you can do using "
2889 "libguestfs, L<guestfish(1)> and the virt tools."
2893 #: ../examples/guestfs-recipes.pod:23
2894 msgid "Audit a virtual machine for setuid files"
2898 #: ../examples/guestfs-recipes.pod:25
2900 "The link below contains a small program which can be used to audit a Linux "
2901 "virtual machine to see what setuid and setgid files it contains."
2905 #: ../examples/guestfs-recipes.pod:28
2906 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
2910 #: ../examples/guestfs-recipes.pod:30
2911 msgid "Change the background image in a Windows XP VM"
2915 #: ../examples/guestfs-recipes.pod:32
2917 "The links below explain how to use L<guestfish(1)> to change the background "
2918 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
2919 "be substantially different for each version of Windows."
2923 #: ../examples/guestfs-recipes.pod:37
2925 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
2926 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
2930 #: ../examples/guestfs-recipes.pod:40
2931 msgid "Cloning a virtual machine (Linux)"
2935 #: ../examples/guestfs-recipes.pod:42
2937 "The guestfish technique described in the link below works well for most "
2938 "Linux VMs. Depending on the Linux distro you may need to change the paths "
2943 #: ../examples/guestfs-recipes.pod:46
2944 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
2948 #: ../examples/guestfs-recipes.pod:48
2950 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
2955 #: ../examples/guestfs-recipes.pod:51
2956 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2960 #: ../examples/guestfs-recipes.pod:53
2961 msgid "Cloning a virtual machine (Windows)"
2965 #: ../examples/guestfs-recipes.pod:55
2967 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
2968 "straightforward. Currently there is code in the Aeolus Oz project which "
2969 "does this (using libguestfs). As part of our review of the virt-clone tool, "
2970 "we may add sysprepping ability."
2974 #: ../examples/guestfs-recipes.pod:60
2976 "https://github.com/clalancette/oz "
2977 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2981 #: ../examples/guestfs-recipes.pod:63
2982 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
2986 #: ../examples/guestfs-recipes.pod:65
2987 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
2991 #: ../examples/guestfs-recipes.pod:67
2994 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
2999 #: ../examples/guestfs-recipes.pod:69
3000 msgid "To export just a subdirectory, eg. C</files>, do:"
3004 #: ../examples/guestfs-recipes.pod:71
3007 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3012 #: ../examples/guestfs-recipes.pod:73
3013 msgid "Create empty disk images"
3017 #: ../examples/guestfs-recipes.pod:75
3019 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3020 "The useful guide below explains the options available."
3024 #: ../examples/guestfs-recipes.pod:78
3025 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3029 #: ../examples/guestfs-recipes.pod:80
3030 msgid "Dump raw filesystem content from inside a disk image or VM"
3034 #: ../examples/guestfs-recipes.pod:82
3036 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3037 "filesystem content from any filesystem in a disk image or a VM (even one "
3038 "which is encrypted or buried inside an LV):"
3042 #: ../examples/guestfs-recipes.pod:86
3045 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3050 #: ../examples/guestfs-recipes.pod:88
3053 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3058 #: ../examples/guestfs-recipes.pod:90
3059 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3063 #: ../examples/guestfs-recipes.pod:92
3064 msgid "Edit grub configuration in a VM"
3068 #: ../examples/guestfs-recipes.pod:94
3069 msgid "You can use this to:"
3073 #: ../examples/guestfs-recipes.pod:100
3074 msgid "Fix a virtual machine that does not boot."
3078 #: ../examples/guestfs-recipes.pod:104
3079 msgid "Change which kernel is used to boot the VM."
3083 #: ../examples/guestfs-recipes.pod:108
3084 msgid "Change kernel command line options."
3088 #: ../examples/guestfs-recipes.pod:112
3089 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3093 #: ../examples/guestfs-recipes.pod:114
3096 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3101 #: ../examples/guestfs-recipes.pod:116
3103 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3108 #: ../examples/guestfs-recipes.pod:119
3111 " virt-rescue -d BrokenGuest\n"
3116 #: ../examples/guestfs-recipes.pod:121
3117 msgid "Export any directory from a VM"
3121 #: ../examples/guestfs-recipes.pod:123
3122 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3126 #: ../examples/guestfs-recipes.pod:126
3129 " virt-copy-out -d Guest /home .\n"
3134 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1929 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2855 ../src/guestfs.pod:1639 ../tools/virt-win-reg.pl:706
3139 #: ../examples/guestfs-recipes.pod:134
3141 "The final dot of the command is not a printing error. It means we want to "
3142 "copy out to the current directory."
3146 #: ../examples/guestfs-recipes.pod:139
3147 msgid "This creates a directory called C<home> under the current directory."
3151 #: ../examples/guestfs-recipes.pod:143
3153 "If the guest is a Windows guest then you can use drive letters and "
3154 "backslashes, but you must prefix the path with C<win:> and quote it to "
3155 "protect it from the shell, like this:"
3159 #: ../examples/guestfs-recipes.pod:147
3162 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3167 #: ../examples/guestfs-recipes.pod:149
3168 msgid "To get the output as a compressed tarball, do:"
3172 #: ../examples/guestfs-recipes.pod:151
3175 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3180 #: ../examples/guestfs-recipes.pod:153
3182 "Although it sounds tempting, this is usually not a reliable way to get a "
3183 "backup from a running guest. See the entry in the FAQ: "
3184 "http://libguestfs.org/FAQ.html#backup"
3188 #: ../examples/guestfs-recipes.pod:157
3189 msgid "Find out which user is using the most space"
3193 #: ../examples/guestfs-recipes.pod:159
3195 "This simple script examines a Linux guest to find out which user is using "
3196 "the most space in their home directory:"
3200 #: ../examples/guestfs-recipes.pod:162
3208 #: ../examples/guestfs-recipes.pod:164
3216 #: ../examples/guestfs-recipes.pod:166
3225 #: ../examples/guestfs-recipes.pod:169
3228 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3233 #: ../examples/guestfs-recipes.pod:171
3236 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3237 " echo -n \"$dir/$d\"\n"
3239 " guestfish --remote du \"$dir/$d\";\n"
3240 " done | sort -nr -k 2\n"
3245 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3248 " guestfish --remote exit\n"
3253 #: ../examples/guestfs-recipes.pod:179
3254 msgid "Get DHCP address from a VM"
3258 #: ../examples/guestfs-recipes.pod:181
3260 "The link below explains the many different possible techniques for getting "
3261 "the last assigned DHCP address of a virtual machine."
3265 #: ../examples/guestfs-recipes.pod:184
3266 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3270 #: ../examples/guestfs-recipes.pod:186
3272 "In the libguestfs source examples directory you will find the latest version "
3273 "of the C<virt-dhcp-address.c> program."
3277 #: ../examples/guestfs-recipes.pod:189
3278 msgid "Get the operating system product name string"
3282 #: ../examples/guestfs-recipes.pod:191
3283 msgid "Save the following script into a file called C<product-name.sh>:"
3287 #: ../examples/guestfs-recipes.pod:193
3292 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3293 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3294 " guestfish --remote inspect-get-product-name \"$root\"\n"
3295 " guestfish --remote exit\n"
3300 #: ../examples/guestfs-recipes.pod:200
3301 msgid "Make the script executable and run it on a named guest:"
3305 #: ../examples/guestfs-recipes.pod:202
3308 " # product-name.sh RHEL60x64\n"
3309 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3314 #: ../examples/guestfs-recipes.pod:205
3316 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3317 "C<xpath> command line tool or from your favourite programming language:"
3321 #: ../examples/guestfs-recipes.pod:209
3324 " # virt-inspector RHEL60x64 > xml\n"
3325 " # xpath '//product_name' < xml\n"
3328 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3329 "(Santiago)</product_name>\n"
3334 #: ../examples/guestfs-recipes.pod:215
3335 msgid "Get the default boot kernel for a Linux VM"
3339 #: ../examples/guestfs-recipes.pod:217
3341 "The link below contains a program to print the default boot kernel for a "
3346 #: ../examples/guestfs-recipes.pod:220
3347 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3351 #: ../examples/guestfs-recipes.pod:222
3353 "It uses Augeas, and the technique is generally applicable for many different "
3358 #: ../examples/guestfs-recipes.pod:229
3359 msgid "listing the user accounts in the guest"
3363 #: ../examples/guestfs-recipes.pod:233
3364 msgid "what repositories is it configured to use"
3368 #: ../examples/guestfs-recipes.pod:237
3369 msgid "what NTP servers does it connect to"
3373 #: ../examples/guestfs-recipes.pod:241
3374 msgid "what were the boot messages last time it booted"
3378 #: ../examples/guestfs-recipes.pod:245
3379 msgid "listing who was logged in recently"
3383 #: ../examples/guestfs-recipes.pod:249
3384 msgid "http://augeas.net/"
3388 #: ../examples/guestfs-recipes.pod:251
3389 msgid "Install RPMs in a guest"
3393 #: ../examples/guestfs-recipes.pod:253
3395 "The link below contains a method to install RPMs in a guest. In fact the "
3396 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3397 "installs them next time the guest is booted. You could use this technique "
3398 "to install vital security updates in an offline guest."
3402 #: ../examples/guestfs-recipes.pod:259
3403 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3407 #: ../examples/guestfs-recipes.pod:261
3408 msgid "List applications installed in a VM"
3412 #: ../examples/guestfs-recipes.pod:263
3413 msgid "Save the following to a file C<list-apps.sh>:"
3417 #: ../examples/guestfs-recipes.pod:265
3422 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3423 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3424 " guestfish --remote inspect-list-applications \"$root\"\n"
3425 " guestfish --remote exit\n"
3430 #: ../examples/guestfs-recipes.pod:272
3432 "Make the file executable and then you can run it on any named virtual "
3437 #: ../examples/guestfs-recipes.pod:275
3440 " # list-apps.sh WinGuest\n"
3442 " app_name: Mozilla Firefox (3.6.12)\n"
3443 " app_display_name: Mozilla Firefox (3.6.12)\n"
3445 " app_version: 3.6.12 (en-GB)\n"
3447 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3448 " app_trans_path:\n"
3449 " app_publisher: Mozilla\n"
3450 " app_url: http://www.mozilla.com/en-GB/\n"
3451 " app_source_package:\n"
3453 " app_description: Mozilla Firefox\n"
3456 " app_name: VLC media player\n"
3457 " app_display_name: VLC media player 1.1.5\n"
3459 " app_version: 1.1.5\n"
3461 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3462 " app_trans_path:\n"
3463 " app_publisher: VideoLAN\n"
3464 " app_url: http://www.videolan.org/\n"
3465 " app_source_package:\n"
3467 " app_description:\n"
3473 #: ../examples/guestfs-recipes.pod:305
3475 "If you want to run the script on disk images (instead of libvirt virtual "
3476 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
3477 "L<virt-inspector(1)>."
3481 #: ../examples/guestfs-recipes.pod:309
3482 msgid "List files and directories in a VM"
3486 #: ../examples/guestfs-recipes.pod:311
3487 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3491 #: ../examples/guestfs-recipes.pod:313
3494 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3499 #: ../examples/guestfs-recipes.pod:315
3500 msgid "List services in a Windows VM"
3504 #: ../examples/guestfs-recipes.pod:317
3506 "The link below contains a script that can be used to list out the services "
3507 "from a Windows VM, and whether those services run at boot time or are loaded "
3512 #: ../examples/guestfs-recipes.pod:321
3513 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3517 #: ../examples/guestfs-recipes.pod:323
3518 msgid "Make a disk image sparse"
3522 #: ../examples/guestfs-recipes.pod:325
3524 "The link below contains some guides for making a disk image sparse (or "
3525 "reintroducing sparseness)."
3529 #: ../examples/guestfs-recipes.pod:328
3530 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3534 #: ../examples/guestfs-recipes.pod:330
3535 msgid "Monitor disk usage over time"
3539 #: ../examples/guestfs-recipes.pod:332
3541 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3542 "The link below contains a guide."
3546 #: ../examples/guestfs-recipes.pod:335
3547 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3551 #: ../examples/guestfs-recipes.pod:337
3552 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3556 #: ../examples/guestfs-recipes.pod:339
3558 "L<guestfish(1)> plus the tools described in the link below can be used to "
3559 "read out the Windows Event Log from any virtual machine running Windows "
3560 "Vista or a later version."
3564 #: ../examples/guestfs-recipes.pod:343
3565 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3569 #: ../examples/guestfs-recipes.pod:345
3570 msgid "Remove root password (Linux)"
3574 #: ../examples/guestfs-recipes.pod:347
3576 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3577 "files. One use is to remove the root password from a Linux guest:"
3581 #: ../examples/guestfs-recipes.pod:350
3584 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3589 #: ../examples/guestfs-recipes.pod:352
3590 msgid "Remove Administrator password (Windows)"
3594 #: ../examples/guestfs-recipes.pod:354
3596 "The link below contains one technique for removing the Administrator "
3597 "password from a Windows VM, or to be more precise, it gives you a command "
3598 "prompt the next time you log in which you can use to bypass any security:"
3602 #: ../examples/guestfs-recipes.pod:359
3603 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3607 #: ../examples/guestfs-recipes.pod:361
3608 msgid "Unpack a live CD"
3612 #: ../examples/guestfs-recipes.pod:363
3614 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3615 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
3616 "layers, as outlined in the guide below."
3620 #: ../examples/guestfs-recipes.pod:367
3621 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3625 #: ../examples/guestfs-recipes.pod:369
3626 msgid "Uploading and downloading files"
3630 #: ../examples/guestfs-recipes.pod:371
3632 "The link below contains general tips on uploading (copying in) and "
3633 "downloading (copying out) files from VMs."
3637 #: ../examples/guestfs-recipes.pod:374
3638 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3642 #: ../examples/guestfs-recipes.pod:376
3643 msgid "Use libguestfs tools on VMware ESX guests"
3647 #: ../examples/guestfs-recipes.pod:378
3649 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3650 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3654 #: ../examples/guestfs-recipes.pod:382
3655 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3659 #: ../examples/guestfs-recipes.pod:386
3661 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
3662 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3663 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3667 #: ../examples/guestfs-recipes.pod:402
3668 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3672 #: ../fish/guestfish-actions.pod:1
3677 #: ../fish/guestfish-actions.pod:3
3680 " add-cdrom filename\n"
3685 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:7
3686 msgid "This function adds a virtual CD-ROM disk image to the guest."
3690 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
3691 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3695 #: ../fish/guestfish-actions.pod:15
3697 "This call checks for the existence of C<filename>. This stops you from "
3698 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3699 "and C<http:> URLs. To specify those, use the general L</config> call "
3704 #: ../fish/guestfish-actions.pod:22
3706 "If you just want to add an ISO file (often you use this as an efficient way "
3707 "to transfer large files into the guest), then you should probably use "
3708 "L</add-drive-ro> instead."
3712 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3714 "This function is deprecated. In new code, use the L</add_drive_opts> call "
3719 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3085 ../fish/guestfish-actions.pod:3292 ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3454 ../fish/guestfish-actions.pod:4355 ../fish/guestfish-actions.pod:4378 ../fish/guestfish-actions.pod:4400 ../fish/guestfish-actions.pod:4438 ../fish/guestfish-actions.pod:5087 ../fish/guestfish-actions.pod:5185 ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513 ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4947 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6574 ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6666 ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7714 ../src/guestfs-actions.pod:7884
3721 "Deprecated functions will not be removed from the API, but the fact that "
3722 "they are deprecated indicates that there are problems with correct use of "
3727 #: ../fish/guestfish-actions.pod:35
3732 #: ../fish/guestfish-actions.pod:37
3737 #: ../fish/guestfish-actions.pod:39
3740 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3746 #: ../fish/guestfish-actions.pod:41
3748 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3749 "It works by connecting to libvirt, requesting the domain and domain XML from "
3750 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3754 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3756 "The number of disks added is returned. This operation is atomic: if an "
3757 "error is returned, then no disks are added."
3761 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3763 "This function does some minimal checks to make sure the libvirt domain is "
3764 "not running (unless C<readonly> is true). In a future version we will try "
3765 "to acquire the libvirt lock on each disk."
3769 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3771 "Disks must be accessible locally. This often means that adding disks from a "
3772 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3773 "unless those disks are accessible via the same device path locally too."
3777 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3779 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3780 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
3781 "default libvirt URI (or one set through an environment variable, see the "
3782 "libvirt documentation for full details)."
3786 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3788 "The optional C<live> flag controls whether this call will try to connect to "
3789 "a running virtual machine C<guestfsd> process if it sees a suitable "
3790 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
3791 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
3792 "DAEMONS> for more information."
3796 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
3798 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
3799 "passed instead of the domain name. The C<dom> string is treated as a UUID "
3800 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
3805 #: ../fish/guestfish-actions.pod:76
3807 "The other optional parameters are passed directly through to "
3808 "L</add-drive-opts>."
3812 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968 ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307 ../fish/guestfish-actions.pod:3442
3814 "This command has one or more optional arguments. See L</OPTIONAL "
3819 #: ../fish/guestfish-actions.pod:81
3824 #: ../fish/guestfish-actions.pod:83
3827 " add-drive filename\n"
3832 #: ../fish/guestfish-actions.pod:85
3834 "This function is the equivalent of calling L</add-drive-opts> with no "
3835 "optional parameters, so the disk is added writable, with the format being "
3836 "detected automatically."
3840 #: ../fish/guestfish-actions.pod:89
3842 "Automatic detection of the format opens you up to a potential security hole "
3843 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3844 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3845 "you should think about replacing calls to this function with calls to "
3846 "L</add-drive-opts>, and specifying the format."
3850 #: ../fish/guestfish-actions.pod:96
3851 msgid "add-drive-opts"
3855 #: ../fish/guestfish-actions.pod:98
3860 #: ../fish/guestfish-actions.pod:100
3863 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
3868 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
3870 "This function adds a virtual machine disk image C<filename> to libguestfs. "
3871 "The first time you call this function, the disk appears as C</dev/sda>, the "
3872 "second time as C</dev/sdb>, and so on."
3876 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
3878 "You don't necessarily need to be root when using libguestfs. However you "
3879 "obviously do need sufficient permissions to access the filename for whatever "
3880 "operations you want to perform (ie. read access if you just want to read the "
3881 "image or write access if you want to modify the image)."
3885 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
3886 msgid "This call checks that C<filename> exists."
3890 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4655
3891 msgid "The optional arguments are:"
3895 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
3900 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
3902 "If true then the image is treated as read-only. Writes are still allowed, "
3903 "but they are stored in a temporary snapshot overlay which is discarded at "
3904 "the end. The disk that you add is not modified."
3908 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
3913 #: ../fish/guestfish-actions.pod:127
3915 "This forces the image format. If you omit this (or use L</add-drive> or "
3916 "L</add-drive-ro>) then the format is automatically detected. Possible "
3917 "formats include C<raw> and C<qcow2>."
3921 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
3923 "Automatic detection of the format opens you up to a potential security hole "
3924 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3925 "RHBZ#642934. Specifying the format closes this security hole."
3929 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
3934 #: ../fish/guestfish-actions.pod:138
3936 "This rarely-used option lets you emulate the behaviour of the deprecated "
3937 "L</add-drive-with-if> call (q.v.)"
3941 #: ../fish/guestfish-actions.pod:145
3942 msgid "add-drive-ro"
3946 #: ../fish/guestfish-actions.pod:147
3951 #: ../fish/guestfish-actions.pod:149
3954 " add-drive-ro filename\n"
3959 #: ../fish/guestfish-actions.pod:151
3961 "This function is the equivalent of calling L</add-drive-opts> with the "
3962 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
3963 "is added read-only, with the format being detected automatically."
3967 #: ../fish/guestfish-actions.pod:156
3968 msgid "add-drive-ro-with-if"
3972 #: ../fish/guestfish-actions.pod:158
3975 " add-drive-ro-with-if filename iface\n"
3980 #: ../fish/guestfish-actions.pod:160
3982 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
3983 "interface emulation to use at run time."
3987 #: ../fish/guestfish-actions.pod:170
3988 msgid "add-drive-with-if"
3992 #: ../fish/guestfish-actions.pod:172
3995 " add-drive-with-if filename iface\n"
4000 #: ../fish/guestfish-actions.pod:174
4002 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4003 "interface emulation to use at run time."
4007 #: ../fish/guestfish-actions.pod:184
4012 #: ../fish/guestfish-actions.pod:186
4015 " aug-clear augpath\n"
4020 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4022 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4023 "L<augtool(1)> C<clear> command."
4027 #: ../fish/guestfish-actions.pod:191
4032 #: ../fish/guestfish-actions.pod:193
4040 #: ../fish/guestfish-actions.pod:195
4042 "Close the current Augeas handle and free up any resources used by it. After "
4043 "calling this, you have to call L</aug-init> again before you can use any "
4044 "other Augeas functions."
4048 #: ../fish/guestfish-actions.pod:200
4053 #: ../fish/guestfish-actions.pod:202
4056 " aug-defnode name expr val\n"
4061 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4062 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4066 #: ../fish/guestfish-actions.pod:207
4068 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4069 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4070 "containing that single node."
4074 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4076 "On success this returns a pair containing the number of nodes in the "
4077 "nodeset, and a boolean flag if a node was created."
4081 #: ../fish/guestfish-actions.pod:215
4086 #: ../fish/guestfish-actions.pod:217
4089 " aug-defvar name expr\n"
4094 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4096 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4097 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4101 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4103 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4104 "evaluates to something which is not a nodeset."
4108 #: ../fish/guestfish-actions.pod:226
4113 #: ../fish/guestfish-actions.pod:228
4116 " aug-get augpath\n"
4121 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4123 "Look up the value associated with C<path>. If C<path> matches exactly one "
4124 "node, the C<value> is returned."
4128 #: ../fish/guestfish-actions.pod:233
4133 #: ../fish/guestfish-actions.pod:235
4136 " aug-init root flags\n"
4141 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4143 "Create a new Augeas handle for editing configuration files. If there was "
4144 "any previous Augeas handle associated with this guestfs session, then it is "
4149 #: ../fish/guestfish-actions.pod:241
4150 msgid "You must call this before using any other L</aug-*> commands."
4154 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4155 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4159 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4161 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4162 "logical I<or> of the following integers:"
4166 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4167 msgid "C<AUG_SAVE_BACKUP> = 1"
4171 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4172 msgid "Keep the original file with a C<.augsave> extension."
4176 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4177 msgid "C<AUG_SAVE_NEWFILE> = 2"
4181 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4183 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4184 "original. Overrides C<AUG_SAVE_BACKUP>."
4188 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4189 msgid "C<AUG_TYPE_CHECK> = 4"
4193 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4194 msgid "Typecheck lenses (can be expensive)."
4198 #: ../fish/guestfish-actions.pod:266 ../src/guestfs-actions.pod:404
4199 msgid "C<AUG_NO_STDINC> = 8"
4203 #: ../fish/guestfish-actions.pod:268 ../src/guestfs-actions.pod:406
4204 msgid "Do not use standard load path for modules."
4208 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:408
4209 msgid "C<AUG_SAVE_NOOP> = 16"
4213 #: ../fish/guestfish-actions.pod:272 ../src/guestfs-actions.pod:410
4214 msgid "Make save a no-op, just record what would have been changed."
4218 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:412
4219 msgid "C<AUG_NO_LOAD> = 32"
4223 #: ../fish/guestfish-actions.pod:276
4224 msgid "Do not load the tree in L</aug-init>."
4228 #: ../fish/guestfish-actions.pod:280
4229 msgid "To close the handle, you can call L</aug-close>."
4233 #: ../fish/guestfish-actions.pod:282 ../src/guestfs-actions.pod:420
4234 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4238 #: ../fish/guestfish-actions.pod:284
4243 #: ../fish/guestfish-actions.pod:286
4246 " aug-insert augpath label true|false\n"
4251 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:434
4253 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4254 "or after C<path> (depending on the boolean flag C<before>)."
4258 #: ../fish/guestfish-actions.pod:292 ../src/guestfs-actions.pod:438
4260 "C<path> must match exactly one existing node in the tree, and C<label> must "
4261 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4265 #: ../fish/guestfish-actions.pod:296
4270 #: ../fish/guestfish-actions.pod:298
4278 #: ../fish/guestfish-actions.pod:300 ../src/guestfs-actions.pod:451
4279 msgid "Load files into the tree."
4283 #: ../fish/guestfish-actions.pod:302 ../src/guestfs-actions.pod:453
4284 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4288 #: ../fish/guestfish-actions.pod:305
4293 #: ../fish/guestfish-actions.pod:307
4301 #: ../fish/guestfish-actions.pod:309
4303 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4304 "resulting nodes into alphabetical order."
4308 #: ../fish/guestfish-actions.pod:312
4313 #: ../fish/guestfish-actions.pod:314
4316 " aug-match augpath\n"
4321 #: ../fish/guestfish-actions.pod:316 ../src/guestfs-actions.pod:481
4323 "Returns a list of paths which match the path expression C<path>. The "
4324 "returned paths are sufficiently qualified so that they match exactly one "
4325 "node in the current tree."
4329 #: ../fish/guestfish-actions.pod:320
4334 #: ../fish/guestfish-actions.pod:322
4337 " aug-mv src dest\n"
4342 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:498
4344 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4345 "C<dest> is overwritten if it exists."
4349 #: ../fish/guestfish-actions.pod:327
4354 #: ../fish/guestfish-actions.pod:329
4362 #: ../fish/guestfish-actions.pod:331 ../src/guestfs-actions.pod:511
4363 msgid "Remove C<path> and all of its children."
4367 #: ../fish/guestfish-actions.pod:333 ../src/guestfs-actions.pod:513
4368 msgid "On success this returns the number of entries which were removed."
4372 #: ../fish/guestfish-actions.pod:335
4377 #: ../fish/guestfish-actions.pod:337
4385 #: ../fish/guestfish-actions.pod:339 ../src/guestfs-actions.pod:524
4386 msgid "This writes all pending changes to disk."
4390 #: ../fish/guestfish-actions.pod:341
4392 "The flags which were passed to L</aug-init> affect exactly how files are "
4397 #: ../fish/guestfish-actions.pod:344
4402 #: ../fish/guestfish-actions.pod:346
4405 " aug-set augpath val\n"
4410 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:540
4411 msgid "Set the value associated with C<path> to C<val>."
4415 #: ../fish/guestfish-actions.pod:350
4417 "In the Augeas API, it is possible to clear a node by setting the value to "
4418 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4419 "this call. Instead you must use the L</aug-clear> call."
4423 #: ../fish/guestfish-actions.pod:355
4428 #: ../fish/guestfish-actions.pod:357
4431 " available 'groups ...'\n"
4436 #: ../fish/guestfish-actions.pod:359 ../src/guestfs-actions.pod:557
4438 "This command is used to check the availability of some groups of "
4439 "functionality in the appliance, which not all builds of the libguestfs "
4440 "appliance will be able to provide."
4444 #: ../fish/guestfish-actions.pod:363
4446 "The libguestfs groups, and the functions that those groups correspond to, "
4447 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4448 "runtime by calling L</available-all-groups>."
4452 #: ../fish/guestfish-actions.pod:368 ../src/guestfs-actions.pod:566
4454 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4455 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4456 "and Augeas (configuration file editing) functions."
4460 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4461 msgid "The command returns no error if I<all> requested groups are available."
4465 #: ../fish/guestfish-actions.pod:375 ../src/guestfs-actions.pod:573
4467 "It fails with an error if one or more of the requested groups is unavailable "
4472 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4474 "If an unknown group name is included in the list of groups then an error is "
4479 #: ../fish/guestfish-actions.pod:381 ../src/guestfs-actions.pod:579
4484 #: ../fish/guestfish-actions.pod:387
4485 msgid "You must call L</launch> before calling this function."
4489 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:587
4491 "The reason is because we don't know what groups are supported by the "
4492 "appliance/daemon until it is running and can be queried."
4496 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:593
4498 "If a group of functions is available, this does not necessarily mean that "
4499 "they will work. You still have to check for errors when calling individual "
4500 "API functions even if they are available."
4504 #: ../fish/guestfish-actions.pod:402 ../src/guestfs-actions.pod:600
4506 "It is usually the job of distro packagers to build complete functionality "
4507 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4508 "with all requirements satisfied, will support everything."
4512 #: ../fish/guestfish-actions.pod:409
4514 "This call was added in version C<1.0.80>. In previous versions of "
4515 "libguestfs all you could do would be to speculatively execute a command to "
4516 "find out if the daemon implemented it. See also L</version>."
4520 #: ../fish/guestfish-actions.pod:416
4521 msgid "available-all-groups"
4525 #: ../fish/guestfish-actions.pod:418
4528 " available-all-groups\n"
4533 #: ../fish/guestfish-actions.pod:420
4535 "This command returns a list of all optional groups that this daemon knows "
4536 "about. Note this returns both supported and unsupported groups. To find "
4537 "out which ones the daemon can actually support you have to call "
4538 "L</available> on each member of the returned list."
4542 #: ../fish/guestfish-actions.pod:426
4543 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4547 #: ../fish/guestfish-actions.pod:428
4552 #: ../fish/guestfish-actions.pod:430
4555 " base64-in (base64file|-) filename\n"
4560 #: ../fish/guestfish-actions.pod:432 ../src/guestfs-actions.pod:644
4561 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4565 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444 ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862 ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255 ../fish/guestfish-actions.pod:4658 ../fish/guestfish-actions.pod:4670 ../fish/guestfish-actions.pod:4681 ../fish/guestfish-actions.pod:4692 ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4753 ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4830
4566 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4570 #: ../fish/guestfish-actions.pod:437
4575 #: ../fish/guestfish-actions.pod:439
4578 " base64-out filename (base64file|-)\n"
4583 #: ../fish/guestfish-actions.pod:441 ../src/guestfs-actions.pod:658
4585 "This command downloads the contents of C<filename>, writing it out to local "
4586 "file C<base64file> encoded as base64."
4590 #: ../fish/guestfish-actions.pod:446
4591 msgid "blockdev-flushbufs"
4595 #: ../fish/guestfish-actions.pod:448
4598 " blockdev-flushbufs device\n"
4603 #: ../fish/guestfish-actions.pod:450 ../src/guestfs-actions.pod:671
4604 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4608 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508 ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527 ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543 ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
4609 msgid "This uses the L<blockdev(8)> command."
4613 #: ../fish/guestfish-actions.pod:455
4614 msgid "blockdev-getbsz"
4618 #: ../fish/guestfish-actions.pod:457
4621 " blockdev-getbsz device\n"
4626 #: ../fish/guestfish-actions.pod:459 ../src/guestfs-actions.pod:686
4627 msgid "This returns the block size of a device."
4631 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524 ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
4633 "(Note this is different from both I<size in blocks> and I<filesystem block "
4638 #: ../fish/guestfish-actions.pod:466
4639 msgid "blockdev-getro"
4643 #: ../fish/guestfish-actions.pod:468
4646 " blockdev-getro device\n"
4651 #: ../fish/guestfish-actions.pod:470 ../src/guestfs-actions.pod:703
4653 "Returns a boolean indicating if the block device is read-only (true if "
4654 "read-only, false if not)."
4658 #: ../fish/guestfish-actions.pod:475
4659 msgid "blockdev-getsize64"
4663 #: ../fish/guestfish-actions.pod:477
4666 " blockdev-getsize64 device\n"
4671 #: ../fish/guestfish-actions.pod:479 ../src/guestfs-actions.pod:718
4672 msgid "This returns the size of the device in bytes."
4676 #: ../fish/guestfish-actions.pod:481
4677 msgid "See also L</blockdev-getsz>."
4681 #: ../fish/guestfish-actions.pod:485
4682 msgid "blockdev-getss"
4686 #: ../fish/guestfish-actions.pod:487
4689 " blockdev-getss device\n"
4694 #: ../fish/guestfish-actions.pod:489 ../src/guestfs-actions.pod:734
4696 "This returns the size of sectors on a block device. Usually 512, but can be "
4697 "larger for modern devices."
4701 #: ../fish/guestfish-actions.pod:492
4702 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4706 #: ../fish/guestfish-actions.pod:497
4707 msgid "blockdev-getsz"
4711 #: ../fish/guestfish-actions.pod:499
4714 " blockdev-getsz device\n"
4719 #: ../fish/guestfish-actions.pod:501 ../src/guestfs-actions.pod:752
4721 "This returns the size of the device in units of 512-byte sectors (even if "
4722 "the sectorsize isn't 512 bytes ... weird)."
4726 #: ../fish/guestfish-actions.pod:504
4728 "See also L</blockdev-getss> for the real sector size of the device, and "
4729 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4733 #: ../fish/guestfish-actions.pod:510
4734 msgid "blockdev-rereadpt"
4738 #: ../fish/guestfish-actions.pod:512
4741 " blockdev-rereadpt device\n"
4746 #: ../fish/guestfish-actions.pod:514 ../src/guestfs-actions.pod:771
4747 msgid "Reread the partition table on C<device>."
4751 #: ../fish/guestfish-actions.pod:518
4752 msgid "blockdev-setbsz"
4756 #: ../fish/guestfish-actions.pod:520
4759 " blockdev-setbsz device blocksize\n"
4764 #: ../fish/guestfish-actions.pod:522 ../src/guestfs-actions.pod:786
4765 msgid "This sets the block size of a device."
4769 #: ../fish/guestfish-actions.pod:529
4770 msgid "blockdev-setro"
4774 #: ../fish/guestfish-actions.pod:531
4777 " blockdev-setro device\n"
4782 #: ../fish/guestfish-actions.pod:533 ../src/guestfs-actions.pod:803
4783 msgid "Sets the block device named C<device> to read-only."
4787 #: ../fish/guestfish-actions.pod:537
4788 msgid "blockdev-setrw"
4792 #: ../fish/guestfish-actions.pod:539
4795 " blockdev-setrw device\n"
4800 #: ../fish/guestfish-actions.pod:541 ../src/guestfs-actions.pod:817
4801 msgid "Sets the block device named C<device> to read-write."
4805 #: ../fish/guestfish-actions.pod:545
4806 msgid "btrfs-filesystem-resize"
4810 #: ../fish/guestfish-actions.pod:547
4813 " btrfs-filesystem-resize mountpoint [size:..]\n"
4818 #: ../fish/guestfish-actions.pod:549 ../src/guestfs-actions.pod:839
4819 msgid "This command resizes a btrfs filesystem."
4823 #: ../fish/guestfish-actions.pod:551 ../src/guestfs-actions.pod:841
4825 "Note that unlike other resize calls, the filesystem has to be mounted and "
4826 "the parameter is the mountpoint not the device (this is a requirement of "
4831 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417 ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5189
4832 msgid "The optional parameters are:"
4836 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5193
4841 #: ../fish/guestfish-actions.pod:561 ../src/guestfs-actions.pod:851
4843 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
4844 "resized to the maximum size."
4848 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
4849 msgid "See also L<btrfs(8)>."
4853 #: ../fish/guestfish-actions.pod:570
4854 msgid "case-sensitive-path"
4858 #: ../fish/guestfish-actions.pod:572
4861 " case-sensitive-path path\n"
4866 #: ../fish/guestfish-actions.pod:574 ../src/guestfs-actions.pod:890
4868 "This can be used to resolve case insensitive paths on a filesystem which is "
4869 "case sensitive. The use case is to resolve paths which you have read from "
4870 "Windows configuration files or the Windows Registry, to the true path."
4874 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
4876 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
4877 "(and probably others), which is that although the underlying filesystem is "
4878 "case-insensitive, the driver exports the filesystem to Linux as "
4883 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
4885 "One consequence of this is that special directories such as C<c:\\windows> "
4886 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
4887 "precise details of how they were created. In Windows itself this would not "
4892 #: ../fish/guestfish-actions.pod:590 ../src/guestfs-actions.pod:906
4894 "Bug or feature? You decide: "
4895 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
4899 #: ../fish/guestfish-actions.pod:593 ../src/guestfs-actions.pod:909
4901 "This function resolves the true case of each element in the path and returns "
4902 "the case-sensitive path."
4906 #: ../fish/guestfish-actions.pod:596
4908 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
4909 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
4910 "how the directories were originally created under Windows)."
4914 #: ../fish/guestfish-actions.pod:601 ../src/guestfs-actions.pod:917
4915 msgid "I<Note>: This function does not handle drive names, backslashes etc."
4919 #: ../fish/guestfish-actions.pod:604
4920 msgid "See also L</realpath>."
4924 #: ../fish/guestfish-actions.pod:606
4929 #: ../fish/guestfish-actions.pod:608
4937 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3837 ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5832
4938 msgid "Return the contents of the file named C<path>."
4942 #: ../fish/guestfish-actions.pod:612
4944 "Note that this function cannot correctly handle binary files (specifically, "
4945 "files containing C<\\0> character which is treated as end of string). For "
4946 "those you need to use the L</read-file> or L</download> functions which have "
4947 "a more complex interface."
4951 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752 ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017 ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536 ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579 ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608 ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722 ../fish/guestfish-actions.pod:3798 ../fish/guestfish-actions.pod:3815 ../fish/guestfish-actions.pod:3830 ../fish/guestfish-actions.pod:4499 ../fish/guestfish-actions.pod:4545 ../fish/guestfish-actions.pod:4630 ../fish/guestfish-actions.pod:4645 ../fish/guestfish-actions.pod:5051 ../fish/guestfish-actions.pod:5063 ../fish/guestfish-actions.pod:5081 ../fish/guestfish-actions.pod:5098 ../fish/guestfish-actions.pod:5108 ../fish/guestfish-actions.pod:5157 ../fish/guestfish-actions.pod:5167 ../fish/guestfish-actions.pod:5196 ../fish/guestfish-actions.pod:5206 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560 ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825 ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:2315 ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:2382 ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2428 ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5640 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:6772 ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6973 ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7662 ../src/guestfs-actions.pod:7682 ../src/guestfs-actions.pod:7708 ../src/guestfs-actions.pod:7734 ../src/guestfs-actions.pod:7753 ../src/guestfs-actions.pod:7839 ../src/guestfs-actions.pod:7858 ../src/guestfs-actions.pod:7904 ../src/guestfs-actions.pod:7923
4953 "Because of the message protocol, there is a transfer limit of somewhere "
4954 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4958 #: ../fish/guestfish-actions.pod:620
4963 #: ../fish/guestfish-actions.pod:622
4966 " checksum csumtype path\n"
4971 #: ../fish/guestfish-actions.pod:624 ../src/guestfs-actions.pod:955
4972 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
4976 #: ../fish/guestfish-actions.pod:627 ../src/guestfs-actions.pod:958
4978 "The type of checksum to compute is given by the C<csumtype> parameter which "
4979 "must have one of the following values:"
4983 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
4988 #: ../fish/guestfish-actions.pod:634 ../src/guestfs-actions.pod:965
4990 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
4995 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5000 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5001 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5005 #: ../fish/guestfish-actions.pod:641 ../src/guestfs-actions.pod:972
5010 #: ../fish/guestfish-actions.pod:643 ../src/guestfs-actions.pod:974
5011 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5015 #: ../fish/guestfish-actions.pod:645 ../src/guestfs-actions.pod:976
5020 #: ../fish/guestfish-actions.pod:647 ../src/guestfs-actions.pod:978
5021 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5025 #: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:980
5030 #: ../fish/guestfish-actions.pod:651 ../src/guestfs-actions.pod:982
5031 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5035 #: ../fish/guestfish-actions.pod:653 ../src/guestfs-actions.pod:984
5040 #: ../fish/guestfish-actions.pod:655 ../src/guestfs-actions.pod:986
5041 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5045 #: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:988
5050 #: ../fish/guestfish-actions.pod:659 ../src/guestfs-actions.pod:990
5051 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5055 #: ../fish/guestfish-actions.pod:663 ../src/guestfs-actions.pod:994
5056 msgid "The checksum is returned as a printable string."
5060 #: ../fish/guestfish-actions.pod:665
5061 msgid "To get the checksum for a device, use L</checksum-device>."
5065 #: ../fish/guestfish-actions.pod:667
5066 msgid "To get the checksums for many files, use L</checksums-out>."
5070 #: ../fish/guestfish-actions.pod:669
5071 msgid "checksum-device"
5075 #: ../fish/guestfish-actions.pod:671
5078 " checksum-device csumtype device\n"
5083 #: ../fish/guestfish-actions.pod:673
5085 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5086 "device named C<device>. For the types of checksums supported see the "
5087 "L</checksum> command."
5091 #: ../fish/guestfish-actions.pod:677
5092 msgid "checksums-out"
5096 #: ../fish/guestfish-actions.pod:679
5099 " checksums-out csumtype directory (sumsfile|-)\n"
5104 #: ../fish/guestfish-actions.pod:681 ../src/guestfs-actions.pod:1029
5106 "This command computes the checksums of all regular files in C<directory> and "
5107 "then emits a list of those checksums to the local output file C<sumsfile>."
5111 #: ../fish/guestfish-actions.pod:685 ../src/guestfs-actions.pod:1033
5113 "This can be used for verifying the integrity of a virtual machine. However "
5114 "to be properly secure you should pay attention to the output of the checksum "
5115 "command (it uses the ones from GNU coreutils). In particular when the "
5116 "filename is not printable, coreutils uses a special backslash syntax. For "
5117 "more information, see the GNU coreutils info file."
5121 #: ../fish/guestfish-actions.pod:695
5126 #: ../fish/guestfish-actions.pod:697
5129 " chmod mode path\n"
5134 #: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1052
5136 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5141 #: ../fish/guestfish-actions.pod:702 ../src/guestfs-actions.pod:1055
5143 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5144 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5149 #: ../fish/guestfish-actions.pod:706 ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3199 ../fish/guestfish-actions.pod:3209 ../fish/guestfish-actions.pod:3219 ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4833
5150 msgid "The mode actually set is affected by the umask."
5154 #: ../fish/guestfish-actions.pod:708
5159 #: ../fish/guestfish-actions.pod:710
5162 " chown owner group path\n"
5167 #: ../fish/guestfish-actions.pod:712 ../src/guestfs-actions.pod:1073
5168 msgid "Change the file owner to C<owner> and group to C<group>."
5172 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495 ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3657
5174 "Only numeric uid and gid are supported. If you want to use names, you will "
5175 "need to locate and parse the password file yourself (Augeas support makes "
5176 "this relatively easy)."
5180 #: ../fish/guestfish-actions.pod:718
5185 #: ../fish/guestfish-actions.pod:720
5188 " command 'arguments ...'\n"
5193 #: ../fish/guestfish-actions.pod:722 ../src/guestfs-actions.pod:1089
5195 "This call runs a command from the guest filesystem. The filesystem must be "
5196 "mounted, and must contain a compatible operating system (ie. something "
5197 "Linux, with the same or compatible processor architecture)."
5201 #: ../fish/guestfish-actions.pod:727
5203 "The single parameter is an argv-style list of arguments. The first element "
5204 "is the name of the program to run. Subsequent elements are parameters. The "
5205 "list must be non-empty (ie. must contain a program name). Note that the "
5206 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5210 #: ../fish/guestfish-actions.pod:734 ../src/guestfs-actions.pod:1101
5211 msgid "The return value is anything printed to I<stdout> by the command."
5215 #: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1104
5217 "If the command returns a non-zero exit status, then this function returns an "
5218 "error message. The error message string is the content of I<stderr> from "
5223 #: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1108
5225 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5226 "C</bin>. If you require a program from another location, you should provide "
5227 "the full path in the first parameter."
5231 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5233 "Shared libraries and data files required by the program must be available on "
5234 "filesystems which are mounted in the correct places. It is the caller's "
5235 "responsibility to ensure all filesystems that are needed are mounted at the "
5240 #: ../fish/guestfish-actions.pod:755
5241 msgid "command-lines"
5245 #: ../fish/guestfish-actions.pod:757
5248 " command-lines 'arguments ...'\n"
5253 #: ../fish/guestfish-actions.pod:759
5254 msgid "This is the same as L</command>, but splits the result into a list of lines."
5258 #: ../fish/guestfish-actions.pod:762
5259 msgid "See also: L</sh-lines>"
5263 #: ../fish/guestfish-actions.pod:767
5268 #: ../fish/guestfish-actions.pod:769
5271 " config qemuparam qemuvalue\n"
5276 #: ../fish/guestfish-actions.pod:771 ../src/guestfs-actions.pod:1154
5278 "This can be used to add arbitrary qemu command line parameters of the form "
5279 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5280 "setting some parameters which would interfere with parameters that we use."
5284 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5285 msgid "The first character of C<param> string must be a C<-> (dash)."
5289 #: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1161
5290 msgid "C<value> can be NULL."
5294 #: ../fish/guestfish-actions.pod:780
5299 #: ../fish/guestfish-actions.pod:782
5302 " copy-size src dest size\n"
5307 #: ../fish/guestfish-actions.pod:784 ../src/guestfs-actions.pod:1175
5309 "This command copies exactly C<size> bytes from one source device or file "
5310 "C<src> to another destination device or file C<dest>."
5314 #: ../fish/guestfish-actions.pod:787 ../src/guestfs-actions.pod:1178
5316 "Note this will fail if the source is too short or if the destination is not "
5321 #: ../fish/guestfish-actions.pod:790
5326 #: ../fish/guestfish-actions.pod:792
5334 #: ../fish/guestfish-actions.pod:794 ../src/guestfs-actions.pod:1197
5336 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5337 "destination filename or destination directory."
5341 #: ../fish/guestfish-actions.pod:797
5346 #: ../fish/guestfish-actions.pod:799
5354 #: ../fish/guestfish-actions.pod:801 ../src/guestfs-actions.pod:1211
5356 "This copies a file or directory from C<src> to C<dest> recursively using the "
5361 #: ../fish/guestfish-actions.pod:804
5366 #: ../fish/guestfish-actions.pod:806
5374 #: ../fish/guestfish-actions.pod:808 ../src/guestfs-actions.pod:1225
5376 "This command copies from one source device or file C<src> to another "
5377 "destination device or file C<dest>. Normally you would use this to copy to "
5378 "or from a device or partition, for example to duplicate a filesystem."
5382 #: ../fish/guestfish-actions.pod:813
5384 "If the destination is a device, it must be as large or larger than the "
5385 "source file or device, otherwise the copy will fail. This command cannot do "
5386 "partial copies (see L</copy-size>)."
5390 #: ../fish/guestfish-actions.pod:817
5395 #: ../fish/guestfish-actions.pod:819
5403 #: ../fish/guestfish-actions.pod:821 ../src/guestfs-actions.pod:1243
5404 msgid "This command runs the C<df> command to report disk space used."
5408 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
5410 "This command is mostly useful for interactive sessions. It is I<not> "
5411 "intended that you try to parse the output string. Use L</statvfs> from "
5416 #: ../fish/guestfish-actions.pod:827
5421 #: ../fish/guestfish-actions.pod:829
5429 #: ../fish/guestfish-actions.pod:831 ../src/guestfs-actions.pod:1259
5431 "This command runs the C<df -h> command to report disk space used in "
5432 "human-readable format."
5436 #: ../fish/guestfish-actions.pod:838
5441 #: ../fish/guestfish-actions.pod:840
5449 #: ../fish/guestfish-actions.pod:842 ../src/guestfs-actions.pod:1276
5451 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5452 "This is sometimes useful for extended debugging of problems."
5456 #: ../fish/guestfish-actions.pod:846
5458 "Another way to get the same information is to enable verbose messages with "
5459 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5460 "before running the program."
5464 #: ../fish/guestfish-actions.pod:851
5469 #: ../fish/guestfish-actions.pod:853
5472 " download remotefilename (filename|-)\n"
5477 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868 ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
5479 "Download file C<remotefilename> and save it as C<filename> on the local "
5484 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4803 ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7232
5485 msgid "C<filename> can also be a named pipe."
5489 #: ../fish/guestfish-actions.pod:860
5490 msgid "See also L</upload>, L</cat>."
5494 #: ../fish/guestfish-actions.pod:864
5495 msgid "download-offset"
5499 #: ../fish/guestfish-actions.pod:866
5502 " download-offset remotefilename (filename|-) offset size\n"
5507 #: ../fish/guestfish-actions.pod:871 ../src/guestfs-actions.pod:1325
5509 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5510 "region must be within the file or device)."
5514 #: ../fish/guestfish-actions.pod:874
5516 "Note that there is no limit on the amount of data that can be downloaded "
5517 "with this call, unlike with L</pread>, and this call always reads the full "
5518 "amount unless an error occurs."
5522 #: ../fish/guestfish-actions.pod:879
5523 msgid "See also L</download>, L</pread>."
5527 #: ../fish/guestfish-actions.pod:883
5532 #: ../fish/guestfish-actions.pod:885
5535 " drop-caches whattodrop\n"
5540 #: ../fish/guestfish-actions.pod:887 ../src/guestfs-actions.pod:1350
5542 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5543 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5544 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5548 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
5549 msgid "Setting C<whattodrop> to 3 should drop everything."
5553 #: ../fish/guestfish-actions.pod:894 ../src/guestfs-actions.pod:1357
5555 "This automatically calls L<sync(2)> before the operation, so that the "
5556 "maximum guest memory is freed."
5560 #: ../fish/guestfish-actions.pod:897
5565 #: ../fish/guestfish-actions.pod:899
5573 #: ../fish/guestfish-actions.pod:901 ../src/guestfs-actions.pod:1370
5575 "This command runs the C<du -s> command to estimate file space usage for "
5580 #: ../fish/guestfish-actions.pod:904 ../src/guestfs-actions.pod:1373
5582 "C<path> can be a file or a directory. If C<path> is a directory then the "
5583 "estimate includes the contents of the directory and all subdirectories "
5588 #: ../fish/guestfish-actions.pod:908 ../src/guestfs-actions.pod:1377
5589 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5593 #: ../fish/guestfish-actions.pod:911
5598 #: ../fish/guestfish-actions.pod:913
5601 " e2fsck-f device\n"
5606 #: ../fish/guestfish-actions.pod:915 ../src/guestfs-actions.pod:1395
5608 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5609 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5614 #: ../fish/guestfish-actions.pod:919
5616 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
5617 "should use L</fsck>."
5621 #: ../fish/guestfish-actions.pod:922
5626 #: ../fish/guestfish-actions.pod:924
5629 " echo-daemon 'words ...'\n"
5634 #: ../fish/guestfish-actions.pod:926 ../src/guestfs-actions.pod:1412
5636 "This command concatenates the list of C<words> passed with single spaces "
5637 "between them and returns the resulting string."
5641 #: ../fish/guestfish-actions.pod:929 ../src/guestfs-actions.pod:1415
5642 msgid "You can use this command to test the connection through to the daemon."
5646 #: ../fish/guestfish-actions.pod:931
5647 msgid "See also L</ping-daemon>."
5651 #: ../fish/guestfish-actions.pod:933
5656 #: ../fish/guestfish-actions.pod:935
5659 " egrep regex path\n"
5664 #: ../fish/guestfish-actions.pod:937 ../src/guestfs-actions.pod:1431
5665 msgid "This calls the external C<egrep> program and returns the matching lines."
5669 #: ../fish/guestfish-actions.pod:943
5674 #: ../fish/guestfish-actions.pod:945
5677 " egrepi regex path\n"
5682 #: ../fish/guestfish-actions.pod:947 ../src/guestfs-actions.pod:1450
5683 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5687 #: ../fish/guestfish-actions.pod:953
5692 #: ../fish/guestfish-actions.pod:955
5695 " equal file1 file2\n"
5700 #: ../fish/guestfish-actions.pod:957 ../src/guestfs-actions.pod:1469
5702 "This compares the two files C<file1> and C<file2> and returns true if their "
5703 "content is exactly equal, or false otherwise."
5707 #: ../fish/guestfish-actions.pod:960 ../src/guestfs-actions.pod:1472
5708 msgid "The external L<cmp(1)> program is used for the comparison."
5712 #: ../fish/guestfish-actions.pod:962
5717 #: ../fish/guestfish-actions.pod:964
5725 #: ../fish/guestfish-actions.pod:966 ../src/guestfs-actions.pod:1484
5727 "This returns C<true> if and only if there is a file, directory (or anything) "
5728 "with the given C<path> name."
5732 #: ../fish/guestfish-actions.pod:969
5733 msgid "See also L</is-file>, L</is-dir>, L</stat>."
5737 #: ../fish/guestfish-actions.pod:971
5742 #: ../fish/guestfish-actions.pod:973
5745 " fallocate path len\n"
5750 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
5752 "This command preallocates a file (containing zero bytes) named C<path> of "
5753 "size C<len> bytes. If the file exists already, it is overwritten."
5757 #: ../fish/guestfish-actions.pod:979 ../src/guestfs-actions.pod:1504
5759 "Do not confuse this with the guestfish-specific C<alloc> command which "
5760 "allocates a file in the host and attaches it as a device."
5764 #: ../fish/guestfish-actions.pod:983
5766 "This function is deprecated. In new code, use the L</fallocate64> call "
5771 #: ../fish/guestfish-actions.pod:990
5776 #: ../fish/guestfish-actions.pod:992
5779 " fallocate64 path len\n"
5784 #: ../fish/guestfish-actions.pod:998
5786 "Note that this call allocates disk blocks for the file. To create a sparse "
5787 "file use L</truncate-size> instead."
5791 #: ../fish/guestfish-actions.pod:1001
5793 "The deprecated call L</fallocate> does the same, but owing to an oversight "
5794 "it only allowed 30 bit lengths to be specified, effectively limiting the "
5795 "maximum size of files created through that call to 1GB."
5799 #: ../fish/guestfish-actions.pod:1006 ../src/guestfs-actions.pod:1538
5801 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
5802 "commands which create a file in the host and attach it as a device."
5806 #: ../fish/guestfish-actions.pod:1010
5811 #: ../fish/guestfish-actions.pod:1012
5814 " fgrep pattern path\n"
5819 #: ../fish/guestfish-actions.pod:1014 ../src/guestfs-actions.pod:1553
5820 msgid "This calls the external C<fgrep> program and returns the matching lines."
5824 #: ../fish/guestfish-actions.pod:1020
5829 #: ../fish/guestfish-actions.pod:1022
5832 " fgrepi pattern path\n"
5837 #: ../fish/guestfish-actions.pod:1024 ../src/guestfs-actions.pod:1572
5838 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
5842 #: ../fish/guestfish-actions.pod:1030
5847 #: ../fish/guestfish-actions.pod:1032
5855 #: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1590
5857 "This call uses the standard L<file(1)> command to determine the type or "
5858 "contents of the file."
5862 #: ../fish/guestfish-actions.pod:1037 ../src/guestfs-actions.pod:1593
5864 "This call will also transparently look inside various types of compressed "
5869 #: ../fish/guestfish-actions.pod:1040 ../src/guestfs-actions.pod:1596
5871 "The exact command which runs is C<file -zb path>. Note in particular that "
5872 "the filename is not prepended to the output (the I<-b> option)."
5876 #: ../fish/guestfish-actions.pod:1044 ../src/guestfs-actions.pod:1600
5878 "The output depends on the output of the underlying L<file(1)> command and it "
5879 "can change in future in ways beyond our control. In other words, the output "
5880 "is not guaranteed by the ABI."
5884 #: ../fish/guestfish-actions.pod:1048
5886 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
5887 "(etc), L</is-zero>."
5891 #: ../fish/guestfish-actions.pod:1051
5892 msgid "file-architecture"
5896 #: ../fish/guestfish-actions.pod:1053
5899 " file-architecture filename\n"
5904 #: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1618
5906 "This detects the architecture of the binary C<filename>, and returns it if "
5911 #: ../fish/guestfish-actions.pod:1058 ../src/guestfs-actions.pod:1621
5912 msgid "Currently defined architectures are:"
5916 #: ../fish/guestfish-actions.pod:1062 ../src/guestfs-actions.pod:1625
5921 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1627
5923 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
5924 "irrespective of the precise processor requirements of the binary."
5928 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
5933 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
5934 msgid "64 bit x86-64."
5938 #: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1634
5943 #: ../fish/guestfish-actions.pod:1073 ../src/guestfs-actions.pod:1636
5944 msgid "32 bit SPARC."
5948 #: ../fish/guestfish-actions.pod:1075 ../src/guestfs-actions.pod:1638
5953 #: ../fish/guestfish-actions.pod:1077 ../src/guestfs-actions.pod:1640
5954 msgid "64 bit SPARC V9 and above."
5958 #: ../fish/guestfish-actions.pod:1079 ../src/guestfs-actions.pod:1642
5963 #: ../fish/guestfish-actions.pod:1081 ../src/guestfs-actions.pod:1644
5964 msgid "Intel Itanium."
5968 #: ../fish/guestfish-actions.pod:1083 ../src/guestfs-actions.pod:1646
5973 #: ../fish/guestfish-actions.pod:1085 ../src/guestfs-actions.pod:1648
5974 msgid "32 bit Power PC."
5978 #: ../fish/guestfish-actions.pod:1087 ../src/guestfs-actions.pod:1650
5983 #: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1652
5984 msgid "64 bit Power PC."
5988 #: ../fish/guestfish-actions.pod:1093 ../src/guestfs-actions.pod:1656
5989 msgid "Libguestfs may return other architecture strings in future."
5993 #: ../fish/guestfish-actions.pod:1095 ../src/guestfs-actions.pod:1658
5994 msgid "The function works on at least the following types of files:"
5998 #: ../fish/guestfish-actions.pod:1101 ../src/guestfs-actions.pod:1664
5999 msgid "many types of Un*x and Linux binary"
6003 #: ../fish/guestfish-actions.pod:1105 ../src/guestfs-actions.pod:1668
6004 msgid "many types of Un*x and Linux shared library"
6008 #: ../fish/guestfish-actions.pod:1109 ../src/guestfs-actions.pod:1672
6009 msgid "Windows Win32 and Win64 binaries"
6013 #: ../fish/guestfish-actions.pod:1113 ../src/guestfs-actions.pod:1676
6014 msgid "Windows Win32 and Win64 DLLs"
6018 #: ../fish/guestfish-actions.pod:1115 ../src/guestfs-actions.pod:1678
6019 msgid "Win32 binaries and DLLs return C<i386>."
6023 #: ../fish/guestfish-actions.pod:1117 ../src/guestfs-actions.pod:1680
6024 msgid "Win64 binaries and DLLs return C<x86_64>."
6028 #: ../fish/guestfish-actions.pod:1121 ../src/guestfs-actions.pod:1684
6029 msgid "Linux kernel modules"
6033 #: ../fish/guestfish-actions.pod:1125 ../src/guestfs-actions.pod:1688
6034 msgid "Linux new-style initrd images"
6038 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1692
6039 msgid "some non-x86 Linux vmlinuz kernels"
6043 #: ../fish/guestfish-actions.pod:1133 ../src/guestfs-actions.pod:1696
6044 msgid "What it can't do currently:"
6048 #: ../fish/guestfish-actions.pod:1139 ../src/guestfs-actions.pod:1702
6049 msgid "static libraries (libfoo.a)"
6053 #: ../fish/guestfish-actions.pod:1143 ../src/guestfs-actions.pod:1706
6054 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6058 #: ../fish/guestfish-actions.pod:1147 ../src/guestfs-actions.pod:1710
6059 msgid "x86 Linux vmlinuz kernels"
6063 #: ../fish/guestfish-actions.pod:1149 ../src/guestfs-actions.pod:1712
6065 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6066 "compressed code, and are horribly hard to unpack. If you want to find the "
6067 "architecture of a kernel, use the architecture of the associated initrd or "
6068 "kernel module(s) instead."
6072 #: ../fish/guestfish-actions.pod:1156
6077 #: ../fish/guestfish-actions.pod:1158
6085 #: ../fish/guestfish-actions.pod:1160 ../src/guestfs-actions.pod:1730
6086 msgid "This command returns the size of C<file> in bytes."
6090 #: ../fish/guestfish-actions.pod:1162
6092 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6093 "L</is-file> etc. To get the size of block devices, use "
6094 "L</blockdev-getsize64>."
6098 #: ../fish/guestfish-actions.pod:1166
6103 #: ../fish/guestfish-actions.pod:1168
6106 " fill c len path\n"
6111 #: ../fish/guestfish-actions.pod:1170 ../src/guestfs-actions.pod:1748
6113 "This command creates a new file called C<path>. The initial content of the "
6114 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6119 #: ../fish/guestfish-actions.pod:1174
6121 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6122 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6127 #: ../fish/guestfish-actions.pod:1179
6128 msgid "fill-pattern"
6132 #: ../fish/guestfish-actions.pod:1181
6135 " fill-pattern pattern len path\n"
6140 #: ../fish/guestfish-actions.pod:1183
6142 "This function is like L</fill> except that it creates a new file of length "
6143 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6144 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6149 #: ../fish/guestfish-actions.pod:1188
6154 #: ../fish/guestfish-actions.pod:1190
6162 #: ../fish/guestfish-actions.pod:1192 ../src/guestfs-actions.pod:1794
6164 "This command lists out all files and directories, recursively, starting at "
6165 "C<directory>. It is essentially equivalent to running the shell command "
6166 "C<find directory -print> but some post-processing happens on the output, "
6171 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6173 "This returns a list of strings I<without any prefix>. Thus if the directory "
6178 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:1802
6188 #: ../fish/guestfish-actions.pod:1204
6189 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6193 #: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:1809
6204 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6205 msgid "If C<directory> is not a directory, then this command returns an error."
6209 #: ../fish/guestfish-actions.pod:1215 ../src/guestfs-actions.pod:1817
6210 msgid "The returned list is sorted."
6214 #: ../fish/guestfish-actions.pod:1217
6215 msgid "See also L</find0>."
6219 #: ../fish/guestfish-actions.pod:1222
6224 #: ../fish/guestfish-actions.pod:1224
6227 " find0 directory (files|-)\n"
6232 #: ../fish/guestfish-actions.pod:1226 ../src/guestfs-actions.pod:1837
6234 "This command lists out all files and directories, recursively, starting at "
6235 "C<directory>, placing the resulting list in the external file called "
6240 #: ../fish/guestfish-actions.pod:1230
6241 msgid "This command works the same way as L</find> with the following exceptions:"
6245 #: ../fish/guestfish-actions.pod:1237 ../src/guestfs-actions.pod:1848
6246 msgid "The resulting list is written to an external file."
6250 #: ../fish/guestfish-actions.pod:1241 ../src/guestfs-actions.pod:1852
6252 "Items (filenames) in the result are separated by C<\\0> characters. See "
6253 "L<find(1)> option I<-print0>."
6257 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6258 msgid "This command is not limited in the number of names that it can return."
6262 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6263 msgid "The result list is not sorted."
6267 #: ../fish/guestfish-actions.pod:1257
6268 msgid "findfs-label"
6272 #: ../fish/guestfish-actions.pod:1259
6275 " findfs-label label\n"
6280 #: ../fish/guestfish-actions.pod:1261 ../src/guestfs-actions.pod:1876
6282 "This command searches the filesystems and returns the one which has the "
6283 "given label. An error is returned if no such filesystem can be found."
6287 #: ../fish/guestfish-actions.pod:1265
6288 msgid "To find the label of a filesystem, use L</vfs-label>."
6292 #: ../fish/guestfish-actions.pod:1267
6297 #: ../fish/guestfish-actions.pod:1269
6300 " findfs-uuid uuid\n"
6305 #: ../fish/guestfish-actions.pod:1271 ../src/guestfs-actions.pod:1893
6307 "This command searches the filesystems and returns the one which has the "
6308 "given UUID. An error is returned if no such filesystem can be found."
6312 #: ../fish/guestfish-actions.pod:1275
6313 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6317 #: ../fish/guestfish-actions.pod:1277
6322 #: ../fish/guestfish-actions.pod:1279
6325 " fsck fstype device\n"
6330 #: ../fish/guestfish-actions.pod:1281 ../src/guestfs-actions.pod:1911
6332 "This runs the filesystem checker (fsck) on C<device> which should have "
6333 "filesystem type C<fstype>."
6337 #: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:1914
6339 "The returned integer is the status. See L<fsck(8)> for the list of status "
6340 "codes from C<fsck>."
6344 #: ../fish/guestfish-actions.pod:1293 ../src/guestfs-actions.pod:1923
6345 msgid "Multiple status codes can be summed together."
6349 #: ../fish/guestfish-actions.pod:1297 ../src/guestfs-actions.pod:1927
6351 "A non-zero return code can mean \"success\", for example if errors have been "
6352 "corrected on the filesystem."
6356 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6357 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6361 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6362 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6366 #: ../fish/guestfish-actions.pod:1309
6371 #: ../fish/guestfish-actions.pod:1311
6379 #: ../fish/guestfish-actions.pod:1313 ../src/guestfs-actions.pod:1948
6381 "Return the additional kernel options which are added to the guest kernel "
6386 #: ../fish/guestfish-actions.pod:1316 ../src/guestfs-actions.pod:1951
6387 msgid "If C<NULL> then no options are added."
6391 #: ../fish/guestfish-actions.pod:1318
6392 msgid "get-attach-method"
6396 #: ../fish/guestfish-actions.pod:1320
6399 " get-attach-method\n"
6404 #: ../fish/guestfish-actions.pod:1322
6405 msgid "Return the current attach method. See L</set-attach-method>."
6409 #: ../fish/guestfish-actions.pod:1324
6410 msgid "get-autosync"
6414 #: ../fish/guestfish-actions.pod:1326
6422 #: ../fish/guestfish-actions.pod:1328 ../src/guestfs-actions.pod:1976
6423 msgid "Get the autosync flag."
6427 #: ../fish/guestfish-actions.pod:1330
6432 #: ../fish/guestfish-actions.pod:1332
6440 #: ../fish/guestfish-actions.pod:1334 ../src/guestfs-actions.pod:1987
6441 msgid "Return the direct appliance mode flag."
6445 #: ../fish/guestfish-actions.pod:1336
6450 #: ../fish/guestfish-actions.pod:1338
6453 " get-e2label device\n"
6458 #: ../fish/guestfish-actions.pod:1340 ../src/guestfs-actions.pod:1999
6459 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6463 #: ../fish/guestfish-actions.pod:1343
6465 "This function is deprecated. In new code, use the L</vfs_label> call "
6470 #: ../fish/guestfish-actions.pod:1350
6475 #: ../fish/guestfish-actions.pod:1352
6478 " get-e2uuid device\n"
6483 #: ../fish/guestfish-actions.pod:1354 ../src/guestfs-actions.pod:2020
6484 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6488 #: ../fish/guestfish-actions.pod:1357
6490 "This function is deprecated. In new code, use the L</vfs_uuid> call "
6495 #: ../fish/guestfish-actions.pod:1364
6500 #: ../fish/guestfish-actions.pod:1366
6508 #: ../fish/guestfish-actions.pod:1368 ../src/guestfs-actions.pod:2040
6509 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6513 #: ../fish/guestfish-actions.pod:1371
6515 "If L</set-memsize> was not called on this handle, and if "
6516 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6517 "value for memsize."
6521 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432 ../fish/guestfish-actions.pod:4163 ../fish/guestfish-actions.pod:4265 ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6419
6522 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6526 #: ../fish/guestfish-actions.pod:1378
6531 #: ../fish/guestfish-actions.pod:1380
6539 #: ../fish/guestfish-actions.pod:1382 ../src/guestfs-actions.pod:2059
6540 msgid "This returns the enable network flag."
6544 #: ../fish/guestfish-actions.pod:1384
6549 #: ../fish/guestfish-actions.pod:1386
6557 #: ../fish/guestfish-actions.pod:1388 ../src/guestfs-actions.pod:2070
6558 msgid "Return the current search path."
6562 #: ../fish/guestfish-actions.pod:1390 ../src/guestfs-actions.pod:2072
6564 "This is always non-NULL. If it wasn't set already, then this will return "
6569 #: ../fish/guestfish-actions.pod:1393
6574 #: ../fish/guestfish-actions.pod:1395
6582 #: ../fish/guestfish-actions.pod:1397 ../src/guestfs-actions.pod:2085
6583 msgid "This returns the process group flag."
6587 #: ../fish/guestfish-actions.pod:1399
6592 #: ../fish/guestfish-actions.pod:1401
6597 #: ../fish/guestfish-actions.pod:1403
6605 #: ../fish/guestfish-actions.pod:1405 ../src/guestfs-actions.pod:2096
6607 "Return the process ID of the qemu subprocess. If there is no qemu "
6608 "subprocess, then this will return an error."
6612 #: ../fish/guestfish-actions.pod:1408 ../src/guestfs-actions.pod:2099
6613 msgid "This is an internal call used for debugging and testing."
6617 #: ../fish/guestfish-actions.pod:1410
6622 #: ../fish/guestfish-actions.pod:1412
6630 #: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2110
6631 msgid "Return the current qemu binary."
6635 #: ../fish/guestfish-actions.pod:1416 ../src/guestfs-actions.pod:2112
6637 "This is always non-NULL. If it wasn't set already, then this will return "
6638 "the default qemu binary name."
6642 #: ../fish/guestfish-actions.pod:1419
6643 msgid "get-recovery-proc"
6647 #: ../fish/guestfish-actions.pod:1421
6650 " get-recovery-proc\n"
6655 #: ../fish/guestfish-actions.pod:1423 ../src/guestfs-actions.pod:2125
6656 msgid "Return the recovery process enabled flag."
6660 #: ../fish/guestfish-actions.pod:1425
6665 #: ../fish/guestfish-actions.pod:1427
6673 #: ../fish/guestfish-actions.pod:1429
6675 "This returns the current setting of the selinux flag which is passed to the "
6676 "appliance at boot time. See L</set-selinux>."
6680 #: ../fish/guestfish-actions.pod:1435
6685 #: ../fish/guestfish-actions.pod:1437
6693 #: ../fish/guestfish-actions.pod:1439 ../src/guestfs-actions.pod:2151
6695 "This returns the current state as an opaque integer. This is only useful "
6696 "for printing debug and internal error messages."
6700 #: ../fish/guestfish-actions.pod:1442 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2418 ../fish/guestfish-actions.pod:2434 ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3551
6701 msgid "For more information on states, see L<guestfs(3)>."
6705 #: ../fish/guestfish-actions.pod:1444
6710 #: ../fish/guestfish-actions.pod:1446
6718 #: ../fish/guestfish-actions.pod:1448 ../src/guestfs-actions.pod:2165
6719 msgid "Return the command trace flag."
6723 #: ../fish/guestfish-actions.pod:1450
6728 #: ../fish/guestfish-actions.pod:1452
6736 #: ../fish/guestfish-actions.pod:1454
6738 "Return the current umask. By default the umask is C<022> unless it has been "
6739 "set by calling L</umask>."
6743 #: ../fish/guestfish-actions.pod:1457
6748 #: ../fish/guestfish-actions.pod:1459
6756 #: ../fish/guestfish-actions.pod:1461 ../src/guestfs-actions.pod:2188
6757 msgid "This returns the verbose messages flag."
6761 #: ../fish/guestfish-actions.pod:1463
6766 #: ../fish/guestfish-actions.pod:1465
6774 #: ../fish/guestfish-actions.pod:1467 ../src/guestfs-actions.pod:2199
6775 msgid "This gets the SELinux security context of the daemon."
6779 #: ../fish/guestfish-actions.pod:1469
6780 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
6784 #: ../fish/guestfish-actions.pod:1472
6789 #: ../fish/guestfish-actions.pod:1474
6792 " getxattr path name\n"
6797 #: ../fish/guestfish-actions.pod:1476
6799 "Get a single extended attribute from file C<path> named C<name>. This call "
6800 "follows symlinks. If you want to lookup an extended attribute for the "
6801 "symlink itself, use L</lgetxattr>."
6805 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
6807 "Normally it is better to get all extended attributes from a file in one go "
6808 "by calling L</getxattrs>. However some Linux filesystem implementations are "
6809 "buggy and do not provide a way to list out attributes. For these "
6810 "filesystems (notably ntfs-3g) you have to know the names of the extended "
6811 "attributes you want in advance and call this function."
6815 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514 ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:3684
6817 "Extended attribute values are blobs of binary data. If there is no extended "
6818 "attribute named C<name>, this returns an error."
6822 #: ../fish/guestfish-actions.pod:1490
6823 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
6827 #: ../fish/guestfish-actions.pod:1492
6832 #: ../fish/guestfish-actions.pod:1494
6840 #: ../fish/guestfish-actions.pod:1496 ../src/guestfs-actions.pod:2245
6841 msgid "This call lists the extended attributes of the file or directory C<path>."
6845 #: ../fish/guestfish-actions.pod:1499 ../src/guestfs-actions.pod:2248
6847 "At the system call level, this is a combination of the L<listxattr(2)> and "
6848 "L<getxattr(2)> calls."
6852 #: ../fish/guestfish-actions.pod:1502
6853 msgid "See also: L</lgetxattrs>, L<attr(5)>."
6857 #: ../fish/guestfish-actions.pod:1504
6862 #: ../fish/guestfish-actions.pod:1506
6865 " glob-expand pattern\n"
6870 #: ../fish/guestfish-actions.pod:1508 ../src/guestfs-actions.pod:2265
6872 "This command searches for all the pathnames matching C<pattern> according to "
6873 "the wildcard expansion rules used by the shell."
6877 #: ../fish/guestfish-actions.pod:1512 ../src/guestfs-actions.pod:2269
6878 msgid "If no paths match, then this returns an empty list (note: not an error)."
6882 #: ../fish/guestfish-actions.pod:1515 ../src/guestfs-actions.pod:2272
6884 "It is just a wrapper around the C L<glob(3)> function with flags "
6885 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
6889 #: ../fish/guestfish-actions.pod:1519
6894 #: ../fish/guestfish-actions.pod:1521
6897 " grep regex path\n"
6902 #: ../fish/guestfish-actions.pod:1523 ../src/guestfs-actions.pod:2289
6903 msgid "This calls the external C<grep> program and returns the matching lines."
6907 #: ../fish/guestfish-actions.pod:1529
6912 #: ../fish/guestfish-actions.pod:1531
6915 " grepi regex path\n"
6920 #: ../fish/guestfish-actions.pod:1533 ../src/guestfs-actions.pod:2308
6921 msgid "This calls the external C<grep -i> program and returns the matching lines."
6925 #: ../fish/guestfish-actions.pod:1539
6926 msgid "grub-install"
6930 #: ../fish/guestfish-actions.pod:1541
6933 " grub-install root device\n"
6938 #: ../fish/guestfish-actions.pod:1543 ../src/guestfs-actions.pod:2327
6940 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
6941 "the root directory being C<root>."
6945 #: ../fish/guestfish-actions.pod:1546 ../src/guestfs-actions.pod:2330
6947 "Note: If grub-install reports the error \"No suitable drive was found in the "
6948 "generated device map.\" it may be that you need to create a "
6949 "C</boot/grub/device.map> file first that contains the mapping between grub "
6950 "device names and Linux device names. It is usually sufficient to create a "
6955 #: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2337
6963 #: ../fish/guestfish-actions.pod:1555 ../src/guestfs-actions.pod:2339
6964 msgid "replacing C</dev/vda> with the name of the installation device."
6968 #: ../fish/guestfish-actions.pod:1557
6973 #: ../fish/guestfish-actions.pod:1559
6981 #: ../fish/guestfish-actions.pod:1561 ../src/guestfs-actions.pod:2351
6983 "This command returns up to the first 10 lines of a file as a list of "
6988 #: ../fish/guestfish-actions.pod:1567
6993 #: ../fish/guestfish-actions.pod:1569
6996 " head-n nrlines path\n"
7001 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2370
7003 "If the parameter C<nrlines> is a positive number, this returns the first "
7004 "C<nrlines> lines of the file C<path>."
7008 #: ../fish/guestfish-actions.pod:1574 ../src/guestfs-actions.pod:2373
7010 "If the parameter C<nrlines> is a negative number, this returns lines from "
7011 "the file C<path>, excluding the last C<nrlines> lines."
7015 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4643 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:6991
7016 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7020 #: ../fish/guestfish-actions.pod:1582
7025 #: ../fish/guestfish-actions.pod:1584
7033 #: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2393
7035 "This runs C<hexdump -C> on the given C<path>. The result is the "
7036 "human-readable, canonical hex dump of the file."
7040 #: ../fish/guestfish-actions.pod:1592
7045 #: ../fish/guestfish-actions.pod:1594
7048 " initrd-cat initrdpath filename\n"
7053 #: ../fish/guestfish-actions.pod:1596 ../src/guestfs-actions.pod:2412
7055 "This command unpacks the file C<filename> from the initrd file called "
7056 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7061 #: ../fish/guestfish-actions.pod:1600 ../src/guestfs-actions.pod:2416
7063 "For example, in guestfish you could use the following command to examine the "
7064 "boot script (usually called C</init>) contained in a Linux initrd or "
7069 #: ../fish/guestfish-actions.pod:1604 ../src/guestfs-actions.pod:2420
7072 " initrd-cat /boot/initrd-<version>.img init\n"
7077 #: ../fish/guestfish-actions.pod:1606
7078 msgid "See also L</initrd-list>."
7082 #: ../fish/guestfish-actions.pod:1611
7087 #: ../fish/guestfish-actions.pod:1613
7090 " initrd-list path\n"
7095 #: ../fish/guestfish-actions.pod:1615 ../src/guestfs-actions.pod:2439
7096 msgid "This command lists out files contained in an initrd."
7100 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2441
7102 "The files are listed without any initial C</> character. The files are "
7103 "listed in the order they appear (not necessarily alphabetical). Directory "
7104 "names are listed as separate items."
7108 #: ../fish/guestfish-actions.pod:1621 ../src/guestfs-actions.pod:2445
7110 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7111 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7116 #: ../fish/guestfish-actions.pod:1625
7117 msgid "inotify-add-watch"
7121 #: ../fish/guestfish-actions.pod:1627
7124 " inotify-add-watch path mask\n"
7129 #: ../fish/guestfish-actions.pod:1629 ../src/guestfs-actions.pod:2462
7130 msgid "Watch C<path> for the events listed in C<mask>."
7134 #: ../fish/guestfish-actions.pod:1631 ../src/guestfs-actions.pod:2464
7136 "Note that if C<path> is a directory then events within that directory are "
7137 "watched, but this does I<not> happen recursively (in subdirectories)."
7141 #: ../fish/guestfish-actions.pod:1635 ../src/guestfs-actions.pod:2468
7143 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7144 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7148 #: ../fish/guestfish-actions.pod:1639
7149 msgid "inotify-close"
7153 #: ../fish/guestfish-actions.pod:1641
7161 #: ../fish/guestfish-actions.pod:1643 ../src/guestfs-actions.pod:2481
7163 "This closes the inotify handle which was previously opened by inotify_init. "
7164 "It removes all watches, throws away any pending events, and deallocates all "
7169 #: ../fish/guestfish-actions.pod:1647
7170 msgid "inotify-files"
7174 #: ../fish/guestfish-actions.pod:1649
7182 #: ../fish/guestfish-actions.pod:1651
7184 "This function is a helpful wrapper around L</inotify-read> which just "
7185 "returns a list of pathnames of objects that were touched. The returned "
7186 "pathnames are sorted and deduplicated."
7190 #: ../fish/guestfish-actions.pod:1655
7191 msgid "inotify-init"
7195 #: ../fish/guestfish-actions.pod:1657
7198 " inotify-init maxevents\n"
7203 #: ../fish/guestfish-actions.pod:1659 ../src/guestfs-actions.pod:2510
7205 "This command creates a new inotify handle. The inotify subsystem can be "
7206 "used to notify events which happen to objects in the guest filesystem."
7210 #: ../fish/guestfish-actions.pod:1663
7212 "C<maxevents> is the maximum number of events which will be queued up between "
7213 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7214 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7215 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7216 "but records the fact that it threw them away by setting a flag "
7217 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7221 #: ../fish/guestfish-actions.pod:1673
7223 "Before any events are generated, you have to add some watches to the "
7224 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7225 "L</inotify-watch-all>."
7229 #: ../fish/guestfish-actions.pod:1679
7231 "Queued up events should be read periodically by calling L</inotify-read> (or "
7232 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7233 "If you don't read the events out often enough then you risk the internal "
7234 "queue overflowing."
7238 #: ../fish/guestfish-actions.pod:1686
7240 "The handle should be closed after use by calling L</inotify-close>. This "
7241 "also removes any watches automatically."
7245 #: ../fish/guestfish-actions.pod:1690 ../src/guestfs-actions.pod:2541
7247 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7248 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7249 "that there is one global inotify handle per libguestfs instance."
7253 #: ../fish/guestfish-actions.pod:1695
7254 msgid "inotify-read"
7258 #: ../fish/guestfish-actions.pod:1697
7266 #: ../fish/guestfish-actions.pod:1699 ../src/guestfs-actions.pod:2555
7268 "Return the complete queue of events that have happened since the previous "
7273 #: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2558
7274 msgid "If no events have happened, this returns an empty list."
7278 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7280 "I<Note>: In order to make sure that all events have been read, you must call "
7281 "this function repeatedly until it returns an empty list. The reason is that "
7282 "the call will read events up to the maximum appliance-to-host message size "
7283 "and leave remaining events in the queue."
7287 #: ../fish/guestfish-actions.pod:1710
7288 msgid "inotify-rm-watch"
7292 #: ../fish/guestfish-actions.pod:1712
7295 " inotify-rm-watch wd\n"
7300 #: ../fish/guestfish-actions.pod:1714
7301 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7305 #: ../fish/guestfish-actions.pod:1717
7306 msgid "inspect-get-arch"
7310 #: ../fish/guestfish-actions.pod:1719
7313 " inspect-get-arch root\n"
7318 #: ../fish/guestfish-actions.pod:1721
7320 "This returns the architecture of the inspected operating system. The "
7321 "possible return values are listed under L</file-architecture>."
7325 #: ../fish/guestfish-actions.pod:1725 ../src/guestfs-actions.pod:2595
7327 "If the architecture could not be determined, then the string C<unknown> is "
7332 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2047 ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2082 ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2167 ../fish/guestfish-actions.pod:2180 ../fish/guestfish-actions.pod:2190 ../fish/guestfish-actions.pod:2200 ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2342 ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2942 ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3167 ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3401
7333 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7337 #: ../fish/guestfish-actions.pod:1730
7338 msgid "inspect-get-distro"
7342 #: ../fish/guestfish-actions.pod:1732
7345 " inspect-get-distro root\n"
7350 #: ../fish/guestfish-actions.pod:1734 ../src/guestfs-actions.pod:2611
7351 msgid "This returns the distro (distribution) of the inspected operating system."
7355 #: ../fish/guestfish-actions.pod:1737 ../src/guestfs-actions.pod:2614
7356 msgid "Currently defined distros are:"
7360 #: ../fish/guestfish-actions.pod:1741 ../src/guestfs-actions.pod:2618
7361 msgid "\"archlinux\""
7365 #: ../fish/guestfish-actions.pod:1743 ../src/guestfs-actions.pod:2620
7370 #: ../fish/guestfish-actions.pod:1745 ../src/guestfs-actions.pod:2622
7375 #: ../fish/guestfish-actions.pod:1747 ../src/guestfs-actions.pod:2624
7380 #: ../fish/guestfish-actions.pod:1749 ../src/guestfs-actions.pod:2626
7385 #: ../fish/guestfish-actions.pod:1751 ../src/guestfs-actions.pod:2628
7390 #: ../fish/guestfish-actions.pod:1753 ../src/guestfs-actions.pod:2630
7395 #: ../fish/guestfish-actions.pod:1755 ../src/guestfs-actions.pod:2632
7400 #: ../fish/guestfish-actions.pod:1757 ../src/guestfs-actions.pod:2634
7405 #: ../fish/guestfish-actions.pod:1759 ../src/guestfs-actions.pod:2636
7410 #: ../fish/guestfish-actions.pod:1761 ../src/guestfs-actions.pod:2638
7411 msgid "\"linuxmint\""
7415 #: ../fish/guestfish-actions.pod:1763 ../src/guestfs-actions.pod:2640
7420 #: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2642
7421 msgid "\"mandriva\""
7425 #: ../fish/guestfish-actions.pod:1767 ../src/guestfs-actions.pod:2644
7430 #: ../fish/guestfish-actions.pod:1769 ../src/guestfs-actions.pod:2646
7435 #: ../fish/guestfish-actions.pod:1771 ../src/guestfs-actions.pod:2648
7440 #: ../fish/guestfish-actions.pod:1773 ../src/guestfs-actions.pod:2650
7445 #: ../fish/guestfish-actions.pod:1775 ../src/guestfs-actions.pod:2652
7450 #: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2654
7451 msgid "\"redhat-based\""
7455 #: ../fish/guestfish-actions.pod:1779 ../src/guestfs-actions.pod:2656
7456 msgid "Some Red Hat-derived distro."
7460 #: ../fish/guestfish-actions.pod:1781 ../src/guestfs-actions.pod:2658
7465 #: ../fish/guestfish-actions.pod:1783 ../src/guestfs-actions.pod:2660
7466 msgid "Red Hat Enterprise Linux."
7470 #: ../fish/guestfish-actions.pod:1785 ../src/guestfs-actions.pod:2662
7471 msgid "\"scientificlinux\""
7475 #: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2664
7476 msgid "Scientific Linux."
7480 #: ../fish/guestfish-actions.pod:1789 ../src/guestfs-actions.pod:2666
7481 msgid "\"slackware\""
7485 #: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2668
7490 #: ../fish/guestfish-actions.pod:1793 ../src/guestfs-actions.pod:2670
7495 #: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2672
7500 #: ../fish/guestfish-actions.pod:1797 ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145 ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:3158
7505 #: ../fish/guestfish-actions.pod:1799 ../src/guestfs-actions.pod:2676
7506 msgid "The distro could not be determined."
7510 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137 ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:3150
7515 #: ../fish/guestfish-actions.pod:1803 ../src/guestfs-actions.pod:2680
7517 "Windows does not have distributions. This string is returned if the OS type "
7522 #: ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:2151 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:3164
7524 "Future versions of libguestfs may return other strings here. The caller "
7525 "should be prepared to handle any string."
7529 #: ../fish/guestfish-actions.pod:1813
7530 msgid "inspect-get-drive-mappings"
7534 #: ../fish/guestfish-actions.pod:1815
7537 " inspect-get-drive-mappings root\n"
7542 #: ../fish/guestfish-actions.pod:1817 ../src/guestfs-actions.pod:2701
7544 "This call is useful for Windows which uses a primitive system of assigning "
7545 "drive letters (like \"C:\") to partitions. This inspection API examines the "
7546 "Windows Registry to find out how disks/partitions are mapped to drive "
7547 "letters, and returns a hash table as in the example below:"
7551 #: ../fish/guestfish-actions.pod:1823 ../src/guestfs-actions.pod:2707
7561 #: ../fish/guestfish-actions.pod:1827 ../src/guestfs-actions.pod:2711
7563 "Note that keys are drive letters. For Windows, the key is case insensitive "
7564 "and just contains the drive letter, without the customary colon separator "
7569 #: ../fish/guestfish-actions.pod:1831 ../src/guestfs-actions.pod:2715
7571 "In future we may support other operating systems that also used drive "
7572 "letters, but the keys for those might not be case insensitive and might be "
7573 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
7578 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
7580 "For Windows guests, currently only hard drive mappings are returned. "
7581 "Removable disks (eg. DVD-ROMs) are ignored."
7585 #: ../fish/guestfish-actions.pod:1839 ../src/guestfs-actions.pod:2723
7587 "For guests that do not use drive mappings, or if the drive mappings could "
7588 "not be determined, this returns an empty hash table."
7592 #: ../fish/guestfish-actions.pod:1842
7594 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7595 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7599 #: ../fish/guestfish-actions.pod:1846
7600 msgid "inspect-get-filesystems"
7604 #: ../fish/guestfish-actions.pod:1848
7607 " inspect-get-filesystems root\n"
7612 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2744
7614 "This returns a list of all the filesystems that we think are associated with "
7615 "this operating system. This includes the root filesystem, other ordinary "
7616 "filesystems, and non-mounted devices like swap partitions."
7620 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
7622 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7623 "to be shared between operating systems."
7627 #: ../fish/guestfish-actions.pod:1858
7629 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7630 "L</inspect-get-mountpoints>."
7634 #: ../fish/guestfish-actions.pod:1861
7635 msgid "inspect-get-format"
7639 #: ../fish/guestfish-actions.pod:1863
7642 " inspect-get-format root\n"
7647 #: ../fish/guestfish-actions.pod:1865 ../src/guestfs-actions.pod:2767
7649 "This returns the format of the inspected operating system. You can use it "
7650 "to detect install images, live CDs and similar."
7654 #: ../fish/guestfish-actions.pod:1868 ../src/guestfs-actions.pod:2770
7655 msgid "Currently defined formats are:"
7659 #: ../fish/guestfish-actions.pod:1872 ../src/guestfs-actions.pod:2774
7660 msgid "\"installed\""
7664 #: ../fish/guestfish-actions.pod:1874 ../src/guestfs-actions.pod:2776
7665 msgid "This is an installed operating system."
7669 #: ../fish/guestfish-actions.pod:1876 ../src/guestfs-actions.pod:2778
7670 msgid "\"installer\""
7674 #: ../fish/guestfish-actions.pod:1878 ../src/guestfs-actions.pod:2780
7676 "The disk image being inspected is not an installed operating system, but a "
7677 "I<bootable> install disk, live CD, or similar."
7681 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
7682 msgid "The format of this disk image is not known."
7686 #: ../fish/guestfish-actions.pod:1892
7687 msgid "inspect-get-hostname"
7691 #: ../fish/guestfish-actions.pod:1894
7694 " inspect-get-hostname root\n"
7699 #: ../fish/guestfish-actions.pod:1896 ../src/guestfs-actions.pod:2805
7701 "This function returns the hostname of the operating system as found by "
7702 "inspection of the guest's configuration files."
7706 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2808
7708 "If the hostname could not be determined, then the string C<unknown> is "
7713 #: ../fish/guestfish-actions.pod:1904
7714 msgid "inspect-get-icon"
7718 #: ../fish/guestfish-actions.pod:1906
7721 " inspect-get-icon root [favicon:..] [highquality:..]\n"
7726 #: ../fish/guestfish-actions.pod:1908 ../src/guestfs-actions.pod:2834
7728 "This function returns an icon corresponding to the inspected operating "
7729 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
7730 "to PNG if necessary)."
7734 #: ../fish/guestfish-actions.pod:1912 ../src/guestfs-actions.pod:2838
7736 "If it was not possible to get an icon this function returns a zero-length "
7737 "(non-NULL) buffer. I<Callers must check for this case>."
7741 #: ../fish/guestfish-actions.pod:1915 ../src/guestfs-actions.pod:2841
7743 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
7744 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
7745 "this file will be returned. You can disable favicons by passing the "
7746 "optional C<favicon> boolean as false (default is true)."
7750 #: ../fish/guestfish-actions.pod:1921 ../src/guestfs-actions.pod:2847
7752 "If finding the favicon fails, then we look in other places in the guest for "
7757 #: ../fish/guestfish-actions.pod:1924 ../src/guestfs-actions.pod:2850
7759 "If the optional C<highquality> boolean is true then only high quality icons "
7760 "are returned, which means only icons of high resolution with an alpha "
7761 "channel. The default (false) is to return any icon we can, even if it is of "
7762 "substandard quality."
7766 #: ../fish/guestfish-actions.pod:1935 ../src/guestfs-actions.pod:2861
7768 "Unlike most other inspection API calls, the guest's disks must be mounted up "
7769 "before you call this, since it needs to read information from the guest "
7770 "filesystem during the call."
7774 #: ../fish/guestfish-actions.pod:1941 ../src/guestfs-actions.pod:2867
7776 "B<Security:> The icon data comes from the untrusted guest, and should be "
7777 "treated with caution. PNG files have been known to contain exploits. "
7778 "Ensure that libpng (or other relevant libraries) are fully up to date before "
7779 "trying to process or display the icon."
7783 #: ../fish/guestfish-actions.pod:1949 ../src/guestfs-actions.pod:2875
7785 "The PNG image returned can be any size. It might not be square. Libguestfs "
7786 "tries to return the largest, highest quality icon available. The "
7787 "application must scale the icon to the required size."
7791 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:2882
7793 "Extracting icons from Windows guests requires the external C<wrestool> "
7794 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
7795 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
7796 "installed separately."
7800 #: ../fish/guestfish-actions.pod:1963 ../src/guestfs-actions.pod:2889
7802 "Operating system icons are usually trademarks. Seek legal advice before "
7803 "using trademarks in applications."
7807 #: ../fish/guestfish-actions.pod:1970
7808 msgid "inspect-get-major-version"
7812 #: ../fish/guestfish-actions.pod:1972
7815 " inspect-get-major-version root\n"
7820 #: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:2930
7821 msgid "This returns the major version number of the inspected operating system."
7825 #: ../fish/guestfish-actions.pod:1977 ../src/guestfs-actions.pod:2933
7827 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7828 "popular public names used by the operating system. Notably the operating "
7829 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7830 "1). You can find out the real versions corresponding to releases of Windows "
7831 "by consulting Wikipedia or MSDN."
7835 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995 ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2957
7836 msgid "If the version could not be determined, then C<0> is returned."
7840 #: ../fish/guestfish-actions.pod:1988
7841 msgid "inspect-get-minor-version"
7845 #: ../fish/guestfish-actions.pod:1990
7848 " inspect-get-minor-version root\n"
7853 #: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:2954
7854 msgid "This returns the minor version number of the inspected operating system."
7858 #: ../fish/guestfish-actions.pod:1997
7860 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7861 "L</inspect-get-major-version>."
7865 #: ../fish/guestfish-actions.pod:2000
7866 msgid "inspect-get-mountpoints"
7870 #: ../fish/guestfish-actions.pod:2002
7873 " inspect-get-mountpoints root\n"
7878 #: ../fish/guestfish-actions.pod:2004 ../src/guestfs-actions.pod:2972
7880 "This returns a hash of where we think the filesystems associated with this "
7881 "operating system should be mounted. Callers should note that this is at "
7882 "best an educated guess made by reading configuration files such as "
7883 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
7884 "are non-existent or not mountable and callers should be prepared to handle "
7885 "or ignore failures if they try to mount them."
7889 #: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:2981
7891 "Each element in the returned hashtable has a key which is the path of the "
7892 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7893 "mounted there (eg. C</dev/sda1>)."
7897 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
7898 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
7902 #: ../fish/guestfish-actions.pod:2021
7904 "For operating systems like Windows which still use drive letters, this call "
7905 "will only return an entry for the first drive \"mounted on\" C</>. For "
7906 "information about the mapping of drive letters to partitions, see "
7907 "L</inspect-get-drive-mappings>."
7911 #: ../fish/guestfish-actions.pod:2027
7913 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7914 "L</inspect-get-filesystems>."
7918 #: ../fish/guestfish-actions.pod:2030
7919 msgid "inspect-get-package-format"
7923 #: ../fish/guestfish-actions.pod:2032
7926 " inspect-get-package-format root\n"
7931 #: ../fish/guestfish-actions.pod:2034
7933 "This function and L</inspect-get-package-management> return the package "
7934 "format and package management tool used by the inspected operating system. "
7935 "For example for Fedora these functions would return C<rpm> (package format) "
7936 "and C<yum> (package management)."
7940 #: ../fish/guestfish-actions.pod:2040 ../src/guestfs-actions.pod:3018
7942 "This returns the string C<unknown> if we could not determine the package "
7943 "format I<or> if the operating system does not have a real packaging system "
7948 #: ../fish/guestfish-actions.pod:2044 ../src/guestfs-actions.pod:3022
7950 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
7951 "Future versions of libguestfs may return other strings."
7955 #: ../fish/guestfish-actions.pod:2049
7956 msgid "inspect-get-package-management"
7960 #: ../fish/guestfish-actions.pod:2051
7963 " inspect-get-package-management root\n"
7968 #: ../fish/guestfish-actions.pod:2053
7970 "L</inspect-get-package-format> and this function return the package format "
7971 "and package management tool used by the inspected operating system. For "
7972 "example for Fedora these functions would return C<rpm> (package format) and "
7973 "C<yum> (package management)."
7977 #: ../fish/guestfish-actions.pod:2059 ../src/guestfs-actions.pod:3044
7979 "This returns the string C<unknown> if we could not determine the package "
7980 "management tool I<or> if the operating system does not have a real packaging "
7981 "system (eg. Windows)."
7985 #: ../fish/guestfish-actions.pod:2063 ../src/guestfs-actions.pod:3048
7987 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
7988 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
7989 "libguestfs may return other strings."
7993 #: ../fish/guestfish-actions.pod:2070
7994 msgid "inspect-get-product-name"
7998 #: ../fish/guestfish-actions.pod:2072
8001 " inspect-get-product-name root\n"
8006 #: ../fish/guestfish-actions.pod:2074 ../src/guestfs-actions.pod:3066
8008 "This returns the product name of the inspected operating system. The "
8009 "product name is generally some freeform string which can be displayed to the "
8010 "user, but should not be parsed by programs."
8014 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8016 "If the product name could not be determined, then the string C<unknown> is "
8021 #: ../fish/guestfish-actions.pod:2084
8022 msgid "inspect-get-product-variant"
8026 #: ../fish/guestfish-actions.pod:2086
8029 " inspect-get-product-variant root\n"
8034 #: ../fish/guestfish-actions.pod:2088 ../src/guestfs-actions.pod:3087
8035 msgid "This returns the product variant of the inspected operating system."
8039 #: ../fish/guestfish-actions.pod:2091 ../src/guestfs-actions.pod:3090
8041 "For Windows guests, this returns the contents of the Registry key "
8042 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8043 "which is usually a string such as C<Client> or C<Server> (other values are "
8044 "possible). This can be used to distinguish consumer and enterprise versions "
8045 "of Windows that have the same version number (for example, Windows 7 and "
8046 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8047 "the latter is C<Server>)."
8051 #: ../fish/guestfish-actions.pod:2100 ../src/guestfs-actions.pod:3099
8053 "For enterprise Linux guests, in future we intend this to return the product "
8054 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8055 "implemented at present."
8059 #: ../fish/guestfish-actions.pod:2104 ../src/guestfs-actions.pod:3103
8061 "If the product variant could not be determined, then the string C<unknown> "
8066 #: ../fish/guestfish-actions.pod:2107
8068 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8069 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8073 #: ../fish/guestfish-actions.pod:2111
8074 msgid "inspect-get-roots"
8078 #: ../fish/guestfish-actions.pod:2113
8081 " inspect-get-roots\n"
8086 #: ../fish/guestfish-actions.pod:2115
8088 "This function is a convenient way to get the list of root devices, as "
8089 "returned from a previous call to L</inspect-os>, but without redoing the "
8090 "whole inspection process."
8094 #: ../fish/guestfish-actions.pod:2119
8096 "This returns an empty list if either no root devices were found or the "
8097 "caller has not called L</inspect-os>."
8101 #: ../fish/guestfish-actions.pod:2124
8102 msgid "inspect-get-type"
8106 #: ../fish/guestfish-actions.pod:2126
8109 " inspect-get-type root\n"
8114 #: ../fish/guestfish-actions.pod:2128 ../src/guestfs-actions.pod:3141
8116 "This returns the type of the inspected operating system. Currently defined "
8121 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8126 #: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3148
8127 msgid "Any Linux-based operating system."
8131 #: ../fish/guestfish-actions.pod:2139 ../src/guestfs-actions.pod:3152
8132 msgid "Any Microsoft Windows operating system."
8136 #: ../fish/guestfish-actions.pod:2141 ../src/guestfs-actions.pod:3154
8141 #: ../fish/guestfish-actions.pod:2143 ../src/guestfs-actions.pod:3156
8146 #: ../fish/guestfish-actions.pod:2147 ../src/guestfs-actions.pod:3160
8147 msgid "The operating system type could not be determined."
8151 #: ../fish/guestfish-actions.pod:2156
8152 msgid "inspect-get-windows-current-control-set"
8156 #: ../fish/guestfish-actions.pod:2158
8159 " inspect-get-windows-current-control-set root\n"
8164 #: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3180
8166 "This returns the Windows CurrentControlSet of the inspected guest. The "
8167 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8171 #: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:3183
8173 "This call assumes that the guest is Windows and that the Registry could be "
8174 "examined by inspection. If this is not the case then an error is returned."
8178 #: ../fish/guestfish-actions.pod:2169
8179 msgid "inspect-get-windows-systemroot"
8183 #: ../fish/guestfish-actions.pod:2171
8186 " inspect-get-windows-systemroot root\n"
8191 #: ../fish/guestfish-actions.pod:2173 ../src/guestfs-actions.pod:3200
8193 "This returns the Windows systemroot of the inspected guest. The systemroot "
8194 "is a directory path such as C</WINDOWS>."
8198 #: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:3203
8200 "This call assumes that the guest is Windows and that the systemroot could be "
8201 "determined by inspection. If this is not the case then an error is "
8206 #: ../fish/guestfish-actions.pod:2182
8207 msgid "inspect-is-live"
8211 #: ../fish/guestfish-actions.pod:2184
8214 " inspect-is-live root\n"
8219 #: ../fish/guestfish-actions.pod:2186
8221 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8222 "then this returns true if a live image was detected on the disk."
8226 #: ../fish/guestfish-actions.pod:2192
8227 msgid "inspect-is-multipart"
8231 #: ../fish/guestfish-actions.pod:2194
8234 " inspect-is-multipart root\n"
8239 #: ../fish/guestfish-actions.pod:2196
8241 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8242 "then this returns true if the disk is part of a set."
8246 #: ../fish/guestfish-actions.pod:2202
8247 msgid "inspect-is-netinst"
8251 #: ../fish/guestfish-actions.pod:2204
8254 " inspect-is-netinst root\n"
8259 #: ../fish/guestfish-actions.pod:2206
8261 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8262 "then this returns true if the disk is a network installer, ie. not a "
8263 "self-contained install CD but one which is likely to require network access "
8264 "to complete the install."
8268 #: ../fish/guestfish-actions.pod:2214
8269 msgid "inspect-list-applications"
8273 #: ../fish/guestfish-actions.pod:2216
8276 " inspect-list-applications root\n"
8281 #: ../fish/guestfish-actions.pod:2218 ../src/guestfs-actions.pod:3270
8282 msgid "Return the list of applications installed in the operating system."
8286 #: ../fish/guestfish-actions.pod:2220
8288 "I<Note:> This call works differently from other parts of the inspection "
8289 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8290 "then mount up the disks, before calling this. Listing applications is a "
8291 "significantly more difficult operation which requires access to the full "
8292 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8293 "are just returning data cached in the libguestfs handle, this call actually "
8294 "reads parts of the mounted filesystems during the call."
8298 #: ../fish/guestfish-actions.pod:2230 ../src/guestfs-actions.pod:3282
8300 "This returns an empty list if the inspection code was not able to determine "
8301 "the list of applications."
8305 #: ../fish/guestfish-actions.pod:2233 ../src/guestfs-actions.pod:3285
8306 msgid "The application structure contains the following fields:"
8310 #: ../fish/guestfish-actions.pod:2237 ../src/guestfs-actions.pod:3289
8315 #: ../fish/guestfish-actions.pod:2239 ../src/guestfs-actions.pod:3291
8317 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8318 "guests, this is the package name."
8322 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8323 msgid "C<app_display_name>"
8327 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8329 "The display name of the application, sometimes localized to the install "
8330 "language of the guest operating system."
8334 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8336 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8337 "to display something can use C<app_name> instead."
8341 #: ../fish/guestfish-actions.pod:2250 ../src/guestfs-actions.pod:3302
8342 msgid "C<app_epoch>"
8346 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8348 "For package managers which use epochs, this contains the epoch of the "
8349 "package (an integer). If unavailable, this is returned as C<0>."
8353 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8354 msgid "C<app_version>"
8358 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8360 "The version string of the application or package. If unavailable this is "
8361 "returned as an empty string C<\"\">."
8365 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8366 msgid "C<app_release>"
8370 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8372 "The release string of the application or package, for package managers that "
8373 "use this. If unavailable this is returned as an empty string C<\"\">."
8377 #: ../fish/guestfish-actions.pod:2266 ../src/guestfs-actions.pod:3318
8378 msgid "C<app_install_path>"
8382 #: ../fish/guestfish-actions.pod:2268 ../src/guestfs-actions.pod:3320
8384 "The installation path of the application (on operating systems such as "
8385 "Windows which use installation paths). This path is in the format used by "
8386 "the guest operating system, it is not a libguestfs path."
8390 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8391 msgid "If unavailable this is returned as an empty string C<\"\">."
8395 #: ../fish/guestfish-actions.pod:2275 ../src/guestfs-actions.pod:3327
8396 msgid "C<app_trans_path>"
8400 #: ../fish/guestfish-actions.pod:2277 ../src/guestfs-actions.pod:3329
8402 "The install path translated into a libguestfs path. If unavailable this is "
8403 "returned as an empty string C<\"\">."
8407 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8408 msgid "C<app_publisher>"
8412 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8414 "The name of the publisher of the application, for package managers that use "
8415 "this. If unavailable this is returned as an empty string C<\"\">."
8419 #: ../fish/guestfish-actions.pod:2286 ../src/guestfs-actions.pod:3338
8424 #: ../fish/guestfish-actions.pod:2288 ../src/guestfs-actions.pod:3340
8426 "The URL (eg. upstream URL) of the application. If unavailable this is "
8427 "returned as an empty string C<\"\">."
8431 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8432 msgid "C<app_source_package>"
8436 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8438 "For packaging systems which support this, the name of the source package. "
8439 "If unavailable this is returned as an empty string C<\"\">."
8443 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8444 msgid "C<app_summary>"
8448 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8450 "A short (usually one line) description of the application or package. If "
8451 "unavailable this is returned as an empty string C<\"\">."
8455 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8456 msgid "C<app_description>"
8460 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8462 "A longer description of the application or package. If unavailable this is "
8463 "returned as an empty string C<\"\">."
8467 #: ../fish/guestfish-actions.pod:2310
8472 #: ../fish/guestfish-actions.pod:2312
8480 #: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3373
8482 "This function uses other libguestfs functions and certain heuristics to "
8483 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8484 "for operating systems."
8488 #: ../fish/guestfish-actions.pod:2318 ../src/guestfs-actions.pod:3377
8489 msgid "The list returned is empty if no operating systems were found."
8493 #: ../fish/guestfish-actions.pod:2320 ../src/guestfs-actions.pod:3379
8495 "If one operating system was found, then this returns a list with a single "
8496 "element, which is the name of the root filesystem of this operating system. "
8497 "It is also possible for this function to return a list containing more than "
8498 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8499 "element being the root filesystem of one of the operating systems."
8503 #: ../fish/guestfish-actions.pod:2327
8505 "You can pass the root string(s) returned to other L</inspect-get-*> "
8506 "functions in order to query further information about each operating system, "
8507 "such as the name and version."
8511 #: ../fish/guestfish-actions.pod:2332
8513 "This function uses other libguestfs features such as L</mount-ro> and "
8514 "L</umount-all> in order to mount and unmount filesystems and look at the "
8515 "contents. This should be called with no disks currently mounted. The "
8516 "function may also use Augeas, so any existing Augeas handle will be closed."
8520 #: ../fish/guestfish-actions.pod:2338 ../src/guestfs-actions.pod:3397
8522 "This function cannot decrypt encrypted disks. The caller must do that first "
8523 "(supplying the necessary keys) if the disk is encrypted."
8527 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542 ../fish/guestfish-actions.pod:2601
8528 msgid "See also L</list-filesystems>."
8532 #: ../fish/guestfish-actions.pod:2346
8537 #: ../fish/guestfish-actions.pod:2348
8540 " is-blockdev path\n"
8545 #: ../fish/guestfish-actions.pod:2350 ../src/guestfs-actions.pod:3417
8547 "This returns C<true> if and only if there is a block device with the given "
8552 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399 ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2452
8553 msgid "See also L</stat>."
8557 #: ../fish/guestfish-actions.pod:2355
8562 #: ../fish/guestfish-actions.pod:2357
8570 #: ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3431
8572 "This returns true iff this handle is busy processing a command (in the "
8577 #: ../fish/guestfish-actions.pod:2364
8582 #: ../fish/guestfish-actions.pod:2366
8585 " is-chardev path\n"
8590 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3446
8592 "This returns C<true> if and only if there is a character device with the "
8593 "given C<path> name."
8597 #: ../fish/guestfish-actions.pod:2373
8602 #: ../fish/guestfish-actions.pod:2375
8610 #: ../fish/guestfish-actions.pod:2377 ../src/guestfs-actions.pod:3460
8612 "This returns true iff this handle is being configured (in the C<CONFIG> "
8617 #: ../fish/guestfish-actions.pod:2382
8622 #: ../fish/guestfish-actions.pod:2384
8630 #: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3475
8632 "This returns C<true> if and only if there is a directory with the given "
8633 "C<path> name. Note that it returns false for other objects like files."
8637 #: ../fish/guestfish-actions.pod:2392
8642 #: ../fish/guestfish-actions.pod:2394
8650 #: ../fish/guestfish-actions.pod:2396 ../src/guestfs-actions.pod:3491
8652 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8653 "given C<path> name."
8657 #: ../fish/guestfish-actions.pod:2401
8662 #: ../fish/guestfish-actions.pod:2403
8670 #: ../fish/guestfish-actions.pod:2405 ../src/guestfs-actions.pod:3506
8672 "This returns C<true> if and only if there is a regular file with the given "
8673 "C<path> name. Note that it returns false for other objects like "
8678 #: ../fish/guestfish-actions.pod:2411
8679 msgid "is-launching"
8683 #: ../fish/guestfish-actions.pod:2413
8691 #: ../fish/guestfish-actions.pod:2415 ../src/guestfs-actions.pod:3521
8693 "This returns true iff this handle is launching the subprocess (in the "
8694 "C<LAUNCHING> state)."
8698 #: ../fish/guestfish-actions.pod:2420
8703 #: ../fish/guestfish-actions.pod:2422
8711 #: ../fish/guestfish-actions.pod:2424 ../src/guestfs-actions.pod:3536
8713 "This command tests whether C<device> is a logical volume, and returns true "
8714 "iff this is the case."
8718 #: ../fish/guestfish-actions.pod:2427
8723 #: ../fish/guestfish-actions.pod:2429
8731 #: ../fish/guestfish-actions.pod:2431 ../src/guestfs-actions.pod:3548
8733 "This returns true iff this handle is ready to accept commands (in the "
8738 #: ../fish/guestfish-actions.pod:2436
8743 #: ../fish/guestfish-actions.pod:2438
8751 #: ../fish/guestfish-actions.pod:2440 ../src/guestfs-actions.pod:3563
8753 "This returns C<true> if and only if there is a Unix domain socket with the "
8754 "given C<path> name."
8758 #: ../fish/guestfish-actions.pod:2445
8763 #: ../fish/guestfish-actions.pod:2447
8766 " is-symlink path\n"
8771 #: ../fish/guestfish-actions.pod:2449 ../src/guestfs-actions.pod:3578
8773 "This returns C<true> if and only if there is a symbolic link with the given "
8778 #: ../fish/guestfish-actions.pod:2454
8783 #: ../fish/guestfish-actions.pod:2456
8791 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3593
8793 "This returns true iff the file exists and the file is empty or it contains "
8798 #: ../fish/guestfish-actions.pod:2461
8799 msgid "is-zero-device"
8803 #: ../fish/guestfish-actions.pod:2463
8806 " is-zero-device device\n"
8811 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3606
8812 msgid "This returns true iff the device exists and contains all zero bytes."
8816 #: ../fish/guestfish-actions.pod:2467 ../src/guestfs-actions.pod:3608
8817 msgid "Note that for large devices this can take a long time to run."
8821 #: ../fish/guestfish-actions.pod:2469
8822 msgid "kill-subprocess"
8826 #: ../fish/guestfish-actions.pod:2471
8829 " kill-subprocess\n"
8834 #: ../fish/guestfish-actions.pod:2473 ../src/guestfs-actions.pod:3619
8835 msgid "This kills the qemu subprocess. You should never need to call this."
8839 #: ../fish/guestfish-actions.pod:2475
8844 #: ../fish/guestfish-actions.pod:2477
8849 #: ../fish/guestfish-actions.pod:2479
8857 #: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3630
8859 "Internally libguestfs is implemented by running a virtual machine using "
8864 #: ../fish/guestfish-actions.pod:2484 ../src/guestfs-actions.pod:3633
8866 "You should call this after configuring the handle (eg. adding drives) but "
8867 "before performing any actions."
8871 #: ../fish/guestfish-actions.pod:2487
8876 #: ../fish/guestfish-actions.pod:2489
8879 " lchown owner group path\n"
8884 #: ../fish/guestfish-actions.pod:2491
8886 "Change the file owner to C<owner> and group to C<group>. This is like "
8887 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
8892 #: ../fish/guestfish-actions.pod:2499
8897 #: ../fish/guestfish-actions.pod:2501
8900 " lgetxattr path name\n"
8905 #: ../fish/guestfish-actions.pod:2503 ../src/guestfs-actions.pod:3673
8907 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
8908 "is a symlink, then this call returns an extended attribute from the symlink."
8912 #: ../fish/guestfish-actions.pod:2517
8913 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
8917 #: ../fish/guestfish-actions.pod:2519
8922 #: ../fish/guestfish-actions.pod:2521
8925 " lgetxattrs path\n"
8930 #: ../fish/guestfish-actions.pod:2523
8932 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
8933 "it returns the extended attributes of the link itself."
8937 #: ../fish/guestfish-actions.pod:2527
8942 #: ../fish/guestfish-actions.pod:2529
8950 #: ../fish/guestfish-actions.pod:2531 ../src/guestfs-actions.pod:3716
8952 "List all 9p filesystems attached to the guest. A list of mount tags is "
8957 #: ../fish/guestfish-actions.pod:2534
8958 msgid "list-devices"
8962 #: ../fish/guestfish-actions.pod:2536
8970 #: ../fish/guestfish-actions.pod:2538 ../src/guestfs-actions.pod:3730
8971 msgid "List all the block devices."
8975 #: ../fish/guestfish-actions.pod:2540 ../src/guestfs-actions.pod:3732
8976 msgid "The full block device names are returned, eg. C</dev/sda>."
8980 #: ../fish/guestfish-actions.pod:2544
8981 msgid "list-dm-devices"
8985 #: ../fish/guestfish-actions.pod:2546
8988 " list-dm-devices\n"
8993 #: ../fish/guestfish-actions.pod:2548 ../src/guestfs-actions.pod:3747
8994 msgid "List all device mapper devices."
8998 #: ../fish/guestfish-actions.pod:2550
9000 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9001 "previous call to L</luks-open>."
9005 #: ../fish/guestfish-actions.pod:2553
9007 "Device mapper devices which correspond to logical volumes are I<not> "
9008 "returned in this list. Call L</lvs> if you want to list logical volumes."
9012 #: ../fish/guestfish-actions.pod:2557
9013 msgid "list-filesystems"
9017 #: ../fish/guestfish-actions.pod:2559
9020 " list-filesystems\n"
9025 #: ../fish/guestfish-actions.pod:2561 ../src/guestfs-actions.pod:3767
9027 "This inspection command looks for filesystems on partitions, block devices "
9028 "and logical volumes, returning a list of devices containing filesystems and "
9033 #: ../fish/guestfish-actions.pod:2565 ../src/guestfs-actions.pod:3771
9035 "The return value is a hash, where the keys are the devices containing "
9036 "filesystems, and the values are the filesystem types. For example:"
9040 #: ../fish/guestfish-actions.pod:2569 ../src/guestfs-actions.pod:3775
9043 " \"/dev/sda1\" => \"ntfs\"\n"
9044 " \"/dev/sda2\" => \"ext2\"\n"
9045 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9046 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9051 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9053 "The value can have the special value \"unknown\", meaning the content of the "
9054 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9058 #: ../fish/guestfish-actions.pod:2578
9060 "This command runs other libguestfs commands, which might include L</mount> "
9061 "and L</umount>, and therefore you should use this soon after launch and only "
9062 "when nothing is mounted."
9066 #: ../fish/guestfish-actions.pod:2582
9068 "Not all of the filesystems returned will be mountable. In particular, swap "
9069 "partitions are returned in the list. Also this command does not check that "
9070 "each filesystem found is valid and mountable, and some filesystems might be "
9071 "mountable but require special options. Filesystems may not all belong to a "
9072 "single logical operating system (use L</inspect-os> to look for OSes)."
9076 #: ../fish/guestfish-actions.pod:2590
9077 msgid "list-partitions"
9081 #: ../fish/guestfish-actions.pod:2592
9084 " list-partitions\n"
9089 #: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3809
9090 msgid "List all the partitions detected on all block devices."
9094 #: ../fish/guestfish-actions.pod:2596 ../src/guestfs-actions.pod:3811
9095 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9099 #: ../fish/guestfish-actions.pod:2598
9101 "This does not return logical volumes. For that you will need to call "
9106 #: ../fish/guestfish-actions.pod:2603
9111 #: ../fish/guestfish-actions.pod:2605
9119 #: ../fish/guestfish-actions.pod:2607 ../src/guestfs-actions.pod:3830
9121 "List the files in C<directory> (relative to the root directory, there is no "
9122 "cwd) in the format of 'ls -la'."
9126 #: ../fish/guestfish-actions.pod:2610 ../src/guestfs-actions.pod:3833
9128 "This command is mostly useful for interactive sessions. It is I<not> "
9129 "intended that you try to parse the output string."
9133 #: ../fish/guestfish-actions.pod:2613
9138 #: ../fish/guestfish-actions.pod:2615
9141 " ln target linkname\n"
9146 #: ../fish/guestfish-actions.pod:2617 ../src/guestfs-actions.pod:3848
9147 msgid "This command creates a hard link using the C<ln> command."
9151 #: ../fish/guestfish-actions.pod:2619
9156 #: ../fish/guestfish-actions.pod:2621
9159 " ln-f target linkname\n"
9164 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3861
9166 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9167 "option removes the link (C<linkname>) if it exists already."
9171 #: ../fish/guestfish-actions.pod:2626
9176 #: ../fish/guestfish-actions.pod:2628
9179 " ln-s target linkname\n"
9184 #: ../fish/guestfish-actions.pod:2630 ../src/guestfs-actions.pod:3875
9185 msgid "This command creates a symbolic link using the C<ln -s> command."
9189 #: ../fish/guestfish-actions.pod:2632
9194 #: ../fish/guestfish-actions.pod:2634
9197 " ln-sf target linkname\n"
9202 #: ../fish/guestfish-actions.pod:2636 ../src/guestfs-actions.pod:3888
9204 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9205 "option removes the link (C<linkname>) if it exists already."
9209 #: ../fish/guestfish-actions.pod:2639
9210 msgid "lremovexattr"
9214 #: ../fish/guestfish-actions.pod:2641
9217 " lremovexattr xattr path\n"
9222 #: ../fish/guestfish-actions.pod:2643
9224 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9225 "it removes an extended attribute of the link itself."
9229 #: ../fish/guestfish-actions.pod:2647
9234 #: ../fish/guestfish-actions.pod:2649
9242 #: ../fish/guestfish-actions.pod:2651 ../src/guestfs-actions.pod:3916
9244 "List the files in C<directory> (relative to the root directory, there is no "
9245 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9250 #: ../fish/guestfish-actions.pod:2655
9252 "This command is mostly useful for interactive sessions. Programs should "
9253 "probably use L</readdir> instead."
9257 #: ../fish/guestfish-actions.pod:2658
9262 #: ../fish/guestfish-actions.pod:2660
9265 " lsetxattr xattr val vallen path\n"
9270 #: ../fish/guestfish-actions.pod:2662
9272 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9273 "sets an extended attribute of the link itself."
9277 #: ../fish/guestfish-actions.pod:2666
9282 #: ../fish/guestfish-actions.pod:2668
9290 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4478 ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:6731
9291 msgid "Returns file information for the given C<path>."
9295 #: ../fish/guestfish-actions.pod:2672
9297 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9298 "the link is stat-ed, not the file it refers to."
9302 #: ../fish/guestfish-actions.pod:2676 ../src/guestfs-actions.pod:3958
9303 msgid "This is the same as the C<lstat(2)> system call."
9307 #: ../fish/guestfish-actions.pod:2678
9312 #: ../fish/guestfish-actions.pod:2680
9315 " lstatlist path 'names ...'\n"
9320 #: ../fish/guestfish-actions.pod:2682
9322 "This call allows you to perform the L</lstat> operation on multiple files, "
9323 "where all files are in the directory C<path>. C<names> is the list of files "
9324 "from this directory."
9328 #: ../fish/guestfish-actions.pod:2686 ../src/guestfs-actions.pod:3977
9330 "On return you get a list of stat structs, with a one-to-one correspondence "
9331 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9332 "then the C<ino> field of that structure is set to C<-1>."
9336 #: ../fish/guestfish-actions.pod:2691
9338 "This call is intended for programs that want to efficiently list a directory "
9339 "contents without making many round-trips. See also L</lxattrlist> for a "
9340 "similarly efficient call for getting extended attributes. Very long "
9341 "directory listings might cause the protocol message size to be exceeded, "
9342 "causing this call to fail. The caller must split up such requests into "
9343 "smaller groups of names."
9347 #: ../fish/guestfish-actions.pod:2699
9348 msgid "luks-add-key"
9352 #: ../fish/guestfish-actions.pod:2701
9355 " luks-add-key device keyslot\n"
9360 #: ../fish/guestfish-actions.pod:2703 ../src/guestfs-actions.pod:4005
9362 "This command adds a new key on LUKS device C<device>. C<key> is any "
9363 "existing key, and is used to access the device. C<newkey> is the new key to "
9364 "add. C<keyslot> is the key slot that will be replaced."
9368 #: ../fish/guestfish-actions.pod:2708
9370 "Note that if C<keyslot> already contains a key, then this command will "
9371 "fail. You have to use L</luks-kill-slot> first to remove that key."
9375 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734 ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761 ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
9377 "This command has one or more key or passphrase parameters. Guestfish will "
9378 "prompt for these separately."
9382 #: ../fish/guestfish-actions.pod:2715
9387 #: ../fish/guestfish-actions.pod:2717
9390 " luks-close device\n"
9395 #: ../fish/guestfish-actions.pod:2719
9397 "This closes a LUKS device that was created earlier by L</luks-open> or "
9398 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
9399 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9400 "underlying block device."
9404 #: ../fish/guestfish-actions.pod:2725
9409 #: ../fish/guestfish-actions.pod:2727
9412 " luks-format device keyslot\n"
9417 #: ../fish/guestfish-actions.pod:2729 ../src/guestfs-actions.pod:4046
9419 "This command erases existing data on C<device> and formats the device as a "
9420 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9421 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9425 #: ../fish/guestfish-actions.pod:2737 ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2837 ../fish/guestfish-actions.pod:3498 ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4349 ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394 ../fish/guestfish-actions.pod:5132 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:7799
9427 "B<This command is dangerous. Without careful use you can easily destroy all "
9432 #: ../fish/guestfish-actions.pod:2740
9433 msgid "luks-format-cipher"
9437 #: ../fish/guestfish-actions.pod:2742
9440 " luks-format-cipher device keyslot cipher\n"
9445 #: ../fish/guestfish-actions.pod:2744
9447 "This command is the same as L</luks-format> but it also allows you to set "
9448 "the C<cipher> used."
9452 #: ../fish/guestfish-actions.pod:2753
9453 msgid "luks-kill-slot"
9457 #: ../fish/guestfish-actions.pod:2755
9460 " luks-kill-slot device keyslot\n"
9465 #: ../fish/guestfish-actions.pod:2757 ../src/guestfs-actions.pod:4093
9467 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9468 "device C<device>. C<key> must be one of the I<other> keys."
9472 #: ../fish/guestfish-actions.pod:2764
9477 #: ../fish/guestfish-actions.pod:2766
9480 " luks-open device mapname\n"
9485 #: ../fish/guestfish-actions.pod:2768 ../src/guestfs-actions.pod:4113
9487 "This command opens a block device which has been encrypted according to the "
9488 "Linux Unified Key Setup (LUKS) standard."
9492 #: ../fish/guestfish-actions.pod:2771 ../src/guestfs-actions.pod:4116
9493 msgid "C<device> is the encrypted block device or partition."
9497 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
9499 "The caller must supply one of the keys associated with the LUKS block "
9500 "device, in the C<key> parameter."
9504 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
9506 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9507 "writes to this block device are decrypted from and encrypted to the "
9508 "underlying C<device> respectively."
9512 #: ../fish/guestfish-actions.pod:2780
9514 "If this block device contains LVM volume groups, then calling L</vgscan> "
9515 "followed by L</vg-activate-all> will make them visible."
9519 #: ../fish/guestfish-actions.pod:2784
9520 msgid "Use L</list-dm-devices> to list all device mapper devices."
9524 #: ../fish/guestfish-actions.pod:2790
9525 msgid "luks-open-ro"
9529 #: ../fish/guestfish-actions.pod:2792
9532 " luks-open-ro device mapname\n"
9537 #: ../fish/guestfish-actions.pod:2794
9539 "This is the same as L</luks-open> except that a read-only mapping is "
9544 #: ../fish/guestfish-actions.pod:2800
9549 #: ../fish/guestfish-actions.pod:2802
9552 " lvcreate logvol volgroup mbytes\n"
9557 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4167
9559 "This creates an LVM logical volume called C<logvol> on the volume group "
9560 "C<volgroup>, with C<size> megabytes."
9564 #: ../fish/guestfish-actions.pod:2807
9565 msgid "lvm-canonical-lv-name"
9569 #: ../fish/guestfish-actions.pod:2809
9572 " lvm-canonical-lv-name lvname\n"
9577 #: ../fish/guestfish-actions.pod:2811 ../src/guestfs-actions.pod:4180
9579 "This converts alternative naming schemes for LVs that you might find to the "
9580 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9585 #: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4184
9587 "This command returns an error if the C<lvname> parameter does not refer to a "
9592 #: ../fish/guestfish-actions.pod:2818
9593 msgid "See also L</is-lv>."
9597 #: ../fish/guestfish-actions.pod:2820
9598 msgid "lvm-clear-filter"
9602 #: ../fish/guestfish-actions.pod:2822
9605 " lvm-clear-filter\n"
9610 #: ../fish/guestfish-actions.pod:2824
9612 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
9617 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858 ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4244
9618 msgid "This command also clears the LVM cache and performs a volume group scan."
9622 #: ../fish/guestfish-actions.pod:2830
9623 msgid "lvm-remove-all"
9627 #: ../fish/guestfish-actions.pod:2832
9635 #: ../fish/guestfish-actions.pod:2834 ../src/guestfs-actions.pod:4214
9637 "This command removes all LVM logical volumes, volume groups and physical "
9642 #: ../fish/guestfish-actions.pod:2840
9643 msgid "lvm-set-filter"
9647 #: ../fish/guestfish-actions.pod:2842
9650 " lvm-set-filter 'devices ...'\n"
9655 #: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4230
9657 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9658 "block devices in the list C<devices>, and will ignore all other attached "
9663 #: ../fish/guestfish-actions.pod:2848 ../src/guestfs-actions.pod:4234
9665 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9666 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9667 "there are two types of duplication possible: either cloned PVs/VGs which "
9668 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9669 "same name. In normal operation you cannot create this situation, but you "
9670 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9671 "inside the LVM metadata."
9675 #: ../fish/guestfish-actions.pod:2861 ../src/guestfs-actions.pod:4247
9676 msgid "You can filter whole block devices or individual partitions."
9680 #: ../fish/guestfish-actions.pod:2863 ../src/guestfs-actions.pod:4249
9682 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9683 "filesystem), even if you are not filtering out that VG."
9687 #: ../fish/guestfish-actions.pod:2867
9692 #: ../fish/guestfish-actions.pod:2869
9695 " lvremove device\n"
9700 #: ../fish/guestfish-actions.pod:2871 ../src/guestfs-actions.pod:4263
9702 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9703 "LV, such as C</dev/VG/LV>."
9707 #: ../fish/guestfish-actions.pod:2874 ../src/guestfs-actions.pod:4266
9709 "You can also remove all LVs in a volume group by specifying the VG name, "
9714 #: ../fish/guestfish-actions.pod:2877
9719 #: ../fish/guestfish-actions.pod:2879
9722 " lvrename logvol newlogvol\n"
9727 #: ../fish/guestfish-actions.pod:2881 ../src/guestfs-actions.pod:4280
9728 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9732 #: ../fish/guestfish-actions.pod:2883
9737 #: ../fish/guestfish-actions.pod:2885
9740 " lvresize device mbytes\n"
9745 #: ../fish/guestfish-actions.pod:2887 ../src/guestfs-actions.pod:4293
9747 "This resizes (expands or shrinks) an existing LVM logical volume to "
9748 "C<mbytes>. When reducing, data in the reduced part is lost."
9752 #: ../fish/guestfish-actions.pod:2891
9753 msgid "lvresize-free"
9757 #: ../fish/guestfish-actions.pod:2893
9760 " lvresize-free lv percent\n"
9765 #: ../fish/guestfish-actions.pod:2895 ../src/guestfs-actions.pod:4308
9767 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9768 "remaining free space in the volume group. Commonly you would call this with "
9769 "pc = 100 which expands the logical volume as much as possible, using all "
9770 "remaining free space in the volume group."
9774 #: ../fish/guestfish-actions.pod:2901
9779 #: ../fish/guestfish-actions.pod:2903
9787 #: ../fish/guestfish-actions.pod:2905 ../src/guestfs-actions.pod:4323
9789 "List all the logical volumes detected. This is the equivalent of the "
9790 "L<lvs(8)> command."
9794 #: ../fish/guestfish-actions.pod:2908 ../src/guestfs-actions.pod:4326
9796 "This returns a list of the logical volume device names "
9797 "(eg. C</dev/VolGroup00/LogVol00>)."
9801 #: ../fish/guestfish-actions.pod:2911
9802 msgid "See also L</lvs-full>, L</list-filesystems>."
9806 #: ../fish/guestfish-actions.pod:2913
9811 #: ../fish/guestfish-actions.pod:2915
9819 #: ../fish/guestfish-actions.pod:2917 ../src/guestfs-actions.pod:4342
9821 "List all the logical volumes detected. This is the equivalent of the "
9822 "L<lvs(8)> command. The \"full\" version includes all fields."
9826 #: ../fish/guestfish-actions.pod:2920
9831 #: ../fish/guestfish-actions.pod:2922
9839 #: ../fish/guestfish-actions.pod:2924 ../src/guestfs-actions.pod:4357
9840 msgid "This command returns the UUID of the LVM LV C<device>."
9844 #: ../fish/guestfish-actions.pod:2926
9849 #: ../fish/guestfish-actions.pod:2928
9852 " lxattrlist path 'names ...'\n"
9857 #: ../fish/guestfish-actions.pod:2930 ../src/guestfs-actions.pod:4371
9859 "This call allows you to get the extended attributes of multiple files, where "
9860 "all files are in the directory C<path>. C<names> is the list of files from "
9865 #: ../fish/guestfish-actions.pod:2934 ../src/guestfs-actions.pod:4375
9867 "On return you get a flat list of xattr structs which must be interpreted "
9868 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9869 "C<attrval> in this struct is zero-length to indicate there was an error "
9870 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9871 "number (the number of following attributes for this file, which could be "
9872 "C<\"0\">). Then after the first xattr struct are the zero or more "
9873 "attributes for the first named file. This repeats for the second and "
9878 #: ../fish/guestfish-actions.pod:2944
9880 "This call is intended for programs that want to efficiently list a directory "
9881 "contents without making many round-trips. See also L</lstatlist> for a "
9882 "similarly efficient call for getting standard stats. Very long directory "
9883 "listings might cause the protocol message size to be exceeded, causing this "
9884 "call to fail. The caller must split up such requests into smaller groups of "
9889 #: ../fish/guestfish-actions.pod:2952
9894 #: ../fish/guestfish-actions.pod:2954
9902 #: ../fish/guestfish-actions.pod:2956 ../src/guestfs-actions.pod:4405
9903 msgid "Create a directory named C<path>."
9907 #: ../fish/guestfish-actions.pod:2958
9912 #: ../fish/guestfish-actions.pod:2960
9915 " mkdir-mode path mode\n"
9920 #: ../fish/guestfish-actions.pod:2962 ../src/guestfs-actions.pod:4418
9922 "This command creates a directory, setting the initial permissions of the "
9923 "directory to C<mode>."
9927 #: ../fish/guestfish-actions.pod:2965 ../src/guestfs-actions.pod:4421
9929 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9930 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9935 #: ../fish/guestfish-actions.pod:2969
9936 msgid "See also L</mkdir>, L</umask>"
9940 #: ../fish/guestfish-actions.pod:2971
9945 #: ../fish/guestfish-actions.pod:2973
9953 #: ../fish/guestfish-actions.pod:2975 ../src/guestfs-actions.pod:4437
9955 "Create a directory named C<path>, creating any parent directories as "
9956 "necessary. This is like the C<mkdir -p> shell command."
9960 #: ../fish/guestfish-actions.pod:2978
9965 #: ../fish/guestfish-actions.pod:2980
9968 " mkdtemp template\n"
9973 #: ../fish/guestfish-actions.pod:2982 ../src/guestfs-actions.pod:4450
9975 "This command creates a temporary directory. The C<template> parameter "
9976 "should be a full pathname for the temporary directory name with the final "
9977 "six characters being \"XXXXXX\"."
9981 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
9983 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
9984 "being suitable for Windows filesystems."
9988 #: ../fish/guestfish-actions.pod:2990 ../src/guestfs-actions.pod:4458
9989 msgid "The name of the temporary directory that was created is returned."
9993 #: ../fish/guestfish-actions.pod:2993 ../src/guestfs-actions.pod:4461
9994 msgid "The temporary directory is created with mode 0700 and is owned by root."
9998 #: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4464
10000 "The caller is responsible for deleting the temporary directory and its "
10001 "contents after use."
10005 #: ../fish/guestfish-actions.pod:2999 ../src/guestfs-actions.pod:4467
10006 msgid "See also: L<mkdtemp(3)>"
10010 #: ../fish/guestfish-actions.pod:3001
10015 #: ../fish/guestfish-actions.pod:3003
10018 " mke2fs-J fstype blocksize device journal\n"
10023 #: ../fish/guestfish-actions.pod:3005 ../src/guestfs-actions.pod:4483
10025 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10026 "C<journal>. It is equivalent to the command:"
10030 #: ../fish/guestfish-actions.pod:3009 ../src/guestfs-actions.pod:4487
10033 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10038 #: ../fish/guestfish-actions.pod:3011
10039 msgid "See also L</mke2journal>."
10043 #: ../fish/guestfish-actions.pod:3013
10048 #: ../fish/guestfish-actions.pod:3015
10051 " mke2fs-JL fstype blocksize device label\n"
10056 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4504
10058 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10059 "the journal labeled C<label>."
10063 #: ../fish/guestfish-actions.pod:3020
10064 msgid "See also L</mke2journal-L>."
10068 #: ../fish/guestfish-actions.pod:3022
10073 #: ../fish/guestfish-actions.pod:3024
10076 " mke2fs-JU fstype blocksize device uuid\n"
10081 #: ../fish/guestfish-actions.pod:3026 ../src/guestfs-actions.pod:4522
10083 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10084 "the journal with UUID C<uuid>."
10088 #: ../fish/guestfish-actions.pod:3029
10089 msgid "See also L</mke2journal-U>."
10093 #: ../fish/guestfish-actions.pod:3031
10094 msgid "mke2journal"
10098 #: ../fish/guestfish-actions.pod:3033
10101 " mke2journal blocksize device\n"
10106 #: ../fish/guestfish-actions.pod:3035 ../src/guestfs-actions.pod:4538
10108 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10113 #: ../fish/guestfish-actions.pod:3038 ../src/guestfs-actions.pod:4541
10116 " mke2fs -O journal_dev -b blocksize device\n"
10121 #: ../fish/guestfish-actions.pod:3040
10122 msgid "mke2journal-L"
10126 #: ../fish/guestfish-actions.pod:3042
10129 " mke2journal-L blocksize label device\n"
10134 #: ../fish/guestfish-actions.pod:3044 ../src/guestfs-actions.pod:4555
10135 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10139 #: ../fish/guestfish-actions.pod:3046
10140 msgid "mke2journal-U"
10144 #: ../fish/guestfish-actions.pod:3048
10147 " mke2journal-U blocksize uuid device\n"
10152 #: ../fish/guestfish-actions.pod:3050 ../src/guestfs-actions.pod:4569
10153 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10157 #: ../fish/guestfish-actions.pod:3052
10162 #: ../fish/guestfish-actions.pod:3054
10165 " mkfifo mode path\n"
10170 #: ../fish/guestfish-actions.pod:3056
10172 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10173 "is just a convenient wrapper around L</mknod>."
10177 #: ../fish/guestfish-actions.pod:3062
10182 #: ../fish/guestfish-actions.pod:3064
10185 " mkfs fstype device\n"
10190 #: ../fish/guestfish-actions.pod:3066 ../src/guestfs-actions.pod:4599
10192 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10193 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10197 #: ../fish/guestfish-actions.pod:3070
10202 #: ../fish/guestfish-actions.pod:3072
10205 " mkfs-b fstype blocksize device\n"
10210 #: ../fish/guestfish-actions.pod:3074
10212 "This call is similar to L</mkfs>, but it allows you to control the block "
10213 "size of the resulting filesystem. Supported block sizes depend on the "
10214 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10218 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106 ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4665
10220 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10225 #: ../fish/guestfish-actions.pod:3082
10227 "This function is deprecated. In new code, use the L</mkfs_opts> call "
10232 #: ../fish/guestfish-actions.pod:3089
10237 #: ../fish/guestfish-actions.pod:3091
10240 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10241 "[sectorsize:..]\n"
10246 #: ../fish/guestfish-actions.pod:3093 ../src/guestfs-actions.pod:4652
10248 "This function creates a filesystem on C<device>. The filesystem type is "
10249 "C<fstype>, for example C<ext3>."
10253 #: ../fish/guestfish-actions.pod:3100 ../src/guestfs-actions.pod:4659
10254 msgid "C<blocksize>"
10258 #: ../fish/guestfish-actions.pod:3102 ../src/guestfs-actions.pod:4661
10260 "The filesystem block size. Supported block sizes depend on the filesystem "
10261 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10266 #: ../fish/guestfish-actions.pod:3109 ../src/guestfs-actions.pod:4668
10267 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10271 #: ../fish/guestfish-actions.pod:3111 ../src/guestfs-actions.pod:4670
10272 msgid "C<features>"
10276 #: ../fish/guestfish-actions.pod:3113 ../src/guestfs-actions.pod:4672
10277 msgid "This passes the I<-O> parameter to the external mkfs program."
10281 #: ../fish/guestfish-actions.pod:3115 ../src/guestfs-actions.pod:4674
10283 "For certain filesystem types, this allows extra filesystem features to be "
10284 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10288 #: ../fish/guestfish-actions.pod:3119 ../src/guestfs-actions.pod:4678
10290 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10295 #: ../fish/guestfish-actions.pod:3122 ../src/guestfs-actions.pod:4681
10300 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10302 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10303 "sets the inode size (only for ext2/3/4 filesystems at present)."
10307 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10308 msgid "C<sectorsize>"
10312 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10314 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10315 "sets sector size for ufs filesystem."
10319 #: ../fish/guestfish-actions.pod:3136
10320 msgid "mkmountpoint"
10324 #: ../fish/guestfish-actions.pod:3138
10327 " mkmountpoint exemptpath\n"
10332 #: ../fish/guestfish-actions.pod:3140
10334 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10335 "to create extra mountpoints before mounting the first filesystem."
10339 #: ../fish/guestfish-actions.pod:3144 ../src/guestfs-actions.pod:4731
10341 "These calls are I<only> necessary in some very limited circumstances, mainly "
10342 "the case where you want to mount a mix of unrelated and/or read-only "
10343 "filesystems together."
10347 #: ../fish/guestfish-actions.pod:3148 ../src/guestfs-actions.pod:4735
10349 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10350 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10351 "inside that. You can unpack this as follows in guestfish:"
10355 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10358 " add-ro Fedora-11-i686-Live.iso\n"
10360 " mkmountpoint /cd\n"
10361 " mkmountpoint /sqsh\n"
10362 " mkmountpoint /ext3fs\n"
10363 " mount /dev/sda /cd\n"
10364 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10365 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10370 #: ../fish/guestfish-actions.pod:3162 ../src/guestfs-actions.pod:4749
10371 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10375 #: ../fish/guestfish-actions.pod:3164
10377 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10378 "unexpected errors if you try to mix these calls. It is safest to manually "
10379 "unmount filesystems and remove mountpoints after use."
10383 #: ../fish/guestfish-actions.pod:3168
10385 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10386 "for this to work for manual mountpoints, you must ensure that the innermost "
10387 "mountpoints have the longest pathnames, as in the example code above."
10391 #: ../fish/guestfish-actions.pod:3173 ../src/guestfs-actions.pod:4760
10392 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10396 #: ../fish/guestfish-actions.pod:3175
10398 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10399 "L</umount-all> to be called when the handle is closed which can also trigger "
10404 #: ../fish/guestfish-actions.pod:3179
10409 #: ../fish/guestfish-actions.pod:3181
10412 " mknod mode devmajor devminor path\n"
10417 #: ../fish/guestfish-actions.pod:3183 ../src/guestfs-actions.pod:4779
10419 "This call creates block or character special devices, or named pipes "
10424 #: ../fish/guestfish-actions.pod:3186 ../src/guestfs-actions.pod:4782
10426 "The C<mode> parameter should be the mode, using the standard constants. "
10427 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10428 "used when creating block and character special devices."
10432 #: ../fish/guestfish-actions.pod:3191
10434 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10435 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10436 "regular file). These constants are available in the standard Linux header "
10437 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10438 "wrappers around this command which bitwise OR in the appropriate constant "
10443 #: ../fish/guestfish-actions.pod:3201
10448 #: ../fish/guestfish-actions.pod:3203
10451 " mknod-b mode devmajor devminor path\n"
10456 #: ../fish/guestfish-actions.pod:3205
10458 "This call creates a block device node called C<path> with mode C<mode> and "
10459 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10460 "wrapper around L</mknod>."
10464 #: ../fish/guestfish-actions.pod:3211
10469 #: ../fish/guestfish-actions.pod:3213
10472 " mknod-c mode devmajor devminor path\n"
10477 #: ../fish/guestfish-actions.pod:3215
10479 "This call creates a char device node called C<path> with mode C<mode> and "
10480 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10481 "wrapper around L</mknod>."
10485 #: ../fish/guestfish-actions.pod:3221
10490 #: ../fish/guestfish-actions.pod:3223
10498 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4845
10499 msgid "Create a swap partition on C<device>."
10503 #: ../fish/guestfish-actions.pod:3227
10508 #: ../fish/guestfish-actions.pod:3229
10511 " mkswap-L label device\n"
10516 #: ../fish/guestfish-actions.pod:3231 ../src/guestfs-actions.pod:4858
10517 msgid "Create a swap partition on C<device> with label C<label>."
10521 #: ../fish/guestfish-actions.pod:3233 ../src/guestfs-actions.pod:4860
10523 "Note that you cannot attach a swap label to a block device "
10524 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10525 "the kernel or swap tools."
10529 #: ../fish/guestfish-actions.pod:3237
10534 #: ../fish/guestfish-actions.pod:3239
10537 " mkswap-U uuid device\n"
10542 #: ../fish/guestfish-actions.pod:3241 ../src/guestfs-actions.pod:4875
10543 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10547 #: ../fish/guestfish-actions.pod:3243
10548 msgid "mkswap-file"
10552 #: ../fish/guestfish-actions.pod:3245
10555 " mkswap-file path\n"
10560 #: ../fish/guestfish-actions.pod:3247 ../src/guestfs-actions.pod:4887
10561 msgid "Create a swap file."
10565 #: ../fish/guestfish-actions.pod:3249
10567 "This command just writes a swap file signature to an existing file. To "
10568 "create the file itself, use something like L</fallocate>."
10572 #: ../fish/guestfish-actions.pod:3252
10577 #: ../fish/guestfish-actions.pod:3254
10580 " modprobe modulename\n"
10585 #: ../fish/guestfish-actions.pod:3256 ../src/guestfs-actions.pod:4902
10586 msgid "This loads a kernel module in the appliance."
10590 #: ../fish/guestfish-actions.pod:3258 ../src/guestfs-actions.pod:4904
10592 "The kernel module must have been whitelisted when libguestfs was built (see "
10593 "C<appliance/kmod.whitelist.in> in the source)."
10597 #: ../fish/guestfish-actions.pod:3261
10602 #: ../fish/guestfish-actions.pod:3263
10605 " mount device mountpoint\n"
10610 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:4918
10612 "Mount a guest disk at a position in the filesystem. Block devices are named "
10613 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10614 "those block devices contain partitions, they will have the usual names "
10615 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10619 #: ../fish/guestfish-actions.pod:3271 ../src/guestfs-actions.pod:4924
10621 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10622 "mounted on C</> before others can be mounted. Other filesystems can only be "
10623 "mounted on directories which already exist."
10627 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4929
10629 "The mounted filesystem is writable, if we have sufficient permissions on the "
10630 "underlying device."
10634 #: ../fish/guestfish-actions.pod:3279
10636 "B<Important note:> When you use this call, the filesystem options C<sync> "
10637 "and C<noatime> are set implicitly. This was originally done because we "
10638 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10639 "very large negative performance impact and negligible effect on "
10640 "reliability. Therefore we recommend that you avoid using L</mount> in any "
10641 "code that needs performance, and instead use L</mount-options> (use an empty "
10642 "string for the first parameter if you don't want any options)."
10646 #: ../fish/guestfish-actions.pod:3289
10648 "This function is deprecated. In new code, use the L</mount_options> call "
10653 #: ../fish/guestfish-actions.pod:3296
10658 #: ../fish/guestfish-actions.pod:3298
10661 " mount-9p mounttag mountpoint [options:..]\n"
10666 #: ../fish/guestfish-actions.pod:3300 ../src/guestfs-actions.pod:4968
10668 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10673 #: ../fish/guestfish-actions.pod:3303 ../src/guestfs-actions.pod:4971
10675 "If required, C<trans=virtio> will be automatically added to the options. "
10676 "Any other options required can be passed in the optional C<options> "
10681 #: ../fish/guestfish-actions.pod:3309
10686 #: ../fish/guestfish-actions.pod:3311
10689 " mount-loop file mountpoint\n"
10694 #: ../fish/guestfish-actions.pod:3313 ../src/guestfs-actions.pod:5010
10696 "This command lets you mount C<file> (a filesystem image in a file) on a "
10697 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10702 #: ../fish/guestfish-actions.pod:3317
10703 msgid "mount-options"
10707 #: ../fish/guestfish-actions.pod:3319
10710 " mount-options options device mountpoint\n"
10715 #: ../fish/guestfish-actions.pod:3321
10717 "This is the same as the L</mount> command, but it allows you to set the "
10718 "mount options as for the L<mount(8)> I<-o> flag."
10722 #: ../fish/guestfish-actions.pod:3325 ../src/guestfs-actions.pod:5030
10724 "If the C<options> parameter is an empty string, then no options are passed "
10725 "(all options default to whatever the filesystem uses)."
10729 #: ../fish/guestfish-actions.pod:3329
10734 #: ../fish/guestfish-actions.pod:3331
10737 " mount-ro device mountpoint\n"
10742 #: ../fish/guestfish-actions.pod:3333
10744 "This is the same as the L</mount> command, but it mounts the filesystem with "
10745 "the read-only (I<-o ro>) flag."
10749 #: ../fish/guestfish-actions.pod:3336
10754 #: ../fish/guestfish-actions.pod:3338
10757 " mount-vfs options vfstype device mountpoint\n"
10762 #: ../fish/guestfish-actions.pod:3340
10764 "This is the same as the L</mount> command, but it allows you to set both the "
10765 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
10769 #: ../fish/guestfish-actions.pod:3344
10770 msgid "mountpoints"
10774 #: ../fish/guestfish-actions.pod:3346
10782 #: ../fish/guestfish-actions.pod:3348
10784 "This call is similar to L</mounts>. That call returns a list of devices. "
10785 "This one returns a hash table (map) of device name to directory where the "
10786 "device is mounted."
10790 #: ../fish/guestfish-actions.pod:3352
10795 #: ../fish/guestfish-actions.pod:3354
10803 #: ../fish/guestfish-actions.pod:3356 ../src/guestfs-actions.pod:5091
10805 "This returns the list of currently mounted filesystems. It returns the list "
10806 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10810 #: ../fish/guestfish-actions.pod:3359 ../src/guestfs-actions.pod:5094
10811 msgid "Some internal mounts are not shown."
10815 #: ../fish/guestfish-actions.pod:3361
10816 msgid "See also: L</mountpoints>"
10820 #: ../fish/guestfish-actions.pod:3363
10825 #: ../fish/guestfish-actions.pod:3365
10833 #: ../fish/guestfish-actions.pod:3367 ../src/guestfs-actions.pod:5111
10835 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10836 "destination filename or destination directory."
10840 #: ../fish/guestfish-actions.pod:3370
10841 msgid "ntfs-3g-probe"
10845 #: ../fish/guestfish-actions.pod:3372
10848 " ntfs-3g-probe true|false device\n"
10853 #: ../fish/guestfish-actions.pod:3374 ../src/guestfs-actions.pod:5125
10855 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10856 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10857 "read-write, and some cannot be mounted at all)."
10861 #: ../fish/guestfish-actions.pod:3378 ../src/guestfs-actions.pod:5129
10863 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10864 "can be mounted read-write. Set it to false if you want to test if the "
10865 "volume can be mounted read-only."
10869 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5133
10871 "The return value is an integer which C<0> if the operation would succeed, or "
10872 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10876 #: ../fish/guestfish-actions.pod:3386
10881 #: ../fish/guestfish-actions.pod:3388
10884 " ntfsresize device\n"
10889 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414 ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5186
10891 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10892 "size of the underlying device."
10896 #: ../fish/guestfish-actions.pod:3393 ../src/guestfs-actions.pod:5150
10898 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
10899 "consistency check (for safety). You have to boot into Windows to perform "
10900 "this check and clear this condition. Furthermore, ntfsresize refuses to "
10901 "resize filesystems which have been marked in this way. So in effect it is "
10902 "not possible to call ntfsresize multiple times on a single filesystem "
10903 "without booting into Windows between each resize."
10907 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5212
10908 msgid "See also L<ntfsresize(8)>."
10912 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
10914 "This function is deprecated. In new code, use the L</ntfsresize_opts> call "
10919 #: ../fish/guestfish-actions.pod:3410
10920 msgid "ntfsresize-opts"
10924 #: ../fish/guestfish-actions.pod:3412
10927 " ntfsresize-opts device [size:..] [force:..]\n"
10932 #: ../fish/guestfish-actions.pod:3423 ../src/guestfs-actions.pod:5195
10934 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
10935 "resized to fit the container (eg. partition)."
10939 #: ../fish/guestfish-actions.pod:3426 ../src/guestfs-actions.pod:5198
10944 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
10946 "If this option is true, then force the resize of the filesystem even if the "
10947 "filesystem is marked as requiring a consistency check."
10951 #: ../fish/guestfish-actions.pod:3431
10953 "After the resize operation, the filesystem is always marked as requiring a "
10954 "consistency check (for safety). You have to boot into Windows to perform "
10955 "this check and clear this condition. If you I<don't> set the C<force> "
10956 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
10957 "a single filesystem without booting into Windows between each resize."
10961 #: ../fish/guestfish-actions.pod:3444
10962 msgid "ntfsresize-size"
10966 #: ../fish/guestfish-actions.pod:3446
10969 " ntfsresize-size device size\n"
10974 #: ../fish/guestfish-actions.pod:3448
10976 "This command is the same as L</ntfsresize> except that it allows you to "
10977 "specify the new size (in bytes) explicitly."
10981 #: ../fish/guestfish-actions.pod:3458
10986 #: ../fish/guestfish-actions.pod:3460
10989 " part-add device prlogex startsect endsect\n"
10994 #: ../fish/guestfish-actions.pod:3462
10996 "This command adds a partition to C<device>. If there is no partition table "
10997 "on the device, call L</part-init> first."
11001 #: ../fish/guestfish-actions.pod:3465 ../src/guestfs-actions.pod:5273
11003 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11004 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11005 "C<logical>) and C<e> (or C<extended>) partition types."
11009 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11011 "C<startsect> and C<endsect> are the start and end of the partition in "
11012 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11013 "from the end of the disk (C<-1> is the last sector)."
11017 #: ../fish/guestfish-actions.pod:3474
11019 "Creating a partition which covers the whole disk is not so easy. Use "
11020 "L</part-disk> to do that."
11024 #: ../fish/guestfish-actions.pod:3477
11029 #: ../fish/guestfish-actions.pod:3479
11032 " part-del device partnum\n"
11037 #: ../fish/guestfish-actions.pod:3481 ../src/guestfs-actions.pod:5296
11038 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11042 #: ../fish/guestfish-actions.pod:3483 ../src/guestfs-actions.pod:5298
11044 "Note that in the case of MBR partitioning, deleting an extended partition "
11045 "also deletes any logical partitions it contains."
11049 #: ../fish/guestfish-actions.pod:3487
11054 #: ../fish/guestfish-actions.pod:3489
11057 " part-disk device parttype\n"
11062 #: ../fish/guestfish-actions.pod:3491
11064 "This command is simply a combination of L</part-init> followed by "
11065 "L</part-add> to create a single primary partition covering the whole disk."
11069 #: ../fish/guestfish-actions.pod:3495
11071 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11072 "possible values are described in L</part-init>."
11076 #: ../fish/guestfish-actions.pod:3501
11077 msgid "part-get-bootable"
11081 #: ../fish/guestfish-actions.pod:3503
11084 " part-get-bootable device partnum\n"
11089 #: ../fish/guestfish-actions.pod:3505 ../src/guestfs-actions.pod:5334
11091 "This command returns true if the partition C<partnum> on C<device> has the "
11092 "bootable flag set."
11096 #: ../fish/guestfish-actions.pod:3508
11097 msgid "See also L</part-set-bootable>."
11101 #: ../fish/guestfish-actions.pod:3510
11102 msgid "part-get-mbr-id"
11106 #: ../fish/guestfish-actions.pod:3512
11109 " part-get-mbr-id device partnum\n"
11114 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5350
11116 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11117 "partition C<partnum>."
11121 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3661
11123 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11124 "undefined results for other partition table types (see "
11125 "L</part-get-parttype>)."
11129 #: ../fish/guestfish-actions.pod:3521
11130 msgid "part-get-parttype"
11134 #: ../fish/guestfish-actions.pod:3523
11137 " part-get-parttype device\n"
11142 #: ../fish/guestfish-actions.pod:3525 ../src/guestfs-actions.pod:5367
11144 "This command examines the partition table on C<device> and returns the "
11145 "partition table type (format) being used."
11149 #: ../fish/guestfish-actions.pod:3528
11151 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11152 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11153 "possible, although unusual. See L</part-init> for a full list."
11157 #: ../fish/guestfish-actions.pod:3533
11162 #: ../fish/guestfish-actions.pod:3535
11165 " part-init device parttype\n"
11170 #: ../fish/guestfish-actions.pod:3537 ../src/guestfs-actions.pod:5387
11172 "This creates an empty partition table on C<device> of one of the partition "
11173 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11174 "(for large disks)."
11178 #: ../fish/guestfish-actions.pod:3541
11180 "Initially there are no partitions. Following this, you should call "
11181 "L</part-add> for each partition required."
11185 #: ../fish/guestfish-actions.pod:3544 ../src/guestfs-actions.pod:5394
11186 msgid "Possible values for C<parttype> are:"
11190 #: ../fish/guestfish-actions.pod:3548 ../src/guestfs-actions.pod:5398
11195 #: ../fish/guestfish-actions.pod:3550 ../src/guestfs-actions.pod:5400
11200 #: ../fish/guestfish-actions.pod:3552 ../src/guestfs-actions.pod:5402
11201 msgid "Intel EFI / GPT partition table."
11205 #: ../fish/guestfish-actions.pod:3554 ../src/guestfs-actions.pod:5404
11207 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11208 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11209 "the C<mbr> format."
11213 #: ../fish/guestfish-actions.pod:3558 ../src/guestfs-actions.pod:5408
11218 #: ../fish/guestfish-actions.pod:3560 ../src/guestfs-actions.pod:5410
11223 #: ../fish/guestfish-actions.pod:3562 ../src/guestfs-actions.pod:5412
11225 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11226 "Windows. This partition type will B<only> work for device sizes up to 2 "
11227 "TB. For large disks we recommend using C<gpt>."
11231 #: ../fish/guestfish-actions.pod:3569 ../src/guestfs-actions.pod:5419
11232 msgid "Other partition table types that may work but are not supported include:"
11236 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11241 #: ../fish/guestfish-actions.pod:3576 ../src/guestfs-actions.pod:5426
11242 msgid "AIX disk labels."
11246 #: ../fish/guestfish-actions.pod:3578 ../src/guestfs-actions.pod:5428
11251 #: ../fish/guestfish-actions.pod:3580 ../src/guestfs-actions.pod:5430
11256 #: ../fish/guestfish-actions.pod:3582 ../src/guestfs-actions.pod:5432
11257 msgid "Amiga \"Rigid Disk Block\" format."
11261 #: ../fish/guestfish-actions.pod:3584 ../src/guestfs-actions.pod:5434
11266 #: ../fish/guestfish-actions.pod:3586 ../src/guestfs-actions.pod:5436
11267 msgid "BSD disk labels."
11271 #: ../fish/guestfish-actions.pod:3588 ../src/guestfs-actions.pod:5438
11276 #: ../fish/guestfish-actions.pod:3590 ../src/guestfs-actions.pod:5440
11277 msgid "DASD, used on IBM mainframes."
11281 #: ../fish/guestfish-actions.pod:3592 ../src/guestfs-actions.pod:5442
11286 #: ../fish/guestfish-actions.pod:3594 ../src/guestfs-actions.pod:5444
11287 msgid "MIPS/SGI volumes."
11291 #: ../fish/guestfish-actions.pod:3596 ../src/guestfs-actions.pod:5446
11296 #: ../fish/guestfish-actions.pod:3598 ../src/guestfs-actions.pod:5448
11297 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11301 #: ../fish/guestfish-actions.pod:3600 ../src/guestfs-actions.pod:5450
11306 #: ../fish/guestfish-actions.pod:3602 ../src/guestfs-actions.pod:5452
11307 msgid "NEC PC-98 format, common in Japan apparently."
11311 #: ../fish/guestfish-actions.pod:3604 ../src/guestfs-actions.pod:5454
11316 #: ../fish/guestfish-actions.pod:3606 ../src/guestfs-actions.pod:5456
11317 msgid "Sun disk labels."
11321 #: ../fish/guestfish-actions.pod:3610
11326 #: ../fish/guestfish-actions.pod:3612
11329 " part-list device\n"
11334 #: ../fish/guestfish-actions.pod:3614 ../src/guestfs-actions.pod:5470
11336 "This command parses the partition table on C<device> and returns the list of "
11337 "partitions found."
11341 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5473
11342 msgid "The fields in the returned structure are:"
11346 #: ../fish/guestfish-actions.pod:3621 ../src/guestfs-actions.pod:5477
11347 msgid "B<part_num>"
11351 #: ../fish/guestfish-actions.pod:3623 ../src/guestfs-actions.pod:5479
11352 msgid "Partition number, counting from 1."
11356 #: ../fish/guestfish-actions.pod:3625 ../src/guestfs-actions.pod:5481
11357 msgid "B<part_start>"
11361 #: ../fish/guestfish-actions.pod:3627
11363 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11364 "the device's sector size, see L</blockdev-getss>."
11368 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11369 msgid "B<part_end>"
11373 #: ../fish/guestfish-actions.pod:3632 ../src/guestfs-actions.pod:5488
11374 msgid "End of the partition in bytes."
11378 #: ../fish/guestfish-actions.pod:3634 ../src/guestfs-actions.pod:5490
11379 msgid "B<part_size>"
11383 #: ../fish/guestfish-actions.pod:3636 ../src/guestfs-actions.pod:5492
11384 msgid "Size of the partition in bytes."
11388 #: ../fish/guestfish-actions.pod:3640
11389 msgid "part-set-bootable"
11393 #: ../fish/guestfish-actions.pod:3642
11396 " part-set-bootable device partnum true|false\n"
11401 #: ../fish/guestfish-actions.pod:3644 ../src/guestfs-actions.pod:5510
11403 "This sets the bootable flag on partition numbered C<partnum> on device "
11404 "C<device>. Note that partitions are numbered from 1."
11408 #: ../fish/guestfish-actions.pod:3647 ../src/guestfs-actions.pod:5513
11410 "The bootable flag is used by some operating systems (notably Windows) to "
11411 "determine which partition to boot from. It is by no means universally "
11416 #: ../fish/guestfish-actions.pod:3651
11417 msgid "part-set-mbr-id"
11421 #: ../fish/guestfish-actions.pod:3653
11424 " part-set-mbr-id device partnum idbyte\n"
11429 #: ../fish/guestfish-actions.pod:3655 ../src/guestfs-actions.pod:5529
11431 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11432 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11433 "documentation are in fact hexadecimal numbers, but usually documented "
11434 "without any leading \"0x\" which might be confusing."
11438 #: ../fish/guestfish-actions.pod:3665
11439 msgid "part-set-name"
11443 #: ../fish/guestfish-actions.pod:3667
11446 " part-set-name device partnum name\n"
11451 #: ../fish/guestfish-actions.pod:3669 ../src/guestfs-actions.pod:5551
11453 "This sets the partition name on partition numbered C<partnum> on device "
11454 "C<device>. Note that partitions are numbered from 1."
11458 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5554
11460 "The partition name can only be set on certain types of partition table. "
11461 "This works on C<gpt> but not on C<mbr> partitions."
11465 #: ../fish/guestfish-actions.pod:3675
11466 msgid "part-to-dev"
11470 #: ../fish/guestfish-actions.pod:3677
11473 " part-to-dev partition\n"
11478 #: ../fish/guestfish-actions.pod:3679 ../src/guestfs-actions.pod:5567
11480 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11481 "partition number, returning the device name (eg. \"/dev/sdb\")."
11485 #: ../fish/guestfish-actions.pod:3683
11487 "The named partition must exist, for example as a string returned from "
11488 "L</list-partitions>."
11492 #: ../fish/guestfish-actions.pod:3686
11493 msgid "ping-daemon"
11497 #: ../fish/guestfish-actions.pod:3688
11505 #: ../fish/guestfish-actions.pod:3690 ../src/guestfs-actions.pod:5584
11507 "This is a test probe into the guestfs daemon running inside the qemu "
11508 "subprocess. Calling this function checks that the daemon responds to the "
11509 "ping message, without affecting the daemon or attached block device(s) in "
11514 #: ../fish/guestfish-actions.pod:3695
11519 #: ../fish/guestfish-actions.pod:3697
11522 " pread path count offset\n"
11527 #: ../fish/guestfish-actions.pod:3699 ../src/guestfs-actions.pod:5602
11529 "This command lets you read part of a file. It reads C<count> bytes of the "
11530 "file, starting at C<offset>, from file C<path>."
11534 #: ../fish/guestfish-actions.pod:3702 ../fish/guestfish-actions.pod:3717 ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5631
11536 "This may read fewer bytes than requested. For further details see the "
11537 "L<pread(2)> system call."
11541 #: ../fish/guestfish-actions.pod:3705
11542 msgid "See also L</pwrite>, L</pread-device>."
11546 #: ../fish/guestfish-actions.pod:3710
11547 msgid "pread-device"
11551 #: ../fish/guestfish-actions.pod:3712
11554 " pread-device device count offset\n"
11559 #: ../fish/guestfish-actions.pod:3714 ../src/guestfs-actions.pod:5628
11561 "This command lets you read part of a file. It reads C<count> bytes of "
11562 "C<device>, starting at C<offset>."
11566 #: ../fish/guestfish-actions.pod:3720
11567 msgid "See also L</pread>."
11571 #: ../fish/guestfish-actions.pod:3725
11576 #: ../fish/guestfish-actions.pod:3727
11579 " pvcreate device\n"
11584 #: ../fish/guestfish-actions.pod:3729 ../src/guestfs-actions.pod:5651
11586 "This creates an LVM physical volume on the named C<device>, where C<device> "
11587 "should usually be a partition name such as C</dev/sda1>."
11591 #: ../fish/guestfish-actions.pod:3733
11596 #: ../fish/guestfish-actions.pod:3735
11599 " pvremove device\n"
11604 #: ../fish/guestfish-actions.pod:3737 ../src/guestfs-actions.pod:5665
11606 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11611 #: ../fish/guestfish-actions.pod:3740 ../src/guestfs-actions.pod:5668
11613 "The implementation uses the C<pvremove> command which refuses to wipe "
11614 "physical volumes that contain any volume groups, so you have to remove those "
11619 #: ../fish/guestfish-actions.pod:3744
11624 #: ../fish/guestfish-actions.pod:3746
11627 " pvresize device\n"
11632 #: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5682
11634 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11635 "the new size of the underlying device."
11639 #: ../fish/guestfish-actions.pod:3751
11640 msgid "pvresize-size"
11644 #: ../fish/guestfish-actions.pod:3753
11647 " pvresize-size device size\n"
11652 #: ../fish/guestfish-actions.pod:3755
11654 "This command is the same as L</pvresize> except that it allows you to "
11655 "specify the new size (in bytes) explicitly."
11659 #: ../fish/guestfish-actions.pod:3758
11664 #: ../fish/guestfish-actions.pod:3760
11672 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5708
11674 "List all the physical volumes detected. This is the equivalent of the "
11675 "L<pvs(8)> command."
11679 #: ../fish/guestfish-actions.pod:3765 ../src/guestfs-actions.pod:5711
11681 "This returns a list of just the device names that contain PVs "
11682 "(eg. C</dev/sda2>)."
11686 #: ../fish/guestfish-actions.pod:3768
11687 msgid "See also L</pvs-full>."
11691 #: ../fish/guestfish-actions.pod:3770
11696 #: ../fish/guestfish-actions.pod:3772
11704 #: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5727
11706 "List all the physical volumes detected. This is the equivalent of the "
11707 "L<pvs(8)> command. The \"full\" version includes all fields."
11711 #: ../fish/guestfish-actions.pod:3777
11716 #: ../fish/guestfish-actions.pod:3779
11724 #: ../fish/guestfish-actions.pod:3781 ../src/guestfs-actions.pod:5742
11725 msgid "This command returns the UUID of the LVM PV C<device>."
11729 #: ../fish/guestfish-actions.pod:3783
11734 #: ../fish/guestfish-actions.pod:3785
11737 " pwrite path content offset\n"
11742 #: ../fish/guestfish-actions.pod:3787 ../src/guestfs-actions.pod:5758
11744 "This command writes to part of a file. It writes the data buffer C<content> "
11745 "to the file C<path> starting at offset C<offset>."
11749 #: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5761
11751 "This command implements the L<pwrite(2)> system call, and like that system "
11752 "call it may not write the full data requested. The return value is the "
11753 "number of bytes that were actually written to the file. This could even be "
11754 "0, although short writes are unlikely for regular files in ordinary "
11759 #: ../fish/guestfish-actions.pod:3796
11760 msgid "See also L</pread>, L</pwrite-device>."
11764 #: ../fish/guestfish-actions.pod:3801
11765 msgid "pwrite-device"
11769 #: ../fish/guestfish-actions.pod:3803
11772 " pwrite-device device content offset\n"
11777 #: ../fish/guestfish-actions.pod:3805 ../src/guestfs-actions.pod:5785
11779 "This command writes to part of a device. It writes the data buffer "
11780 "C<content> to C<device> starting at offset C<offset>."
11784 #: ../fish/guestfish-actions.pod:3808 ../src/guestfs-actions.pod:5788
11786 "This command implements the L<pwrite(2)> system call, and like that system "
11787 "call it may not write the full data requested (although short writes to disk "
11788 "devices and partitions are probably impossible with standard Linux kernels)."
11792 #: ../fish/guestfish-actions.pod:3813
11793 msgid "See also L</pwrite>."
11797 #: ../fish/guestfish-actions.pod:3818
11802 #: ../fish/guestfish-actions.pod:3820
11805 " read-file path\n"
11810 #: ../fish/guestfish-actions.pod:3822 ../src/guestfs-actions.pod:5809
11811 msgid "This calls returns the contents of the file C<path> as a buffer."
11815 #: ../fish/guestfish-actions.pod:3825
11817 "Unlike L</cat>, this function can correctly handle files that contain "
11818 "embedded ASCII NUL characters. However unlike L</download>, this function "
11819 "is limited in the total size of file that can be handled."
11823 #: ../fish/guestfish-actions.pod:3833
11828 #: ../fish/guestfish-actions.pod:3835
11831 " read-lines path\n"
11836 #: ../fish/guestfish-actions.pod:3839 ../src/guestfs-actions.pod:5834
11838 "The file contents are returned as a list of lines. Trailing C<LF> and "
11839 "C<CRLF> character sequences are I<not> returned."
11843 #: ../fish/guestfish-actions.pod:3842
11845 "Note that this function cannot correctly handle binary files (specifically, "
11846 "files containing C<\\0> character which is treated as end of line). For "
11847 "those you need to use the L</read-file> function which has a more complex "
11852 #: ../fish/guestfish-actions.pod:3847
11857 #: ../fish/guestfish-actions.pod:3849
11865 #: ../fish/guestfish-actions.pod:3851 ../src/guestfs-actions.pod:5854
11866 msgid "This returns the list of directory entries in directory C<dir>."
11870 #: ../fish/guestfish-actions.pod:3853 ../src/guestfs-actions.pod:5856
11872 "All entries in the directory are returned, including C<.> and C<..>. The "
11873 "entries are I<not> sorted, but returned in the same order as the underlying "
11878 #: ../fish/guestfish-actions.pod:3857 ../src/guestfs-actions.pod:5860
11880 "Also this call returns basic file type information about each file. The "
11881 "C<ftyp> field will contain one of the following characters:"
11885 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
11890 #: ../fish/guestfish-actions.pod:3864 ../src/guestfs-actions.pod:5867
11891 msgid "Block special"
11895 #: ../fish/guestfish-actions.pod:3866 ../src/guestfs-actions.pod:5869
11900 #: ../fish/guestfish-actions.pod:3868 ../src/guestfs-actions.pod:5871
11901 msgid "Char special"
11905 #: ../fish/guestfish-actions.pod:3870 ../src/guestfs-actions.pod:5873
11910 #: ../fish/guestfish-actions.pod:3872 ../src/guestfs-actions.pod:5875
11915 #: ../fish/guestfish-actions.pod:3874 ../src/guestfs-actions.pod:5877
11920 #: ../fish/guestfish-actions.pod:3876 ../src/guestfs-actions.pod:5879
11921 msgid "FIFO (named pipe)"
11925 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:5881
11930 #: ../fish/guestfish-actions.pod:3880 ../src/guestfs-actions.pod:5883
11931 msgid "Symbolic link"
11935 #: ../fish/guestfish-actions.pod:3882 ../src/guestfs-actions.pod:5885
11940 #: ../fish/guestfish-actions.pod:3884 ../src/guestfs-actions.pod:5887
11941 msgid "Regular file"
11945 #: ../fish/guestfish-actions.pod:3886 ../src/guestfs-actions.pod:5889
11950 #: ../fish/guestfish-actions.pod:3888 ../src/guestfs-actions.pod:5891
11955 #: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:5893
11960 #: ../fish/guestfish-actions.pod:3892 ../src/guestfs-actions.pod:5895
11961 msgid "Unknown file type"
11965 #: ../fish/guestfish-actions.pod:3894 ../src/guestfs-actions.pod:5897
11970 #: ../fish/guestfish-actions.pod:3896 ../src/guestfs-actions.pod:5899
11971 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11975 #: ../fish/guestfish-actions.pod:3901
11977 "This function is primarily intended for use by programs. To get a simple "
11978 "list of names, use L</ls>. To get a printable directory for human "
11979 "consumption, use L</ll>."
11983 #: ../fish/guestfish-actions.pod:3905
11988 #: ../fish/guestfish-actions.pod:3907
11996 #: ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:5920
11997 msgid "This command reads the target of a symbolic link."
12001 #: ../fish/guestfish-actions.pod:3911
12002 msgid "readlinklist"
12006 #: ../fish/guestfish-actions.pod:3913
12009 " readlinklist path 'names ...'\n"
12014 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:5934
12016 "This call allows you to do a C<readlink> operation on multiple files, where "
12017 "all files are in the directory C<path>. C<names> is the list of files from "
12022 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:5938
12024 "On return you get a list of strings, with a one-to-one correspondence to the "
12025 "C<names> list. Each string is the value of the symbolic link."
12029 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:5942
12031 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12032 "result string is the empty string C<\"\">. However the whole operation is "
12033 "completed even if there were C<readlink(2)> errors, and so you can call this "
12034 "function with names where you don't know if they are symbolic links already "
12035 "(albeit slightly less efficient)."
12039 #: ../fish/guestfish-actions.pod:3930 ../src/guestfs-actions.pod:5949
12041 "This call is intended for programs that want to efficiently list a directory "
12042 "contents without making many round-trips. Very long directory listings "
12043 "might cause the protocol message size to be exceeded, causing this call to "
12044 "fail. The caller must split up such requests into smaller groups of names."
12048 #: ../fish/guestfish-actions.pod:3937
12053 #: ../fish/guestfish-actions.pod:3939
12061 #: ../fish/guestfish-actions.pod:3941 ../src/guestfs-actions.pod:5968
12063 "Return the canonicalized absolute pathname of C<path>. The returned path "
12064 "has no C<.>, C<..> or symbolic link path elements."
12068 #: ../fish/guestfish-actions.pod:3944
12069 msgid "removexattr"
12073 #: ../fish/guestfish-actions.pod:3946
12076 " removexattr xattr path\n"
12081 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:5983
12082 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12086 #: ../fish/guestfish-actions.pod:3951
12087 msgid "See also: L</lremovexattr>, L<attr(5)>."
12091 #: ../fish/guestfish-actions.pod:3953
12096 #: ../fish/guestfish-actions.pod:3955
12099 " resize2fs device\n"
12104 #: ../fish/guestfish-actions.pod:3957 ../src/guestfs-actions.pod:5998
12106 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12107 "underlying device."
12111 #: ../fish/guestfish-actions.pod:3960
12113 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12114 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12115 "gives an error about this and sometimes not. In any case, it is always safe "
12116 "to call L</e2fsck-f> before calling this function."
12120 #: ../fish/guestfish-actions.pod:3966
12121 msgid "resize2fs-M"
12125 #: ../fish/guestfish-actions.pod:3968
12128 " resize2fs-M device\n"
12133 #: ../fish/guestfish-actions.pod:3970
12135 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12136 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12141 #: ../fish/guestfish-actions.pod:3974
12143 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12144 "and read the C<Block size> and C<Block count> values. These two numbers, "
12145 "multiplied together, give the resulting size of the minimal filesystem in "
12150 #: ../fish/guestfish-actions.pod:3979
12151 msgid "resize2fs-size"
12155 #: ../fish/guestfish-actions.pod:3981
12158 " resize2fs-size device size\n"
12163 #: ../fish/guestfish-actions.pod:3983
12165 "This command is the same as L</resize2fs> except that it allows you to "
12166 "specify the new size (in bytes) explicitly."
12170 #: ../fish/guestfish-actions.pod:3986
12175 #: ../fish/guestfish-actions.pod:3988
12183 #: ../fish/guestfish-actions.pod:3990 ../src/guestfs-actions.pod:6050
12184 msgid "Remove the single file C<path>."
12188 #: ../fish/guestfish-actions.pod:3992
12193 #: ../fish/guestfish-actions.pod:3994
12201 #: ../fish/guestfish-actions.pod:3996 ../src/guestfs-actions.pod:6062
12203 "Remove the file or directory C<path>, recursively removing the contents if "
12204 "its a directory. This is like the C<rm -rf> shell command."
12208 #: ../fish/guestfish-actions.pod:4000
12213 #: ../fish/guestfish-actions.pod:4002
12221 #: ../fish/guestfish-actions.pod:4004 ../src/guestfs-actions.pod:6076
12222 msgid "Remove the single directory C<path>."
12226 #: ../fish/guestfish-actions.pod:4006
12227 msgid "rmmountpoint"
12231 #: ../fish/guestfish-actions.pod:4008
12234 " rmmountpoint exemptpath\n"
12239 #: ../fish/guestfish-actions.pod:4010
12241 "This calls removes a mountpoint that was previously created with "
12242 "L</mkmountpoint>. See L</mkmountpoint> for full details."
12246 #: ../fish/guestfish-actions.pod:4014
12247 msgid "scrub-device"
12251 #: ../fish/guestfish-actions.pod:4016
12254 " scrub-device device\n"
12259 #: ../fish/guestfish-actions.pod:4018 ../src/guestfs-actions.pod:6102
12261 "This command writes patterns over C<device> to make data retrieval more "
12266 #: ../fish/guestfish-actions.pod:4021 ../fish/guestfish-actions.pod:4036 ../fish/guestfish-actions.pod:4049 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6126 ../src/guestfs-actions.pod:6145
12268 "It is an interface to the L<scrub(1)> program. See that manual page for "
12273 #: ../fish/guestfish-actions.pod:4027
12278 #: ../fish/guestfish-actions.pod:4029
12281 " scrub-file file\n"
12286 #: ../fish/guestfish-actions.pod:4031 ../src/guestfs-actions.pod:6121
12288 "This command writes patterns over a file to make data retrieval more "
12293 #: ../fish/guestfish-actions.pod:4034 ../src/guestfs-actions.pod:6124
12294 msgid "The file is I<removed> after scrubbing."
12298 #: ../fish/guestfish-actions.pod:4039
12299 msgid "scrub-freespace"
12303 #: ../fish/guestfish-actions.pod:4041
12306 " scrub-freespace dir\n"
12311 #: ../fish/guestfish-actions.pod:4043
12313 "This command creates the directory C<dir> and then fills it with files until "
12314 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12315 "deletes them. The intention is to scrub any free space on the partition "
12316 "containing C<dir>."
12320 #: ../fish/guestfish-actions.pod:4052
12325 #: ../fish/guestfish-actions.pod:4054
12330 #: ../fish/guestfish-actions.pod:4056
12333 " set-append append\n"
12338 #: ../fish/guestfish-actions.pod:4058 ../src/guestfs-actions.pod:6158
12340 "This function is used to add additional options to the guest kernel command "
12345 #: ../fish/guestfish-actions.pod:4061 ../src/guestfs-actions.pod:6161
12347 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12348 "environment variable."
12352 #: ../fish/guestfish-actions.pod:4064 ../src/guestfs-actions.pod:6164
12354 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12355 "(libguestfs always adds a few of its own)."
12359 #: ../fish/guestfish-actions.pod:4067
12360 msgid "set-attach-method"
12364 #: ../fish/guestfish-actions.pod:4069
12365 msgid "attach-method"
12369 #: ../fish/guestfish-actions.pod:4071
12372 " set-attach-method attachmethod\n"
12377 #: ../fish/guestfish-actions.pod:4073 ../src/guestfs-actions.pod:6177
12379 "Set the method that libguestfs uses to connect to the back end guestfsd "
12380 "daemon. Possible methods are:"
12384 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182 ../src/guestfs.pod:2687
12385 msgid "C<appliance>"
12389 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6184
12391 "Launch an appliance and connect to it. This is the ordinary method and the "
12396 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187
12397 msgid "C<unix:I<path>>"
12401 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12402 msgid "Connect to the Unix domain socket I<path>."
12406 #: ../fish/guestfish-actions.pod:4087 ../src/guestfs-actions.pod:6191
12408 "This method lets you connect to an existing daemon or (using virtio-serial) "
12409 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12410 "RUNNING DAEMONS>."
12414 #: ../fish/guestfish-actions.pod:4093
12415 msgid "set-autosync"
12419 #: ../fish/guestfish-actions.pod:4095
12424 #: ../fish/guestfish-actions.pod:4097
12427 " set-autosync true|false\n"
12432 #: ../fish/guestfish-actions.pod:4099 ../src/guestfs-actions.pod:6207
12434 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12435 "effort attempt to make filesystems consistent and synchronized when the "
12436 "handle is closed (also if the program exits without closing handles)."
12440 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
12442 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12443 "disabled by default)."
12447 #: ../fish/guestfish-actions.pod:4107
12452 #: ../fish/guestfish-actions.pod:4109
12457 #: ../fish/guestfish-actions.pod:4111
12460 " set-direct true|false\n"
12465 #: ../fish/guestfish-actions.pod:4113 ../src/guestfs-actions.pod:6225
12467 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12468 "passed directly through to the appliance once it is launched."
12472 #: ../fish/guestfish-actions.pod:4117
12474 "One consequence of this is that log messages aren't caught by the library "
12475 "and handled by L</set-log-message-callback>, but go straight to stdout."
12479 #: ../fish/guestfish-actions.pod:4121 ../src/guestfs-actions.pod:6233
12480 msgid "You probably don't want to use this unless you know what you are doing."
12484 #: ../fish/guestfish-actions.pod:4124 ../src/guestfs-actions.pod:6236
12485 msgid "The default is disabled."
12489 #: ../fish/guestfish-actions.pod:4126
12490 msgid "set-e2label"
12494 #: ../fish/guestfish-actions.pod:4128
12497 " set-e2label device label\n"
12502 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6249
12504 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12505 "C<label>. Filesystem labels are limited to 16 characters."
12509 #: ../fish/guestfish-actions.pod:4134
12511 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12512 "label on a filesystem."
12516 #: ../fish/guestfish-actions.pod:4137
12521 #: ../fish/guestfish-actions.pod:4139
12524 " set-e2uuid device uuid\n"
12529 #: ../fish/guestfish-actions.pod:4141 ../src/guestfs-actions.pod:6267
12531 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12532 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12533 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12537 #: ../fish/guestfish-actions.pod:4146
12539 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12540 "UUID of a filesystem."
12544 #: ../fish/guestfish-actions.pod:4149
12545 msgid "set-memsize"
12549 #: ../fish/guestfish-actions.pod:4151
12554 #: ../fish/guestfish-actions.pod:4153
12557 " set-memsize memsize\n"
12562 #: ../fish/guestfish-actions.pod:4155
12564 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12565 "This only has any effect if called before L</launch>."
12569 #: ../fish/guestfish-actions.pod:4159 ../src/guestfs-actions.pod:6289
12571 "You can also change this by setting the environment variable "
12572 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12576 #: ../fish/guestfish-actions.pod:4166
12577 msgid "set-network"
12581 #: ../fish/guestfish-actions.pod:4168
12586 #: ../fish/guestfish-actions.pod:4170
12589 " set-network true|false\n"
12594 #: ../fish/guestfish-actions.pod:4172 ../src/guestfs-actions.pod:6306
12596 "If C<network> is true, then the network is enabled in the libguestfs "
12597 "appliance. The default is false."
12601 #: ../fish/guestfish-actions.pod:4175 ../src/guestfs-actions.pod:6309
12603 "This affects whether commands are able to access the network (see "
12604 "L<guestfs(3)/RUNNING COMMANDS>)."
12608 #: ../fish/guestfish-actions.pod:4178
12609 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12613 #: ../fish/guestfish-actions.pod:4181
12618 #: ../fish/guestfish-actions.pod:4185
12621 " set-path searchpath\n"
12626 #: ../fish/guestfish-actions.pod:4187 ../src/guestfs-actions.pod:6325
12627 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12631 #: ../fish/guestfish-actions.pod:4189 ../src/guestfs-actions.pod:6327
12633 "The default is C<$libdir/guestfs> unless overridden by setting "
12634 "C<LIBGUESTFS_PATH> environment variable."
12638 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
12639 msgid "Setting C<path> to C<NULL> restores the default path."
12643 #: ../fish/guestfish-actions.pod:4194
12648 #: ../fish/guestfish-actions.pod:4196
12653 #: ../fish/guestfish-actions.pod:4198
12656 " set-pgroup true|false\n"
12661 #: ../fish/guestfish-actions.pod:4200 ../src/guestfs-actions.pod:6342
12663 "If C<pgroup> is true, child processes are placed into their own process "
12668 #: ../fish/guestfish-actions.pod:4203 ../src/guestfs-actions.pod:6345
12670 "The practical upshot of this is that signals like C<SIGINT> (from users "
12671 "pressing C<^C>) won't be received by the child process."
12675 #: ../fish/guestfish-actions.pod:4206 ../src/guestfs-actions.pod:6348
12677 "The default for this flag is false, because usually you want C<^C> to kill "
12682 #: ../fish/guestfish-actions.pod:4209
12687 #: ../fish/guestfish-actions.pod:4211
12692 #: ../fish/guestfish-actions.pod:4213
12700 #: ../fish/guestfish-actions.pod:4215 ../src/guestfs-actions.pod:6361
12701 msgid "Set the qemu binary that we will use."
12705 #: ../fish/guestfish-actions.pod:4217 ../src/guestfs-actions.pod:6363
12706 msgid "The default is chosen when the library was compiled by the configure script."
12710 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
12712 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12717 #: ../fish/guestfish-actions.pod:4223 ../src/guestfs-actions.pod:6369
12718 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12722 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
12724 "Note that you should call this function as early as possible after creating "
12725 "the handle. This is because some pre-launch operations depend on testing "
12726 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12727 "don't retest features, and so you might see inconsistent results. Using the "
12728 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12729 "the qemu binary at the same time as the handle is created."
12733 #: ../fish/guestfish-actions.pod:4233
12734 msgid "set-recovery-proc"
12738 #: ../fish/guestfish-actions.pod:4235
12739 msgid "recovery-proc"
12743 #: ../fish/guestfish-actions.pod:4237
12746 " set-recovery-proc true|false\n"
12751 #: ../fish/guestfish-actions.pod:4239
12753 "If this is called with the parameter C<false> then L</launch> does not "
12754 "create a recovery process. The purpose of the recovery process is to stop "
12755 "runaway qemu processes in the case where the main program aborts abruptly."
12759 #: ../fish/guestfish-actions.pod:4244
12761 "This only has any effect if called before L</launch>, and the default is "
12766 #: ../fish/guestfish-actions.pod:4247 ../src/guestfs-actions.pod:6397
12768 "About the only time when you would want to disable this is if the main "
12769 "process will fork itself into the background (\"daemonize\" itself). In "
12770 "this case the recovery process thinks that the main program has disappeared "
12771 "and so kills qemu, which is not very helpful."
12775 #: ../fish/guestfish-actions.pod:4253
12776 msgid "set-selinux"
12780 #: ../fish/guestfish-actions.pod:4255
12785 #: ../fish/guestfish-actions.pod:4257
12788 " set-selinux true|false\n"
12793 #: ../fish/guestfish-actions.pod:4259 ../src/guestfs-actions.pod:6413
12795 "This sets the selinux flag that is passed to the appliance at boot time. "
12796 "The default is C<selinux=0> (disabled)."
12800 #: ../fish/guestfish-actions.pod:4262 ../src/guestfs-actions.pod:6416
12802 "Note that if SELinux is enabled, it is always in Permissive mode "
12803 "(C<enforcing=0>)."
12807 #: ../fish/guestfish-actions.pod:4268
12812 #: ../fish/guestfish-actions.pod:4270
12817 #: ../fish/guestfish-actions.pod:4272
12820 " set-trace true|false\n"
12825 #: ../fish/guestfish-actions.pod:4274 ../src/guestfs-actions.pod:6432
12827 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
12828 "return values are traced."
12832 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6435
12834 "If you want to trace C API calls into libguestfs (and other libraries) then "
12835 "possibly a better way is to use the external ltrace(1) command."
12839 #: ../fish/guestfish-actions.pod:4281 ../src/guestfs-actions.pod:6439
12841 "Command traces are disabled unless the environment variable "
12842 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12846 #: ../fish/guestfish-actions.pod:4284
12848 "Trace messages are normally sent to C<stderr>, unless you register a "
12849 "callback to send them somewhere else (see L</set-event-callback>)."
12853 #: ../fish/guestfish-actions.pod:4288
12854 msgid "set-verbose"
12858 #: ../fish/guestfish-actions.pod:4290
12863 #: ../fish/guestfish-actions.pod:4292
12866 " set-verbose true|false\n"
12871 #: ../fish/guestfish-actions.pod:4294 ../src/guestfs-actions.pod:6456
12872 msgid "If C<verbose> is true, this turns on verbose messages."
12876 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6458
12878 "Verbose messages are disabled unless the environment variable "
12879 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12883 #: ../fish/guestfish-actions.pod:4299
12885 "Verbose messages are normally sent to C<stderr>, unless you register a "
12886 "callback to send them somewhere else (see L</set-event-callback>)."
12890 #: ../fish/guestfish-actions.pod:4303
12895 #: ../fish/guestfish-actions.pod:4305
12898 " setcon context\n"
12903 #: ../fish/guestfish-actions.pod:4307 ../src/guestfs-actions.pod:6475
12905 "This sets the SELinux security context of the daemon to the string "
12910 #: ../fish/guestfish-actions.pod:4310 ../src/guestfs-actions.pod:6478
12911 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12915 #: ../fish/guestfish-actions.pod:4312
12920 #: ../fish/guestfish-actions.pod:4314
12923 " setxattr xattr val vallen path\n"
12928 #: ../fish/guestfish-actions.pod:4316 ../src/guestfs-actions.pod:6493
12930 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12931 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12935 #: ../fish/guestfish-actions.pod:4320
12936 msgid "See also: L</lsetxattr>, L<attr(5)>."
12940 #: ../fish/guestfish-actions.pod:4322
12945 #: ../fish/guestfish-actions.pod:4324
12948 " sfdisk device cyls heads sectors 'lines ...'\n"
12953 #: ../fish/guestfish-actions.pod:4326 ../src/guestfs-actions.pod:6513
12955 "This is a direct interface to the L<sfdisk(8)> program for creating "
12956 "partitions on block devices."
12960 #: ../fish/guestfish-actions.pod:4329 ../src/guestfs-actions.pod:6516
12961 msgid "C<device> should be a block device, for example C</dev/sda>."
12965 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6518
12967 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12968 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
12969 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12970 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12971 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12972 "the kernel) cannot work out the right geometry and you will need to tell it."
12976 #: ../fish/guestfish-actions.pod:4339 ../src/guestfs-actions.pod:6526
12978 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12979 "refer to the L<sfdisk(8)> manpage."
12983 #: ../fish/guestfish-actions.pod:4342 ../src/guestfs-actions.pod:6529
12985 "To create a single partition occupying the whole disk, you would pass "
12986 "C<lines> as a single element list, when the single element being the string "
12991 #: ../fish/guestfish-actions.pod:4346
12992 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
12996 #: ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375 ../fish/guestfish-actions.pod:4397
12998 "This function is deprecated. In new code, use the L</part_add> call "
13003 #: ../fish/guestfish-actions.pod:4359
13008 #: ../fish/guestfish-actions.pod:4361
13011 " sfdiskM device 'lines ...'\n"
13016 #: ../fish/guestfish-actions.pod:4363
13018 "This is a simplified interface to the L</sfdisk> command, where partition "
13019 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13020 "you don't need to specify the cyls, heads and sectors parameters which were "
13021 "rarely if ever used anyway."
13025 #: ../fish/guestfish-actions.pod:4369
13026 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13030 #: ../fish/guestfish-actions.pod:4382
13035 #: ../fish/guestfish-actions.pod:4384
13038 " sfdisk-N device partnum cyls heads sectors line\n"
13043 #: ../fish/guestfish-actions.pod:4386 ../src/guestfs-actions.pod:6591
13045 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13046 "(note: C<n> counts from 1)."
13050 #: ../fish/guestfish-actions.pod:4389
13052 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13053 "cyls/heads/sectors parameters."
13057 #: ../fish/guestfish-actions.pod:4392
13058 msgid "See also: L</part-add>"
13062 #: ../fish/guestfish-actions.pod:4404
13063 msgid "sfdisk-disk-geometry"
13067 #: ../fish/guestfish-actions.pod:4406
13070 " sfdisk-disk-geometry device\n"
13075 #: ../fish/guestfish-actions.pod:4408
13077 "This displays the disk geometry of C<device> read from the partition table. "
13078 "Especially in the case where the underlying block device has been resized, "
13079 "this can be different from the kernel's idea of the geometry (see "
13080 "L</sfdisk-kernel-geometry>)."
13084 #: ../fish/guestfish-actions.pod:4413 ../fish/guestfish-actions.pod:4422 ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:6640
13085 msgid "The result is in human-readable format, and not designed to be parsed."
13089 #: ../fish/guestfish-actions.pod:4416
13090 msgid "sfdisk-kernel-geometry"
13094 #: ../fish/guestfish-actions.pod:4418
13097 " sfdisk-kernel-geometry device\n"
13102 #: ../fish/guestfish-actions.pod:4420 ../src/guestfs-actions.pod:6638
13103 msgid "This displays the kernel's idea of the geometry of C<device>."
13107 #: ../fish/guestfish-actions.pod:4425
13112 #: ../fish/guestfish-actions.pod:4427
13115 " sfdisk-l device\n"
13120 #: ../fish/guestfish-actions.pod:4429 ../src/guestfs-actions.pod:6654
13122 "This displays the partition table on C<device>, in the human-readable output "
13123 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13127 #: ../fish/guestfish-actions.pod:4433
13128 msgid "See also: L</part-list>"
13132 #: ../fish/guestfish-actions.pod:4435
13134 "This function is deprecated. In new code, use the L</part_list> call "
13139 #: ../fish/guestfish-actions.pod:4442
13144 #: ../fish/guestfish-actions.pod:4444
13152 #: ../fish/guestfish-actions.pod:4446 ../src/guestfs-actions.pod:6678
13154 "This call runs a command from the guest filesystem via the guest's "
13159 #: ../fish/guestfish-actions.pod:4449
13160 msgid "This is like L</command>, but passes the command to:"
13164 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13167 " /bin/sh -c \"command\"\n"
13172 #: ../fish/guestfish-actions.pod:4453 ../src/guestfs-actions.pod:6685
13174 "Depending on the guest's shell, this usually results in wildcards being "
13175 "expanded, shell expressions being interpolated and so on."
13179 #: ../fish/guestfish-actions.pod:4457
13180 msgid "All the provisos about L</command> apply to this call."
13184 #: ../fish/guestfish-actions.pod:4459
13189 #: ../fish/guestfish-actions.pod:4461
13192 " sh-lines command\n"
13197 #: ../fish/guestfish-actions.pod:4463
13198 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13202 #: ../fish/guestfish-actions.pod:4466
13203 msgid "See also: L</command-lines>"
13207 #: ../fish/guestfish-actions.pod:4468
13212 #: ../fish/guestfish-actions.pod:4470
13220 #: ../fish/guestfish-actions.pod:4472 ../src/guestfs-actions.pod:6719
13221 msgid "Sleep for C<secs> seconds."
13225 #: ../fish/guestfish-actions.pod:4474
13230 #: ../fish/guestfish-actions.pod:4476
13238 #: ../fish/guestfish-actions.pod:4480 ../src/guestfs-actions.pod:6733
13239 msgid "This is the same as the C<stat(2)> system call."
13243 #: ../fish/guestfish-actions.pod:4482
13248 #: ../fish/guestfish-actions.pod:4484
13256 #: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6747
13258 "Returns file system statistics for any mounted file system. C<path> should "
13259 "be a file or directory in the mounted file system (typically it is the mount "
13260 "point itself, but it doesn't need to be)."
13264 #: ../fish/guestfish-actions.pod:4490 ../src/guestfs-actions.pod:6751
13265 msgid "This is the same as the C<statvfs(2)> system call."
13269 #: ../fish/guestfish-actions.pod:4492
13274 #: ../fish/guestfish-actions.pod:4494
13282 #: ../fish/guestfish-actions.pod:4496 ../src/guestfs-actions.pod:6765
13284 "This runs the L<strings(1)> command on a file and returns the list of "
13285 "printable strings found."
13289 #: ../fish/guestfish-actions.pod:4502
13294 #: ../fish/guestfish-actions.pod:4504
13297 " strings-e encoding path\n"
13302 #: ../fish/guestfish-actions.pod:4506
13304 "This is like the L</strings> command, but allows you to specify the encoding "
13305 "of strings that are looked for in the source file C<path>."
13309 #: ../fish/guestfish-actions.pod:4510 ../src/guestfs-actions.pod:6788
13310 msgid "Allowed encodings are:"
13314 #: ../fish/guestfish-actions.pod:4514 ../src/guestfs-actions.pod:6792
13319 #: ../fish/guestfish-actions.pod:4516
13321 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13322 "ISO-8859-X (this is what L</strings> uses)."
13326 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13331 #: ../fish/guestfish-actions.pod:4521 ../src/guestfs-actions.pod:6799
13332 msgid "Single 8-bit-byte characters."
13336 #: ../fish/guestfish-actions.pod:4523 ../src/guestfs-actions.pod:6801
13341 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6803
13342 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13346 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13347 msgid "l (lower case letter L)"
13351 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13353 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13354 "examining binaries in Windows guests."
13358 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13363 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13364 msgid "32-bit big endian such as UCS-4BE."
13368 #: ../fish/guestfish-actions.pod:4537 ../src/guestfs-actions.pod:6815
13373 #: ../fish/guestfish-actions.pod:4539 ../src/guestfs-actions.pod:6817
13374 msgid "32-bit little endian such as UCS-4LE."
13378 #: ../fish/guestfish-actions.pod:4543 ../src/guestfs-actions.pod:6821
13379 msgid "The returned strings are transcoded to UTF-8."
13383 #: ../fish/guestfish-actions.pod:4548
13384 msgid "swapoff-device"
13388 #: ../fish/guestfish-actions.pod:4550
13391 " swapoff-device device\n"
13396 #: ../fish/guestfish-actions.pod:4552
13398 "This command disables the libguestfs appliance swap device or partition "
13399 "named C<device>. See L</swapon-device>."
13403 #: ../fish/guestfish-actions.pod:4556
13404 msgid "swapoff-file"
13408 #: ../fish/guestfish-actions.pod:4558
13411 " swapoff-file file\n"
13416 #: ../fish/guestfish-actions.pod:4560 ../src/guestfs-actions.pod:6852
13417 msgid "This command disables the libguestfs appliance swap on file."
13421 #: ../fish/guestfish-actions.pod:4562
13422 msgid "swapoff-label"
13426 #: ../fish/guestfish-actions.pod:4564
13429 " swapoff-label label\n"
13434 #: ../fish/guestfish-actions.pod:4566 ../src/guestfs-actions.pod:6864
13436 "This command disables the libguestfs appliance swap on labeled swap "
13441 #: ../fish/guestfish-actions.pod:4569
13442 msgid "swapoff-uuid"
13446 #: ../fish/guestfish-actions.pod:4571
13449 " swapoff-uuid uuid\n"
13454 #: ../fish/guestfish-actions.pod:4573 ../src/guestfs-actions.pod:6877
13456 "This command disables the libguestfs appliance swap partition with the given "
13461 #: ../fish/guestfish-actions.pod:4576
13462 msgid "swapon-device"
13466 #: ../fish/guestfish-actions.pod:4578
13469 " swapon-device device\n"
13474 #: ../fish/guestfish-actions.pod:4580
13476 "This command enables the libguestfs appliance to use the swap device or "
13477 "partition named C<device>. The increased memory is made available for all "
13478 "commands, for example those run using L</command> or L</sh>."
13482 #: ../fish/guestfish-actions.pod:4585 ../src/guestfs-actions.pod:6895
13484 "Note that you should not swap to existing guest swap partitions unless you "
13485 "know what you are doing. They may contain hibernation information, or other "
13486 "information that the guest doesn't want you to trash. You also risk leaking "
13487 "information about the host to the guest this way. Instead, attach a new "
13488 "host device to the guest and swap on that."
13492 #: ../fish/guestfish-actions.pod:4592
13493 msgid "swapon-file"
13497 #: ../fish/guestfish-actions.pod:4594
13500 " swapon-file file\n"
13505 #: ../fish/guestfish-actions.pod:4596
13506 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
13510 #: ../fish/guestfish-actions.pod:4599
13511 msgid "swapon-label"
13515 #: ../fish/guestfish-actions.pod:4601
13518 " swapon-label label\n"
13523 #: ../fish/guestfish-actions.pod:4603
13525 "This command enables swap to a labeled swap partition. See "
13526 "L</swapon-device> for other notes."
13530 #: ../fish/guestfish-actions.pod:4606
13531 msgid "swapon-uuid"
13535 #: ../fish/guestfish-actions.pod:4608
13538 " swapon-uuid uuid\n"
13543 #: ../fish/guestfish-actions.pod:4610
13545 "This command enables swap to a swap partition with the given UUID. See "
13546 "L</swapon-device> for other notes."
13550 #: ../fish/guestfish-actions.pod:4613
13555 #: ../fish/guestfish-actions.pod:4615
13563 #: ../fish/guestfish-actions.pod:4617 ../src/guestfs-actions.pod:6950
13565 "This syncs the disk, so that any writes are flushed through to the "
13566 "underlying disk image."
13570 #: ../fish/guestfish-actions.pod:4620 ../src/guestfs-actions.pod:6953
13572 "You should always call this if you have modified a disk image, before "
13573 "closing the handle."
13577 #: ../fish/guestfish-actions.pod:4623
13582 #: ../fish/guestfish-actions.pod:4625
13590 #: ../fish/guestfish-actions.pod:4627 ../src/guestfs-actions.pod:6966
13591 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13595 #: ../fish/guestfish-actions.pod:4633
13600 #: ../fish/guestfish-actions.pod:4635
13603 " tail-n nrlines path\n"
13608 #: ../fish/guestfish-actions.pod:4637 ../src/guestfs-actions.pod:6985
13610 "If the parameter C<nrlines> is a positive number, this returns the last "
13611 "C<nrlines> lines of the file C<path>."
13615 #: ../fish/guestfish-actions.pod:4640 ../src/guestfs-actions.pod:6988
13617 "If the parameter C<nrlines> is a negative number, this returns lines from "
13618 "the file C<path>, starting with the C<-nrlines>th line."
13622 #: ../fish/guestfish-actions.pod:4648
13627 #: ../fish/guestfish-actions.pod:4650
13630 " tar-in (tarfile|-) directory\n"
13635 #: ../fish/guestfish-actions.pod:4652 ../src/guestfs-actions.pod:7009
13637 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13638 "tar file) into C<directory>."
13642 #: ../fish/guestfish-actions.pod:4655
13643 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
13647 #: ../fish/guestfish-actions.pod:4660
13652 #: ../fish/guestfish-actions.pod:4662
13655 " tar-out directory (tarfile|-)\n"
13660 #: ../fish/guestfish-actions.pod:4664 ../src/guestfs-actions.pod:7026
13662 "This command packs the contents of C<directory> and downloads it to local "
13667 #: ../fish/guestfish-actions.pod:4667
13668 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
13672 #: ../fish/guestfish-actions.pod:4672
13677 #: ../fish/guestfish-actions.pod:4674
13680 " tgz-in (tarball|-) directory\n"
13685 #: ../fish/guestfish-actions.pod:4676 ../src/guestfs-actions.pod:7043
13687 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13688 "tar file) into C<directory>."
13692 #: ../fish/guestfish-actions.pod:4679
13693 msgid "To upload an uncompressed tarball, use L</tar-in>."
13697 #: ../fish/guestfish-actions.pod:4683
13702 #: ../fish/guestfish-actions.pod:4685
13705 " tgz-out directory (tarball|-)\n"
13710 #: ../fish/guestfish-actions.pod:4687 ../src/guestfs-actions.pod:7059
13712 "This command packs the contents of C<directory> and downloads it to local "
13717 #: ../fish/guestfish-actions.pod:4690
13718 msgid "To download an uncompressed tarball, use L</tar-out>."
13722 #: ../fish/guestfish-actions.pod:4694
13727 #: ../fish/guestfish-actions.pod:4696
13735 #: ../fish/guestfish-actions.pod:4698 ../src/guestfs-actions.pod:7074
13737 "Touch acts like the L<touch(1)> command. It can be used to update the "
13738 "timestamps on a file, or, if the file does not exist, to create a new "
13739 "zero-length file."
13743 #: ../fish/guestfish-actions.pod:4702 ../src/guestfs-actions.pod:7078
13745 "This command only works on regular files, and will fail on other file types "
13746 "such as directories, symbolic links, block special etc."
13750 #: ../fish/guestfish-actions.pod:4705
13755 #: ../fish/guestfish-actions.pod:4707
13763 #: ../fish/guestfish-actions.pod:4709 ../src/guestfs-actions.pod:7091
13765 "This command truncates C<path> to a zero-length file. The file must exist "
13770 #: ../fish/guestfish-actions.pod:4712
13771 msgid "truncate-size"
13775 #: ../fish/guestfish-actions.pod:4714
13778 " truncate-size path size\n"
13783 #: ../fish/guestfish-actions.pod:4716 ../src/guestfs-actions.pod:7105
13785 "This command truncates C<path> to size C<size> bytes. The file must exist "
13790 #: ../fish/guestfish-actions.pod:4719
13792 "If the current file size is less than C<size> then the file is extended to "
13793 "the required size with zero bytes. This creates a sparse file (ie. disk "
13794 "blocks are not allocated for the file until you write to it). To create a "
13795 "non-sparse file of zeroes, use L</fallocate64> instead."
13799 #: ../fish/guestfish-actions.pod:4725
13804 #: ../fish/guestfish-actions.pod:4727
13807 " tune2fs-l device\n"
13812 #: ../fish/guestfish-actions.pod:4729 ../src/guestfs-actions.pod:7124
13814 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13819 #: ../fish/guestfish-actions.pod:4732 ../src/guestfs-actions.pod:7127
13821 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13822 "for more details. The list of fields returned isn't clearly defined, and "
13823 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13824 "and the filesystem itself."
13828 #: ../fish/guestfish-actions.pod:4737
13833 #: ../fish/guestfish-actions.pod:4739
13836 " txz-in (tarball|-) directory\n"
13841 #: ../fish/guestfish-actions.pod:4741 ../src/guestfs-actions.pod:7147
13843 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13844 "tar file) into C<directory>."
13848 #: ../fish/guestfish-actions.pod:4746
13853 #: ../fish/guestfish-actions.pod:4748
13856 " txz-out directory (tarball|-)\n"
13861 #: ../fish/guestfish-actions.pod:4750 ../src/guestfs-actions.pod:7161
13863 "This command packs the contents of C<directory> and downloads it to local "
13864 "file C<tarball> (as an xz compressed tar archive)."
13868 #: ../fish/guestfish-actions.pod:4755
13873 #: ../fish/guestfish-actions.pod:4757
13881 #: ../fish/guestfish-actions.pod:4759 ../src/guestfs-actions.pod:7174
13883 "This function sets the mask used for creating new files and device nodes to "
13888 #: ../fish/guestfish-actions.pod:4762 ../src/guestfs-actions.pod:7177
13890 "Typical umask values would be C<022> which creates new files with "
13891 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13892 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13896 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
13898 "The default umask is C<022>. This is important because it means that "
13899 "directories and device nodes will be created with C<0644> or C<0755> mode "
13900 "even if you specify C<0777>."
13904 #: ../fish/guestfish-actions.pod:4771
13905 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
13909 #: ../fish/guestfish-actions.pod:4774 ../src/guestfs-actions.pod:7189
13910 msgid "This call returns the previous umask."
13914 #: ../fish/guestfish-actions.pod:4776
13919 #: ../fish/guestfish-actions.pod:4778
13924 #: ../fish/guestfish-actions.pod:4780
13927 " umount pathordevice\n"
13932 #: ../fish/guestfish-actions.pod:4782 ../src/guestfs-actions.pod:7201
13934 "This unmounts the given filesystem. The filesystem may be specified either "
13935 "by its mountpoint (path) or the device which contains the filesystem."
13939 #: ../fish/guestfish-actions.pod:4786
13944 #: ../fish/guestfish-actions.pod:4788
13945 msgid "unmount-all"
13949 #: ../fish/guestfish-actions.pod:4790
13957 #: ../fish/guestfish-actions.pod:4792 ../src/guestfs-actions.pod:7214
13958 msgid "This unmounts all mounted filesystems."
13962 #: ../fish/guestfish-actions.pod:4794 ../src/guestfs-actions.pod:7216
13963 msgid "Some internal mounts are not unmounted by this call."
13967 #: ../fish/guestfish-actions.pod:4796
13972 #: ../fish/guestfish-actions.pod:4798
13975 " upload (filename|-) remotefilename\n"
13980 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4813 ../src/guestfs-actions.pod:7229 ../src/guestfs-actions.pod:7253
13981 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
13985 #: ../fish/guestfish-actions.pod:4805
13986 msgid "See also L</download>."
13990 #: ../fish/guestfish-actions.pod:4809
13991 msgid "upload-offset"
13995 #: ../fish/guestfish-actions.pod:4811
13998 " upload-offset (filename|-) remotefilename offset\n"
14003 #: ../fish/guestfish-actions.pod:4816 ../src/guestfs-actions.pod:7256
14005 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14006 "The intention is to overwrite parts of existing files or devices, although "
14007 "if a non-existant file is specified then it is created with a \"hole\" "
14008 "before C<offset>. The size of the data written is implicit in the size of "
14009 "the source C<filename>."
14013 #: ../fish/guestfish-actions.pod:4823
14015 "Note that there is no limit on the amount of data that can be uploaded with "
14016 "this call, unlike with L</pwrite>, and this call always writes the full "
14017 "amount unless an error occurs."
14021 #: ../fish/guestfish-actions.pod:4828
14022 msgid "See also L</upload>, L</pwrite>."
14026 #: ../fish/guestfish-actions.pod:4832
14031 #: ../fish/guestfish-actions.pod:4834
14034 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14039 #: ../fish/guestfish-actions.pod:4836 ../src/guestfs-actions.pod:7289
14040 msgid "This command sets the timestamps of a file with nanosecond precision."
14044 #: ../fish/guestfish-actions.pod:4839 ../src/guestfs-actions.pod:7292
14046 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14051 #: ../fish/guestfish-actions.pod:4842 ../src/guestfs-actions.pod:7295
14053 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14054 "nanoseconds from the epoch."
14058 #: ../fish/guestfish-actions.pod:4845 ../src/guestfs-actions.pod:7298
14060 "If the C<*nsecs> field contains the special value C<-1> then the "
14061 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14062 "ignored in this case)."
14066 #: ../fish/guestfish-actions.pod:4849 ../src/guestfs-actions.pod:7302
14068 "If the C<*nsecs> field contains the special value C<-2> then the "
14069 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14074 #: ../fish/guestfish-actions.pod:4853
14079 #: ../fish/guestfish-actions.pod:4855
14087 #: ../fish/guestfish-actions.pod:4857 ../src/guestfs-actions.pod:7315
14088 msgid "Return the libguestfs version number that the program is linked against."
14092 #: ../fish/guestfish-actions.pod:4860 ../src/guestfs-actions.pod:7318
14094 "Note that because of dynamic linking this is not necessarily the version of "
14095 "libguestfs that you compiled against. You can compile the program, and then "
14096 "at runtime dynamically link against a completely different C<libguestfs.so> "
14101 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14103 "This call was added in version C<1.0.58>. In previous versions of "
14104 "libguestfs there was no way to get the version number. From C code you can "
14105 "use dynamic linker functions to find out if this symbol exists (if it "
14106 "doesn't, then it's an earlier version)."
14110 #: ../fish/guestfish-actions.pod:4871 ../src/guestfs-actions.pod:7329
14112 "The call returns a structure with four elements. The first three (C<major>, "
14113 "C<minor> and C<release>) are numbers and correspond to the usual version "
14114 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14115 "but may be used for distro-specific information."
14119 #: ../fish/guestfish-actions.pod:4877 ../src/guestfs-actions.pod:7335
14120 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14124 #: ../fish/guestfish-actions.pod:4880 ../src/guestfs-actions.pod:7338
14125 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14129 #: ../fish/guestfish-actions.pod:4882
14131 "I<Note:> Don't use this call to test for availability of features. In "
14132 "enterprise distributions we backport features from later versions into "
14133 "earlier versions, making this an unreliable way to test for features. Use "
14134 "L</available> instead."
14138 #: ../fish/guestfish-actions.pod:4888
14143 #: ../fish/guestfish-actions.pod:4890
14146 " vfs-label device\n"
14151 #: ../fish/guestfish-actions.pod:4892 ../src/guestfs-actions.pod:7358
14152 msgid "This returns the filesystem label of the filesystem on C<device>."
14156 #: ../fish/guestfish-actions.pod:4895 ../src/guestfs-actions.pod:7361
14157 msgid "If the filesystem is unlabeled, this returns the empty string."
14161 #: ../fish/guestfish-actions.pod:4897
14162 msgid "To find a filesystem from the label, use L</findfs-label>."
14166 #: ../fish/guestfish-actions.pod:4899
14171 #: ../fish/guestfish-actions.pod:4901
14174 " vfs-type device\n"
14179 #: ../fish/guestfish-actions.pod:4903 ../src/guestfs-actions.pod:7376
14181 "This command gets the filesystem type corresponding to the filesystem on "
14186 #: ../fish/guestfish-actions.pod:4906 ../src/guestfs-actions.pod:7379
14188 "For most filesystems, the result is the name of the Linux VFS module which "
14189 "would be used to mount this filesystem if you mounted it without specifying "
14190 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14194 #: ../fish/guestfish-actions.pod:4911
14199 #: ../fish/guestfish-actions.pod:4913
14202 " vfs-uuid device\n"
14207 #: ../fish/guestfish-actions.pod:4915 ../src/guestfs-actions.pod:7395
14208 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14212 #: ../fish/guestfish-actions.pod:4918 ../src/guestfs-actions.pod:7398
14213 msgid "If the filesystem does not have a UUID, this returns the empty string."
14217 #: ../fish/guestfish-actions.pod:4920
14218 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14222 #: ../fish/guestfish-actions.pod:4922
14223 msgid "vg-activate"
14227 #: ../fish/guestfish-actions.pod:4924
14230 " vg-activate true|false 'volgroups ...'\n"
14235 #: ../fish/guestfish-actions.pod:4926 ../src/guestfs-actions.pod:7414
14237 "This command activates or (if C<activate> is false) deactivates all logical "
14238 "volumes in the listed volume groups C<volgroups>."
14242 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7417
14243 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14247 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14249 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14250 "activated or deactivated."
14254 #: ../fish/guestfish-actions.pod:4934
14255 msgid "vg-activate-all"
14259 #: ../fish/guestfish-actions.pod:4936
14262 " vg-activate-all true|false\n"
14267 #: ../fish/guestfish-actions.pod:4938 ../src/guestfs-actions.pod:7432
14269 "This command activates or (if C<activate> is false) deactivates all logical "
14270 "volumes in all volume groups."
14274 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7435
14275 msgid "This command is the same as running C<vgchange -a y|n>"
14279 #: ../fish/guestfish-actions.pod:4943
14284 #: ../fish/guestfish-actions.pod:4945
14287 " vgcreate volgroup 'physvols ...'\n"
14292 #: ../fish/guestfish-actions.pod:4947 ../src/guestfs-actions.pod:7448
14294 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14295 "of physical volumes C<physvols>."
14299 #: ../fish/guestfish-actions.pod:4950
14304 #: ../fish/guestfish-actions.pod:4952
14307 " vglvuuids vgname\n"
14312 #: ../fish/guestfish-actions.pod:4954 ../src/guestfs-actions.pod:7461
14314 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14315 "volumes created in this volume group."
14319 #: ../fish/guestfish-actions.pod:4957
14321 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14322 "logical volumes and volume groups."
14326 #: ../fish/guestfish-actions.pod:4960
14327 msgid "See also L</vgpvuuids>."
14331 #: ../fish/guestfish-actions.pod:4962
14336 #: ../fish/guestfish-actions.pod:4964
14339 " vgpvuuids vgname\n"
14344 #: ../fish/guestfish-actions.pod:4966 ../src/guestfs-actions.pod:7481
14346 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14347 "volumes that this volume group resides on."
14351 #: ../fish/guestfish-actions.pod:4969
14353 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14354 "physical volumes and volume groups."
14358 #: ../fish/guestfish-actions.pod:4972
14359 msgid "See also L</vglvuuids>."
14363 #: ../fish/guestfish-actions.pod:4974
14368 #: ../fish/guestfish-actions.pod:4976
14371 " vgremove vgname\n"
14376 #: ../fish/guestfish-actions.pod:4978 ../src/guestfs-actions.pod:7501
14377 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14381 #: ../fish/guestfish-actions.pod:4980 ../src/guestfs-actions.pod:7503
14382 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14386 #: ../fish/guestfish-actions.pod:4983
14391 #: ../fish/guestfish-actions.pod:4985
14394 " vgrename volgroup newvolgroup\n"
14399 #: ../fish/guestfish-actions.pod:4987 ../src/guestfs-actions.pod:7517
14400 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14404 #: ../fish/guestfish-actions.pod:4989
14409 #: ../fish/guestfish-actions.pod:4991
14417 #: ../fish/guestfish-actions.pod:4993 ../src/guestfs-actions.pod:7528
14419 "List all the volumes groups detected. This is the equivalent of the "
14420 "L<vgs(8)> command."
14424 #: ../fish/guestfish-actions.pod:4996 ../src/guestfs-actions.pod:7531
14426 "This returns a list of just the volume group names that were detected "
14427 "(eg. C<VolGroup00>)."
14431 #: ../fish/guestfish-actions.pod:4999
14432 msgid "See also L</vgs-full>."
14436 #: ../fish/guestfish-actions.pod:5001
14441 #: ../fish/guestfish-actions.pod:5003
14449 #: ../fish/guestfish-actions.pod:5005 ../src/guestfs-actions.pod:7547
14451 "List all the volumes groups detected. This is the equivalent of the "
14452 "L<vgs(8)> command. The \"full\" version includes all fields."
14456 #: ../fish/guestfish-actions.pod:5008
14461 #: ../fish/guestfish-actions.pod:5010
14469 #: ../fish/guestfish-actions.pod:5012 ../src/guestfs-actions.pod:7561
14471 "This rescans all block devices and rebuilds the list of LVM physical "
14472 "volumes, volume groups and logical volumes."
14476 #: ../fish/guestfish-actions.pod:5015
14481 #: ../fish/guestfish-actions.pod:5017
14489 #: ../fish/guestfish-actions.pod:5019 ../src/guestfs-actions.pod:7574
14490 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14494 #: ../fish/guestfish-actions.pod:5021
14499 #: ../fish/guestfish-actions.pod:5023
14507 #: ../fish/guestfish-actions.pod:5025 ../src/guestfs-actions.pod:7614
14509 "This command counts the characters in a file, using the C<wc -c> external "
14514 #: ../fish/guestfish-actions.pod:5028
14519 #: ../fish/guestfish-actions.pod:5030
14527 #: ../fish/guestfish-actions.pod:5032 ../src/guestfs-actions.pod:7627
14529 "This command counts the lines in a file, using the C<wc -l> external "
14534 #: ../fish/guestfish-actions.pod:5035
14539 #: ../fish/guestfish-actions.pod:5037
14547 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7640
14549 "This command counts the words in a file, using the C<wc -w> external "
14554 #: ../fish/guestfish-actions.pod:5042
14559 #: ../fish/guestfish-actions.pod:5044
14562 " write path content\n"
14567 #: ../fish/guestfish-actions.pod:5046 ../src/guestfs-actions.pod:7655
14569 "This call creates a file called C<path>. The content of the file is the "
14570 "string C<content> (which can contain any 8 bit data)."
14574 #: ../fish/guestfish-actions.pod:5049
14575 msgid "See also L</write-append>."
14579 #: ../fish/guestfish-actions.pod:5054
14580 msgid "write-append"
14584 #: ../fish/guestfish-actions.pod:5056
14587 " write-append path content\n"
14592 #: ../fish/guestfish-actions.pod:5058 ../src/guestfs-actions.pod:7675
14594 "This call appends C<content> to the end of file C<path>. If C<path> does "
14595 "not exist, then a new file is created."
14599 #: ../fish/guestfish-actions.pod:5061
14600 msgid "See also L</write>."
14604 #: ../fish/guestfish-actions.pod:5066
14609 #: ../fish/guestfish-actions.pod:5068
14612 " write-file path content size\n"
14617 #: ../fish/guestfish-actions.pod:5070 ../src/guestfs-actions.pod:7695
14619 "This call creates a file called C<path>. The contents of the file is the "
14620 "string C<content> (which can contain any 8 bit data), with length C<size>."
14624 #: ../fish/guestfish-actions.pod:5074 ../src/guestfs-actions.pod:7699
14626 "As a special case, if C<size> is C<0> then the length is calculated using "
14627 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14631 #: ../fish/guestfish-actions.pod:5078 ../src/guestfs-actions.pod:7703
14633 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14634 "I<not> work, even if the length is specified."
14638 #: ../fish/guestfish-actions.pod:5084
14639 msgid "This function is deprecated. In new code, use the L</write> call instead."
14643 #: ../fish/guestfish-actions.pod:5091
14648 #: ../fish/guestfish-actions.pod:5093
14651 " zegrep regex path\n"
14656 #: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7727
14657 msgid "This calls the external C<zegrep> program and returns the matching lines."
14661 #: ../fish/guestfish-actions.pod:5101
14666 #: ../fish/guestfish-actions.pod:5103
14669 " zegrepi regex path\n"
14674 #: ../fish/guestfish-actions.pod:5105 ../src/guestfs-actions.pod:7746
14675 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14679 #: ../fish/guestfish-actions.pod:5111
14684 #: ../fish/guestfish-actions.pod:5113
14692 #: ../fish/guestfish-actions.pod:5115 ../src/guestfs-actions.pod:7764
14693 msgid "This command writes zeroes over the first few blocks of C<device>."
14697 #: ../fish/guestfish-actions.pod:5117 ../src/guestfs-actions.pod:7766
14699 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14700 "securely wipe the device). It should be sufficient to remove any partition "
14701 "tables, filesystem superblocks and so on."
14705 #: ../fish/guestfish-actions.pod:5121
14706 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
14710 #: ../fish/guestfish-actions.pod:5124
14711 msgid "zero-device"
14715 #: ../fish/guestfish-actions.pod:5126
14718 " zero-device device\n"
14723 #: ../fish/guestfish-actions.pod:5128
14725 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
14726 "which just zeroes the first few blocks of a device."
14730 #: ../fish/guestfish-actions.pod:5135
14735 #: ../fish/guestfish-actions.pod:5137
14738 " zerofree device\n"
14743 #: ../fish/guestfish-actions.pod:5139 ../src/guestfs-actions.pod:7810
14745 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14746 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14747 "possible to compress the filesystem more effectively."
14751 #: ../fish/guestfish-actions.pod:5144 ../src/guestfs-actions.pod:7815
14752 msgid "You should B<not> run this program if the filesystem is mounted."
14756 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7818
14758 "It is possible that using this program can damage the filesystem or data on "
14763 #: ../fish/guestfish-actions.pod:5150
14768 #: ../fish/guestfish-actions.pod:5152
14771 " zfgrep pattern path\n"
14776 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7832
14777 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14781 #: ../fish/guestfish-actions.pod:5160
14786 #: ../fish/guestfish-actions.pod:5162
14789 " zfgrepi pattern path\n"
14794 #: ../fish/guestfish-actions.pod:5164 ../src/guestfs-actions.pod:7851
14795 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14799 #: ../fish/guestfish-actions.pod:5170
14804 #: ../fish/guestfish-actions.pod:5172
14807 " zfile meth path\n"
14812 #: ../fish/guestfish-actions.pod:5174 ../src/guestfs-actions.pod:7870
14813 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14817 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7873
14818 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14822 #: ../fish/guestfish-actions.pod:5179
14823 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
14827 #: ../fish/guestfish-actions.pod:5182
14828 msgid "This function is deprecated. In new code, use the L</file> call instead."
14832 #: ../fish/guestfish-actions.pod:5189
14837 #: ../fish/guestfish-actions.pod:5191
14840 " zgrep regex path\n"
14845 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7897
14846 msgid "This calls the external C<zgrep> program and returns the matching lines."
14850 #: ../fish/guestfish-actions.pod:5199
14855 #: ../fish/guestfish-actions.pod:5201
14858 " zgrepi regex path\n"
14863 #: ../fish/guestfish-actions.pod:5203 ../src/guestfs-actions.pod:7916
14864 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
14868 #: ../fish/guestfish-commands.pod:1
14873 #: ../fish/guestfish-commands.pod:3
14878 #: ../fish/guestfish-commands.pod:5
14881 " alloc filename size\n"
14886 #: ../fish/guestfish-commands.pod:7
14888 "This creates an empty (zeroed) file of the given size, and then adds so it "
14889 "can be further examined."
14893 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
14894 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
14898 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
14899 msgid "Size can be specified using standard suffixes, eg. C<1M>."
14903 #: ../fish/guestfish-commands.pod:14
14905 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
14906 "image, see L</PREPARED DISK IMAGES>."
14910 #: ../fish/guestfish-commands.pod:17
14915 #: ../fish/guestfish-commands.pod:19
14918 " copy-in local [local ...] /remotedir\n"
14923 #: ../fish/guestfish-commands.pod:21
14925 "C<copy-in> copies local files or directories recursively into the disk "
14926 "image, placing them in the directory called C</remotedir> (which must "
14927 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
14928 "other commands as necessary."
14932 #: ../fish/guestfish-commands.pod:26
14934 "Multiple local files and directories can be specified, but the last "
14935 "parameter must always be a remote directory. Wildcards cannot be used."
14939 #: ../fish/guestfish-commands.pod:30
14944 #: ../fish/guestfish-commands.pod:32
14947 " copy-out remote [remote ...] localdir\n"
14952 #: ../fish/guestfish-commands.pod:34
14954 "C<copy-out> copies remote files or directories recursively out of the disk "
14955 "image, placing them on the host disk in a local directory called C<localdir> "
14956 "(which must exist). This guestfish meta-command turns into a sequence of "
14957 "L</download>, L</tar-out> and other commands as necessary."
14961 #: ../fish/guestfish-commands.pod:40
14963 "Multiple remote files and directories can be specified, but the last "
14964 "parameter must always be a local directory. To download to the current "
14965 "directory, use C<.> as in:"
14969 #: ../fish/guestfish-commands.pod:44
14972 " copy-out /home .\n"
14977 #: ../fish/guestfish-commands.pod:46
14979 "Wildcards cannot be used in the ordinary command, but you can use them with "
14980 "the help of L</glob> like this:"
14984 #: ../fish/guestfish-commands.pod:49
14987 " glob copy-out /home/* .\n"
14992 #: ../fish/guestfish-commands.pod:51
14997 #: ../fish/guestfish-commands.pod:53
15000 " display filename\n"
15005 #: ../fish/guestfish-commands.pod:55
15007 "Use C<display> (a graphical display program) to display an image file. It "
15008 "downloads the file, and runs C<display> on it."
15012 #: ../fish/guestfish-commands.pod:58
15014 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15015 "environment variable. For example to use the GNOME display program:"
15019 #: ../fish/guestfish-commands.pod:61
15022 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15027 #: ../fish/guestfish-commands.pod:63
15028 msgid "See also L<display(1)>."
15032 #: ../fish/guestfish-commands.pod:65
15037 #: ../fish/guestfish-commands.pod:67
15040 " echo [params ...]\n"
15045 #: ../fish/guestfish-commands.pod:69
15046 msgid "This echos the parameters to the terminal."
15050 #: ../fish/guestfish-commands.pod:71
15055 #: ../fish/guestfish-commands.pod:73
15060 #: ../fish/guestfish-commands.pod:75
15065 #: ../fish/guestfish-commands.pod:77
15073 #: ../fish/guestfish-commands.pod:79
15075 "This is used to edit a file. It downloads the file, edits it locally using "
15076 "your editor, then uploads the result."
15080 #: ../fish/guestfish-commands.pod:82
15082 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15083 "or C<emacs> you will get those corresponding editors."
15087 #: ../fish/guestfish-commands.pod:86
15092 #: ../fish/guestfish-commands.pod:88
15095 " glob command args...\n"
15100 #: ../fish/guestfish-commands.pod:90
15102 "Expand wildcards in any paths in the args list, and run C<command> "
15103 "repeatedly on each matching path."
15107 #: ../fish/guestfish-commands.pod:93
15108 msgid "See L</WILDCARDS AND GLOBBING>."
15112 #: ../fish/guestfish-commands.pod:95
15117 #: ../fish/guestfish-commands.pod:97
15120 " hexedit <filename|device>\n"
15121 " hexedit <filename|device> <max>\n"
15122 " hexedit <filename|device> <start> <max>\n"
15127 #: ../fish/guestfish-commands.pod:101
15129 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15134 #: ../fish/guestfish-commands.pod:104
15136 "This command works by downloading potentially the whole file or device, "
15137 "editing it locally, then uploading it. If the file or device is large, you "
15138 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15139 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15140 "usual modifiers allowed such as C<1M> (1 megabyte)."
15144 #: ../fish/guestfish-commands.pod:111
15145 msgid "For example to edit the first few sectors of a disk you might do:"
15149 #: ../fish/guestfish-commands.pod:114
15152 " hexedit /dev/sda 1M\n"
15157 #: ../fish/guestfish-commands.pod:116
15159 "which would allow you to edit anywhere within the first megabyte of the "
15164 #: ../fish/guestfish-commands.pod:119
15165 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15169 #: ../fish/guestfish-commands.pod:121
15172 " hexedit /dev/sda1 0x400 0x400\n"
15177 #: ../fish/guestfish-commands.pod:123
15178 msgid "(assuming the superblock is in the standard location)."
15182 #: ../fish/guestfish-commands.pod:125
15184 "This command requires the external L<hexedit(1)> program. You can specify "
15185 "another program to use by setting the C<HEXEDITOR> environment variable."
15189 #: ../fish/guestfish-commands.pod:129
15190 msgid "See also L</hexdump>."
15194 #: ../fish/guestfish-commands.pod:131
15199 #: ../fish/guestfish-commands.pod:133
15207 #: ../fish/guestfish-commands.pod:135
15208 msgid "Change the local directory, ie. the current directory of guestfish itself."
15212 #: ../fish/guestfish-commands.pod:138
15213 msgid "Note that C<!cd> won't do what you might expect."
15217 #: ../fish/guestfish-commands.pod:140
15222 #: ../fish/guestfish-commands.pod:142
15227 #: ../fish/guestfish-commands.pod:144
15235 #: ../fish/guestfish-commands.pod:146
15236 msgid "Opens the manual page for guestfish."
15240 #: ../fish/guestfish-commands.pod:148
15245 #: ../fish/guestfish-commands.pod:150
15250 #: ../fish/guestfish-commands.pod:152
15258 #: ../fish/guestfish-commands.pod:154
15266 #: ../fish/guestfish-commands.pod:156
15267 msgid "This is used to view a file."
15271 #: ../fish/guestfish-commands.pod:158
15273 "The default viewer is C<$PAGER>. However if you use the alternate command "
15274 "C<less> you will get the C<less> command specifically."
15278 #: ../fish/guestfish-commands.pod:161
15283 #: ../fish/guestfish-commands.pod:163
15291 #: ../fish/guestfish-commands.pod:165
15293 "Close and reopen the libguestfs handle. It is not necessary to use this "
15294 "normally, because the handle is closed properly when guestfish exits. "
15295 "However this is occasionally useful for testing."
15299 #: ../fish/guestfish-commands.pod:169
15304 #: ../fish/guestfish-commands.pod:171
15307 " sparse filename size\n"
15312 #: ../fish/guestfish-commands.pod:173
15314 "This creates an empty sparse file of the given size, and then adds so it can "
15315 "be further examined."
15319 #: ../fish/guestfish-commands.pod:176
15321 "In all respects it works the same as the L</alloc> command, except that the "
15322 "image file is allocated sparsely, which means that disk blocks are not "
15323 "assigned to the file until they are needed. Sparse disk files only use "
15324 "space when written to, but they are slower and there is a danger you could "
15325 "run out of real disk space during a write operation."
15329 #: ../fish/guestfish-commands.pod:186
15334 #: ../fish/guestfish-commands.pod:188
15342 #: ../fish/guestfish-commands.pod:190
15344 "This command returns a list of the optional groups known to the daemon, and "
15345 "indicates which ones are supported by this build of the libguestfs "
15350 #: ../fish/guestfish-commands.pod:194
15351 msgid "See also L<guestfs(3)/AVAILABILITY>."
15355 #: ../fish/guestfish-commands.pod:196
15360 #: ../fish/guestfish-commands.pod:198
15363 " time command args...\n"
15368 #: ../fish/guestfish-commands.pod:200
15370 "Run the command as usual, but print the elapsed time afterwards. This can "
15371 "be useful for benchmarking operations."
15375 #: ../fish/guestfish.pod:5
15376 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15380 #: ../fish/guestfish.pod:9
15383 " guestfish [--options] [commands]\n"
15388 #: ../fish/guestfish.pod:11
15396 #: ../fish/guestfish.pod:13
15399 " guestfish [--ro|--rw] -a disk.img\n"
15404 #: ../fish/guestfish.pod:15
15407 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15412 #: ../fish/guestfish.pod:17
15415 " guestfish -d libvirt-domain\n"
15420 #: ../fish/guestfish.pod:19
15423 " guestfish [--ro|--rw] -a disk.img -i\n"
15428 #: ../fish/guestfish.pod:21
15431 " guestfish -d libvirt-domain -i\n"
15436 #: ../fish/guestfish.pod:25
15438 "Using guestfish in read/write mode on live virtual machines can be "
15439 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15440 "option to use guestfish safely if the disk image or virtual machine might be "
15445 #: ../fish/guestfish.pod:32
15447 "Guestfish is a shell and command-line tool for examining and modifying "
15448 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15449 "functionality of the guestfs API, see L<guestfs(3)>."
15453 #: ../fish/guestfish.pod:36
15455 "Guestfish gives you structured access to the libguestfs API, from shell "
15456 "scripts or the command line or interactively. If you want to rescue a "
15457 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15462 #: ../fish/guestfish.pod:43
15463 msgid "As an interactive shell"
15467 #: ../fish/guestfish.pod:45
15475 #: ../fish/guestfish.pod:47
15478 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15479 " editing virtual machine filesystems.\n"
15484 #: ../fish/guestfish.pod:50
15487 " Type: 'help' for a list of commands\n"
15488 " 'man' to read the manual\n"
15489 " 'quit' to quit the shell\n"
15494 #: ../fish/guestfish.pod:54
15497 " ><fs> add-ro disk.img\n"
15499 " ><fs> list-filesystems\n"
15500 " /dev/sda1: ext4\n"
15501 " /dev/vg_guest/lv_root: ext4\n"
15502 " /dev/vg_guest/lv_swap: swap\n"
15503 " ><fs> mount /dev/vg_guest/lv_root /\n"
15504 " ><fs> cat /etc/fstab\n"
15506 " # Created by anaconda\n"
15513 #: ../fish/guestfish.pod:67
15514 msgid "From shell scripts"
15518 #: ../fish/guestfish.pod:69
15519 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15523 #: ../fish/guestfish.pod:71
15526 " guestfish <<_EOF_\n"
15529 " mount /dev/vg_guest/lv_root /\n"
15530 " write /etc/motd \"Welcome, new users\"\n"
15536 #: ../fish/guestfish.pod:78
15537 msgid "List the LVM logical volumes in a disk image:"
15541 #: ../fish/guestfish.pod:80
15544 " guestfish -a disk.img --ro <<_EOF_\n"
15552 #: ../fish/guestfish.pod:85
15553 msgid "List all the filesystems in a disk image:"
15557 #: ../fish/guestfish.pod:87
15560 " guestfish -a disk.img --ro <<_EOF_\n"
15562 " list-filesystems\n"
15568 #: ../fish/guestfish.pod:92
15569 msgid "On one command line"
15573 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15574 msgid "Update C</etc/resolv.conf> in a guest:"
15578 #: ../fish/guestfish.pod:96
15582 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15583 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15588 #: ../fish/guestfish.pod:100
15589 msgid "Edit C</boot/grub/grub.conf> interactively:"
15593 #: ../fish/guestfish.pod:102
15596 " guestfish --rw --add disk.img \\\n"
15597 " --mount /dev/vg_guest/lv_root \\\n"
15598 " --mount /dev/sda1:/boot \\\n"
15599 " edit /boot/grub/grub.conf\n"
15604 #: ../fish/guestfish.pod:107
15605 msgid "Mount disks automatically"
15609 #: ../fish/guestfish.pod:109
15611 "Use the I<-i> option to automatically mount the disks from a virtual "
15616 #: ../fish/guestfish.pod:112
15619 " guestfish --ro -a disk.img -i cat /etc/group\n"
15624 #: ../fish/guestfish.pod:114
15627 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15632 #: ../fish/guestfish.pod:116
15633 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15637 #: ../fish/guestfish.pod:118
15640 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
15645 #: ../fish/guestfish.pod:120
15646 msgid "As a script interpreter"
15650 #: ../fish/guestfish.pod:122
15651 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15655 #: ../fish/guestfish.pod:124
15658 " #!/usr/bin/guestfish -f\n"
15659 " sparse test1.img 100M\n"
15661 " part-disk /dev/sda mbr\n"
15662 " mkfs ext2 /dev/sda1\n"
15667 #: ../fish/guestfish.pod:130
15668 msgid "Start with a prepared disk"
15672 #: ../fish/guestfish.pod:132
15674 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15675 "single ext2-formatted partition:"
15679 #: ../fish/guestfish.pod:135
15682 " guestfish -N fs\n"
15687 #: ../fish/guestfish.pod:137
15688 msgid "To list what is available do:"
15692 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
15695 " guestfish -N help | less\n"
15700 #: ../fish/guestfish.pod:141
15701 msgid "Remote control"
15705 #: ../fish/guestfish.pod:143
15708 " eval \"`guestfish --listen`\"\n"
15709 " guestfish --remote add-ro disk.img\n"
15710 " guestfish --remote run\n"
15711 " guestfish --remote lvs\n"
15716 #: ../fish/guestfish.pod:154
15717 msgid "Displays general help on options."
15721 #: ../fish/guestfish.pod:158
15722 msgid "B<--cmd-help>"
15726 #: ../fish/guestfish.pod:160
15727 msgid "Lists all available guestfish commands."
15731 #: ../fish/guestfish.pod:162
15736 #: ../fish/guestfish.pod:164
15737 msgid "B<--cmd-help cmd>"
15741 #: ../fish/guestfish.pod:166
15742 msgid "Displays detailed help on a single command C<cmd>."
15746 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
15747 msgid "B<-a image>"
15751 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
15752 msgid "B<--add image>"
15756 #: ../fish/guestfish.pod:172
15757 msgid "Add a block device or virtual machine image to the shell."
15761 #: ../fish/guestfish.pod:177
15763 "Using this flag is mostly equivalent to using the C<add> command, with "
15764 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
15765 "the I<--format=...> flag was given."
15769 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
15771 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15772 "URI to use. The default is to use the default libvirt connection."
15776 #: ../fish/guestfish.pod:189
15781 #: ../fish/guestfish.pod:191
15783 "If using the I<--listen> option and a csh-like shell, use this option. See "
15784 "section L</REMOTE CONTROL AND CSH> below."
15788 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
15789 msgid "B<-d libvirt-domain>"
15793 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
15794 msgid "B<--domain libvirt-domain>"
15798 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
15800 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15801 "used, then any libvirt domain can be used. However in write mode, only "
15802 "libvirt domains which are shut down can be named here."
15806 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
15807 msgid "Domain UUIDs can be used instead of names."
15811 #: ../fish/guestfish.pod:204
15813 "Using this flag is mostly equivalent to using the C<add-domain> command, "
15814 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
15815 "if the I<--format:...> flag was given."
15819 #: ../fish/guestfish.pod:208
15824 #: ../fish/guestfish.pod:210
15825 msgid "B<--no-dest-paths>"
15829 #: ../fish/guestfish.pod:212
15831 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15832 "to hit the tab key to complete paths on the guest filesystem, but this "
15833 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15834 "allow this feature to be disabled."
15838 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
15840 "When prompting for keys and passphrases, guestfish normally turns echoing "
15841 "off so you cannot see what you are typing. If you are not worried about "
15842 "Tempest attacks and there is no one else in the room you can specify this "
15843 "flag to see what you are typing."
15847 #: ../fish/guestfish.pod:224
15852 #: ../fish/guestfish.pod:226
15853 msgid "B<--file file>"
15857 #: ../fish/guestfish.pod:228
15858 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15862 #: ../fish/guestfish.pod:231
15865 " #!/usr/bin/guestfish -f\n"
15870 #: ../fish/guestfish.pod:244
15873 " guestfish --format=raw -a disk.img\n"
15878 #: ../fish/guestfish.pod:248
15881 " guestfish --format=raw -a disk.img --format -a another.img\n"
15886 #: ../fish/guestfish.pod:253
15888 "If you have untrusted raw-format guest disk images, you should use this "
15889 "option to specify the disk format. This avoids a possible security problem "
15890 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
15894 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
15895 msgid "B<--inspector>"
15899 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
15901 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15902 "system and mount filesystems as they would be mounted on the real virtual "
15907 #: ../fish/guestfish.pod:266
15908 msgid "Typical usage is either:"
15912 #: ../fish/guestfish.pod:268
15915 " guestfish -d myguest -i\n"
15920 #: ../fish/guestfish.pod:270
15921 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15925 #: ../fish/guestfish.pod:272
15928 " guestfish --ro -d myguest -i\n"
15933 #: ../fish/guestfish.pod:274
15934 msgid "(for active domains, readonly), or specify the block device directly:"
15938 #: ../fish/guestfish.pod:276
15941 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
15946 #: ../fish/guestfish.pod:278
15948 "Note that the command line syntax changed slightly over older versions of "
15949 "guestfish. You can still use the old syntax:"
15953 #: ../fish/guestfish.pod:281
15956 " guestfish [--ro] -i disk.img\n"
15961 #: ../fish/guestfish.pod:283
15964 " guestfish [--ro] -i libvirt-domain\n"
15969 #: ../fish/guestfish.pod:285
15971 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
15972 "then using other commands to mount the filesystems that were found."
15976 #: ../fish/guestfish.pod:294
15977 msgid "B<--listen>"
15981 #: ../fish/guestfish.pod:296
15983 "Fork into the background and listen for remote commands. See section "
15984 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
15988 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
15993 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
15995 "Connect to a live virtual machine. (Experimental, see "
15996 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16000 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16001 msgid "B<-m dev[:mountpoint[:options]]>"
16005 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16006 msgid "B<--mount dev[:mountpoint[:options]]>"
16010 #: ../fish/guestfish.pod:308
16011 msgid "Mount the named partition or logical volume on the given mountpoint."
16015 #: ../fish/guestfish.pod:310
16016 msgid "If the mountpoint is omitted, it defaults to C</>."
16020 #: ../fish/guestfish.pod:312
16021 msgid "You have to mount something on C</> before most commands will work."
16025 #: ../fish/guestfish.pod:314
16027 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16032 #: ../fish/guestfish.pod:317
16034 "If you don't know what filesystems a disk image contains, you can either run "
16035 "guestfish without this option, then list the partitions, filesystems and LVs "
16036 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16037 "commands), or you can use the L<virt-filesystems(1)> program."
16041 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16043 "The third (and rarely used) part of the mount parameter is the list of mount "
16044 "options used to mount the underlying filesystem. If this is not given, then "
16045 "the mount options are either the empty string or C<ro> (the latter if the "
16046 "I<--ro> flag is used). By specifying the mount options, you override this "
16047 "default choice. Probably the only time you would use this is to enable ACLs "
16048 "and/or extended attributes if the filesystem can support them:"
16052 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16055 " -m /dev/sda1:/:acl,user_xattr\n"
16060 #: ../fish/guestfish.pod:333
16061 msgid "Using this flag is equivalent to using the C<mount-options> command."
16065 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193 ../resize/virt-resize.pod:352
16070 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16071 msgid "B<--no-sync>"
16075 #: ../fish/guestfish.pod:339
16077 "Disable autosync. This is enabled by default. See the discussion of "
16078 "autosync in the L<guestfs(3)> manpage."
16082 #: ../fish/guestfish.pod:342
16087 #: ../fish/guestfish.pod:344
16088 msgid "B<--new type>"
16092 #: ../fish/guestfish.pod:346
16097 #: ../fish/guestfish.pod:348
16099 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16100 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16101 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16106 #: ../fish/guestfish.pod:353
16107 msgid "B<--progress-bars>"
16111 #: ../fish/guestfish.pod:355
16112 msgid "Enable progress bars, even when guestfish is used non-interactively."
16116 #: ../fish/guestfish.pod:357
16118 "Progress bars are enabled by default when guestfish is used as an "
16119 "interactive shell."
16123 #: ../fish/guestfish.pod:360
16124 msgid "B<--no-progress-bars>"
16128 #: ../fish/guestfish.pod:362
16129 msgid "Disable progress bars."
16133 #: ../fish/guestfish.pod:364
16134 msgid "B<--remote[=pid]>"
16138 #: ../fish/guestfish.pod:366
16140 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16141 "CONTROL GUESTFISH OVER A SOCKET> below."
16145 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239 ../rescue/virt-rescue.pod:161
16150 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241 ../rescue/virt-rescue.pod:163
16155 #: ../fish/guestfish.pod:373
16157 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16158 "mounts are done read-only."
16162 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16164 "The option must always be used if the disk image or virtual machine might be "
16165 "running, and is generally recommended in cases where you don't need write "
16166 "access to the disk."
16170 #: ../fish/guestfish.pod:380
16172 "Note that prepared disk images created with I<-N> are not affected by this "
16173 "option. Also commands like C<add> are not affected - you have to specify "
16174 "the C<readonly:true> option explicitly if you need it."
16178 #: ../fish/guestfish.pod:384
16179 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16183 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253 ../rescue/virt-rescue.pod:173
16184 msgid "B<--selinux>"
16188 #: ../fish/guestfish.pod:388
16189 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16193 #: ../fish/guestfish.pod:394
16195 "Enable very verbose messages. This is particularly useful if you find a "
16200 #: ../fish/guestfish.pod:401
16201 msgid "Display the guestfish / libguestfs version number and exit."
16205 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269 ../rescue/virt-rescue.pod:190
16210 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271 ../rescue/virt-rescue.pod:192
16215 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16217 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16218 "mounts are done read-write."
16222 #: ../fish/guestfish.pod:410
16223 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16227 #: ../fish/guestfish.pod:414
16228 msgid "Echo each command before executing it."
16232 #: ../fish/guestfish.pod:418
16233 msgid "COMMANDS ON COMMAND LINE"
16237 #: ../fish/guestfish.pod:420
16238 msgid "Any additional (non-option) arguments are treated as commands to execute."
16242 #: ../fish/guestfish.pod:423
16244 "Commands to execute should be separated by a colon (C<:>), where the colon "
16245 "is a separate parameter. Thus:"
16249 #: ../fish/guestfish.pod:426
16252 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16257 #: ../fish/guestfish.pod:428
16259 "If there are no additional arguments, then we enter a shell, either an "
16260 "interactive shell with a prompt (if the input is a terminal) or a "
16261 "non-interactive shell."
16265 #: ../fish/guestfish.pod:432
16267 "In either command line mode or non-interactive shell, the first command that "
16268 "gives an error causes the whole shell to exit. In interactive mode (with a "
16269 "prompt) if a command fails, you can continue to enter commands."
16273 #: ../fish/guestfish.pod:437
16274 msgid "USING launch (OR run)"
16278 #: ../fish/guestfish.pod:439
16280 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16281 "then launch it, then mount any disks you need, and finally issue "
16282 "actions/commands. So the general order of the day is:"
16286 #: ../fish/guestfish.pod:447
16287 msgid "add or -a/--add"
16291 #: ../fish/guestfish.pod:451
16292 msgid "launch (aka run)"
16296 #: ../fish/guestfish.pod:455
16297 msgid "mount or -m/--mount"
16301 #: ../fish/guestfish.pod:459
16302 msgid "any other commands"
16306 #: ../fish/guestfish.pod:463
16308 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16309 "guest before mounting or performing any other commands."
16313 #: ../fish/guestfish.pod:466
16315 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16316 "I<--new> options were given then C<run> is done automatically, simply "
16317 "because guestfish can't perform the action you asked for without doing this."
16321 #: ../fish/guestfish.pod:471
16322 msgid "OPENING DISKS FOR READ AND WRITE"
16326 #: ../fish/guestfish.pod:473
16328 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16329 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16330 "I<-i> and I<-m> open disk images read-only or for writing."
16334 #: ../fish/guestfish.pod:478
16336 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16337 "opening disk images supplied on the command line for write. To open a disk "
16338 "image read-only you have to do I<-a image --ro>."
16342 #: ../fish/guestfish.pod:482
16344 "This matters: If you accidentally open a live VM disk image writable then "
16345 "you will cause irreversible disk corruption."
16349 #: ../fish/guestfish.pod:485
16351 "In a future libguestfs we intend to change the default the other way. Disk "
16352 "images will be opened read-only. You will have to either specify "
16353 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16354 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16355 "access for disk images specified by those other command line options."
16359 #: ../fish/guestfish.pod:492
16361 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16362 "which does nothing (it is already the default). However it is highly "
16363 "recommended that you use this option to indicate that you need write access, "
16364 "and prepare your scripts for the day when this option will be required for "
16369 #: ../fish/guestfish.pod:498
16371 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16372 "other libguestfs program apart from guestfish and guestmount."
16376 #: ../fish/guestfish.pod:501
16381 #: ../fish/guestfish.pod:503
16383 "You can quote ordinary parameters using either single or double quotes. For "
16388 #: ../fish/guestfish.pod:506
16391 " add \"file with a space.img\"\n"
16396 #: ../fish/guestfish.pod:508
16399 " rm '/file name'\n"
16404 #: ../fish/guestfish.pod:510
16412 #: ../fish/guestfish.pod:512
16414 "A few commands require a list of strings to be passed. For these, use a "
16415 "whitespace-separated list, enclosed in quotes. Strings containing "
16416 "whitespace to be passed through must be enclosed in single quotes. A "
16417 "literal single quote must be escaped with a backslash."
16421 #: ../fish/guestfish.pod:517
16424 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16425 " command \"/bin/echo 'foo bar'\"\n"
16426 " command \"/bin/echo \\'foo\\'\"\n"
16431 #: ../fish/guestfish.pod:521
16432 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16436 #: ../fish/guestfish.pod:523
16438 "In double-quoted arguments (only) use backslash to insert special "
16443 #: ../fish/guestfish.pod:528
16448 #: ../fish/guestfish.pod:530
16449 msgid "Alert (bell) character."
16453 #: ../fish/guestfish.pod:532
16458 #: ../fish/guestfish.pod:534
16459 msgid "Backspace character."
16463 #: ../fish/guestfish.pod:536
16468 #: ../fish/guestfish.pod:538
16469 msgid "Form feed character."
16473 #: ../fish/guestfish.pod:540
16478 #: ../fish/guestfish.pod:542
16479 msgid "Newline character."
16483 #: ../fish/guestfish.pod:544
16488 #: ../fish/guestfish.pod:546
16489 msgid "Carriage return character."
16493 #: ../fish/guestfish.pod:548
16498 #: ../fish/guestfish.pod:550
16499 msgid "Horizontal tab character."
16503 #: ../fish/guestfish.pod:552
16508 #: ../fish/guestfish.pod:554
16509 msgid "Vertical tab character."
16513 #: ../fish/guestfish.pod:556
16518 #: ../fish/guestfish.pod:558
16519 msgid "A literal double quote character."
16523 #: ../fish/guestfish.pod:560
16528 #: ../fish/guestfish.pod:562
16530 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
16535 #: ../fish/guestfish.pod:565
16540 #: ../fish/guestfish.pod:567
16541 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
16545 #: ../fish/guestfish.pod:570
16547 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16552 #: ../fish/guestfish.pod:573
16557 #: ../fish/guestfish.pod:575
16558 msgid "A literal backslash character."
16562 #: ../fish/guestfish.pod:579
16563 msgid "OPTIONAL ARGUMENTS"
16567 #: ../fish/guestfish.pod:581
16569 "Some commands take optional arguments. These arguments appear in this "
16570 "documentation as C<[argname:..]>. You can use them as in these examples:"
16574 #: ../fish/guestfish.pod:585
16577 " add-drive-opts filename\n"
16582 #: ../fish/guestfish.pod:587
16585 " add-drive-opts filename readonly:true\n"
16590 #: ../fish/guestfish.pod:589
16593 " add-drive-opts filename format:qcow2 readonly:false\n"
16598 #: ../fish/guestfish.pod:591
16600 "Each optional argument can appear at most once. All optional arguments must "
16601 "appear after the required ones."
16605 #: ../fish/guestfish.pod:594
16610 #: ../fish/guestfish.pod:596
16611 msgid "This section applies to all commands which can take integers as parameters."
16615 #: ../fish/guestfish.pod:599
16616 msgid "SIZE SUFFIX"
16620 #: ../fish/guestfish.pod:601
16622 "When the command takes a parameter measured in bytes, you can use one of the "
16623 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16627 #: ../fish/guestfish.pod:607
16628 msgid "B<k> or B<K> or B<KiB>"
16632 #: ../fish/guestfish.pod:609
16633 msgid "The size in kilobytes (multiplied by 1024)."
16637 #: ../fish/guestfish.pod:611
16642 #: ../fish/guestfish.pod:613
16643 msgid "The size in SI 1000 byte units."
16647 #: ../fish/guestfish.pod:615
16648 msgid "B<M> or B<MiB>"
16652 #: ../fish/guestfish.pod:617
16653 msgid "The size in megabytes (multiplied by 1048576)."
16657 #: ../fish/guestfish.pod:619
16662 #: ../fish/guestfish.pod:621
16663 msgid "The size in SI 1000000 byte units."
16667 #: ../fish/guestfish.pod:623
16668 msgid "B<G> or B<GiB>"
16672 #: ../fish/guestfish.pod:625
16673 msgid "The size in gigabytes (multiplied by 2**30)."
16677 #: ../fish/guestfish.pod:627
16682 #: ../fish/guestfish.pod:629
16683 msgid "The size in SI 10**9 byte units."
16687 #: ../fish/guestfish.pod:631
16688 msgid "B<T> or B<TiB>"
16692 #: ../fish/guestfish.pod:633
16693 msgid "The size in terabytes (multiplied by 2**40)."
16697 #: ../fish/guestfish.pod:635
16702 #: ../fish/guestfish.pod:637
16703 msgid "The size in SI 10**12 byte units."
16707 #: ../fish/guestfish.pod:639
16708 msgid "B<P> or B<PiB>"
16712 #: ../fish/guestfish.pod:641
16713 msgid "The size in petabytes (multiplied by 2**50)."
16717 #: ../fish/guestfish.pod:643
16722 #: ../fish/guestfish.pod:645
16723 msgid "The size in SI 10**15 byte units."
16727 #: ../fish/guestfish.pod:647
16728 msgid "B<E> or B<EiB>"
16732 #: ../fish/guestfish.pod:649
16733 msgid "The size in exabytes (multiplied by 2**60)."
16737 #: ../fish/guestfish.pod:651
16742 #: ../fish/guestfish.pod:653
16743 msgid "The size in SI 10**18 byte units."
16747 #: ../fish/guestfish.pod:655
16748 msgid "B<Z> or B<ZiB>"
16752 #: ../fish/guestfish.pod:657
16753 msgid "The size in zettabytes (multiplied by 2**70)."
16757 #: ../fish/guestfish.pod:659
16762 #: ../fish/guestfish.pod:661
16763 msgid "The size in SI 10**21 byte units."
16767 #: ../fish/guestfish.pod:663
16768 msgid "B<Y> or B<YiB>"
16772 #: ../fish/guestfish.pod:665
16773 msgid "The size in yottabytes (multiplied by 2**80)."
16777 #: ../fish/guestfish.pod:667
16782 #: ../fish/guestfish.pod:669
16783 msgid "The size in SI 10**24 byte units."
16787 #: ../fish/guestfish.pod:675
16790 " truncate-size /file 1G\n"
16795 #: ../fish/guestfish.pod:677
16796 msgid "would truncate the file to 1 gigabyte."
16800 #: ../fish/guestfish.pod:679
16802 "Be careful because a few commands take sizes in kilobytes or megabytes "
16803 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16804 "Adding a suffix will probably not do what you expect."
16808 #: ../fish/guestfish.pod:683
16809 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16813 #: ../fish/guestfish.pod:685
16815 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16816 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16820 #: ../fish/guestfish.pod:688
16823 " 1234 decimal number 1234\n"
16824 " 02322 octal number, equivalent to decimal 1234\n"
16825 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16830 #: ../fish/guestfish.pod:692
16832 "When using the C<chmod> command, you almost always want to specify an octal "
16833 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16834 "L<chmod(1)> program):"
16838 #: ../fish/guestfish.pod:696
16841 " chmod 0777 /public # OK\n"
16842 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16847 #: ../fish/guestfish.pod:699
16849 "Commands that return numbers usually print them in decimal, but some "
16850 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16851 "octal, preceeded by C<0>)."
16855 #: ../fish/guestfish.pod:703
16856 msgid "WILDCARDS AND GLOBBING"
16860 #: ../fish/guestfish.pod:705
16862 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16863 "(globbing) by default. So for example the following will not do what you "
16868 #: ../fish/guestfish.pod:709
16876 #: ../fish/guestfish.pod:711
16878 "Assuming you don't have a directory called literally C</home/*> then the "
16879 "above command will return an error."
16883 #: ../fish/guestfish.pod:714
16884 msgid "To perform wildcard expansion, use the C<glob> command."
16888 #: ../fish/guestfish.pod:716
16891 " glob rm-rf /home/*\n"
16896 #: ../fish/guestfish.pod:718
16898 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16899 "many times), equivalent to:"
16903 #: ../fish/guestfish.pod:721
16906 " rm-rf /home/jim\n"
16907 " rm-rf /home/joe\n"
16908 " rm-rf /home/mary\n"
16913 #: ../fish/guestfish.pod:725
16914 msgid "C<glob> only works on simple guest paths and not on device names."
16918 #: ../fish/guestfish.pod:727
16920 "If you have several parameters, each containing a wildcard, then glob will "
16921 "perform a Cartesian product."
16925 #: ../fish/guestfish.pod:730
16930 #: ../fish/guestfish.pod:732
16932 "Any line which starts with a I<#> character is treated as a comment and "
16933 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16934 "a command. For example:"
16938 #: ../fish/guestfish.pod:736
16941 " # this is a comment\n"
16942 " # this is a comment\n"
16943 " foo # NOT a comment\n"
16948 #: ../fish/guestfish.pod:740
16949 msgid "Blank lines are also ignored."
16953 #: ../fish/guestfish.pod:742
16954 msgid "RUNNING COMMANDS LOCALLY"
16958 #: ../fish/guestfish.pod:744
16960 "Any line which starts with a I<!> character is treated as a command sent to "
16961 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
16965 #: ../fish/guestfish.pod:748
16969 " tgz-out /remote local/remote-data.tar.gz\n"
16974 #: ../fish/guestfish.pod:751
16976 "will create a directory C<local> on the host, and then export the contents "
16977 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
16978 "(See C<tgz-out>)."
16982 #: ../fish/guestfish.pod:755
16984 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
16985 "effect, due to the way that subprocesses work in Unix."
16989 #: ../fish/guestfish.pod:758
16990 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
16994 #: ../fish/guestfish.pod:760
16996 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
16997 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
16998 "and executed as guestfish commands."
17002 #: ../fish/guestfish.pod:764
17004 "Thus you can use shell script to construct arbitrary guestfish commands "
17005 "which are then parsed by guestfish."
17009 #: ../fish/guestfish.pod:767
17011 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17012 "through C</foo.100>) using guestfish commands alone. However this is simple "
17013 "if we use a shell script to create the guestfish commands for us:"
17017 #: ../fish/guestfish.pod:772
17020 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17025 #: ../fish/guestfish.pod:774
17026 msgid "or with names like C</foo.001>:"
17030 #: ../fish/guestfish.pod:776
17033 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17038 #: ../fish/guestfish.pod:778
17040 "When using guestfish interactively it can be helpful to just run the shell "
17041 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17042 "ordinary I<!> local command), see what guestfish commands it would run, and "
17043 "when you are happy with those prepend the C<E<lt>> character to run the "
17044 "guestfish commands for real."
17048 #: ../fish/guestfish.pod:784
17053 #: ../fish/guestfish.pod:786
17055 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17056 "command (a guestfish command) to the second command (any host command). For "
17061 #: ../fish/guestfish.pod:790
17064 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17069 #: ../fish/guestfish.pod:792
17071 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17072 "program). The above command would list all accounts in the guest filesystem "
17073 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17077 #: ../fish/guestfish.pod:797
17080 " hexdump /bin/ls | head\n"
17081 " list-devices | tail -1\n"
17082 " tgz-out / - | tar ztf -\n"
17087 #: ../fish/guestfish.pod:801
17089 "The space before the pipe symbol is required, any space after the pipe "
17090 "symbol is optional. Everything after the pipe symbol is just passed "
17091 "straight to the host shell, so it can contain redirections, globs and "
17092 "anything else that makes sense on the host side."
17096 #: ../fish/guestfish.pod:806
17098 "To use a literal argument which begins with a pipe symbol, you have to quote "
17103 #: ../fish/guestfish.pod:809
17111 #: ../fish/guestfish.pod:811
17112 msgid "HOME DIRECTORIES"
17116 #: ../fish/guestfish.pod:813
17118 "If a parameter starts with the character C<~> then the tilde may be expanded "
17119 "as a home directory path (either C<~> for the current user's home directory, "
17120 "or C<~user> for another user)."
17124 #: ../fish/guestfish.pod:817
17126 "Note that home directory expansion happens for users known I<on the host>, "
17127 "not in the guest filesystem."
17131 #: ../fish/guestfish.pod:820
17133 "To use a literal argument which begins with a tilde, you have to quote it, "
17138 #: ../fish/guestfish.pod:823
17146 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17147 msgid "ENCRYPTED DISKS"
17151 #: ../fish/guestfish.pod:827
17153 "Libguestfs has some support for Linux guests encrypted according to the "
17154 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17155 "disk encryption systems used by modern Linux guests. Currently only "
17156 "LVM-on-LUKS is supported."
17160 #: ../fish/guestfish.pod:832
17161 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17165 #: ../fish/guestfish.pod:834
17168 " ><fs> vfs-type /dev/sda2\n"
17174 #: ../fish/guestfish.pod:837
17176 "Then open those devices using L</luks-open>. This creates a device-mapper "
17177 "device called C</dev/mapper/luksdev>."
17181 #: ../fish/guestfish.pod:840
17184 " ><fs> luks-open /dev/sda2 luksdev\n"
17185 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17190 #: ../fish/guestfish.pod:843
17192 "Finally you have to tell LVM to scan for volume groups on the newly created "
17197 #: ../fish/guestfish.pod:846
17201 " vg-activate-all true\n"
17206 #: ../fish/guestfish.pod:849
17207 msgid "The logical volume(s) can now be mounted in the usual way."
17211 #: ../fish/guestfish.pod:851
17213 "Before closing a LUKS device you must unmount any logical volumes on it and "
17214 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17215 "one. Then you can close the mapper device:"
17219 #: ../fish/guestfish.pod:855
17222 " vg-activate false /dev/VG\n"
17223 " luks-close /dev/mapper/luksdev\n"
17228 #: ../fish/guestfish.pod:860
17230 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17231 "letters and paths (with some limitations). The following commands are "
17236 #: ../fish/guestfish.pod:864
17239 " file /WINDOWS/system32/config/system.LOG\n"
17244 #: ../fish/guestfish.pod:866
17247 " file win:\\windows\\system32\\config\\system.log\n"
17252 #: ../fish/guestfish.pod:868
17255 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17260 #: ../fish/guestfish.pod:870
17262 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17263 "where the drive is mounted, prepending that to the path, changing all "
17264 "backslash characters to forward slash, then resolving the result using "
17265 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
17266 "then the parameter might be rewritten like this:"
17270 #: ../fish/guestfish.pod:876
17273 " win:e:\\foo\\bar => /e/FOO/bar\n"
17278 #: ../fish/guestfish.pod:878
17279 msgid "This only works in argument positions that expect a path."
17283 #: ../fish/guestfish.pod:880
17284 msgid "UPLOADING AND DOWNLOADING FILES"
17288 #: ../fish/guestfish.pod:882
17290 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17291 "others which upload from or download to a local file, you can use the "
17292 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17296 #: ../fish/guestfish.pod:886
17304 #: ../fish/guestfish.pod:888
17305 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17309 #: ../fish/guestfish.pod:891
17312 " tar-out /etc - | tar tf -\n"
17317 #: ../fish/guestfish.pod:893
17319 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17320 "command (see L</PIPES>)."
17324 #: ../fish/guestfish.pod:896
17326 "When using C<-> to read from stdin, the input is read up to the end of "
17327 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17328 "some arbitrary end marker:"
17332 #: ../fish/guestfish.pod:900
17335 " upload -<<END /foo\n"
17344 #: ../fish/guestfish.pod:906
17346 "Any string of characters can be used instead of C<END>. The end marker must "
17347 "appear on a line of its own, without any preceeding or following characters "
17348 "(not even spaces)."
17352 #: ../fish/guestfish.pod:910
17354 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17355 "upload local files (so-called \"FileIn\" parameters in the generator)."
17359 #: ../fish/guestfish.pod:913
17360 msgid "EXIT ON ERROR BEHAVIOUR"
17364 #: ../fish/guestfish.pod:915
17366 "By default, guestfish will ignore any errors when in interactive mode "
17367 "(ie. taking commands from a human over a tty), and will exit on the first "
17368 "error in non-interactive mode (scripts, commands given on the command line)."
17372 #: ../fish/guestfish.pod:920
17374 "If you prefix a command with a I<-> character, then that command will not "
17375 "cause guestfish to exit, even if that (one) command returns an error."
17379 #: ../fish/guestfish.pod:924
17380 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17384 #: ../fish/guestfish.pod:926
17386 "Guestfish can be remote-controlled over a socket. This is useful "
17387 "particularly in shell scripts where you want to make several different "
17388 "changes to a filesystem, but you don't want the overhead of starting up a "
17389 "guestfish process each time."
17393 #: ../fish/guestfish.pod:931
17394 msgid "Start a guestfish server process using:"
17398 #: ../fish/guestfish.pod:933
17401 " eval \"`guestfish --listen`\"\n"
17406 #: ../fish/guestfish.pod:935
17407 msgid "and then send it commands by doing:"
17411 #: ../fish/guestfish.pod:937
17414 " guestfish --remote cmd [...]\n"
17419 #: ../fish/guestfish.pod:939
17420 msgid "To cause the server to exit, send it the exit command:"
17424 #: ../fish/guestfish.pod:943
17426 "Note that the server will normally exit if there is an error in a command. "
17427 "You can change this in the usual way. See section L</EXIT ON ERROR "
17432 #: ../fish/guestfish.pod:947
17433 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17437 #: ../fish/guestfish.pod:949
17439 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17440 "is how the I<--remote> option knows where to send the commands. You can "
17441 "have several guestfish listener processes running using:"
17445 #: ../fish/guestfish.pod:953
17448 " eval \"`guestfish --listen`\"\n"
17449 " pid1=$GUESTFISH_PID\n"
17450 " eval \"`guestfish --listen`\"\n"
17451 " pid2=$GUESTFISH_PID\n"
17453 " guestfish --remote=$pid1 cmd\n"
17454 " guestfish --remote=$pid2 cmd\n"
17459 #: ../fish/guestfish.pod:961
17460 msgid "REMOTE CONTROL AND CSH"
17464 #: ../fish/guestfish.pod:963
17466 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17471 #: ../fish/guestfish.pod:966
17474 " eval \"`guestfish --listen --csh`\"\n"
17479 #: ../fish/guestfish.pod:968
17480 msgid "REMOTE CONTROL DETAILS"
17484 #: ../fish/guestfish.pod:970
17486 "Remote control happens over a Unix domain socket called "
17487 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17488 "of the process, and C<$PID> is the process ID of the server."
17492 #: ../fish/guestfish.pod:974
17493 msgid "Guestfish client and server versions must match exactly."
17497 #: ../fish/guestfish.pod:976
17498 msgid "PREPARED DISK IMAGES"
17502 #: ../fish/guestfish.pod:978
17504 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17505 "preformatted disk images that guestfish can make for you to save typing. "
17506 "This is particularly useful for testing purposes. This option is used "
17507 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17508 "can be mixed with I<-a>)."
17512 #: ../fish/guestfish.pod:984
17514 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17515 "the second and so on. Existing files in the current directory are "
17520 #: ../fish/guestfish.pod:988
17522 "The type briefly describes how the disk should be sized, partitioned, how "
17523 "filesystem(s) should be created, and how content should be added. "
17524 "Optionally the type can be followed by extra parameters, separated by C<:> "
17525 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17526 "sparsely-allocated disk, containing a single partition, with the partition "
17527 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17528 "on a 1GB disk instead."
17532 #: ../fish/guestfish.pod:996
17533 msgid "To list the available types and any extra parameters they take, run:"
17537 #: ../fish/guestfish.pod:1000
17539 "Note that the prepared filesystem is not mounted. You would usually have to "
17540 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17544 #: ../fish/guestfish.pod:1004
17546 "If any I<-N> or I<--new> options are given, the guest is automatically "
17551 #: ../fish/guestfish.pod:1009
17552 msgid "Create a 100MB disk with an ext4-formatted partition:"
17556 #: ../fish/guestfish.pod:1011
17559 " guestfish -N fs:ext4\n"
17564 #: ../fish/guestfish.pod:1013
17565 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17569 #: ../fish/guestfish.pod:1015
17572 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17577 #: ../fish/guestfish.pod:1017
17578 msgid "Create a blank 200MB disk:"
17582 #: ../fish/guestfish.pod:1019
17585 " guestfish -N disk:200M\n"
17590 #: ../fish/guestfish.pod:1021
17591 msgid "PROGRESS BARS"
17595 #: ../fish/guestfish.pod:1023
17597 "Some (not all) long-running commands send progress notification messages as "
17598 "they are running. Guestfish turns these messages into progress bars."
17602 #: ../fish/guestfish.pod:1027
17604 "When a command that supports progress bars takes longer than two seconds to "
17605 "run, and if progress bars are enabled, then you will see one appearing below "
17610 #: ../fish/guestfish.pod:1031
17613 " ><fs> copy-size /large-file /another-file 2048M\n"
17614 " / 10% [#####-----------------------------------------] 00:30\n"
17619 #: ../fish/guestfish.pod:1034
17621 "The spinner on the left hand side moves round once for every progress "
17622 "notification received from the backend. This is a (reasonably) golden "
17623 "assurance that the command is \"doing something\" even if the progress bar "
17624 "is not moving, because the command is able to send the progress "
17625 "notifications. When the bar reaches 100% and the command finishes, the "
17626 "spinner disappears."
17630 #: ../fish/guestfish.pod:1041
17632 "Progress bars are enabled by default when guestfish is used interactively. "
17633 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17634 "and you can disable them completely using I<--no-progress-bars>."
17638 #: ../fish/guestfish.pod:1046
17639 msgid "GUESTFISH COMMANDS"
17643 #: ../fish/guestfish.pod:1048
17645 "The commands in this section are guestfish convenience commands, in other "
17646 "words, they are not part of the L<guestfs(3)> API."
17650 #: ../fish/guestfish.pod:1051
17655 #: ../fish/guestfish.pod:1053
17664 #: ../fish/guestfish.pod:1056
17665 msgid "Without any parameter, this provides general help."
17669 #: ../fish/guestfish.pod:1058
17670 msgid "With a C<cmd> parameter, this displays detailed help for that command."
17674 #: ../fish/guestfish.pod:1060
17675 msgid "quit | exit"
17679 #: ../fish/guestfish.pod:1062
17680 msgid "This exits guestfish. You can also use C<^D> key."
17684 #: ../fish/guestfish.pod:1064
17685 msgid "@FISH_COMMANDS@"
17689 #: ../fish/guestfish.pod:1066
17694 #: ../fish/guestfish.pod:1068 ../src/guestfs.pod:1474
17699 #: ../fish/guestfish.pod:1070 ../test-tool/libguestfs-test-tool.pod:77
17704 #: ../fish/guestfish.pod:1072
17706 "guestfish returns 0 if the commands completed without error, or 1 if there "
17711 #: ../fish/guestfish.pod:1079
17716 #: ../fish/guestfish.pod:1081
17718 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17723 #: ../fish/guestfish.pod:1084 ../src/guestfs.pod:2969
17724 msgid "FEBOOTSTRAP_KERNEL"
17728 #: ../fish/guestfish.pod:1086 ../src/guestfs.pod:2971
17729 msgid "FEBOOTSTRAP_MODULES"
17733 #: ../fish/guestfish.pod:1088 ../src/guestfs.pod:2973
17735 "These two environment variables allow the kernel that libguestfs uses in the "
17736 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
17737 "most recent host kernel is chosen. For more information about kernel "
17738 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
17739 "available in febootstrap E<ge> 3.8."
17743 #: ../fish/guestfish.pod:1094
17744 msgid "GUESTFISH_DISPLAY_IMAGE"
17748 #: ../fish/guestfish.pod:1096
17750 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
17751 "If not set, it uses L<display(1)>."
17755 #: ../fish/guestfish.pod:1099
17756 msgid "GUESTFISH_PID"
17760 #: ../fish/guestfish.pod:1101
17762 "Used with the I<--remote> option to specify the remote guestfish process to "
17763 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17767 #: ../fish/guestfish.pod:1105
17772 #: ../fish/guestfish.pod:1107
17774 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17775 "not specified, the external L<hexedit(1)> program is used."
17779 #: ../fish/guestfish.pod:1111
17784 #: ../fish/guestfish.pod:1113
17786 "If compiled with GNU readline support, various files in the home directory "
17787 "can be used. See L</FILES>."
17791 #: ../fish/guestfish.pod:1116 ../src/guestfs.pod:2979
17792 msgid "LIBGUESTFS_APPEND"
17796 #: ../fish/guestfish.pod:1118 ../src/guestfs.pod:2981
17797 msgid "Pass additional options to the guest kernel."
17801 #: ../fish/guestfish.pod:1120 ../src/guestfs.pod:2983
17802 msgid "LIBGUESTFS_DEBUG"
17806 #: ../fish/guestfish.pod:1122
17808 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17809 "effect as using the B<-v> option."
17813 #: ../fish/guestfish.pod:1125 ../src/guestfs.pod:2988
17814 msgid "LIBGUESTFS_MEMSIZE"
17818 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2990
17819 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
17823 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:2993
17826 " LIBGUESTFS_MEMSIZE=700\n"
17831 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:2995
17832 msgid "LIBGUESTFS_PATH"
17836 #: ../fish/guestfish.pod:1134
17838 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17839 "the discussion of paths in L<guestfs(3)>."
17843 #: ../fish/guestfish.pod:1137 ../src/guestfs.pod:3000
17844 msgid "LIBGUESTFS_QEMU"
17848 #: ../fish/guestfish.pod:1139 ../src/guestfs.pod:3002
17850 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
17851 "which was found at compile time by the configure script is used."
17855 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:3008
17856 msgid "LIBGUESTFS_TRACE"
17860 #: ../fish/guestfish.pod:1145
17861 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17865 #: ../fish/guestfish.pod:1147
17870 #: ../fish/guestfish.pod:1149
17872 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17877 #: ../fish/guestfish.pod:1152 ../src/guestfs.pod:3013
17882 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3015
17884 "Location of temporary directory, defaults to C</tmp> except for the cached "
17885 "supermin appliance which defaults to C</var/tmp>."
17889 #: ../fish/guestfish.pod:1157 ../src/guestfs.pod:3018
17891 "If libguestfs was compiled to use the supermin appliance then the real "
17892 "appliance is cached in this directory, shared between all handles belonging "
17893 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
17894 "use in case C</var/tmp> is not large enough."
17898 #: ../fish/guestfish.pod:1165 ../fuse/guestmount.pod:288 ../rescue/virt-rescue.pod:269
17903 #: ../fish/guestfish.pod:1169 ../fuse/guestmount.pod:292 ../rescue/virt-rescue.pod:273
17904 msgid "$HOME/.libguestfs-tools.rc"
17908 #: ../fish/guestfish.pod:1171 ../fuse/guestmount.pod:294 ../rescue/virt-rescue.pod:275
17909 msgid "/etc/libguestfs-tools.conf"
17913 #: ../fish/guestfish.pod:1173 ../fuse/guestmount.pod:296 ../rescue/virt-rescue.pod:277
17915 "This configuration file controls the default read-only or read-write mode "
17916 "(I<--ro> or I<--rw>)."
17920 #: ../fish/guestfish.pod:1176
17921 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
17925 #: ../fish/guestfish.pod:1178
17926 msgid "$HOME/.guestfish"
17930 #: ../fish/guestfish.pod:1180
17932 "If compiled with GNU readline support, then the command history is saved in "
17937 #: ../fish/guestfish.pod:1183
17938 msgid "$HOME/.inputrc"
17942 #: ../fish/guestfish.pod:1185
17943 msgid "/etc/inputrc"
17947 #: ../fish/guestfish.pod:1187
17949 "If compiled with GNU readline support, then these files can be used to "
17950 "configure readline. For further information, please see "
17951 "L<readline(3)/INITIALIZATION FILE>."
17955 #: ../fish/guestfish.pod:1191
17956 msgid "To write rules which only apply to guestfish, use:"
17960 #: ../fish/guestfish.pod:1193
17970 #: ../fish/guestfish.pod:1197
17972 "Variables that you can set in inputrc that change the behaviour of guestfish "
17973 "in useful ways include:"
17977 #: ../fish/guestfish.pod:1202
17978 msgid "completion-ignore-case (default: on)"
17982 #: ../fish/guestfish.pod:1204
17984 "By default, guestfish will ignore case when tab-completing paths on the "
17989 #: ../fish/guestfish.pod:1207
17992 " set completion-ignore-case off\n"
17997 #: ../fish/guestfish.pod:1209
17998 msgid "to make guestfish case sensitive."
18002 #: ../fish/guestfish.pod:1213
18007 #: ../fish/guestfish.pod:1215
18008 msgid "test2.img (etc)"
18012 #: ../fish/guestfish.pod:1217
18014 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18015 "will be created in the file C<test1.img> in the current directory. The "
18016 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18017 "the same name will be overwritten."
18021 #: ../fish/guestfish.pod:1226
18023 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18024 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18025 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18026 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18027 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18028 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18029 "L<febootstrap-supermin-helper(8)>."
18033 #: ../fish/guestfish.pod:1255 ../src/guestfs.pod:3104 ../test-tool/libguestfs-test-tool.pod:99
18034 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18038 #: ../fish/virt-copy-in.pod:5
18039 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18043 #: ../fish/virt-copy-in.pod:9
18046 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18051 #: ../fish/virt-copy-in.pod:11
18054 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18059 #: ../fish/virt-copy-in.pod:15
18061 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18062 "causing disk corruption. The virtual machine must be shut down before you "
18063 "use this command."
18067 #: ../fish/virt-copy-in.pod:21
18069 "C<virt-copy-in> copies files and directories from the local disk into a "
18070 "virtual machine disk image or named libvirt domain."
18074 #: ../fish/virt-copy-in.pod:24
18076 "You can give one of more filenames and directories on the command line. "
18077 "Directories are copied in recursively. The final parameter must be the "
18078 "destination directory in the disk image which must be an absolute path "
18079 "starting with a C</> character."
18083 #: ../fish/virt-copy-in.pod:33
18086 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18091 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18092 msgid "Upload a home directory to a guest:"
18096 #: ../fish/virt-copy-in.pod:37
18099 " virt-copy-in -d MyGuest skel /home\n"
18104 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18105 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18109 #: ../fish/virt-copy-in.pod:41
18111 "This command is just a simple shell script wrapper around the "
18112 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
18113 "trivial copy, you are probably better off using guestfish directly."
18117 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18119 "Since the shell script just passes options straight to guestfish, read "
18120 "L<guestfish(1)> to see the full list of options."
18124 #: ../fish/virt-copy-in.pod:52
18126 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18127 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18131 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18132 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18136 #: ../fish/virt-copy-out.pod:5
18138 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18143 #: ../fish/virt-copy-out.pod:9
18146 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18151 #: ../fish/virt-copy-out.pod:11
18154 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18159 #: ../fish/virt-copy-out.pod:15
18161 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18162 "image or named libvirt domain."
18166 #: ../fish/virt-copy-out.pod:18
18168 "You can give one of more filenames and directories on the command line. "
18169 "Directories are copied out recursively."
18173 #: ../fish/virt-copy-out.pod:23
18174 msgid "Download the home directories from a virtual machine:"
18178 #: ../fish/virt-copy-out.pod:25
18182 " virt-copy-out -d MyGuest /home homes\n"
18187 #: ../fish/virt-copy-out.pod:30
18189 "This command is just a simple shell script wrapper around the "
18190 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
18191 "trivial copy, you are probably better off using guestfish directly."
18195 #: ../fish/virt-copy-out.pod:41
18197 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18198 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18202 #: ../fish/virt-tar-in.pod:5
18203 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18207 #: ../fish/virt-tar-in.pod:9
18210 " virt-tar-in -a disk.img data.tar /destination\n"
18215 #: ../fish/virt-tar-in.pod:11
18218 " virt-tar-in -d domain data.tar /destination\n"
18223 #: ../fish/virt-tar-in.pod:13
18226 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18231 #: ../fish/virt-tar-in.pod:17
18233 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18234 "causing disk corruption. The virtual machine must be shut down before you "
18235 "use this command."
18239 #: ../fish/virt-tar-in.pod:23
18241 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18242 "image or named libvirt domain."
18246 #: ../fish/virt-tar-in.pod:26
18248 "The first parameter is the tar file. Use C<-> to read the tar file from "
18249 "standard input. The second parameter is the absolute target directory to "
18254 #: ../fish/virt-tar-in.pod:34
18257 " virt-tar-in -d MyGuest homes.tar /home\n"
18262 #: ../fish/virt-tar-in.pod:38
18264 "This command is just a simple shell script wrapper around the "
18265 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
18266 "copy, you are probably better off using guestfish directly."
18270 #: ../fish/virt-tar-in.pod:49
18272 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18273 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18274 "L<http://libguestfs.org/>."
18278 #: ../fish/virt-tar-out.pod:5
18279 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18283 #: ../fish/virt-tar-out.pod:9
18286 " virt-tar-out -a disk.img /dir files.tar\n"
18291 #: ../fish/virt-tar-out.pod:11
18294 " virt-tar-out -d domain /dir files.tar\n"
18299 #: ../fish/virt-tar-out.pod:13
18302 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18307 #: ../fish/virt-tar-out.pod:17
18308 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18312 #: ../fish/virt-tar-out.pod:20
18314 "The first parameter is the absolute path of the virtual machine directory. "
18315 "The second parameter is the tar file to write. Use C<-> to write to "
18320 #: ../fish/virt-tar-out.pod:26
18321 msgid "Download the home directories from a guest:"
18325 #: ../fish/virt-tar-out.pod:28
18328 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18333 #: ../fish/virt-tar-out.pod:32
18335 "This command is just a simple shell script wrapper around the "
18336 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
18337 "trivial copy, you are probably better off using guestfish directly."
18341 #: ../fish/virt-tar-out.pod:43
18343 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18344 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18348 #: ../fuse/guestmount.pod:5
18349 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18353 #: ../fuse/guestmount.pod:9
18356 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18361 #: ../fuse/guestmount.pod:11
18364 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18369 #: ../fuse/guestmount.pod:13
18372 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18377 #: ../fuse/guestmount.pod:17
18379 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18380 "machines. If you do this, you risk disk corruption in the VM."
18384 #: ../fuse/guestmount.pod:22
18386 "The guestmount program can be used to mount virtual machine filesystems and "
18387 "other disk images on the host. It uses libguestfs for access to the guest "
18388 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18389 "a mountable device."
18393 #: ../fuse/guestmount.pod:27
18395 "Along with other options, you have to give at least one device (I<-a> "
18396 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18397 "option) or use the I<-i> inspection option. How this works is better "
18398 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18403 #: ../fuse/guestmount.pod:33
18405 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18406 "by you, and the filesystem will not be visible to any other users unless you "
18407 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18408 "the filesystem, use the C<fusermount -u> command."
18412 #: ../fuse/guestmount.pod:41
18414 "For a typical Windows guest which has its main filesystem on the first "
18419 #: ../fuse/guestmount.pod:44
18422 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18427 #: ../fuse/guestmount.pod:46
18429 "For a typical Linux guest which has a /boot filesystem on the first "
18430 "partition, and the root filesystem on a logical volume:"
18434 #: ../fuse/guestmount.pod:49
18437 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18442 #: ../fuse/guestmount.pod:51
18443 msgid "To get libguestfs to detect guest mountpoints for you:"
18447 #: ../fuse/guestmount.pod:53
18450 " guestmount -a guest.img -i --ro /mnt\n"
18455 #: ../fuse/guestmount.pod:55
18456 msgid "For a libvirt guest called \"Guest\" you could do:"
18460 #: ../fuse/guestmount.pod:57
18463 " guestmount -d Guest -i --ro /mnt\n"
18468 #: ../fuse/guestmount.pod:59
18470 "If you don't know what filesystems are contained in a guest or disk image, "
18471 "use L<virt-filesystems(1)> first:"
18475 #: ../fuse/guestmount.pod:62
18478 " virt-filesystems MyGuest\n"
18483 #: ../fuse/guestmount.pod:64
18485 "If you want to trace the libguestfs calls but without excessive debugging "
18486 "information, we recommend:"
18490 #: ../fuse/guestmount.pod:67
18493 " guestmount [...] --trace /mnt\n"
18498 #: ../fuse/guestmount.pod:69
18499 msgid "If you want to debug the program, we recommend:"
18503 #: ../fuse/guestmount.pod:71
18506 " guestmount [...] --trace --verbose /mnt\n"
18511 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:486
18516 #: ../fuse/guestmount.pod:75
18517 msgid "Other users cannot see the filesystem by default"
18521 #: ../fuse/guestmount.pod:77
18523 "If you mount a filesystem as one user (eg. root), then other users will not "
18524 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
18525 "option when mounting:"
18529 #: ../fuse/guestmount.pod:81
18532 " sudo guestmount [...] -o allow_other /mnt\n"
18537 #: ../fuse/guestmount.pod:91
18538 msgid "Add a block device or virtual machine image."
18542 #: ../fuse/guestmount.pod:114
18543 msgid "B<--dir-cache-timeout N>"
18547 #: ../fuse/guestmount.pod:116
18549 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18550 "seconds. The readdir cache [actually, there are several semi-independent "
18551 "caches] is populated after a readdir(2) call with the stat and extended "
18552 "attributes of the files in the directory, in anticipation that they will be "
18553 "requested soon after."
18557 #: ../fuse/guestmount.pod:122
18559 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18560 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18561 "requests, only cache existing ones."
18565 #: ../fuse/guestmount.pod:142
18567 "If you have untrusted raw-format guest disk images, you should use this "
18568 "option to specify the disk format. This avoids a possible security problem "
18569 "with malicious guests (CVE-2010-3851). See also "
18570 "L<guestfs(3)/guestfs_add_drive_opts>."
18574 #: ../fuse/guestmount.pod:147
18575 msgid "B<--fuse-help>"
18579 #: ../fuse/guestmount.pod:149
18580 msgid "Display help on special FUSE options (see I<-o> below)."
18584 #: ../fuse/guestmount.pod:153
18585 msgid "Display brief help and exit."
18589 #: ../fuse/guestmount.pod:177
18591 "Mount the named partition or logical volume on the given mountpoint B<in the "
18592 "guest> (this has nothing to do with mountpoints in the host)."
18596 #: ../fuse/guestmount.pod:180
18598 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
18599 "something on C</>."
18603 #: ../fuse/guestmount.pod:197
18605 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
18606 "unmounted. If you specify this option, then we don't attempt to sync the "
18607 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
18611 #: ../fuse/guestmount.pod:202
18612 msgid "B<-o option>"
18616 #: ../fuse/guestmount.pod:204
18617 msgid "B<--option option>"
18621 #: ../fuse/guestmount.pod:206
18622 msgid "Pass extra options to FUSE."
18626 #: ../fuse/guestmount.pod:208
18628 "To get a list of all the extra options supported by FUSE, use the command "
18629 "below. Note that only the FUSE I<-o> options can be passed, and only some "
18630 "of them are a good idea."
18634 #: ../fuse/guestmount.pod:212
18637 " guestmount --fuse-help\n"
18642 #: ../fuse/guestmount.pod:214
18643 msgid "Some potentially useful FUSE options:"
18647 #: ../fuse/guestmount.pod:218
18648 msgid "B<-o allow_other>"
18652 #: ../fuse/guestmount.pod:220
18653 msgid "Allow other users to see the filesystem."
18657 #: ../fuse/guestmount.pod:222
18658 msgid "B<-o attr_timeout=N>"
18662 #: ../fuse/guestmount.pod:224
18663 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
18667 #: ../fuse/guestmount.pod:226
18668 msgid "B<-o kernel_cache>"
18672 #: ../fuse/guestmount.pod:228
18674 "Allow the kernel to cache files (reduces the number of reads that have to go "
18675 "through the L<guestfs(3)> API). This is generally a good idea if you can "
18676 "afford the extra memory usage."
18680 #: ../fuse/guestmount.pod:232
18681 msgid "B<-o uid=N> B<-o gid=N>"
18685 #: ../fuse/guestmount.pod:234
18687 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
18688 "the chosen values."
18692 #: ../fuse/guestmount.pod:243
18694 "Add devices and mount everything read-only. Also disallow writes and make "
18695 "the disk appear read-only to FUSE."
18699 #: ../fuse/guestmount.pod:246
18701 "This is highly recommended if you are not going to edit the guest disk. If "
18702 "the guest is running and this option is I<not> supplied, then there is a "
18703 "strong risk of disk corruption in the guest. We try to prevent this from "
18704 "happening, but it is not always possible."
18708 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
18709 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18713 #: ../fuse/guestmount.pod:255
18714 msgid "Enable SELinux support for the guest."
18718 #: ../fuse/guestmount.pod:261
18719 msgid "Enable verbose messages from underlying libguestfs."
18723 #: ../fuse/guestmount.pod:267
18724 msgid "Display the program version and exit."
18728 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299 ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
18729 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18733 #: ../fuse/guestmount.pod:280
18738 #: ../fuse/guestmount.pod:282
18739 msgid "Trace libguestfs calls and entry into each FUSE function."
18743 #: ../fuse/guestmount.pod:284
18744 msgid "This also stops the daemon from forking into the background."
18748 #: ../fuse/guestmount.pod:305
18750 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
18751 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
18752 "L<http://fuse.sf.net/>."
18756 #: ../fuse/guestmount.pod:320
18757 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
18761 #: ../inspector/virt-inspector.pod:5
18763 "virt-inspector - Display operating system version and other information "
18764 "about a virtual machine"
18768 #: ../inspector/virt-inspector.pod:9
18771 " virt-inspector [--options] -d domname\n"
18776 #: ../inspector/virt-inspector.pod:11
18779 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
18784 #: ../inspector/virt-inspector.pod:15
18787 " virt-inspector domname\n"
18792 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
18795 " virt-inspector disk.img [disk.img ...]\n"
18800 #: ../inspector/virt-inspector.pod:21
18802 "B<virt-inspector> examines a virtual machine or disk image and tries to "
18803 "determine the version of the operating system and other information about "
18804 "the virtual machine."
18808 #: ../inspector/virt-inspector.pod:25
18809 msgid "Virt-inspector produces XML output for feeding into other programs."
18813 #: ../inspector/virt-inspector.pod:27
18815 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
18816 "the libvirt domain (see: C<virsh list --all>)."
18820 #: ../inspector/virt-inspector.pod:30
18822 "You can also run virt-inspector directly on disk images from a single "
18823 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
18824 "has several block devices, in which case you should list several I<-a> "
18825 "options one after another, with the first corresponding to the guest's "
18826 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
18830 #: ../inspector/virt-inspector.pod:37
18832 "You can also run virt-inspector on install disks, live CDs, bootable USB "
18833 "keys and similar."
18837 #: ../inspector/virt-inspector.pod:40
18839 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
18840 "inspect several virtual machines, you have to run virt-inspector several "
18841 "times (for example, from a shell script for-loop)."
18845 #: ../inspector/virt-inspector.pod:45
18847 "Because virt-inspector needs direct access to guest images, it won't "
18848 "normally work over remote libvirt connections."
18852 #: ../inspector/virt-inspector.pod:48
18854 "All of the information available from virt-inspector is also available "
18855 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
18856 "The same information can also be fetched using guestfish or via libguestfs "
18857 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
18858 "WITH OTHER PROGRAMMING LANGUAGES>)."
18862 #: ../inspector/virt-inspector.pod:81
18864 "Libvirt is only used if you specify a C<domname> on the command line. If "
18865 "you specify guest block devices directly (I<-a>), then libvirt is not used "
18870 #: ../inspector/virt-inspector.pod:94
18872 "When prompting for keys and passphrases, virt-inspector normally turns "
18873 "echoing off so you cannot see what you are typing. If you are not worried "
18874 "about Tempest attacks and there is no one else in the room you can specify "
18875 "this flag to see what you are typing."
18879 #: ../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
18881 "Specify the format of disk images given on the command line. If this is "
18882 "omitted then the format is autodetected from the content of the disk image."
18886 #: ../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
18888 "If disk images are requested from libvirt, then this program asks libvirt "
18889 "for this information. In this case, the value of the format parameter is "
18894 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:400 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
18896 "If working with untrusted raw-format guest disk images, you should ensure "
18897 "the format is always specified."
18901 #: ../inspector/virt-inspector.pod:139
18902 msgid "Previous versions of virt-inspector allowed you to write either:"
18906 #: ../inspector/virt-inspector.pod:145
18909 " virt-inspector guestname\n"
18914 #: ../inspector/virt-inspector.pod:153
18919 #: ../inspector/virt-inspector.pod:155
18921 "The virt-inspector XML is described precisely in a RELAX NG schema file "
18922 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
18923 "just an overview."
18927 #: ../inspector/virt-inspector.pod:159
18929 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
18930 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
18931 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
18932 "which is vanishingly rare in real world VMs."
18936 #: ../inspector/virt-inspector.pod:164
18937 msgid "E<lt>operatingsystemE<gt>"
18941 #: ../inspector/virt-inspector.pod:166
18943 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
18944 "describe the operating system, its architecture, the descriptive \"product "
18945 "name\" string, the type of OS and so on, as in this example:"
18949 #: ../inspector/virt-inspector.pod:170
18952 " <operatingsystems>\n"
18953 " <operatingsystem>\n"
18954 " <root>/dev/sda2</root>\n"
18955 " <name>windows</name>\n"
18956 " <arch>i386</arch>\n"
18957 " <distro>windows</distro>\n"
18958 " <product_name>Windows 7 Enterprise</product_name>\n"
18959 " <product_variant>Client</product_variant>\n"
18960 " <major_version>6</major_version>\n"
18961 " <minor_version>1</minor_version>\n"
18962 " <windows_systemroot>/Windows</windows_systemroot>\n"
18963 " <format>installed</format>\n"
18968 #: ../inspector/virt-inspector.pod:183
18970 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
18971 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
18972 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
18973 "architecture. The other fields are fairly self-explanatory, but because "
18974 "these fields are taken directly from the libguestfs inspection API you can "
18975 "find precise information from L<guestfs(3)/INSPECTION>."
18979 #: ../inspector/virt-inspector.pod:191
18981 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
18982 "of view of libguestfs (block devices may have completely different names "
18983 "inside the VM itself)."
18987 #: ../inspector/virt-inspector.pod:195
18988 msgid "E<lt>mountpointsE<gt>"
18992 #: ../inspector/virt-inspector.pod:197
18994 "Un*x-like guests typically have multiple filesystems which are mounted at "
18995 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
18996 "element which looks like this:"
19000 #: ../inspector/virt-inspector.pod:201
19003 " <operatingsystems>\n"
19004 " <operatingsystem>\n"
19007 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19008 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19009 " </mountpoints>\n"
19014 #: ../inspector/virt-inspector.pod:209
19016 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19017 "and may have completely different names inside the guest. Only mountable "
19018 "filesystems appear in this list, not things like swap devices."
19022 #: ../inspector/virt-inspector.pod:214
19023 msgid "E<lt>filesystemsE<gt>"
19027 #: ../inspector/virt-inspector.pod:216
19029 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19030 "filesystems belonging to the guest, including swap and empty partitions. "
19031 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19032 "this OS or shared with this OS and other OSes)."
19036 #: ../inspector/virt-inspector.pod:222
19037 msgid "You might see something like this:"
19041 #: ../inspector/virt-inspector.pod:224
19044 " <operatingsystems>\n"
19045 " <operatingsystem>\n"
19048 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19049 " <type>ext4</type>\n"
19050 " <label>Fedora-13-x86_64</label>\n"
19051 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19057 #: ../inspector/virt-inspector.pod:234
19059 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19060 "the label, and the UUID."
19064 #: ../inspector/virt-inspector.pod:237
19065 msgid "E<lt>applicationsE<gt>"
19069 #: ../inspector/virt-inspector.pod:239
19071 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19072 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19077 #: ../inspector/virt-inspector.pod:243
19079 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19080 "Typical values would be C<rpm> and C<deb>."
19084 #: ../inspector/virt-inspector.pod:246
19086 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19087 "Typical values include C<yum>, C<up2date> and C<apt>"
19091 #: ../inspector/virt-inspector.pod:249
19092 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19096 #: ../inspector/virt-inspector.pod:252
19099 " <operatingsystems>\n"
19100 " <operatingsystem>\n"
19102 " <applications>\n"
19104 " <name>coreutils</name>\n"
19105 " <version>8.5</version>\n"
19106 " <release>1</release>\n"
19107 " </application>\n"
19112 #: ../inspector/virt-inspector.pod:262
19114 "The version and release fields may not be available for some types guests. "
19115 "Other fields are possible, see "
19116 "L<guestfs(3)/guestfs_inspect_list_applications>."
19120 #: ../inspector/virt-inspector.pod:266
19121 msgid "E<lt>drive_mappingsE<gt>"
19125 #: ../inspector/virt-inspector.pod:268
19127 "For operating systems like Windows which use drive letters, virt-inspector "
19128 "is able to find out how drive letters map to filesystems."
19132 #: ../inspector/virt-inspector.pod:272
19135 " <operatingsystems>\n"
19136 " <operatingsystem>\n"
19138 " <drive_mappings>\n"
19139 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19140 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19141 " </drive_mappings>\n"
19146 #: ../inspector/virt-inspector.pod:280
19148 "In the example above, drive C maps to the filesystem on the second partition "
19149 "on the first disk, and drive E maps to the filesystem on the first partition "
19150 "on the second disk."
19154 #: ../inspector/virt-inspector.pod:284
19156 "Note that this only covers permanent local filesystem mappings, not things "
19157 "like network shares. Furthermore NTFS volume mount points may not be listed "
19162 #: ../inspector/virt-inspector.pod:288
19163 msgid "E<lt>iconE<gt>"
19167 #: ../inspector/virt-inspector.pod:290
19169 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19170 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19171 "very large and high quality."
19175 #: ../inspector/virt-inspector.pod:294
19178 " <operatingsystems>\n"
19179 " <operatingsystem>\n"
19182 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19183 " [... many lines of base64 data ...]\n"
19189 #: ../inspector/virt-inspector.pod:302
19191 "To display the icon, you have to extract it and convert the base64 data back "
19192 "to a binary file. Use an XPath query or simply an editor to extract the "
19193 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19198 #: ../inspector/virt-inspector.pod:307
19201 " base64 -i -d < icon.data > icon.png\n"
19206 #: ../inspector/virt-inspector.pod:309
19207 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19211 #: ../inspector/virt-inspector.pod:311
19213 "Virt-inspector can detect some operating system installers on install disks, "
19214 "live CDs, bootable USB keys and more."
19218 #: ../inspector/virt-inspector.pod:314
19220 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19221 "fields may be present to indicate a live CD, network installer, or one part "
19222 "of a multipart CD. For example:"
19226 #: ../inspector/virt-inspector.pod:318
19229 " <operatingsystems>\n"
19230 " <operatingsystem>\n"
19231 " <root>/dev/sda</root>\n"
19232 " <name>linux</name>\n"
19233 " <arch>i386</arch>\n"
19234 " <distro>ubuntu</distro>\n"
19235 " <product_name>Ubuntu 10.10 "Maverick "
19236 "Meerkat"</product_name>\n"
19237 " <major_version>10</major_version>\n"
19238 " <minor_version>10</minor_version>\n"
19239 " <format>installer</format>\n"
19245 #: ../inspector/virt-inspector.pod:330
19246 msgid "USING XPATH"
19250 #: ../inspector/virt-inspector.pod:332
19252 "You can use the XPath query language, and/or the xpath tool, in order to "
19253 "select parts of the XML."
19257 #: ../inspector/virt-inspector.pod:337
19260 " $ virt-inspector -d Guest | xpath //filesystems\n"
19261 " Found 1 nodes:\n"
19264 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19265 " <type>ext4</type>\n"
19271 #: ../inspector/virt-inspector.pod:345
19274 " $ virt-inspector -d Guest | \\\n"
19275 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19276 " Query didn't return a nodeset. Value: ext4\n"
19281 #: ../inspector/virt-inspector.pod:356
19282 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19286 #: ../inspector/virt-inspector.pod:358
19288 "Early versions of libguestfs shipped with a different virt-inspector program "
19289 "written in Perl (the current version is written in C). The XML output of "
19290 "the Perl virt-inspector was different and it could also output in other "
19291 "formats like text."
19295 #: ../inspector/virt-inspector.pod:363
19296 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19300 #: ../inspector/virt-inspector.pod:366
19302 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19303 "versions of virt-inspector with different names:"
19307 #: ../inspector/virt-inspector.pod:369
19310 " virt-inspector Old Perl version.\n"
19311 " virt-inspector2 New C version.\n"
19316 #: ../inspector/virt-inspector.pod:374
19318 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19319 "L<base64(1)>, L<http://libguestfs.org/>."
19323 #: ../inspector/virt-inspector.pod:390
19324 msgid "Matthew Booth L<mbooth@redhat.com>"
19328 #: ../java/examples/guestfs-java.pod:5
19329 msgid "guestfs-java - How to use libguestfs from Java"
19333 #: ../java/examples/guestfs-java.pod:9
19336 " import com.redhat.et.libguestfs.*;\n"
19341 #: ../java/examples/guestfs-java.pod:11
19344 " GuestFS g = new GuestFS ();\n"
19345 " g.add_drive_opts (\"disk.img\", null);\n"
19351 #: ../java/examples/guestfs-java.pod:17
19353 "This manual page documents how to call libguestfs from the Java programming "
19354 "language. This page just documents the differences from the C API and gives "
19355 "some examples. If you are not familiar with using libguestfs, you also need "
19356 "to read L<guestfs(3)>."
19360 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19361 msgid "CLOSING THE HANDLE"
19365 #: ../java/examples/guestfs-java.pod:24
19367 "The handle is closed when it is reaped by the garbage collector. Because "
19368 "libguestfs handles include a lot of state, it is also possible to close (and "
19369 "hence free) them explicitly by calling the C<close> method."
19373 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19378 #: ../java/examples/guestfs-java.pod:31
19380 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19381 "exception. This has a single parameter which is the error message (a "
19386 #: ../java/examples/guestfs-java.pod:35
19387 msgid "Calling any method on a closed handle raises the same exception."
19391 #: ../java/examples/guestfs-java.pod:47
19393 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, "
19394 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19395 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19399 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
19400 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
19404 #: ../ocaml/examples/guestfs-ocaml.pod:5
19405 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19409 #: ../ocaml/examples/guestfs-ocaml.pod:9
19410 msgid "Module style:"
19414 #: ../ocaml/examples/guestfs-ocaml.pod:11
19417 " let g = Guestfs.create () in\n"
19418 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19419 " Guestfs.launch g;\n"
19424 #: ../ocaml/examples/guestfs-ocaml.pod:15
19425 msgid "Object-oriented style:"
19429 #: ../ocaml/examples/guestfs-ocaml.pod:17
19432 " let g = new Guestfs.guestfs () in\n"
19433 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19439 #: ../ocaml/examples/guestfs-ocaml.pod:21
19442 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19444 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19449 #: ../ocaml/examples/guestfs-ocaml.pod:27
19451 "This manual page documents how to call libguestfs from the OCaml programming "
19452 "language. This page just documents the differences from the C API and gives "
19453 "some examples. If you are not familiar with using libguestfs, you also need "
19454 "to read L<guestfs(3)>."
19458 #: ../ocaml/examples/guestfs-ocaml.pod:32
19459 msgid "PROGRAMMING STYLES"
19463 #: ../ocaml/examples/guestfs-ocaml.pod:34
19465 "There are two different programming styles supported by the OCaml bindings. "
19466 "You can use a module style, with each C function mapped to an OCaml "
19471 #: ../ocaml/examples/guestfs-ocaml.pod:38
19474 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19479 #: ../ocaml/examples/guestfs-ocaml.pod:40
19484 #: ../ocaml/examples/guestfs-ocaml.pod:42
19487 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19492 #: ../ocaml/examples/guestfs-ocaml.pod:44
19494 "Alternately you can use an object-oriented style, calling methods on the "
19495 "class C<Guestfs.guestfs>:"
19499 #: ../ocaml/examples/guestfs-ocaml.pod:47
19502 " method set_verbose : bool -> unit\n"
19507 #: ../ocaml/examples/guestfs-ocaml.pod:49
19509 "The object-oriented style is usually briefer, and the minor performance "
19510 "penalty isn't noticable in the general overhead of performing libguestfs "
19515 #: ../ocaml/examples/guestfs-ocaml.pod:55
19517 "The handle is closed when it is reaped by the garbage collector. Because "
19518 "libguestfs handles include a lot of state, it is also possible to close (and "
19519 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19524 #: ../ocaml/examples/guestfs-ocaml.pod:62
19526 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19527 "exception. This has a single parameter which is the error message (a "
19532 #: ../ocaml/examples/guestfs-ocaml.pod:66
19534 "Calling any function/method on a closed handle raises "
19535 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
19540 #: ../ocaml/examples/guestfs-ocaml.pod:80
19542 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19543 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19544 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19548 #: ../perl/examples/guestfs-perl.pod:5
19549 msgid "guestfs-perl - How to use libguestfs from Perl"
19553 #: ../perl/examples/guestfs-perl.pod:9
19556 " use Sys::Guestfs;\n"
19561 #: ../perl/examples/guestfs-perl.pod:11
19564 " my $h = Sys::Guestfs->new ();\n"
19565 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
19566 " $h->launch ();\n"
19567 " $h->mount_options ('', '/dev/sda1', '/');\n"
19568 " $h->touch ('/hello');\n"
19574 #: ../perl/examples/guestfs-perl.pod:20
19576 "This manual page documents how to call libguestfs from the Perl programming "
19577 "language. This page just documents the differences from the C API and gives "
19578 "some examples. If you are not familiar with using libguestfs, you also need "
19579 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
19583 #: ../perl/examples/guestfs-perl.pod:26
19588 #: ../perl/examples/guestfs-perl.pod:28
19590 "Errors from libguestfs functions turn into calls to C<croak> (see "
19595 #: ../perl/examples/guestfs-perl.pod:41
19597 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
19598 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
19599 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19603 #: ../python/examples/guestfs-python.pod:5
19604 msgid "guestfs-python - How to use libguestfs from Python"
19608 #: ../python/examples/guestfs-python.pod:9
19611 " import guestfs\n"
19612 " g = guestfs.GuestFS ()\n"
19613 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
19619 #: ../python/examples/guestfs-python.pod:16
19621 "This manual page documents how to call libguestfs from the Python "
19622 "programming language. This page just documents the differences from the C "
19623 "API and gives some examples. If you are not familiar with using libguestfs, "
19624 "you also need to read L<guestfs(3)>."
19628 #: ../python/examples/guestfs-python.pod:23
19630 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
19631 "single string argument which is the error message."
19635 #: ../python/examples/guestfs-python.pod:26
19636 msgid "MORE DOCUMENTATION"
19640 #: ../python/examples/guestfs-python.pod:28
19645 #: ../python/examples/guestfs-python.pod:30
19649 " >>> import guestfs\n"
19650 " >>> help (guestfs)\n"
19655 #: ../python/examples/guestfs-python.pod:44
19657 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19658 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
19659 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19663 #: ../rescue/virt-rescue.pod:5
19664 msgid "virt-rescue - Run a rescue shell on a virtual machine"
19668 #: ../rescue/virt-rescue.pod:9
19671 " virt-rescue [--options] -d domname\n"
19676 #: ../rescue/virt-rescue.pod:11
19679 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
19684 #: ../rescue/virt-rescue.pod:15
19687 " virt-rescue [--options] domname\n"
19692 #: ../rescue/virt-rescue.pod:17
19695 " virt-rescue [--options] disk.img [disk.img ...]\n"
19700 #: ../rescue/virt-rescue.pod:21
19702 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
19703 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
19704 "you from doing this, but doesn't catch all cases."
19708 #: ../rescue/virt-rescue.pod:25
19710 "However if you use the I<--ro> (read only) option, then you can attach a "
19711 "shell to a live virtual machine. The results might be strange or "
19712 "inconsistent at times but you won't get disk corruption."
19716 #: ../rescue/virt-rescue.pod:31
19718 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
19719 "need for a CD. virt-rescue gives you a rescue shell and some simple "
19720 "recovery tools which you can use to examine or rescue a virtual machine or "
19725 #: ../rescue/virt-rescue.pod:36
19727 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
19728 "on disk image(s):"
19732 #: ../rescue/virt-rescue.pod:39
19735 " virt-rescue -d GuestName\n"
19740 #: ../rescue/virt-rescue.pod:41
19743 " virt-rescue --ro -a /path/to/disk.img\n"
19748 #: ../rescue/virt-rescue.pod:43
19751 " virt-rescue -a /dev/sdc\n"
19756 #: ../rescue/virt-rescue.pod:45
19757 msgid "For live VMs you I<must> use the --ro option."
19761 #: ../rescue/virt-rescue.pod:47
19763 "When you run virt-rescue on a virtual machine or disk image, you are placed "
19764 "in an interactive bash shell where you can use many ordinary Linux "
19765 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
19766 "appliance. You must mount the virtual machine's filesystems by hand. There "
19767 "is an empty directory called C</sysroot> where you can mount filesystems."
19771 #: ../rescue/virt-rescue.pod:54
19773 "In the example below, we list logical volumes, then choose one to mount "
19774 "under C</sysroot>:"
19778 #: ../rescue/virt-rescue.pod:57
19782 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
19783 " lv_root vg_f11x64 -wi-a- 8.83G\n"
19784 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
19785 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
19786 " ><rescue> ls /sysroot\n"
19791 #: ../rescue/virt-rescue.pod:64
19793 "If you don't know what filesystems are available on the virtual machine then "
19794 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
19798 #: ../rescue/virt-rescue.pod:70
19800 "Virt-rescue can be used on I<any> disk image file or device, not just a "
19801 "virtual machine. For example you can use it on a blank file if you want to "
19802 "partition that file (although we would recommend using L<guestfish(1)> "
19803 "instead as it is more suitable for this purpose). You can even use "
19804 "virt-rescue on things like SD cards."
19808 #: ../rescue/virt-rescue.pod:76
19810 "Virt-rescue does not require root. You only need to run it as root if you "
19811 "need root to open the disk image."
19815 #: ../rescue/virt-rescue.pod:79
19817 "This tool is just designed for quick interactive hacking on a virtual "
19818 "machine. For more structured access to a virtual machine disk image, you "
19819 "should use L<guestfs(3)>. To get a structured shell that you can use to "
19820 "make scripted changes to guests, use L<guestfish(1)>."
19824 #: ../rescue/virt-rescue.pod:103
19825 msgid "B<--append kernelopts>"
19829 #: ../rescue/virt-rescue.pod:105
19830 msgid "Pass additional options to the rescue kernel."
19834 #: ../rescue/virt-rescue.pod:135
19837 " virt-rescue --format=raw -a disk.img\n"
19842 #: ../rescue/virt-rescue.pod:139
19845 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
19850 #: ../rescue/virt-rescue.pod:148
19855 #: ../rescue/virt-rescue.pod:150
19856 msgid "B<--memsize MB>"
19860 #: ../rescue/virt-rescue.pod:152
19862 "Change the amount of memory allocated to the rescue system. The default is "
19863 "set by libguestfs and is small but adequate for running system tools. The "
19864 "occasional program might need more memory. The parameter is specified in "
19869 #: ../rescue/virt-rescue.pod:157
19870 msgid "B<--network>"
19874 #: ../rescue/virt-rescue.pod:159
19875 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
19879 #: ../rescue/virt-rescue.pod:165
19880 msgid "Open the image read-only."
19884 #: ../rescue/virt-rescue.pod:175
19886 "Enable SELinux in the rescue appliance. You should read "
19887 "L<guestfs(3)/SELINUX> before using this option."
19891 #: ../rescue/virt-rescue.pod:194
19893 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
19894 "are done read-write."
19898 #: ../rescue/virt-rescue.pod:207
19899 msgid "Previous versions of virt-rescue allowed you to write either:"
19903 #: ../rescue/virt-rescue.pod:209
19906 " virt-rescue disk.img [disk.img ...]\n"
19911 #: ../rescue/virt-rescue.pod:213
19914 " virt-rescue guestname\n"
19919 #: ../rescue/virt-rescue.pod:221
19924 #: ../rescue/virt-rescue.pod:223
19926 "Adding the I<--network> option enables QEMU user networking in the rescue "
19927 "appliance. There are some differences between user networking and ordinary "
19932 #: ../rescue/virt-rescue.pod:229
19933 msgid "ping does not work"
19937 #: ../rescue/virt-rescue.pod:231
19939 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
19940 "send the ping packets, and because virt-rescue must be able to run as "
19941 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
19942 "command. The ping command will appear to resolve addresses but will not be "
19943 "able to send or receive any packets. This does not mean that the network is "
19948 #: ../rescue/virt-rescue.pod:238
19949 msgid "cannot receive connections"
19953 #: ../rescue/virt-rescue.pod:240
19954 msgid "QEMU user networking cannot receive incoming connections."
19958 #: ../rescue/virt-rescue.pod:242
19959 msgid "making TCP connections"
19963 #: ../rescue/virt-rescue.pod:244
19965 "The virt-rescue appliance needs to be small and so does not include many "
19966 "network tools. In particular there is no L<telnet(1)> command. You can "
19967 "make TCP connections from the shell using the magical "
19968 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
19972 #: ../rescue/virt-rescue.pod:249
19975 " exec 3<>/dev/tcp/redhat.com/80\n"
19976 " echo \"GET /\" >&3\n"
19982 #: ../rescue/virt-rescue.pod:253
19983 msgid "See L<bash(1)> for more details."
19987 #: ../rescue/virt-rescue.pod:259
19989 "Several environment variables affect virt-rescue. See "
19990 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
19994 #: ../rescue/virt-rescue.pod:286
19996 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19997 "L<http://libguestfs.org/>."
20001 #: ../resize/virt-resize.pod:5
20002 msgid "virt-resize - Resize a virtual machine disk"
20006 #: ../resize/virt-resize.pod:9
20009 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20010 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20011 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20016 #: ../resize/virt-resize.pod:15
20018 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20019 "larger or smaller overall, and resizing or deleting any partitions contained "
20024 #: ../resize/virt-resize.pod:19
20026 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20027 "not> be used on live virtual machines - for consistent results, shut the "
20028 "virtual machine down before resizing it."
20032 #: ../resize/virt-resize.pod:23
20034 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20035 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20039 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2465
20044 #: ../resize/virt-resize.pod:33
20046 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20047 "fill the extra 5GB of space."
20051 #: ../resize/virt-resize.pod:36
20054 " virt-filesystems --long -h --all -a olddisk\n"
20059 #: ../resize/virt-resize.pod:38
20062 " truncate -r olddisk newdisk\n"
20063 " truncate -s +5G newdisk\n"
20068 #: ../resize/virt-resize.pod:41
20071 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20072 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20077 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2490
20082 #: ../resize/virt-resize.pod:46
20084 "As above, but make the /boot partition 200MB bigger, while giving the "
20085 "remaining space to /dev/sda2:"
20089 #: ../resize/virt-resize.pod:49
20092 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20093 " olddisk newdisk\n"
20098 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1405
20103 #: ../resize/virt-resize.pod:54
20105 "As in the first example, but expand a logical volume as the final step. "
20106 "This is what you would typically use for Linux guests that use LVM:"
20110 #: ../resize/virt-resize.pod:58
20113 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20114 " olddisk newdisk\n"
20119 #: ../resize/virt-resize.pod:61
20124 #: ../resize/virt-resize.pod:63
20126 "As in the first example, but the output format will be qcow2 instead of a "
20131 #: ../resize/virt-resize.pod:66
20134 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20135 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20140 #: ../resize/virt-resize.pod:71
20141 msgid "DETAILED USAGE"
20145 #: ../resize/virt-resize.pod:73
20146 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20150 #: ../resize/virt-resize.pod:77
20151 msgid "1. Shut down the virtual machine"
20155 #: ../resize/virt-resize.pod:79
20156 msgid "2. Locate input disk image"
20160 #: ../resize/virt-resize.pod:81
20162 "Locate the input disk image (ie. the file or device on the host containing "
20163 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20164 "dumpxml> like this to find the disk image name:"
20168 #: ../resize/virt-resize.pod:85
20171 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20172 " Found 1 nodes:\n"
20174 " <source dev=\"/dev/vg/lv_guest\" />\n"
20179 #: ../resize/virt-resize.pod:90
20180 msgid "3. Look at current sizing"
20184 #: ../resize/virt-resize.pod:92
20185 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20189 #: ../resize/virt-resize.pod:95
20192 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20193 " Name Type Size Parent\n"
20194 " /dev/sda1 partition 101M /dev/sda\n"
20195 " /dev/sda2 partition 7.9G /dev/sda\n"
20196 " /dev/sda device 8.0G -\n"
20201 #: ../resize/virt-resize.pod:101
20203 "(This example is a virtual machine with an 8 GB disk which we would like to "
20204 "expand up to 10 GB)."
20208 #: ../resize/virt-resize.pod:104
20209 msgid "4. Create output disk"
20213 #: ../resize/virt-resize.pod:106
20215 "Virt-resize cannot do in-place disk modifications. You have to have space "
20216 "to store the resized output disk."
20220 #: ../resize/virt-resize.pod:109
20221 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20225 #: ../resize/virt-resize.pod:112
20228 " # rm -f outdisk\n"
20229 " # truncate -s 10G outdisk\n"
20234 #: ../resize/virt-resize.pod:115
20235 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20239 #: ../resize/virt-resize.pod:117
20242 " # lvcreate -L 10G -n lv_name vg_name\n"
20247 #: ../resize/virt-resize.pod:119
20248 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20252 #: ../resize/virt-resize.pod:121
20255 " # virsh pool-list\n"
20256 " # virsh vol-create-as poolname newvol 10G\n"
20261 #: ../resize/virt-resize.pod:124
20266 #: ../resize/virt-resize.pod:126
20268 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20269 "file) and the output disk. The output disk is the one created in the "
20274 #: ../resize/virt-resize.pod:130
20277 " # virt-resize indisk outdisk\n"
20282 #: ../resize/virt-resize.pod:132
20284 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20285 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20286 "larger, then an extra, empty partition is created at the end of the disk "
20287 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20292 #: ../resize/virt-resize.pod:138
20294 "More realistically you'd want to expand existing partitions in the disk "
20295 "image by passing extra options (for the full list see the L</OPTIONS> "
20300 #: ../resize/virt-resize.pod:142
20302 "L</--expand> is the most useful option. It expands the named partition "
20303 "within the disk to fill any extra space:"
20307 #: ../resize/virt-resize.pod:145
20310 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20315 #: ../resize/virt-resize.pod:147
20317 "(In this case, an extra partition is I<not> created at the end of the disk, "
20318 "because there will be no unused space)."
20322 #: ../resize/virt-resize.pod:150
20324 "L</--resize> is the other commonly used option. The following would "
20325 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20326 "rest of the available space:"
20330 #: ../resize/virt-resize.pod:154
20333 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20334 " indisk outdisk\n"
20339 #: ../resize/virt-resize.pod:157
20341 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20342 "if virt-resize knows how, it will resize the contents, the equivalent of "
20343 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20344 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20345 "filesystems, so you would have to online resize them after booting the "
20350 #: ../resize/virt-resize.pod:164
20351 msgid "Other options are covered below."
20355 #: ../resize/virt-resize.pod:166
20360 #: ../resize/virt-resize.pod:168
20361 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20365 #: ../resize/virt-resize.pod:170
20366 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20370 #: ../resize/virt-resize.pod:172
20373 " # virsh edit guestname\n"
20378 #: ../resize/virt-resize.pod:174
20380 "Change E<lt>source ...E<gt>, see "
20381 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20385 #: ../resize/virt-resize.pod:177
20386 msgid "Then start up the domain with the new, resized disk:"
20390 #: ../resize/virt-resize.pod:179
20393 " # virsh start guestname\n"
20398 #: ../resize/virt-resize.pod:181
20400 "and check that it still works. See also the L</NOTES> section below for "
20401 "additional information."
20405 #: ../resize/virt-resize.pod:184
20406 msgid "7. Resize LVs etc inside the guest"
20410 #: ../resize/virt-resize.pod:186
20411 msgid "(This can also be done offline using L<guestfish(1)>)"
20415 #: ../resize/virt-resize.pod:188
20417 "Once the guest has booted you should see the new space available, at least "
20418 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20419 "may need to resize LVs inside PVs, and also resize filesystem types that "
20420 "virt-resize does not know how to expand."
20424 #: ../resize/virt-resize.pod:195
20425 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20429 #: ../resize/virt-resize.pod:197
20431 "Shrinking is somewhat more complex than expanding, and only an overview is "
20436 #: ../resize/virt-resize.pod:200
20438 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20439 "filesystems). The user has to shrink content before passing the disk image "
20440 "to virt-resize, and virt-resize will check that the content has been shrunk "
20445 #: ../resize/virt-resize.pod:205
20446 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20450 #: ../resize/virt-resize.pod:207
20452 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20453 "steps 3 and 4 above to allocate a new disk image."
20457 #: ../resize/virt-resize.pod:210
20458 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20462 #: ../resize/virt-resize.pod:213
20463 msgid "IGNORING OR DELETING PARTITIONS"
20467 #: ../resize/virt-resize.pod:215
20469 "virt-resize also gives a convenient way to ignore or delete partitions when "
20470 "copying from the input disk to the output disk. Ignoring a partition speeds "
20471 "up the copy where you don't care about the existing contents of a "
20472 "partition. Deleting a partition removes it completely, but note that it "
20473 "also renumbers any partitions after the one which is deleted, which can "
20474 "leave some guests unbootable."
20478 #: ../resize/virt-resize.pod:222
20479 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20483 #: ../resize/virt-resize.pod:224
20485 "If the input disk is in qcow2 format, then you may prefer that the output is "
20486 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
20487 "the fly. The output format is simply determined by the format of the empty "
20488 "output container that you provide. Thus to create qcow2 output, use:"
20492 #: ../resize/virt-resize.pod:230
20495 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20500 #: ../resize/virt-resize.pod:232
20501 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20505 #: ../resize/virt-resize.pod:234
20506 msgid "Similarly, to get non-sparse raw output use:"
20510 #: ../resize/virt-resize.pod:236
20513 " fallocate -l size outdisk\n"
20518 #: ../resize/virt-resize.pod:238
20520 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20521 "if=/dev/zero of=outdisk bs=1M count=..>)"
20525 #: ../resize/virt-resize.pod:247
20526 msgid "Display help."
20530 #: ../resize/virt-resize.pod:249
20535 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20540 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20541 msgid "Enable debugging messages."
20545 #: ../resize/virt-resize.pod:255
20546 msgid "B<--delete part>"
20550 #: ../resize/virt-resize.pod:257
20552 "Delete the named partition. It would be more accurate to describe this as "
20553 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
20554 "the original disk image is left intact."
20558 #: ../resize/virt-resize.pod:261
20560 "Note that when you delete a partition, then anything contained in the "
20561 "partition is also deleted. Furthermore, this causes any partitions that "
20562 "come after to be I<renumbered>, which can easily make your guest unbootable."
20566 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:448
20567 msgid "You can give this option multiple times."
20571 #: ../resize/virt-resize.pod:268
20572 msgid "B<--expand part>"
20576 #: ../resize/virt-resize.pod:270
20578 "Expand the named partition so it uses up all extra space (space left over "
20579 "after any other resize changes that you request have been done)."
20583 #: ../resize/virt-resize.pod:273
20585 "If virt-resize knows how, it will expand the direct content of the "
20586 "partition. For example, if the partition is an LVM PV, it will expand the "
20587 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
20588 "content it doesn't know about alone."
20592 #: ../resize/virt-resize.pod:278
20593 msgid "Currently virt-resize can resize:"
20597 #: ../resize/virt-resize.pod:284
20598 msgid "ext2, ext3 and ext4 filesystems."
20602 #: ../resize/virt-resize.pod:288
20603 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
20607 #: ../resize/virt-resize.pod:290
20609 "The filesystem must have been shut down consistently last time it was used. "
20610 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
20611 "consistency check, so at the first boot after resizing Windows will check "
20616 #: ../resize/virt-resize.pod:297
20618 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
20619 "inside the PV, but see the I<--LV-expand> option. The user could also "
20620 "resize LVs as desired after boot."
20624 #: ../resize/virt-resize.pod:303
20625 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
20629 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:476
20630 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
20634 #: ../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
20635 msgid "B<--format> raw"
20639 #: ../resize/virt-resize.pod:311
20641 "Specify the format of the input disk image. If this flag is not given then "
20642 "it is auto-detected from the image itself."
20646 #: ../resize/virt-resize.pod:317
20648 "Note that this option I<does not> affect the output format. See L</QCOW2 "
20649 "AND NON-SPARSE RAW FORMATS>."
20653 #: ../resize/virt-resize.pod:320
20654 msgid "B<--ignore part>"
20658 #: ../resize/virt-resize.pod:322
20660 "Ignore the named partition. Effectively this means the partition is "
20661 "allocated on the destination disk, but the content is not copied across from "
20662 "the source disk. The content of the partition will be blank (all zero "
20667 #: ../resize/virt-resize.pod:329
20668 msgid "B<--LV-expand logvol>"
20672 #: ../resize/virt-resize.pod:331
20674 "This takes the logical volume and, as a final step, expands it to fill all "
20675 "the space available in its volume group. A typical usage, assuming a Linux "
20676 "guest with a single PV C</dev/sda2> and a root device called "
20677 "C</dev/vg_guest/lv_root> would be:"
20681 #: ../resize/virt-resize.pod:336
20684 " virt-resize indisk outdisk \\\n"
20685 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
20690 #: ../resize/virt-resize.pod:339
20692 "This would first expand the partition (and PV), and then expand the root "
20693 "device to fill the extra space in the PV."
20697 #: ../resize/virt-resize.pod:342
20699 "The contents of the LV are also resized if virt-resize knows how to do "
20700 "that. You can stop virt-resize from trying to expand the content by using "
20701 "the option I<--no-expand-content>."
20705 #: ../resize/virt-resize.pod:346
20706 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
20710 #: ../resize/virt-resize.pod:348
20712 "You can give this option multiple times, I<but> it doesn't make sense to do "
20713 "this unless the logical volumes you specify are all in different volume "
20718 #: ../resize/virt-resize.pod:354
20719 msgid "B<--dryrun>"
20723 #: ../resize/virt-resize.pod:356
20724 msgid "Print a summary of what would be done, but don't do anything."
20728 #: ../resize/virt-resize.pod:358
20729 msgid "B<--no-copy-boot-loader>"
20733 #: ../resize/virt-resize.pod:360
20735 "By default, virt-resize copies over some sectors at the start of the disk "
20736 "(up to the beginning of the first partition). Commonly these sectors "
20737 "contain the Master Boot Record (MBR) and the boot loader, and are required "
20738 "in order for the guest to boot correctly."
20742 #: ../resize/virt-resize.pod:365
20744 "If you specify this flag, then this initial copy is not done. You may need "
20745 "to reinstall the boot loader in this case."
20749 #: ../resize/virt-resize.pod:368
20750 msgid "B<--no-extra-partition>"
20754 #: ../resize/virt-resize.pod:370
20756 "By default, virt-resize creates an extra partition if there is any extra, "
20757 "unused space after all resizing has happened. Use this option to prevent "
20758 "the extra partition from being created. If you do this then the extra space "
20759 "will be inaccessible until you run fdisk, parted, or some other partitioning "
20760 "tool in the guest."
20764 #: ../resize/virt-resize.pod:376
20766 "Note that if the surplus space is smaller than 10 MB, no extra partition "
20771 #: ../resize/virt-resize.pod:379
20772 msgid "B<--no-expand-content>"
20776 #: ../resize/virt-resize.pod:381
20778 "By default, virt-resize will try to expand the direct contents of "
20779 "partitions, if it knows how (see I<--expand> option above)."
20783 #: ../resize/virt-resize.pod:384
20785 "If you give the I<--no-expand-content> option then virt-resize will not "
20790 #: ../resize/virt-resize.pod:387
20791 msgid "B<--ntfsresize-force>"
20795 #: ../resize/virt-resize.pod:389
20797 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
20798 "the NTFS disk is marked as needing a consistency check. You have to use "
20799 "this option if you want to resize a Windows guest multiple times without "
20800 "booting into Windows between each resize."
20804 #: ../resize/virt-resize.pod:395
20805 msgid "B<--output-format> raw"
20809 #: ../resize/virt-resize.pod:397
20811 "Specify the format of the output disk image. If this flag is not given then "
20812 "it is auto-detected from the image itself."
20816 #: ../resize/virt-resize.pod:403
20818 "Note that this option I<does not create> the output format. This option "
20819 "just tells libguestfs what it is so it doesn't try to guess it. You still "
20820 "need to create the output disk with the right format. See L</QCOW2 AND "
20821 "NON-SPARSE RAW FORMATS>."
20825 #: ../resize/virt-resize.pod:408
20830 #: ../resize/virt-resize.pod:410
20835 #: ../resize/virt-resize.pod:412
20836 msgid "Don't print the summary."
20840 #: ../resize/virt-resize.pod:414
20841 msgid "B<--resize part=size>"
20845 #: ../resize/virt-resize.pod:416
20847 "Resize the named partition (expanding or shrinking it) so that it has the "
20852 #: ../resize/virt-resize.pod:419
20854 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
20855 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
20856 "size; or as a relative number or percentage. For example:"
20860 #: ../resize/virt-resize.pod:425
20863 " --resize /dev/sda2=10G\n"
20868 #: ../resize/virt-resize.pod:427
20871 " --resize /dev/sda4=90%\n"
20876 #: ../resize/virt-resize.pod:429
20879 " --resize /dev/sda2=+1G\n"
20884 #: ../resize/virt-resize.pod:431
20887 " --resize /dev/sda2=-200M\n"
20892 #: ../resize/virt-resize.pod:433
20895 " --resize /dev/sda1=+128K\n"
20900 #: ../resize/virt-resize.pod:435
20903 " --resize /dev/sda1=+10%\n"
20908 #: ../resize/virt-resize.pod:437
20911 " --resize /dev/sda1=-10%\n"
20916 #: ../resize/virt-resize.pod:439
20918 "You can increase the size of any partition. Virt-resize will expand the "
20919 "direct content of the partition if it knows how (see I<--expand> below)."
20923 #: ../resize/virt-resize.pod:443
20925 "You can only I<decrease> the size of partitions that contain filesystems or "
20926 "PVs which have already been shrunk. Virt-resize will check this has been "
20927 "done before proceeding, or else will print an error (see also "
20928 "I<--resize-force>)."
20932 #: ../resize/virt-resize.pod:450
20933 msgid "B<--resize-force part=size>"
20937 #: ../resize/virt-resize.pod:452
20939 "This is the same as I<--resize> except that it will let you decrease the "
20940 "size of any partition. Generally this means you will lose any data which "
20941 "was at the end of the partition you shrink, but you may not care about that "
20942 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
20943 "as a swap partition)."
20947 #: ../resize/virt-resize.pod:458
20948 msgid "See also the I<--ignore> option."
20952 #: ../resize/virt-resize.pod:460
20953 msgid "B<--shrink part>"
20957 #: ../resize/virt-resize.pod:462
20959 "Shrink the named partition until the overall disk image fits in the "
20960 "destination. The named partition B<must> contain a filesystem or PV which "
20961 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
20962 "online tools). Virt-resize will check this and give an error if it has not "
20967 #: ../resize/virt-resize.pod:468
20969 "The amount by which the overall disk must be shrunk (after carrying out all "
20970 "other operations requested by the user) is called the \"deficit\". For "
20971 "example, a straight copy (assume no other operations) from a 5GB disk image "
20972 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
20973 "would give an error unless the user specified a partition to shrink and that "
20974 "partition had more than a gigabyte of free space."
20978 #: ../resize/virt-resize.pod:488
20979 msgid "\"Partition 1 does not end on cylinder boundary.\""
20983 #: ../resize/virt-resize.pod:490
20985 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
20986 "means the partitions will not be aligned to the ancient CHS geometry. "
20987 "However CHS geometry is meaningless for disks manufactured since the early "
20988 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
20989 "cylinders is not required by any modern operating system."
20993 #: ../resize/virt-resize.pod:497
20994 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
20998 #: ../resize/virt-resize.pod:499
21000 "In Windows Vista and later versions, Microsoft switched to using a separate "
21001 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21002 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21003 "the boot partition. Doing so seems to break the guest completely. However "
21004 "expanding the second partition (ie. C: drive) should work."
21008 #: ../resize/virt-resize.pod:506
21010 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21011 "NTFS partitions have been expanded. This is just a safety check and (unless "
21012 "it find errors) is nothing to worry about."
21016 #: ../resize/virt-resize.pod:510
21017 msgid "GUEST BOOT STUCK AT \"GRUB\""
21021 #: ../resize/virt-resize.pod:512
21023 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21024 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21025 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21026 "although we think is to do with partition alignment."
21030 #: ../resize/virt-resize.pod:517
21033 " guestfish -i -a newdisk\n"
21034 " ><fs> cat /boot/grub/device.map\n"
21035 " # check the contents of this file are sensible or\n"
21036 " # edit the file if necessary\n"
21037 " ><fs> grub-install / /dev/vda\n"
21043 #: ../resize/virt-resize.pod:524
21045 "For more flexible guest reconfiguration, including if you need to specify "
21046 "other parameters to grub-install, use L<virt-rescue(1)>."
21050 #: ../resize/virt-resize.pod:527
21051 msgid "ALTERNATIVE TOOLS"
21055 #: ../resize/virt-resize.pod:529
21057 "There are several proprietary tools for resizing partitions. We won't "
21058 "mention any here."
21062 #: ../resize/virt-resize.pod:532
21064 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21065 "operations on disk images. They can resize and move partitions, but I don't "
21066 "think they can do anything with the contents, and they certainly don't "
21071 #: ../resize/virt-resize.pod:537
21073 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21074 "but at a much lower level. You will probably end up hand-calculating sector "
21075 "offsets, which is something that virt-resize was designed to avoid. If you "
21076 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21081 #: ../resize/virt-resize.pod:552
21083 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21084 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21085 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21086 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21087 "L<http://libguestfs.org/>."
21091 #: ../ruby/examples/guestfs-ruby.pod:5
21092 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21096 #: ../ruby/examples/guestfs-ruby.pod:9
21099 " require 'guestfs'\n"
21100 " g = Guestfs::Guestfs.new()\n"
21101 " g.add_drive_opts(\"disk.img\",\n"
21102 " :readonly => 1, :format => \"raw\")\n"
21108 #: ../ruby/examples/guestfs-ruby.pod:17
21110 "This manual page documents how to call libguestfs from the Ruby programming "
21111 "language. This page just documents the differences from the C API and gives "
21112 "some examples. If you are not familiar with using libguestfs, you also need "
21113 "to read L<guestfs(3)>."
21117 #: ../ruby/examples/guestfs-ruby.pod:24
21119 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21120 "This has a single parameter which is the error message (a string)."
21124 #: ../ruby/examples/guestfs-ruby.pod:38
21126 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
21127 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21128 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21132 #: ../src/guestfs-actions.pod:1
21133 msgid "guestfs_add_cdrom"
21137 #: ../src/guestfs-actions.pod:3
21141 " guestfs_add_cdrom (guestfs_h *g,\n"
21142 " const char *filename);\n"
21147 #: ../src/guestfs-actions.pod:17
21149 "This call checks for the existence of C<filename>. This stops you from "
21150 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21151 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21156 #: ../src/guestfs-actions.pod:24
21158 "If you just want to add an ISO file (often you use this as an efficient way "
21159 "to transfer large files into the guest), then you should probably use "
21160 "C<guestfs_add_drive_ro> instead."
21164 #: ../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:422 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304 ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508 ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4205 ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:4253 ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4282 ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4623 ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5065 ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5250 ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5460 ../src/guestfs-actions.pod:5517 ../src/guestfs-actions.pod:5539 ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5589 ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5699 ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6026 ../src/guestfs-actions.pod:6040 ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6066 ../src/guestfs-actions.pod:6078 ../src/guestfs-actions.pod:6092 ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6129 ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6379 ../src/guestfs-actions.pod:6403 ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6465 ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6499 ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6566 ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6854 ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915 ../src/guestfs-actions.pod:6928 ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6956 ../src/guestfs-actions.pod:7015 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7081 ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7150 ../src/guestfs-actions.pod:7164 ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218 ../src/guestfs-actions.pod:7236 ../src/guestfs-actions.pod:7270 ../src/guestfs-actions.pod:7306 ../src/guestfs-actions.pod:7422 ../src/guestfs-actions.pod:7437 ../src/guestfs-actions.pod:7451 ../src/guestfs-actions.pod:7506 ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7597 ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:7680 ../src/guestfs-actions.pod:7706 ../src/guestfs-actions.pod:7773 ../src/guestfs-actions.pod:7792 ../src/guestfs-actions.pod:7821
21165 msgid "This function returns 0 on success or -1 on error."
21169 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275
21171 "This function is deprecated. In new code, use the "
21172 "L</guestfs_add_drive_opts> call instead."
21176 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2192 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:6217 ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6467 ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:7083 ../src/guestfs-actions.pod:7606
21177 msgid "(Added in 0.3)"
21181 #: ../src/guestfs-actions.pod:41
21182 msgid "guestfs_add_domain"
21186 #: ../src/guestfs-actions.pod:43
21190 " guestfs_add_domain (guestfs_h *g,\n"
21191 " const char *dom,\n"
21197 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4961 ../src/guestfs-actions.pod:5178
21199 "You may supply a list of optional arguments to this call. Use zero or more "
21200 "of the following pairs of parameters, and terminate the list with C<-1> on "
21201 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21205 #: ../src/guestfs-actions.pod:53
21208 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21209 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21210 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21211 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21212 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21217 #: ../src/guestfs-actions.pod:59
21219 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21220 "It works by connecting to libvirt, requesting the domain and domain XML from "
21221 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21226 #: ../src/guestfs-actions.pod:94
21228 "The other optional parameters are passed directly through to "
21229 "C<guestfs_add_drive_opts>."
21233 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380 ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:2179 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:5137 ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7617 ../src/guestfs-actions.pod:7630 ../src/guestfs-actions.pod:7643
21234 msgid "On error this function returns -1."
21238 #: ../src/guestfs-actions.pod:99
21239 msgid "(Added in 1.7.4)"
21243 #: ../src/guestfs-actions.pod:101
21244 msgid "guestfs_add_domain_va"
21248 #: ../src/guestfs-actions.pod:103
21252 " guestfs_add_domain_va (guestfs_h *g,\n"
21253 " const char *dom,\n"
21254 " va_list args);\n"
21259 #: ../src/guestfs-actions.pod:108
21260 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21264 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882 ../src/guestfs-actions.pod:2910 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:4707 ../src/guestfs-actions.pod:4719 ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5238
21265 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21269 #: ../src/guestfs-actions.pod:112
21270 msgid "guestfs_add_domain_argv"
21274 #: ../src/guestfs-actions.pod:114
21278 " guestfs_add_domain_argv (guestfs_h *g,\n"
21279 " const char *dom,\n"
21280 " const struct guestfs_add_domain_argv *optargs);\n"
21285 #: ../src/guestfs-actions.pod:119
21286 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21290 #: ../src/guestfs-actions.pod:123
21291 msgid "guestfs_add_drive"
21295 #: ../src/guestfs-actions.pod:125
21299 " guestfs_add_drive (guestfs_h *g,\n"
21300 " const char *filename);\n"
21305 #: ../src/guestfs-actions.pod:129
21307 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21308 "optional parameters, so the disk is added writable, with the format being "
21309 "detected automatically."
21313 #: ../src/guestfs-actions.pod:133
21315 "Automatic detection of the format opens you up to a potential security hole "
21316 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21317 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21318 "you should think about replacing calls to this function with calls to "
21319 "C<guestfs_add_drive_opts>, and specifying the format."
21323 #: ../src/guestfs-actions.pod:144
21324 msgid "guestfs_add_drive_opts"
21328 #: ../src/guestfs-actions.pod:146
21332 " guestfs_add_drive_opts (guestfs_h *g,\n"
21333 " const char *filename,\n"
21339 #: ../src/guestfs-actions.pod:156
21342 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21343 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21344 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21349 #: ../src/guestfs-actions.pod:185
21351 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
21352 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
21353 "Possible formats include C<raw> and C<qcow2>."
21357 #: ../src/guestfs-actions.pod:196
21359 "This rarely-used option lets you emulate the behaviour of the deprecated "
21360 "C<guestfs_add_drive_with_if> call (q.v.)"
21364 #: ../src/guestfs-actions.pod:203
21365 msgid "(Added in 1.5.23)"
21369 #: ../src/guestfs-actions.pod:205
21370 msgid "guestfs_add_drive_opts_va"
21374 #: ../src/guestfs-actions.pod:207
21378 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21379 " const char *filename,\n"
21380 " va_list args);\n"
21385 #: ../src/guestfs-actions.pod:212
21386 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21390 #: ../src/guestfs-actions.pod:216
21391 msgid "guestfs_add_drive_opts_argv"
21395 #: ../src/guestfs-actions.pod:218
21399 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21400 " const char *filename,\n"
21401 " const struct guestfs_add_drive_opts_argv "
21407 #: ../src/guestfs-actions.pod:223
21408 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21412 #: ../src/guestfs-actions.pod:227
21413 msgid "guestfs_add_drive_ro"
21417 #: ../src/guestfs-actions.pod:229
21421 " guestfs_add_drive_ro (guestfs_h *g,\n"
21422 " const char *filename);\n"
21427 #: ../src/guestfs-actions.pod:233
21429 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21430 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21431 "disk is added read-only, with the format being detected automatically."
21435 #: ../src/guestfs-actions.pod:240
21436 msgid "(Added in 1.0.38)"
21440 #: ../src/guestfs-actions.pod:242
21441 msgid "guestfs_add_drive_ro_with_if"
21445 #: ../src/guestfs-actions.pod:244
21449 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
21450 " const char *filename,\n"
21451 " const char *iface);\n"
21456 #: ../src/guestfs-actions.pod:249
21458 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
21459 "QEMU interface emulation to use at run time."
21463 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2431
21464 msgid "(Added in 1.0.84)"
21468 #: ../src/guestfs-actions.pod:263
21469 msgid "guestfs_add_drive_with_if"
21473 #: ../src/guestfs-actions.pod:265
21477 " guestfs_add_drive_with_if (guestfs_h *g,\n"
21478 " const char *filename,\n"
21479 " const char *iface);\n"
21484 #: ../src/guestfs-actions.pod:270
21486 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
21487 "QEMU interface emulation to use at run time."
21491 #: ../src/guestfs-actions.pod:284
21492 msgid "guestfs_aug_clear"
21496 #: ../src/guestfs-actions.pod:286
21500 " guestfs_aug_clear (guestfs_h *g,\n"
21501 " const char *augpath);\n"
21506 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2181
21507 msgid "(Added in 1.3.4)"
21511 #: ../src/guestfs-actions.pod:297
21512 msgid "guestfs_aug_close"
21516 #: ../src/guestfs-actions.pod:299
21520 " guestfs_aug_close (guestfs_h *g);\n"
21525 #: ../src/guestfs-actions.pod:302
21527 "Close the current Augeas handle and free up any resources used by it. After "
21528 "calling this, you have to call C<guestfs_aug_init> again before you can use "
21529 "any other Augeas functions."
21533 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:5846
21534 msgid "(Added in 0.7)"
21538 #: ../src/guestfs-actions.pod:311
21539 msgid "guestfs_aug_defnode"
21543 #: ../src/guestfs-actions.pod:313
21546 " struct guestfs_int_bool *\n"
21547 " guestfs_aug_defnode (guestfs_h *g,\n"
21548 " const char *name,\n"
21549 " const char *expr,\n"
21550 " const char *val);\n"
21555 #: ../src/guestfs-actions.pod:322
21557 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21558 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
21559 "containing that single node."
21563 #: ../src/guestfs-actions.pod:330
21565 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
21566 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
21570 #: ../src/guestfs-actions.pod:336
21571 msgid "guestfs_aug_defvar"
21575 #: ../src/guestfs-actions.pod:338
21579 " guestfs_aug_defvar (guestfs_h *g,\n"
21580 " const char *name,\n"
21581 " const char *expr);\n"
21586 #: ../src/guestfs-actions.pod:354
21587 msgid "guestfs_aug_get"
21591 #: ../src/guestfs-actions.pod:356
21595 " guestfs_aug_get (guestfs_h *g,\n"
21596 " const char *augpath);\n"
21601 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2204 ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2600 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3076 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3169 ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:4189 ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:4469 ../src/guestfs-actions.pod:5375 ../src/guestfs-actions.pod:5574 ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:5922 ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6627 ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:7365 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7402 ../src/guestfs-actions.pod:7576 ../src/guestfs-actions.pod:7878
21603 "This function returns a string, or NULL on error. I<The caller must free "
21604 "the returned string after use>."
21608 #: ../src/guestfs-actions.pod:368
21609 msgid "guestfs_aug_init"
21613 #: ../src/guestfs-actions.pod:370
21617 " guestfs_aug_init (guestfs_h *g,\n"
21618 " const char *root,\n"
21624 #: ../src/guestfs-actions.pod:379
21625 msgid "You must call this before using any other C<guestfs_aug_*> commands."
21629 #: ../src/guestfs-actions.pod:414
21630 msgid "Do not load the tree in C<guestfs_aug_init>."
21634 #: ../src/guestfs-actions.pod:418
21635 msgid "To close the handle, you can call C<guestfs_aug_close>."
21639 #: ../src/guestfs-actions.pod:426
21640 msgid "guestfs_aug_insert"
21644 #: ../src/guestfs-actions.pod:428
21648 " guestfs_aug_insert (guestfs_h *g,\n"
21649 " const char *augpath,\n"
21650 " const char *label,\n"
21656 #: ../src/guestfs-actions.pod:446
21657 msgid "guestfs_aug_load"
21661 #: ../src/guestfs-actions.pod:448
21665 " guestfs_aug_load (guestfs_h *g);\n"
21670 #: ../src/guestfs-actions.pod:460
21671 msgid "guestfs_aug_ls"
21675 #: ../src/guestfs-actions.pod:462
21679 " guestfs_aug_ls (guestfs_h *g,\n"
21680 " const char *augpath);\n"
21685 #: ../src/guestfs-actions.pod:466
21687 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
21688 "sorting the resulting nodes into alphabetical order."
21692 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485 ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138 ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453 ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:2292 ../src/guestfs-actions.pod:2311 ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:2449 ../src/guestfs-actions.pod:2498 ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:3129 ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3719 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3756 ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3923 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6707 ../src/guestfs-actions.pod:6768 ../src/guestfs-actions.pod:6823 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6993 ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7489 ../src/guestfs-actions.pod:7536 ../src/guestfs-actions.pod:7730 ../src/guestfs-actions.pod:7749 ../src/guestfs-actions.pod:7835 ../src/guestfs-actions.pod:7854 ../src/guestfs-actions.pod:7900 ../src/guestfs-actions.pod:7919
21694 "This function returns a NULL-terminated array of strings (like "
21695 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
21696 "strings and the array after use>."
21700 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063 ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4442 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6080 ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:7207 ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7453 ../src/guestfs-actions.pod:7718
21701 msgid "(Added in 0.8)"
21705 #: ../src/guestfs-actions.pod:475
21706 msgid "guestfs_aug_match"
21710 #: ../src/guestfs-actions.pod:477
21714 " guestfs_aug_match (guestfs_h *g,\n"
21715 " const char *augpath);\n"
21720 #: ../src/guestfs-actions.pod:491
21721 msgid "guestfs_aug_mv"
21725 #: ../src/guestfs-actions.pod:493
21729 " guestfs_aug_mv (guestfs_h *g,\n"
21730 " const char *src,\n"
21731 " const char *dest);\n"
21736 #: ../src/guestfs-actions.pod:505
21737 msgid "guestfs_aug_rm"
21741 #: ../src/guestfs-actions.pod:507
21745 " guestfs_aug_rm (guestfs_h *g,\n"
21746 " const char *augpath);\n"
21751 #: ../src/guestfs-actions.pod:519
21752 msgid "guestfs_aug_save"
21756 #: ../src/guestfs-actions.pod:521
21760 " guestfs_aug_save (guestfs_h *g);\n"
21765 #: ../src/guestfs-actions.pod:526
21767 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
21772 #: ../src/guestfs-actions.pod:533
21773 msgid "guestfs_aug_set"
21777 #: ../src/guestfs-actions.pod:535
21781 " guestfs_aug_set (guestfs_h *g,\n"
21782 " const char *augpath,\n"
21783 " const char *val);\n"
21788 #: ../src/guestfs-actions.pod:542
21790 "In the Augeas API, it is possible to clear a node by setting the value to "
21791 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21792 "this call. Instead you must use the C<guestfs_aug_clear> call."
21796 #: ../src/guestfs-actions.pod:551
21797 msgid "guestfs_available"
21801 #: ../src/guestfs-actions.pod:553
21805 " guestfs_available (guestfs_h *g,\n"
21806 " char *const *groups);\n"
21811 #: ../src/guestfs-actions.pod:561
21813 "The libguestfs groups, and the functions that those groups correspond to, "
21814 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21815 "runtime by calling C<guestfs_available_all_groups>."
21819 #: ../src/guestfs-actions.pod:585
21820 msgid "You must call C<guestfs_launch> before calling this function."
21824 #: ../src/guestfs-actions.pod:607
21826 "This call was added in version C<1.0.80>. In previous versions of "
21827 "libguestfs all you could do would be to speculatively execute a command to "
21828 "find out if the daemon implemented it. See also C<guestfs_version>."
21832 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
21833 msgid "(Added in 1.0.80)"
21837 #: ../src/guestfs-actions.pod:618
21838 msgid "guestfs_available_all_groups"
21842 #: ../src/guestfs-actions.pod:620
21846 " guestfs_available_all_groups (guestfs_h *g);\n"
21851 #: ../src/guestfs-actions.pod:623
21853 "This command returns a list of all optional groups that this daemon knows "
21854 "about. Note this returns both supported and unsupported groups. To find "
21855 "out which ones the daemon can actually support you have to call "
21856 "C<guestfs_available> on each member of the returned list."
21860 #: ../src/guestfs-actions.pod:629
21861 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
21865 #: ../src/guestfs-actions.pod:635
21866 msgid "(Added in 1.3.15)"
21870 #: ../src/guestfs-actions.pod:637
21871 msgid "guestfs_base64_in"
21875 #: ../src/guestfs-actions.pod:639
21879 " guestfs_base64_in (guestfs_h *g,\n"
21880 " const char *base64file,\n"
21881 " const char *filename);\n"
21886 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
21887 msgid "(Added in 1.3.5)"
21891 #: ../src/guestfs-actions.pod:651
21892 msgid "guestfs_base64_out"
21896 #: ../src/guestfs-actions.pod:653
21900 " guestfs_base64_out (guestfs_h *g,\n"
21901 " const char *filename,\n"
21902 " const char *base64file);\n"
21907 #: ../src/guestfs-actions.pod:665
21908 msgid "guestfs_blockdev_flushbufs"
21912 #: ../src/guestfs-actions.pod:667
21916 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
21917 " const char *device);\n"
21922 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
21923 msgid "(Added in 0.9.3)"
21927 #: ../src/guestfs-actions.pod:680
21928 msgid "guestfs_blockdev_getbsz"
21932 #: ../src/guestfs-actions.pod:682
21936 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
21937 " const char *device);\n"
21942 #: ../src/guestfs-actions.pod:697
21943 msgid "guestfs_blockdev_getro"
21947 #: ../src/guestfs-actions.pod:699
21951 " guestfs_blockdev_getro (guestfs_h *g,\n"
21952 " const char *device);\n"
21957 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:5339
21958 msgid "This function returns a C truth value on success or -1 on error."
21962 #: ../src/guestfs-actions.pod:712
21963 msgid "guestfs_blockdev_getsize64"
21967 #: ../src/guestfs-actions.pod:714
21971 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
21972 " const char *device);\n"
21977 #: ../src/guestfs-actions.pod:720
21978 msgid "See also C<guestfs_blockdev_getsz>."
21982 #: ../src/guestfs-actions.pod:728
21983 msgid "guestfs_blockdev_getss"
21987 #: ../src/guestfs-actions.pod:730
21991 " guestfs_blockdev_getss (guestfs_h *g,\n"
21992 " const char *device);\n"
21997 #: ../src/guestfs-actions.pod:737
21999 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22004 #: ../src/guestfs-actions.pod:746
22005 msgid "guestfs_blockdev_getsz"
22009 #: ../src/guestfs-actions.pod:748
22013 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22014 " const char *device);\n"
22019 #: ../src/guestfs-actions.pod:755
22021 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22022 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22026 #: ../src/guestfs-actions.pod:765
22027 msgid "guestfs_blockdev_rereadpt"
22031 #: ../src/guestfs-actions.pod:767
22035 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22036 " const char *device);\n"
22041 #: ../src/guestfs-actions.pod:779
22042 msgid "guestfs_blockdev_setbsz"
22046 #: ../src/guestfs-actions.pod:781
22050 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22051 " const char *device,\n"
22052 " int blocksize);\n"
22057 #: ../src/guestfs-actions.pod:797
22058 msgid "guestfs_blockdev_setro"
22062 #: ../src/guestfs-actions.pod:799
22066 " guestfs_blockdev_setro (guestfs_h *g,\n"
22067 " const char *device);\n"
22072 #: ../src/guestfs-actions.pod:811
22073 msgid "guestfs_blockdev_setrw"
22077 #: ../src/guestfs-actions.pod:813
22081 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22082 " const char *device);\n"
22087 #: ../src/guestfs-actions.pod:825
22088 msgid "guestfs_btrfs_filesystem_resize"
22092 #: ../src/guestfs-actions.pod:827
22096 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22097 " const char *mountpoint,\n"
22103 #: ../src/guestfs-actions.pod:837
22106 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22111 #: ../src/guestfs-actions.pod:860
22112 msgid "(Added in 1.11.17)"
22116 #: ../src/guestfs-actions.pod:862
22117 msgid "guestfs_btrfs_filesystem_resize_va"
22121 #: ../src/guestfs-actions.pod:864
22125 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22126 " const char *mountpoint,\n"
22127 " va_list args);\n"
22132 #: ../src/guestfs-actions.pod:869
22133 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22137 #: ../src/guestfs-actions.pod:873
22138 msgid "guestfs_btrfs_filesystem_resize_argv"
22142 #: ../src/guestfs-actions.pod:875
22146 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22147 " const char *mountpoint,\n"
22149 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22154 #: ../src/guestfs-actions.pod:880
22155 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22159 #: ../src/guestfs-actions.pod:884
22160 msgid "guestfs_case_sensitive_path"
22164 #: ../src/guestfs-actions.pod:886
22168 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22169 " const char *path);\n"
22174 #: ../src/guestfs-actions.pod:912
22176 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
22177 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22178 "how the directories were originally created under Windows)."
22182 #: ../src/guestfs-actions.pod:920
22183 msgid "See also C<guestfs_realpath>."
22187 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7387
22188 msgid "(Added in 1.0.75)"
22192 #: ../src/guestfs-actions.pod:927
22193 msgid "guestfs_cat"
22197 #: ../src/guestfs-actions.pod:929
22201 " guestfs_cat (guestfs_h *g,\n"
22202 " const char *path);\n"
22207 #: ../src/guestfs-actions.pod:935
22209 "Note that this function cannot correctly handle binary files (specifically, "
22210 "files containing C<\\0> character which is treated as end of string). For "
22211 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22212 "functions which have a more complex interface."
22216 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3740 ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3839 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:4335 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:5720 ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:7540 ../src/guestfs-actions.pod:7554
22217 msgid "(Added in 0.4)"
22221 #: ../src/guestfs-actions.pod:948
22222 msgid "guestfs_checksum"
22226 #: ../src/guestfs-actions.pod:950
22230 " guestfs_checksum (guestfs_h *g,\n"
22231 " const char *csumtype,\n"
22232 " const char *path);\n"
22237 #: ../src/guestfs-actions.pod:996
22238 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22242 #: ../src/guestfs-actions.pod:998
22243 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22247 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:7243
22248 msgid "(Added in 1.0.2)"
22252 #: ../src/guestfs-actions.pod:1005
22253 msgid "guestfs_checksum_device"
22257 #: ../src/guestfs-actions.pod:1007
22261 " guestfs_checksum_device (guestfs_h *g,\n"
22262 " const char *csumtype,\n"
22263 " const char *device);\n"
22268 #: ../src/guestfs-actions.pod:1012
22270 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22271 "device named C<device>. For the types of checksums supported see the "
22272 "C<guestfs_checksum> command."
22276 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5341 ../src/guestfs-actions.pod:5359 ../src/guestfs-actions.pod:5541 ../src/guestfs-actions.pod:7152 ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7566
22277 msgid "(Added in 1.3.2)"
22281 #: ../src/guestfs-actions.pod:1021
22282 msgid "guestfs_checksums_out"
22286 #: ../src/guestfs-actions.pod:1023
22290 " guestfs_checksums_out (guestfs_h *g,\n"
22291 " const char *csumtype,\n"
22292 " const char *directory,\n"
22293 " const char *sumsfile);\n"
22298 #: ../src/guestfs-actions.pod:1043
22299 msgid "(Added in 1.3.7)"
22303 #: ../src/guestfs-actions.pod:1045
22304 msgid "guestfs_chmod"
22308 #: ../src/guestfs-actions.pod:1047
22312 " guestfs_chmod (guestfs_h *g,\n"
22314 " const char *path);\n"
22319 #: ../src/guestfs-actions.pod:1065
22320 msgid "guestfs_chown"
22324 #: ../src/guestfs-actions.pod:1067
22328 " guestfs_chown (guestfs_h *g,\n"
22331 " const char *path);\n"
22336 #: ../src/guestfs-actions.pod:1083
22337 msgid "guestfs_command"
22341 #: ../src/guestfs-actions.pod:1085
22345 " guestfs_command (guestfs_h *g,\n"
22346 " char *const *arguments);\n"
22351 #: ../src/guestfs-actions.pod:1094
22353 "The single parameter is an argv-style list of arguments. The first element "
22354 "is the name of the program to run. Subsequent elements are parameters. The "
22355 "list must be non-empty (ie. must contain a program name). Note that the "
22356 "command runs directly, and is I<not> invoked via the shell (see "
22361 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145 ../src/guestfs-actions.pod:1610
22362 msgid "(Added in 0.9.1)"
22366 #: ../src/guestfs-actions.pod:1127
22367 msgid "guestfs_command_lines"
22371 #: ../src/guestfs-actions.pod:1129
22375 " guestfs_command_lines (guestfs_h *g,\n"
22376 " char *const *arguments);\n"
22381 #: ../src/guestfs-actions.pod:1133
22383 "This is the same as C<guestfs_command>, but splits the result into a list of "
22388 #: ../src/guestfs-actions.pod:1136
22389 msgid "See also: C<guestfs_sh_lines>"
22393 #: ../src/guestfs-actions.pod:1147
22394 msgid "guestfs_config"
22398 #: ../src/guestfs-actions.pod:1149
22402 " guestfs_config (guestfs_h *g,\n"
22403 " const char *qemuparam,\n"
22404 " const char *qemuvalue);\n"
22409 #: ../src/guestfs-actions.pod:1167
22410 msgid "guestfs_copy_size"
22414 #: ../src/guestfs-actions.pod:1169
22418 " guestfs_copy_size (guestfs_h *g,\n"
22419 " const char *src,\n"
22420 " const char *dest,\n"
22421 " int64_t size);\n"
22426 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306 ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781 ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:7238 ../src/guestfs-actions.pod:7272 ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7794
22428 "This long-running command can generate progress notification messages so "
22429 "that the caller can display a progress bar or indicator. To receive these "
22430 "messages, the caller must register a progress event callback. See "
22431 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
22435 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:7473 ../src/guestfs-actions.pod:7493 ../src/guestfs-actions.pod:7579
22436 msgid "(Added in 1.0.87)"
22440 #: ../src/guestfs-actions.pod:1190
22445 #: ../src/guestfs-actions.pod:1192
22449 " guestfs_cp (guestfs_h *g,\n"
22450 " const char *src,\n"
22451 " const char *dest);\n"
22456 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216 ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5116 ../src/guestfs-actions.pod:5591
22457 msgid "(Added in 1.0.18)"
22461 #: ../src/guestfs-actions.pod:1204
22462 msgid "guestfs_cp_a"
22466 #: ../src/guestfs-actions.pod:1206
22470 " guestfs_cp_a (guestfs_h *g,\n"
22471 " const char *src,\n"
22472 " const char *dest);\n"
22477 #: ../src/guestfs-actions.pod:1218
22482 #: ../src/guestfs-actions.pod:1220
22486 " guestfs_dd (guestfs_h *g,\n"
22487 " const char *src,\n"
22488 " const char *dest);\n"
22493 #: ../src/guestfs-actions.pod:1230
22495 "If the destination is a device, it must be as large or larger than the "
22496 "source file or device, otherwise the copy will fail. This command cannot do "
22497 "partial copies (see C<guestfs_copy_size>)."
22501 #: ../src/guestfs-actions.pod:1238
22506 #: ../src/guestfs-actions.pod:1240
22510 " guestfs_df (guestfs_h *g);\n"
22515 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
22517 "This command is mostly useful for interactive sessions. It is I<not> "
22518 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
22523 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2361 ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7645
22524 msgid "(Added in 1.0.54)"
22528 #: ../src/guestfs-actions.pod:1254
22529 msgid "guestfs_df_h"
22533 #: ../src/guestfs-actions.pod:1256
22537 " guestfs_df_h (guestfs_h *g);\n"
22542 #: ../src/guestfs-actions.pod:1271
22543 msgid "guestfs_dmesg"
22547 #: ../src/guestfs-actions.pod:1273
22551 " guestfs_dmesg (guestfs_h *g);\n"
22556 #: ../src/guestfs-actions.pod:1280
22558 "Another way to get the same information is to enable verbose messages with "
22559 "C<guestfs_set_verbose> or by setting the environment variable "
22560 "C<LIBGUESTFS_DEBUG=1> before running the program."
22564 #: ../src/guestfs-actions.pod:1290
22565 msgid "guestfs_download"
22569 #: ../src/guestfs-actions.pod:1292
22573 " guestfs_download (guestfs_h *g,\n"
22574 " const char *remotefilename,\n"
22575 " const char *filename);\n"
22580 #: ../src/guestfs-actions.pod:1302
22581 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
22585 #: ../src/guestfs-actions.pod:1313
22586 msgid "guestfs_download_offset"
22590 #: ../src/guestfs-actions.pod:1315
22594 " guestfs_download_offset (guestfs_h *g,\n"
22595 " const char *remotefilename,\n"
22596 " const char *filename,\n"
22597 " int64_t offset,\n"
22598 " int64_t size);\n"
22603 #: ../src/guestfs-actions.pod:1328
22605 "Note that there is no limit on the amount of data that can be downloaded "
22606 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
22607 "full amount unless an error occurs."
22611 #: ../src/guestfs-actions.pod:1333
22612 msgid "See also C<guestfs_download>, C<guestfs_pread>."
22616 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7277
22617 msgid "(Added in 1.5.17)"
22621 #: ../src/guestfs-actions.pod:1344
22622 msgid "guestfs_drop_caches"
22626 #: ../src/guestfs-actions.pod:1346
22630 " guestfs_drop_caches (guestfs_h *g,\n"
22631 " int whattodrop);\n"
22636 #: ../src/guestfs-actions.pod:1364
22641 #: ../src/guestfs-actions.pod:1366
22645 " guestfs_du (guestfs_h *g,\n"
22646 " const char *path);\n"
22651 #: ../src/guestfs-actions.pod:1389
22652 msgid "guestfs_e2fsck_f"
22656 #: ../src/guestfs-actions.pod:1391
22660 " guestfs_e2fsck_f (guestfs_h *g,\n"
22661 " const char *device);\n"
22666 #: ../src/guestfs-actions.pod:1399
22668 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
22669 "Normally you should use C<guestfs_fsck>."
22673 #: ../src/guestfs-actions.pod:1404
22674 msgid "(Added in 1.0.29)"
22678 #: ../src/guestfs-actions.pod:1406
22679 msgid "guestfs_echo_daemon"
22683 #: ../src/guestfs-actions.pod:1408
22687 " guestfs_echo_daemon (guestfs_h *g,\n"
22688 " char *const *words);\n"
22693 #: ../src/guestfs-actions.pod:1417
22694 msgid "See also C<guestfs_ping_daemon>."
22698 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2169 ../src/guestfs-actions.pod:6448
22699 msgid "(Added in 1.0.69)"
22703 #: ../src/guestfs-actions.pod:1424
22704 msgid "guestfs_egrep"
22708 #: ../src/guestfs-actions.pod:1426
22712 " guestfs_egrep (guestfs_h *g,\n"
22713 " const char *regex,\n"
22714 " const char *path);\n"
22719 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460 ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563 ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:2502 ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:4894 ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5974 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6882 ../src/guestfs-actions.pod:6904 ../src/guestfs-actions.pod:6917 ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7756 ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7861 ../src/guestfs-actions.pod:7907 ../src/guestfs-actions.pod:7926
22720 msgid "(Added in 1.0.66)"
22724 #: ../src/guestfs-actions.pod:1443
22725 msgid "guestfs_egrepi"
22729 #: ../src/guestfs-actions.pod:1445
22733 " guestfs_egrepi (guestfs_h *g,\n"
22734 " const char *regex,\n"
22735 " const char *path);\n"
22740 #: ../src/guestfs-actions.pod:1462
22741 msgid "guestfs_equal"
22745 #: ../src/guestfs-actions.pod:1464
22749 " guestfs_equal (guestfs_h *g,\n"
22750 " const char *file1,\n"
22751 " const char *file2);\n"
22756 #: ../src/guestfs-actions.pod:1478
22757 msgid "guestfs_exists"
22761 #: ../src/guestfs-actions.pod:1480
22765 " guestfs_exists (guestfs_h *g,\n"
22766 " const char *path);\n"
22771 #: ../src/guestfs-actions.pod:1487
22772 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
22776 #: ../src/guestfs-actions.pod:1493
22777 msgid "guestfs_fallocate"
22781 #: ../src/guestfs-actions.pod:1495
22785 " guestfs_fallocate (guestfs_h *g,\n"
22786 " const char *path,\n"
22792 #: ../src/guestfs-actions.pod:1510
22794 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
22799 #: ../src/guestfs-actions.pod:1519
22800 msgid "guestfs_fallocate64"
22804 #: ../src/guestfs-actions.pod:1521
22808 " guestfs_fallocate64 (guestfs_h *g,\n"
22809 " const char *path,\n"
22815 #: ../src/guestfs-actions.pod:1530
22817 "Note that this call allocates disk blocks for the file. To create a sparse "
22818 "file use C<guestfs_truncate_size> instead."
22822 #: ../src/guestfs-actions.pod:1533
22824 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
22825 "oversight it only allowed 30 bit lengths to be specified, effectively "
22826 "limiting the maximum size of files created through that call to 1GB."
22830 #: ../src/guestfs-actions.pod:1544
22831 msgid "(Added in 1.3.17)"
22835 #: ../src/guestfs-actions.pod:1546
22836 msgid "guestfs_fgrep"
22840 #: ../src/guestfs-actions.pod:1548
22844 " guestfs_fgrep (guestfs_h *g,\n"
22845 " const char *pattern,\n"
22846 " const char *path);\n"
22851 #: ../src/guestfs-actions.pod:1565
22852 msgid "guestfs_fgrepi"
22856 #: ../src/guestfs-actions.pod:1567
22860 " guestfs_fgrepi (guestfs_h *g,\n"
22861 " const char *pattern,\n"
22862 " const char *path);\n"
22867 #: ../src/guestfs-actions.pod:1584
22868 msgid "guestfs_file"
22872 #: ../src/guestfs-actions.pod:1586
22876 " guestfs_file (guestfs_h *g,\n"
22877 " const char *path);\n"
22882 #: ../src/guestfs-actions.pod:1604
22884 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
22885 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
22889 #: ../src/guestfs-actions.pod:1612
22890 msgid "guestfs_file_architecture"
22894 #: ../src/guestfs-actions.pod:1614
22898 " guestfs_file_architecture (guestfs_h *g,\n"
22899 " const char *filename);\n"
22904 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2603 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2759 ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:3541
22905 msgid "(Added in 1.5.3)"
22909 #: ../src/guestfs-actions.pod:1724
22910 msgid "guestfs_filesize"
22914 #: ../src/guestfs-actions.pod:1726
22918 " guestfs_filesize (guestfs_h *g,\n"
22919 " const char *file);\n"
22924 #: ../src/guestfs-actions.pod:1732
22926 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
22927 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
22928 "devices, use C<guestfs_blockdev_getsize64>."
22932 #: ../src/guestfs-actions.pod:1738
22933 msgid "(Added in 1.0.82)"
22937 #: ../src/guestfs-actions.pod:1740
22938 msgid "guestfs_fill"
22942 #: ../src/guestfs-actions.pod:1742
22946 " guestfs_fill (guestfs_h *g,\n"
22949 " const char *path);\n"
22954 #: ../src/guestfs-actions.pod:1752
22956 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22957 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
22958 "bytes use C<guestfs_fill_pattern>."
22962 #: ../src/guestfs-actions.pod:1764
22963 msgid "(Added in 1.0.79)"
22967 #: ../src/guestfs-actions.pod:1766
22968 msgid "guestfs_fill_pattern"
22972 #: ../src/guestfs-actions.pod:1768
22976 " guestfs_fill_pattern (guestfs_h *g,\n"
22977 " const char *pattern,\n"
22979 " const char *path);\n"
22984 #: ../src/guestfs-actions.pod:1774
22986 "This function is like C<guestfs_fill> except that it creates a new file of "
22987 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
22988 "pattern is truncated if necessary to ensure the length of the file is "
22989 "exactly C<len> bytes."
22993 #: ../src/guestfs-actions.pod:1786
22994 msgid "(Added in 1.3.12)"
22998 #: ../src/guestfs-actions.pod:1788
22999 msgid "guestfs_find"
23003 #: ../src/guestfs-actions.pod:1790
23007 " guestfs_find (guestfs_h *g,\n"
23008 " const char *directory);\n"
23013 #: ../src/guestfs-actions.pod:1806
23014 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23018 #: ../src/guestfs-actions.pod:1819
23019 msgid "See also C<guestfs_find0>."
23023 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:6009
23024 msgid "(Added in 1.0.27)"
23028 #: ../src/guestfs-actions.pod:1830
23029 msgid "guestfs_find0"
23033 #: ../src/guestfs-actions.pod:1832
23037 " guestfs_find0 (guestfs_h *g,\n"
23038 " const char *directory,\n"
23039 " const char *files);\n"
23044 #: ../src/guestfs-actions.pod:1841
23046 "This command works the same way as C<guestfs_find> with the following "
23051 #: ../src/guestfs-actions.pod:1868
23052 msgid "(Added in 1.0.74)"
23056 #: ../src/guestfs-actions.pod:1870
23057 msgid "guestfs_findfs_label"
23061 #: ../src/guestfs-actions.pod:1872
23065 " guestfs_findfs_label (guestfs_h *g,\n"
23066 " const char *label);\n"
23071 #: ../src/guestfs-actions.pod:1880
23072 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23076 #: ../src/guestfs-actions.pod:1887
23077 msgid "guestfs_findfs_uuid"
23081 #: ../src/guestfs-actions.pod:1889
23085 " guestfs_findfs_uuid (guestfs_h *g,\n"
23086 " const char *uuid);\n"
23091 #: ../src/guestfs-actions.pod:1897
23092 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23096 #: ../src/guestfs-actions.pod:1904
23097 msgid "guestfs_fsck"
23101 #: ../src/guestfs-actions.pod:1906
23105 " guestfs_fsck (guestfs_h *g,\n"
23106 " const char *fstype,\n"
23107 " const char *device);\n"
23112 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7780
23113 msgid "(Added in 1.0.16)"
23117 #: ../src/guestfs-actions.pod:1943
23118 msgid "guestfs_get_append"
23122 #: ../src/guestfs-actions.pod:1945
23126 " guestfs_get_append (guestfs_h *g);\n"
23131 #: ../src/guestfs-actions.pod:1953
23133 "This function returns a string which may be NULL. There is no way to return "
23134 "an error from this function. The string is owned by the guest handle and "
23135 "must I<not> be freed."
23139 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5687 ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6611 ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6670 ../src/guestfs-actions.pod:7424 ../src/guestfs-actions.pod:7439 ../src/guestfs-actions.pod:7823
23140 msgid "(Added in 1.0.26)"
23144 #: ../src/guestfs-actions.pod:1959
23145 msgid "guestfs_get_attach_method"
23149 #: ../src/guestfs-actions.pod:1961
23153 " guestfs_get_attach_method (guestfs_h *g);\n"
23158 #: ../src/guestfs-actions.pod:1964
23159 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23163 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6199
23164 msgid "(Added in 1.9.8)"
23168 #: ../src/guestfs-actions.pod:1971
23169 msgid "guestfs_get_autosync"
23173 #: ../src/guestfs-actions.pod:1973
23177 " guestfs_get_autosync (guestfs_h *g);\n"
23182 #: ../src/guestfs-actions.pod:1982
23183 msgid "guestfs_get_direct"
23187 #: ../src/guestfs-actions.pod:1984
23191 " guestfs_get_direct (guestfs_h *g);\n"
23196 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6240
23197 msgid "(Added in 1.0.72)"
23201 #: ../src/guestfs-actions.pod:1993
23202 msgid "guestfs_get_e2label"
23206 #: ../src/guestfs-actions.pod:1995
23210 " guestfs_get_e2label (guestfs_h *g,\n"
23211 " const char *device);\n"
23216 #: ../src/guestfs-actions.pod:2005
23218 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
23223 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6277
23224 msgid "(Added in 1.0.15)"
23228 #: ../src/guestfs-actions.pod:2014
23229 msgid "guestfs_get_e2uuid"
23233 #: ../src/guestfs-actions.pod:2016
23237 " guestfs_get_e2uuid (guestfs_h *g,\n"
23238 " const char *device);\n"
23243 #: ../src/guestfs-actions.pod:2026
23245 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
23250 #: ../src/guestfs-actions.pod:2035
23251 msgid "guestfs_get_memsize"
23255 #: ../src/guestfs-actions.pod:2037
23259 " guestfs_get_memsize (guestfs_h *g);\n"
23264 #: ../src/guestfs-actions.pod:2043
23266 "If C<guestfs_set_memsize> was not called on this handle, and if "
23267 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23268 "value for memsize."
23272 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4849 ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4879 ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:6298 ../src/guestfs-actions.pod:6578 ../src/guestfs-actions.pod:7193
23273 msgid "(Added in 1.0.55)"
23277 #: ../src/guestfs-actions.pod:2054
23278 msgid "guestfs_get_network"
23282 #: ../src/guestfs-actions.pod:2056
23286 " guestfs_get_network (guestfs_h *g);\n"
23291 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6317
23292 msgid "(Added in 1.5.4)"
23296 #: ../src/guestfs-actions.pod:2065
23297 msgid "guestfs_get_path"
23301 #: ../src/guestfs-actions.pod:2067
23305 " guestfs_get_path (guestfs_h *g);\n"
23310 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2115
23312 "This function returns a string, or NULL on error. The string is owned by "
23313 "the guest handle and must I<not> be freed."
23317 #: ../src/guestfs-actions.pod:2080
23318 msgid "guestfs_get_pgroup"
23322 #: ../src/guestfs-actions.pod:2082
23326 " guestfs_get_pgroup (guestfs_h *g);\n"
23331 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:6353 ../src/guestfs-actions.pod:7685
23332 msgid "(Added in 1.11.18)"
23336 #: ../src/guestfs-actions.pod:2091
23337 msgid "guestfs_get_pid"
23341 #: ../src/guestfs-actions.pod:2093
23345 " guestfs_get_pid (guestfs_h *g);\n"
23350 #: ../src/guestfs-actions.pod:2103
23351 msgid "(Added in 1.0.56)"
23355 #: ../src/guestfs-actions.pod:2105
23356 msgid "guestfs_get_qemu"
23360 #: ../src/guestfs-actions.pod:2107
23364 " guestfs_get_qemu (guestfs_h *g);\n"
23369 #: ../src/guestfs-actions.pod:2118 ../src/guestfs-actions.pod:6381
23370 msgid "(Added in 1.0.6)"
23374 #: ../src/guestfs-actions.pod:2120
23375 msgid "guestfs_get_recovery_proc"
23379 #: ../src/guestfs-actions.pod:2122
23383 " guestfs_get_recovery_proc (guestfs_h *g);\n"
23388 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4397 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5960 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7116 ../src/guestfs-actions.pod:7308
23389 msgid "(Added in 1.0.77)"
23393 #: ../src/guestfs-actions.pod:2131
23394 msgid "guestfs_get_selinux"
23398 #: ../src/guestfs-actions.pod:2133
23402 " guestfs_get_selinux (guestfs_h *g);\n"
23407 #: ../src/guestfs-actions.pod:2136
23409 "This returns the current setting of the selinux flag which is passed to the "
23410 "appliance at boot time. See C<guestfs_set_selinux>."
23414 #: ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:2207 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6482
23415 msgid "(Added in 1.0.67)"
23419 #: ../src/guestfs-actions.pod:2146
23420 msgid "guestfs_get_state"
23424 #: ../src/guestfs-actions.pod:2148
23428 " guestfs_get_state (guestfs_h *g);\n"
23433 #: ../src/guestfs-actions.pod:2160
23434 msgid "guestfs_get_trace"
23438 #: ../src/guestfs-actions.pod:2162
23442 " guestfs_get_trace (guestfs_h *g);\n"
23447 #: ../src/guestfs-actions.pod:2171
23448 msgid "guestfs_get_umask"
23452 #: ../src/guestfs-actions.pod:2173
23456 " guestfs_get_umask (guestfs_h *g);\n"
23461 #: ../src/guestfs-actions.pod:2176
23463 "Return the current umask. By default the umask is C<022> unless it has been "
23464 "set by calling C<guestfs_umask>."
23468 #: ../src/guestfs-actions.pod:2183
23469 msgid "guestfs_get_verbose"
23473 #: ../src/guestfs-actions.pod:2185
23477 " guestfs_get_verbose (guestfs_h *g);\n"
23482 #: ../src/guestfs-actions.pod:2194
23483 msgid "guestfs_getcon"
23487 #: ../src/guestfs-actions.pod:2196
23491 " guestfs_getcon (guestfs_h *g);\n"
23496 #: ../src/guestfs-actions.pod:2201
23497 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
23501 #: ../src/guestfs-actions.pod:2209
23502 msgid "guestfs_getxattr"
23506 #: ../src/guestfs-actions.pod:2211
23510 " guestfs_getxattr (guestfs_h *g,\n"
23511 " const char *path,\n"
23512 " const char *name,\n"
23513 " size_t *size_r);\n"
23518 #: ../src/guestfs-actions.pod:2217
23520 "Get a single extended attribute from file C<path> named C<name>. This call "
23521 "follows symlinks. If you want to lookup an extended attribute for the "
23522 "symlink itself, use C<guestfs_lgetxattr>."
23526 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:3677
23528 "Normally it is better to get all extended attributes from a file in one go "
23529 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
23530 "implementations are buggy and do not provide a way to list out attributes. "
23531 "For these filesystems (notably ntfs-3g) you have to know the names of the "
23532 "extended attributes you want in advance and call this function."
23536 #: ../src/guestfs-actions.pod:2231
23537 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
23541 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2424 ../src/guestfs-actions.pod:2894 ../src/guestfs-actions.pod:3689 ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636 ../src/guestfs-actions.pod:5817
23543 "This function returns a buffer, or NULL on error. The size of the returned "
23544 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
23549 #: ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:3693
23550 msgid "(Added in 1.7.24)"
23554 #: ../src/guestfs-actions.pod:2239
23555 msgid "guestfs_getxattrs"
23559 #: ../src/guestfs-actions.pod:2241
23562 " struct guestfs_xattr_list *\n"
23563 " guestfs_getxattrs (guestfs_h *g,\n"
23564 " const char *path);\n"
23569 #: ../src/guestfs-actions.pod:2251
23570 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
23574 #: ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:3705 ../src/guestfs-actions.pod:4393
23576 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
23577 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
23581 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6501 ../src/guestfs-actions.pod:7888
23582 msgid "(Added in 1.0.59)"
23586 #: ../src/guestfs-actions.pod:2259
23587 msgid "guestfs_glob_expand"
23591 #: ../src/guestfs-actions.pod:2261
23595 " guestfs_glob_expand (guestfs_h *g,\n"
23596 " const char *pattern);\n"
23601 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:6694 ../src/guestfs-actions.pod:6711
23602 msgid "(Added in 1.0.50)"
23606 #: ../src/guestfs-actions.pod:2282
23607 msgid "guestfs_grep"
23611 #: ../src/guestfs-actions.pod:2284
23615 " guestfs_grep (guestfs_h *g,\n"
23616 " const char *regex,\n"
23617 " const char *path);\n"
23622 #: ../src/guestfs-actions.pod:2301
23623 msgid "guestfs_grepi"
23627 #: ../src/guestfs-actions.pod:2303
23631 " guestfs_grepi (guestfs_h *g,\n"
23632 " const char *regex,\n"
23633 " const char *path);\n"
23638 #: ../src/guestfs-actions.pod:2320
23639 msgid "guestfs_grub_install"
23643 #: ../src/guestfs-actions.pod:2322
23647 " guestfs_grub_install (guestfs_h *g,\n"
23648 " const char *root,\n"
23649 " const char *device);\n"
23654 #: ../src/guestfs-actions.pod:2343
23655 msgid "(Added in 1.0.17)"
23659 #: ../src/guestfs-actions.pod:2345
23660 msgid "guestfs_head"
23664 #: ../src/guestfs-actions.pod:2347
23668 " guestfs_head (guestfs_h *g,\n"
23669 " const char *path);\n"
23674 #: ../src/guestfs-actions.pod:2363
23675 msgid "guestfs_head_n"
23679 #: ../src/guestfs-actions.pod:2365
23683 " guestfs_head_n (guestfs_h *g,\n"
23685 " const char *path);\n"
23690 #: ../src/guestfs-actions.pod:2387
23691 msgid "guestfs_hexdump"
23695 #: ../src/guestfs-actions.pod:2389
23699 " guestfs_hexdump (guestfs_h *g,\n"
23700 " const char *path);\n"
23705 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:6775 ../src/guestfs-actions.pod:6830
23706 msgid "(Added in 1.0.22)"
23710 #: ../src/guestfs-actions.pod:2404
23711 msgid "guestfs_initrd_cat"
23715 #: ../src/guestfs-actions.pod:2406
23719 " guestfs_initrd_cat (guestfs_h *g,\n"
23720 " const char *initrdpath,\n"
23721 " const char *filename,\n"
23722 " size_t *size_r);\n"
23727 #: ../src/guestfs-actions.pod:2422
23728 msgid "See also C<guestfs_initrd_list>."
23732 #: ../src/guestfs-actions.pod:2433
23733 msgid "guestfs_initrd_list"
23737 #: ../src/guestfs-actions.pod:2435
23741 " guestfs_initrd_list (guestfs_h *g,\n"
23742 " const char *path);\n"
23747 #: ../src/guestfs-actions.pod:2455
23748 msgid "guestfs_inotify_add_watch"
23752 #: ../src/guestfs-actions.pod:2457
23756 " guestfs_inotify_add_watch (guestfs_h *g,\n"
23757 " const char *path,\n"
23763 #: ../src/guestfs-actions.pod:2476
23764 msgid "guestfs_inotify_close"
23768 #: ../src/guestfs-actions.pod:2478
23772 " guestfs_inotify_close (guestfs_h *g);\n"
23777 #: ../src/guestfs-actions.pod:2489
23778 msgid "guestfs_inotify_files"
23782 #: ../src/guestfs-actions.pod:2491
23786 " guestfs_inotify_files (guestfs_h *g);\n"
23791 #: ../src/guestfs-actions.pod:2494
23793 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
23794 "returns a list of pathnames of objects that were touched. The returned "
23795 "pathnames are sorted and deduplicated."
23799 #: ../src/guestfs-actions.pod:2504
23800 msgid "guestfs_inotify_init"
23804 #: ../src/guestfs-actions.pod:2506
23808 " guestfs_inotify_init (guestfs_h *g,\n"
23809 " int maxevents);\n"
23814 #: ../src/guestfs-actions.pod:2514
23816 "C<maxevents> is the maximum number of events which will be queued up between "
23817 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
23818 "passed as C<0>, then the kernel (or previously set) default is used. For "
23819 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
23820 "throws away events, but records the fact that it threw them away by setting "
23821 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
23822 "C<guestfs_inotify_read>)."
23826 #: ../src/guestfs-actions.pod:2524
23828 "Before any events are generated, you have to add some watches to the "
23829 "internal watch list. See: C<guestfs_inotify_add_watch>, "
23830 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
23834 #: ../src/guestfs-actions.pod:2530
23836 "Queued up events should be read periodically by calling "
23837 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
23838 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
23839 "often enough then you risk the internal queue overflowing."
23843 #: ../src/guestfs-actions.pod:2537
23845 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
23846 "This also removes any watches automatically."
23850 #: ../src/guestfs-actions.pod:2550
23851 msgid "guestfs_inotify_read"
23855 #: ../src/guestfs-actions.pod:2552
23858 " struct guestfs_inotify_event_list *\n"
23859 " guestfs_inotify_read (guestfs_h *g);\n"
23864 #: ../src/guestfs-actions.pod:2566
23866 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
23867 "there was an error. I<The caller must call "
23868 "C<guestfs_free_inotify_event_list> after use>."
23872 #: ../src/guestfs-actions.pod:2572
23873 msgid "guestfs_inotify_rm_watch"
23877 #: ../src/guestfs-actions.pod:2574
23881 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
23887 #: ../src/guestfs-actions.pod:2578
23889 "Remove a previously defined inotify watch. See "
23890 "C<guestfs_inotify_add_watch>."
23894 #: ../src/guestfs-actions.pod:2585
23895 msgid "guestfs_inspect_get_arch"
23899 #: ../src/guestfs-actions.pod:2587
23903 " guestfs_inspect_get_arch (guestfs_h *g,\n"
23904 " const char *root);\n"
23909 #: ../src/guestfs-actions.pod:2591
23911 "This returns the architecture of the inspected operating system. The "
23912 "possible return values are listed under C<guestfs_file_architecture>."
23916 #: ../src/guestfs-actions.pod:2605
23917 msgid "guestfs_inspect_get_distro"
23921 #: ../src/guestfs-actions.pod:2607
23925 " guestfs_inspect_get_distro (guestfs_h *g,\n"
23926 " const char *root);\n"
23931 #: ../src/guestfs-actions.pod:2695
23932 msgid "guestfs_inspect_get_drive_mappings"
23936 #: ../src/guestfs-actions.pod:2697
23940 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
23941 " const char *root);\n"
23946 #: ../src/guestfs-actions.pod:2726
23948 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23949 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
23953 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:7132
23955 "This function returns a NULL-terminated array of strings, or NULL if there "
23956 "was an error. The array of strings will always have length C<2n+1>, where "
23957 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
23958 "caller must free the strings and the array after use>."
23962 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:3192
23963 msgid "(Added in 1.9.17)"
23967 #: ../src/guestfs-actions.pod:2738
23968 msgid "guestfs_inspect_get_filesystems"
23972 #: ../src/guestfs-actions.pod:2740
23976 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
23977 " const char *root);\n"
23982 #: ../src/guestfs-actions.pod:2752
23984 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23985 "C<guestfs_inspect_get_mountpoints>."
23989 #: ../src/guestfs-actions.pod:2761
23990 msgid "guestfs_inspect_get_format"
23994 #: ../src/guestfs-actions.pod:2763
23998 " guestfs_inspect_get_format (guestfs_h *g,\n"
23999 " const char *root);\n"
24004 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3262 ../src/guestfs-actions.pod:6028
24005 msgid "(Added in 1.9.4)"
24009 #: ../src/guestfs-actions.pod:2799
24010 msgid "guestfs_inspect_get_hostname"
24014 #: ../src/guestfs-actions.pod:2801
24018 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24019 " const char *root);\n"
24024 #: ../src/guestfs-actions.pod:2816
24025 msgid "(Added in 1.7.9)"
24029 #: ../src/guestfs-actions.pod:2818
24030 msgid "guestfs_inspect_get_icon"
24034 #: ../src/guestfs-actions.pod:2820
24038 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24039 " const char *root,\n"
24040 " size_t *size_r,\n"
24046 #: ../src/guestfs-actions.pod:2831
24049 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24050 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24055 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:4977
24056 msgid "(Added in 1.11.12)"
24060 #: ../src/guestfs-actions.pod:2900
24061 msgid "guestfs_inspect_get_icon_va"
24065 #: ../src/guestfs-actions.pod:2902
24069 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24070 " const char *root,\n"
24071 " size_t *size_r,\n"
24072 " va_list args);\n"
24077 #: ../src/guestfs-actions.pod:2908
24078 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24082 #: ../src/guestfs-actions.pod:2912
24083 msgid "guestfs_inspect_get_icon_argv"
24087 #: ../src/guestfs-actions.pod:2914
24091 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24092 " const char *root,\n"
24093 " size_t *size_r,\n"
24094 " const struct guestfs_inspect_get_icon_argv "
24100 #: ../src/guestfs-actions.pod:2920
24101 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24105 #: ../src/guestfs-actions.pod:2924
24106 msgid "guestfs_inspect_get_major_version"
24110 #: ../src/guestfs-actions.pod:2926
24114 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24115 " const char *root);\n"
24120 #: ../src/guestfs-actions.pod:2948
24121 msgid "guestfs_inspect_get_minor_version"
24125 #: ../src/guestfs-actions.pod:2950
24129 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24130 " const char *root);\n"
24135 #: ../src/guestfs-actions.pod:2959
24137 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24138 "C<guestfs_inspect_get_major_version>."
24142 #: ../src/guestfs-actions.pod:2966
24143 msgid "guestfs_inspect_get_mountpoints"
24147 #: ../src/guestfs-actions.pod:2968
24151 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24152 " const char *root);\n"
24157 #: ../src/guestfs-actions.pod:2989
24159 "For operating systems like Windows which still use drive letters, this call "
24160 "will only return an entry for the first drive \"mounted on\" C</>. For "
24161 "information about the mapping of drive letters to partitions, see "
24162 "C<guestfs_inspect_get_drive_mappings>."
24166 #: ../src/guestfs-actions.pod:2995
24168 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24169 "C<guestfs_inspect_get_filesystems>."
24173 #: ../src/guestfs-actions.pod:3006
24174 msgid "guestfs_inspect_get_package_format"
24178 #: ../src/guestfs-actions.pod:3008
24182 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24183 " const char *root);\n"
24188 #: ../src/guestfs-actions.pod:3012
24190 "This function and C<guestfs_inspect_get_package_management> return the "
24191 "package format and package management tool used by the inspected operating "
24192 "system. For example for Fedora these functions would return C<rpm> (package "
24193 "format) and C<yum> (package management)."
24197 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
24198 msgid "(Added in 1.7.5)"
24202 #: ../src/guestfs-actions.pod:3032
24203 msgid "guestfs_inspect_get_package_management"
24207 #: ../src/guestfs-actions.pod:3034
24211 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24212 " const char *root);\n"
24217 #: ../src/guestfs-actions.pod:3038
24219 "C<guestfs_inspect_get_package_format> and this function return the package "
24220 "format and package management tool used by the inspected operating system. "
24221 "For example for Fedora these functions would return C<rpm> (package format) "
24222 "and C<yum> (package management)."
24226 #: ../src/guestfs-actions.pod:3060
24227 msgid "guestfs_inspect_get_product_name"
24231 #: ../src/guestfs-actions.pod:3062
24235 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24236 " const char *root);\n"
24241 #: ../src/guestfs-actions.pod:3081
24242 msgid "guestfs_inspect_get_product_variant"
24246 #: ../src/guestfs-actions.pod:3083
24250 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24251 " const char *root);\n"
24256 #: ../src/guestfs-actions.pod:3106
24258 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24259 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24263 #: ../src/guestfs-actions.pod:3113
24264 msgid "(Added in 1.9.13)"
24268 #: ../src/guestfs-actions.pod:3115
24269 msgid "guestfs_inspect_get_roots"
24273 #: ../src/guestfs-actions.pod:3117
24277 " guestfs_inspect_get_roots (guestfs_h *g);\n"
24282 #: ../src/guestfs-actions.pod:3120
24284 "This function is a convenient way to get the list of root devices, as "
24285 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
24286 "the whole inspection process."
24290 #: ../src/guestfs-actions.pod:3124
24292 "This returns an empty list if either no root devices were found or the "
24293 "caller has not called C<guestfs_inspect_os>."
24297 #: ../src/guestfs-actions.pod:3133
24298 msgid "(Added in 1.7.3)"
24302 #: ../src/guestfs-actions.pod:3135
24303 msgid "guestfs_inspect_get_type"
24307 #: ../src/guestfs-actions.pod:3137
24311 " guestfs_inspect_get_type (guestfs_h *g,\n"
24312 " const char *root);\n"
24317 #: ../src/guestfs-actions.pod:3174
24318 msgid "guestfs_inspect_get_windows_current_control_set"
24322 #: ../src/guestfs-actions.pod:3176
24326 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
24327 " const char *root);\n"
24332 #: ../src/guestfs-actions.pod:3194
24333 msgid "guestfs_inspect_get_windows_systemroot"
24337 #: ../src/guestfs-actions.pod:3196
24341 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
24342 " const char *root);\n"
24347 #: ../src/guestfs-actions.pod:3212
24348 msgid "(Added in 1.5.25)"
24352 #: ../src/guestfs-actions.pod:3214
24353 msgid "guestfs_inspect_is_live"
24357 #: ../src/guestfs-actions.pod:3216
24361 " guestfs_inspect_is_live (guestfs_h *g,\n"
24362 " const char *root);\n"
24367 #: ../src/guestfs-actions.pod:3220
24369 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24370 "disk), then this returns true if a live image was detected on the disk."
24374 #: ../src/guestfs-actions.pod:3230
24375 msgid "guestfs_inspect_is_multipart"
24379 #: ../src/guestfs-actions.pod:3232
24383 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
24384 " const char *root);\n"
24389 #: ../src/guestfs-actions.pod:3236
24391 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24392 "disk), then this returns true if the disk is part of a set."
24396 #: ../src/guestfs-actions.pod:3246
24397 msgid "guestfs_inspect_is_netinst"
24401 #: ../src/guestfs-actions.pod:3248
24405 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
24406 " const char *root);\n"
24411 #: ../src/guestfs-actions.pod:3252
24413 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24414 "disk), then this returns true if the disk is a network installer, ie. not a "
24415 "self-contained install CD but one which is likely to require network access "
24416 "to complete the install."
24420 #: ../src/guestfs-actions.pod:3264
24421 msgid "guestfs_inspect_list_applications"
24425 #: ../src/guestfs-actions.pod:3266
24428 " struct guestfs_application_list *\n"
24429 " guestfs_inspect_list_applications (guestfs_h *g,\n"
24430 " const char *root);\n"
24435 #: ../src/guestfs-actions.pod:3272
24437 "I<Note:> This call works differently from other parts of the inspection "
24438 "API. You have to call C<guestfs_inspect_os>, then "
24439 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
24440 "this. Listing applications is a significantly more difficult operation "
24441 "which requires access to the full filesystem. Also note that unlike the "
24442 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
24443 "the libguestfs handle, this call actually reads parts of the mounted "
24444 "filesystems during the call."
24448 #: ../src/guestfs-actions.pod:3362
24450 "This function returns a C<struct guestfs_application_list *>, or NULL if "
24451 "there was an error. I<The caller must call C<guestfs_free_application_list> "
24456 #: ../src/guestfs-actions.pod:3366
24457 msgid "(Added in 1.7.8)"
24461 #: ../src/guestfs-actions.pod:3368
24462 msgid "guestfs_inspect_os"
24466 #: ../src/guestfs-actions.pod:3370
24470 " guestfs_inspect_os (guestfs_h *g);\n"
24475 #: ../src/guestfs-actions.pod:3386
24477 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
24478 "functions in order to query further information about each operating system, "
24479 "such as the name and version."
24483 #: ../src/guestfs-actions.pod:3391
24485 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
24486 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
24487 "the contents. This should be called with no disks currently mounted. The "
24488 "function may also use Augeas, so any existing Augeas handle will be closed."
24492 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3816
24493 msgid "See also C<guestfs_list_filesystems>."
24497 #: ../src/guestfs-actions.pod:3411
24498 msgid "guestfs_is_blockdev"
24502 #: ../src/guestfs-actions.pod:3413
24506 " guestfs_is_blockdev (guestfs_h *g,\n"
24507 " const char *path);\n"
24512 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3449 ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3581
24513 msgid "See also C<guestfs_stat>."
24517 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3585
24518 msgid "(Added in 1.5.10)"
24522 #: ../src/guestfs-actions.pod:3426
24523 msgid "guestfs_is_busy"
24527 #: ../src/guestfs-actions.pod:3428
24531 " guestfs_is_busy (guestfs_h *g);\n"
24536 #: ../src/guestfs-actions.pod:3440
24537 msgid "guestfs_is_chardev"
24541 #: ../src/guestfs-actions.pod:3442
24545 " guestfs_is_chardev (guestfs_h *g,\n"
24546 " const char *path);\n"
24551 #: ../src/guestfs-actions.pod:3455
24552 msgid "guestfs_is_config"
24556 #: ../src/guestfs-actions.pod:3457
24560 " guestfs_is_config (guestfs_h *g);\n"
24565 #: ../src/guestfs-actions.pod:3469
24566 msgid "guestfs_is_dir"
24570 #: ../src/guestfs-actions.pod:3471
24574 " guestfs_is_dir (guestfs_h *g,\n"
24575 " const char *path);\n"
24580 #: ../src/guestfs-actions.pod:3485
24581 msgid "guestfs_is_fifo"
24585 #: ../src/guestfs-actions.pod:3487
24589 " guestfs_is_fifo (guestfs_h *g,\n"
24590 " const char *path);\n"
24595 #: ../src/guestfs-actions.pod:3500
24596 msgid "guestfs_is_file"
24600 #: ../src/guestfs-actions.pod:3502
24604 " guestfs_is_file (guestfs_h *g,\n"
24605 " const char *path);\n"
24610 #: ../src/guestfs-actions.pod:3516
24611 msgid "guestfs_is_launching"
24615 #: ../src/guestfs-actions.pod:3518
24619 " guestfs_is_launching (guestfs_h *g);\n"
24624 #: ../src/guestfs-actions.pod:3530
24625 msgid "guestfs_is_lv"
24629 #: ../src/guestfs-actions.pod:3532
24633 " guestfs_is_lv (guestfs_h *g,\n"
24634 " const char *device);\n"
24639 #: ../src/guestfs-actions.pod:3543
24640 msgid "guestfs_is_ready"
24644 #: ../src/guestfs-actions.pod:3545
24648 " guestfs_is_ready (guestfs_h *g);\n"
24653 #: ../src/guestfs-actions.pod:3557
24654 msgid "guestfs_is_socket"
24658 #: ../src/guestfs-actions.pod:3559
24662 " guestfs_is_socket (guestfs_h *g,\n"
24663 " const char *path);\n"
24668 #: ../src/guestfs-actions.pod:3572
24669 msgid "guestfs_is_symlink"
24673 #: ../src/guestfs-actions.pod:3574
24677 " guestfs_is_symlink (guestfs_h *g,\n"
24678 " const char *path);\n"
24683 #: ../src/guestfs-actions.pod:3587
24684 msgid "guestfs_is_zero"
24688 #: ../src/guestfs-actions.pod:3589
24692 " guestfs_is_zero (guestfs_h *g,\n"
24693 " const char *path);\n"
24698 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3612
24699 msgid "(Added in 1.11.8)"
24703 #: ../src/guestfs-actions.pod:3600
24704 msgid "guestfs_is_zero_device"
24708 #: ../src/guestfs-actions.pod:3602
24712 " guestfs_is_zero_device (guestfs_h *g,\n"
24713 " const char *device);\n"
24718 #: ../src/guestfs-actions.pod:3614
24719 msgid "guestfs_kill_subprocess"
24723 #: ../src/guestfs-actions.pod:3616
24727 " guestfs_kill_subprocess (guestfs_h *g);\n"
24732 #: ../src/guestfs-actions.pod:3625
24733 msgid "guestfs_launch"
24737 #: ../src/guestfs-actions.pod:3627
24741 " guestfs_launch (guestfs_h *g);\n"
24746 #: ../src/guestfs-actions.pod:3645
24747 msgid "guestfs_lchown"
24751 #: ../src/guestfs-actions.pod:3647
24755 " guestfs_lchown (guestfs_h *g,\n"
24758 " const char *path);\n"
24763 #: ../src/guestfs-actions.pod:3653
24765 "Change the file owner to C<owner> and group to C<group>. This is like "
24766 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
24767 "changed, not the target."
24771 #: ../src/guestfs-actions.pod:3665
24772 msgid "guestfs_lgetxattr"
24776 #: ../src/guestfs-actions.pod:3667
24780 " guestfs_lgetxattr (guestfs_h *g,\n"
24781 " const char *path,\n"
24782 " const char *name,\n"
24783 " size_t *size_r);\n"
24788 #: ../src/guestfs-actions.pod:3687
24789 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
24793 #: ../src/guestfs-actions.pod:3695
24794 msgid "guestfs_lgetxattrs"
24798 #: ../src/guestfs-actions.pod:3697
24801 " struct guestfs_xattr_list *\n"
24802 " guestfs_lgetxattrs (guestfs_h *g,\n"
24803 " const char *path);\n"
24808 #: ../src/guestfs-actions.pod:3701
24810 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
24811 "then it returns the extended attributes of the link itself."
24815 #: ../src/guestfs-actions.pod:3711
24816 msgid "guestfs_list_9p"
24820 #: ../src/guestfs-actions.pod:3713
24824 " guestfs_list_9p (guestfs_h *g);\n"
24829 #: ../src/guestfs-actions.pod:3725
24830 msgid "guestfs_list_devices"
24834 #: ../src/guestfs-actions.pod:3727
24838 " guestfs_list_devices (guestfs_h *g);\n"
24843 #: ../src/guestfs-actions.pod:3742
24844 msgid "guestfs_list_dm_devices"
24848 #: ../src/guestfs-actions.pod:3744
24852 " guestfs_list_dm_devices (guestfs_h *g);\n"
24857 #: ../src/guestfs-actions.pod:3749
24859 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
24860 "previous call to C<guestfs_luks_open>."
24864 #: ../src/guestfs-actions.pod:3752
24866 "Device mapper devices which correspond to logical volumes are I<not> "
24867 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
24872 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:5216
24873 msgid "(Added in 1.11.15)"
24877 #: ../src/guestfs-actions.pod:3762
24878 msgid "guestfs_list_filesystems"
24882 #: ../src/guestfs-actions.pod:3764
24886 " guestfs_list_filesystems (guestfs_h *g);\n"
24891 #: ../src/guestfs-actions.pod:3784
24893 "This command runs other libguestfs commands, which might include "
24894 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
24895 "soon after launch and only when nothing is mounted."
24899 #: ../src/guestfs-actions.pod:3788
24901 "Not all of the filesystems returned will be mountable. In particular, swap "
24902 "partitions are returned in the list. Also this command does not check that "
24903 "each filesystem found is valid and mountable, and some filesystems might be "
24904 "mountable but require special options. Filesystems may not all belong to a "
24905 "single logical operating system (use C<guestfs_inspect_os> to look for "
24910 #: ../src/guestfs-actions.pod:3802 ../src/guestfs-actions.pod:5577
24911 msgid "(Added in 1.5.15)"
24915 #: ../src/guestfs-actions.pod:3804
24916 msgid "guestfs_list_partitions"
24920 #: ../src/guestfs-actions.pod:3806
24924 " guestfs_list_partitions (guestfs_h *g);\n"
24929 #: ../src/guestfs-actions.pod:3813
24931 "This does not return logical volumes. For that you will need to call "
24936 #: ../src/guestfs-actions.pod:3824
24941 #: ../src/guestfs-actions.pod:3826
24945 " guestfs_ll (guestfs_h *g,\n"
24946 " const char *directory);\n"
24951 #: ../src/guestfs-actions.pod:3841
24956 #: ../src/guestfs-actions.pod:3843
24960 " guestfs_ln (guestfs_h *g,\n"
24961 " const char *target,\n"
24962 " const char *linkname);\n"
24967 #: ../src/guestfs-actions.pod:3854
24968 msgid "guestfs_ln_f"
24972 #: ../src/guestfs-actions.pod:3856
24976 " guestfs_ln_f (guestfs_h *g,\n"
24977 " const char *target,\n"
24978 " const char *linkname);\n"
24983 #: ../src/guestfs-actions.pod:3868
24984 msgid "guestfs_ln_s"
24988 #: ../src/guestfs-actions.pod:3870
24992 " guestfs_ln_s (guestfs_h *g,\n"
24993 " const char *target,\n"
24994 " const char *linkname);\n"
24999 #: ../src/guestfs-actions.pod:3881
25000 msgid "guestfs_ln_sf"
25004 #: ../src/guestfs-actions.pod:3883
25008 " guestfs_ln_sf (guestfs_h *g,\n"
25009 " const char *target,\n"
25010 " const char *linkname);\n"
25015 #: ../src/guestfs-actions.pod:3895
25016 msgid "guestfs_lremovexattr"
25020 #: ../src/guestfs-actions.pod:3897
25024 " guestfs_lremovexattr (guestfs_h *g,\n"
25025 " const char *xattr,\n"
25026 " const char *path);\n"
25031 #: ../src/guestfs-actions.pod:3902
25033 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25034 "link, then it removes an extended attribute of the link itself."
25038 #: ../src/guestfs-actions.pod:3910
25043 #: ../src/guestfs-actions.pod:3912
25047 " guestfs_ls (guestfs_h *g,\n"
25048 " const char *directory);\n"
25053 #: ../src/guestfs-actions.pod:3920
25055 "This command is mostly useful for interactive sessions. Programs should "
25056 "probably use C<guestfs_readdir> instead."
25060 #: ../src/guestfs-actions.pod:3929
25061 msgid "guestfs_lsetxattr"
25065 #: ../src/guestfs-actions.pod:3931
25069 " guestfs_lsetxattr (guestfs_h *g,\n"
25070 " const char *xattr,\n"
25071 " const char *val,\n"
25073 " const char *path);\n"
25078 #: ../src/guestfs-actions.pod:3938
25080 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25081 "then it sets an extended attribute of the link itself."
25085 #: ../src/guestfs-actions.pod:3946
25086 msgid "guestfs_lstat"
25090 #: ../src/guestfs-actions.pod:3948
25093 " struct guestfs_stat *\n"
25094 " guestfs_lstat (guestfs_h *g,\n"
25095 " const char *path);\n"
25100 #: ../src/guestfs-actions.pod:3954
25102 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25103 "link, then the link is stat-ed, not the file it refers to."
25107 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:6735
25109 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25110 "error. I<The caller must call C<guestfs_free_stat> after use>."
25114 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:7138
25115 msgid "(Added in 0.9.2)"
25119 #: ../src/guestfs-actions.pod:3966
25120 msgid "guestfs_lstatlist"
25124 #: ../src/guestfs-actions.pod:3968
25127 " struct guestfs_stat_list *\n"
25128 " guestfs_lstatlist (guestfs_h *g,\n"
25129 " const char *path,\n"
25130 " char *const *names);\n"
25135 #: ../src/guestfs-actions.pod:3973
25137 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25138 "files, where all files are in the directory C<path>. C<names> is the list "
25139 "of files from this directory."
25143 #: ../src/guestfs-actions.pod:3982
25145 "This call is intended for programs that want to efficiently list a directory "
25146 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25147 "for a similarly efficient call for getting extended attributes. Very long "
25148 "directory listings might cause the protocol message size to be exceeded, "
25149 "causing this call to fail. The caller must split up such requests into "
25150 "smaller groups of names."
25154 #: ../src/guestfs-actions.pod:3990
25156 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25157 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25161 #: ../src/guestfs-actions.pod:3996
25162 msgid "guestfs_luks_add_key"
25166 #: ../src/guestfs-actions.pod:3998
25170 " guestfs_luks_add_key (guestfs_h *g,\n"
25171 " const char *device,\n"
25172 " const char *key,\n"
25173 " const char *newkey,\n"
25179 #: ../src/guestfs-actions.pod:4010
25181 "Note that if C<keyslot> already contains a key, then this command will "
25182 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
25186 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4099 ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4153
25188 "This function takes a key or passphrase parameter which could contain "
25189 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
25194 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4103
25195 msgid "(Added in 1.5.2)"
25199 #: ../src/guestfs-actions.pod:4022
25200 msgid "guestfs_luks_close"
25204 #: ../src/guestfs-actions.pod:4024
25208 " guestfs_luks_close (guestfs_h *g,\n"
25209 " const char *device);\n"
25214 #: ../src/guestfs-actions.pod:4028
25216 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25217 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
25218 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25219 "underlying block device."
25223 #: ../src/guestfs-actions.pod:4036 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4255
25224 msgid "(Added in 1.5.1)"
25228 #: ../src/guestfs-actions.pod:4038
25229 msgid "guestfs_luks_format"
25233 #: ../src/guestfs-actions.pod:4040
25237 " guestfs_luks_format (guestfs_h *g,\n"
25238 " const char *device,\n"
25239 " const char *key,\n"
25245 #: ../src/guestfs-actions.pod:4062
25246 msgid "guestfs_luks_format_cipher"
25250 #: ../src/guestfs-actions.pod:4064
25254 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25255 " const char *device,\n"
25256 " const char *key,\n"
25258 " const char *cipher);\n"
25263 #: ../src/guestfs-actions.pod:4071
25265 "This command is the same as C<guestfs_luks_format> but it also allows you to "
25266 "set the C<cipher> used."
25270 #: ../src/guestfs-actions.pod:4085
25271 msgid "guestfs_luks_kill_slot"
25275 #: ../src/guestfs-actions.pod:4087
25279 " guestfs_luks_kill_slot (guestfs_h *g,\n"
25280 " const char *device,\n"
25281 " const char *key,\n"
25287 #: ../src/guestfs-actions.pod:4105
25288 msgid "guestfs_luks_open"
25292 #: ../src/guestfs-actions.pod:4107
25296 " guestfs_luks_open (guestfs_h *g,\n"
25297 " const char *device,\n"
25298 " const char *key,\n"
25299 " const char *mapname);\n"
25304 #: ../src/guestfs-actions.pod:4125
25306 "If this block device contains LVM volume groups, then calling "
25307 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
25312 #: ../src/guestfs-actions.pod:4129
25313 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
25317 #: ../src/guestfs-actions.pod:4140
25318 msgid "guestfs_luks_open_ro"
25322 #: ../src/guestfs-actions.pod:4142
25326 " guestfs_luks_open_ro (guestfs_h *g,\n"
25327 " const char *device,\n"
25328 " const char *key,\n"
25329 " const char *mapname);\n"
25334 #: ../src/guestfs-actions.pod:4148
25336 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
25341 #: ../src/guestfs-actions.pod:4159
25342 msgid "guestfs_lvcreate"
25346 #: ../src/guestfs-actions.pod:4161
25350 " guestfs_lvcreate (guestfs_h *g,\n"
25351 " const char *logvol,\n"
25352 " const char *volgroup,\n"
25358 #: ../src/guestfs-actions.pod:4174
25359 msgid "guestfs_lvm_canonical_lv_name"
25363 #: ../src/guestfs-actions.pod:4176
25367 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
25368 " const char *lvname);\n"
25373 #: ../src/guestfs-actions.pod:4187
25374 msgid "See also C<guestfs_is_lv>."
25378 #: ../src/guestfs-actions.pod:4192
25379 msgid "(Added in 1.5.24)"
25383 #: ../src/guestfs-actions.pod:4194
25384 msgid "guestfs_lvm_clear_filter"
25388 #: ../src/guestfs-actions.pod:4196
25392 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
25397 #: ../src/guestfs-actions.pod:4199
25399 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
25400 "see every block device."
25404 #: ../src/guestfs-actions.pod:4209
25405 msgid "guestfs_lvm_remove_all"
25409 #: ../src/guestfs-actions.pod:4211
25413 " guestfs_lvm_remove_all (guestfs_h *g);\n"
25418 #: ../src/guestfs-actions.pod:4224
25419 msgid "guestfs_lvm_set_filter"
25423 #: ../src/guestfs-actions.pod:4226
25427 " guestfs_lvm_set_filter (guestfs_h *g,\n"
25428 " char *const *devices);\n"
25433 #: ../src/guestfs-actions.pod:4257
25434 msgid "guestfs_lvremove"
25438 #: ../src/guestfs-actions.pod:4259
25442 " guestfs_lvremove (guestfs_h *g,\n"
25443 " const char *device);\n"
25448 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:7508
25449 msgid "(Added in 1.0.13)"
25453 #: ../src/guestfs-actions.pod:4273
25454 msgid "guestfs_lvrename"
25458 #: ../src/guestfs-actions.pod:4275
25462 " guestfs_lvrename (guestfs_h *g,\n"
25463 " const char *logvol,\n"
25464 " const char *newlogvol);\n"
25469 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:7521
25470 msgid "(Added in 1.0.83)"
25474 #: ../src/guestfs-actions.pod:4286
25475 msgid "guestfs_lvresize"
25479 #: ../src/guestfs-actions.pod:4288
25483 " guestfs_lvresize (guestfs_h *g,\n"
25484 " const char *device,\n"
25490 #: ../src/guestfs-actions.pod:4301
25491 msgid "guestfs_lvresize_free"
25495 #: ../src/guestfs-actions.pod:4303
25499 " guestfs_lvresize_free (guestfs_h *g,\n"
25500 " const char *lv,\n"
25506 #: ../src/guestfs-actions.pod:4316
25507 msgid "(Added in 1.3.3)"
25511 #: ../src/guestfs-actions.pod:4318
25512 msgid "guestfs_lvs"
25516 #: ../src/guestfs-actions.pod:4320
25520 " guestfs_lvs (guestfs_h *g);\n"
25525 #: ../src/guestfs-actions.pod:4329
25526 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
25530 #: ../src/guestfs-actions.pod:4337
25531 msgid "guestfs_lvs_full"
25535 #: ../src/guestfs-actions.pod:4339
25538 " struct guestfs_lvm_lv_list *\n"
25539 " guestfs_lvs_full (guestfs_h *g);\n"
25544 #: ../src/guestfs-actions.pod:4345
25546 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
25547 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
25552 #: ../src/guestfs-actions.pod:4351
25553 msgid "guestfs_lvuuid"
25557 #: ../src/guestfs-actions.pod:4353
25561 " guestfs_lvuuid (guestfs_h *g,\n"
25562 " const char *device);\n"
25567 #: ../src/guestfs-actions.pod:4364
25568 msgid "guestfs_lxattrlist"
25572 #: ../src/guestfs-actions.pod:4366
25575 " struct guestfs_xattr_list *\n"
25576 " guestfs_lxattrlist (guestfs_h *g,\n"
25577 " const char *path,\n"
25578 " char *const *names);\n"
25583 #: ../src/guestfs-actions.pod:4385
25585 "This call is intended for programs that want to efficiently list a directory "
25586 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
25587 "a similarly efficient call for getting standard stats. Very long directory "
25588 "listings might cause the protocol message size to be exceeded, causing this "
25589 "call to fail. The caller must split up such requests into smaller groups of "
25594 #: ../src/guestfs-actions.pod:4399
25595 msgid "guestfs_mkdir"
25599 #: ../src/guestfs-actions.pod:4401
25603 " guestfs_mkdir (guestfs_h *g,\n"
25604 " const char *path);\n"
25609 #: ../src/guestfs-actions.pod:4411
25610 msgid "guestfs_mkdir_mode"
25614 #: ../src/guestfs-actions.pod:4413
25618 " guestfs_mkdir_mode (guestfs_h *g,\n"
25619 " const char *path,\n"
25625 #: ../src/guestfs-actions.pod:4425
25626 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
25630 #: ../src/guestfs-actions.pod:4431
25631 msgid "guestfs_mkdir_p"
25635 #: ../src/guestfs-actions.pod:4433
25639 " guestfs_mkdir_p (guestfs_h *g,\n"
25640 " const char *path);\n"
25645 #: ../src/guestfs-actions.pod:4444
25646 msgid "guestfs_mkdtemp"
25650 #: ../src/guestfs-actions.pod:4446
25654 " guestfs_mkdtemp (guestfs_h *g,\n"
25655 " const char *template);\n"
25660 #: ../src/guestfs-actions.pod:4474
25661 msgid "guestfs_mke2fs_J"
25665 #: ../src/guestfs-actions.pod:4476
25669 " guestfs_mke2fs_J (guestfs_h *g,\n"
25670 " const char *fstype,\n"
25671 " int blocksize,\n"
25672 " const char *device,\n"
25673 " const char *journal);\n"
25678 #: ../src/guestfs-actions.pod:4489
25679 msgid "See also C<guestfs_mke2journal>."
25683 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4529 ../src/guestfs-actions.pod:4545 ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4573 ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4909
25684 msgid "(Added in 1.0.68)"
25688 #: ../src/guestfs-actions.pod:4495
25689 msgid "guestfs_mke2fs_JL"
25693 #: ../src/guestfs-actions.pod:4497
25697 " guestfs_mke2fs_JL (guestfs_h *g,\n"
25698 " const char *fstype,\n"
25699 " int blocksize,\n"
25700 " const char *device,\n"
25701 " const char *label);\n"
25706 #: ../src/guestfs-actions.pod:4507
25707 msgid "See also C<guestfs_mke2journal_L>."
25711 #: ../src/guestfs-actions.pod:4513
25712 msgid "guestfs_mke2fs_JU"
25716 #: ../src/guestfs-actions.pod:4515
25720 " guestfs_mke2fs_JU (guestfs_h *g,\n"
25721 " const char *fstype,\n"
25722 " int blocksize,\n"
25723 " const char *device,\n"
25724 " const char *uuid);\n"
25729 #: ../src/guestfs-actions.pod:4525
25730 msgid "See also C<guestfs_mke2journal_U>."
25734 #: ../src/guestfs-actions.pod:4531
25735 msgid "guestfs_mke2journal"
25739 #: ../src/guestfs-actions.pod:4533
25743 " guestfs_mke2journal (guestfs_h *g,\n"
25744 " int blocksize,\n"
25745 " const char *device);\n"
25750 #: ../src/guestfs-actions.pod:4547
25751 msgid "guestfs_mke2journal_L"
25755 #: ../src/guestfs-actions.pod:4549
25759 " guestfs_mke2journal_L (guestfs_h *g,\n"
25760 " int blocksize,\n"
25761 " const char *label,\n"
25762 " const char *device);\n"
25767 #: ../src/guestfs-actions.pod:4561
25768 msgid "guestfs_mke2journal_U"
25772 #: ../src/guestfs-actions.pod:4563
25776 " guestfs_mke2journal_U (guestfs_h *g,\n"
25777 " int blocksize,\n"
25778 " const char *uuid,\n"
25779 " const char *device);\n"
25784 #: ../src/guestfs-actions.pod:4575
25785 msgid "guestfs_mkfifo"
25789 #: ../src/guestfs-actions.pod:4577
25793 " guestfs_mkfifo (guestfs_h *g,\n"
25795 " const char *path);\n"
25800 #: ../src/guestfs-actions.pod:4582
25802 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25803 "is just a convenient wrapper around C<guestfs_mknod>."
25807 #: ../src/guestfs-actions.pod:4592
25808 msgid "guestfs_mkfs"
25812 #: ../src/guestfs-actions.pod:4594
25816 " guestfs_mkfs (guestfs_h *g,\n"
25817 " const char *fstype,\n"
25818 " const char *device);\n"
25823 #: ../src/guestfs-actions.pod:4607
25824 msgid "guestfs_mkfs_b"
25828 #: ../src/guestfs-actions.pod:4609
25832 " guestfs_mkfs_b (guestfs_h *g,\n"
25833 " const char *fstype,\n"
25834 " int blocksize,\n"
25835 " const char *device);\n"
25840 #: ../src/guestfs-actions.pod:4615
25842 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
25843 "block size of the resulting filesystem. Supported block sizes depend on the "
25844 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25848 #: ../src/guestfs-actions.pod:4625
25850 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
25855 #: ../src/guestfs-actions.pod:4634
25856 msgid "guestfs_mkfs_opts"
25860 #: ../src/guestfs-actions.pod:4636
25864 " guestfs_mkfs_opts (guestfs_h *g,\n"
25865 " const char *fstype,\n"
25866 " const char *device,\n"
25872 #: ../src/guestfs-actions.pod:4647
25875 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
25876 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
25877 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
25878 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
25883 #: ../src/guestfs-actions.pod:4695
25884 msgid "(Added in 1.7.19)"
25888 #: ../src/guestfs-actions.pod:4697
25889 msgid "guestfs_mkfs_opts_va"
25893 #: ../src/guestfs-actions.pod:4699
25897 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
25898 " const char *fstype,\n"
25899 " const char *device,\n"
25900 " va_list args);\n"
25905 #: ../src/guestfs-actions.pod:4705
25906 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
25910 #: ../src/guestfs-actions.pod:4709
25911 msgid "guestfs_mkfs_opts_argv"
25915 #: ../src/guestfs-actions.pod:4711
25919 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
25920 " const char *fstype,\n"
25921 " const char *device,\n"
25922 " const struct guestfs_mkfs_opts_argv *optargs);\n"
25927 #: ../src/guestfs-actions.pod:4717
25928 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
25932 #: ../src/guestfs-actions.pod:4721
25933 msgid "guestfs_mkmountpoint"
25937 #: ../src/guestfs-actions.pod:4723
25941 " guestfs_mkmountpoint (guestfs_h *g,\n"
25942 " const char *exemptpath);\n"
25947 #: ../src/guestfs-actions.pod:4727
25949 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
25950 "that can be used to create extra mountpoints before mounting the first "
25955 #: ../src/guestfs-actions.pod:4751
25957 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
25958 "may get unexpected errors if you try to mix these calls. It is safest to "
25959 "manually unmount filesystems and remove mountpoints after use."
25963 #: ../src/guestfs-actions.pod:4755
25965 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
25966 "first, so for this to work for manual mountpoints, you must ensure that the "
25967 "innermost mountpoints have the longest pathnames, as in the example code "
25972 #: ../src/guestfs-actions.pod:4762
25974 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
25975 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
25976 "can also trigger these issues."
25980 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:5084 ../src/guestfs-actions.pod:6094
25981 msgid "(Added in 1.0.62)"
25985 #: ../src/guestfs-actions.pod:4770
25986 msgid "guestfs_mknod"
25990 #: ../src/guestfs-actions.pod:4772
25994 " guestfs_mknod (guestfs_h *g,\n"
25998 " const char *path);\n"
26003 #: ../src/guestfs-actions.pod:4787
26005 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26006 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26007 "regular file). These constants are available in the standard Linux header "
26008 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26009 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26010 "the appropriate constant for you."
26014 #: ../src/guestfs-actions.pod:4801
26015 msgid "guestfs_mknod_b"
26019 #: ../src/guestfs-actions.pod:4803
26023 " guestfs_mknod_b (guestfs_h *g,\n"
26027 " const char *path);\n"
26032 #: ../src/guestfs-actions.pod:4810
26034 "This call creates a block device node called C<path> with mode C<mode> and "
26035 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26036 "wrapper around C<guestfs_mknod>."
26040 #: ../src/guestfs-actions.pod:4820
26041 msgid "guestfs_mknod_c"
26045 #: ../src/guestfs-actions.pod:4822
26049 " guestfs_mknod_c (guestfs_h *g,\n"
26053 " const char *path);\n"
26058 #: ../src/guestfs-actions.pod:4829
26060 "This call creates a char device node called C<path> with mode C<mode> and "
26061 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26062 "wrapper around C<guestfs_mknod>."
26066 #: ../src/guestfs-actions.pod:4839
26067 msgid "guestfs_mkswap"
26071 #: ../src/guestfs-actions.pod:4841
26075 " guestfs_mkswap (guestfs_h *g,\n"
26076 " const char *device);\n"
26081 #: ../src/guestfs-actions.pod:4851
26082 msgid "guestfs_mkswap_L"
26086 #: ../src/guestfs-actions.pod:4853
26090 " guestfs_mkswap_L (guestfs_h *g,\n"
26091 " const char *label,\n"
26092 " const char *device);\n"
26097 #: ../src/guestfs-actions.pod:4868
26098 msgid "guestfs_mkswap_U"
26102 #: ../src/guestfs-actions.pod:4870
26106 " guestfs_mkswap_U (guestfs_h *g,\n"
26107 " const char *uuid,\n"
26108 " const char *device);\n"
26113 #: ../src/guestfs-actions.pod:4881
26114 msgid "guestfs_mkswap_file"
26118 #: ../src/guestfs-actions.pod:4883
26122 " guestfs_mkswap_file (guestfs_h *g,\n"
26123 " const char *path);\n"
26128 #: ../src/guestfs-actions.pod:4889
26130 "This command just writes a swap file signature to an existing file. To "
26131 "create the file itself, use something like C<guestfs_fallocate>."
26135 #: ../src/guestfs-actions.pod:4896
26136 msgid "guestfs_modprobe"
26140 #: ../src/guestfs-actions.pod:4898
26144 " guestfs_modprobe (guestfs_h *g,\n"
26145 " const char *modulename);\n"
26150 #: ../src/guestfs-actions.pod:4911
26151 msgid "guestfs_mount"
26155 #: ../src/guestfs-actions.pod:4913
26159 " guestfs_mount (guestfs_h *g,\n"
26160 " const char *device,\n"
26161 " const char *mountpoint);\n"
26166 #: ../src/guestfs-actions.pod:4932
26168 "B<Important note:> When you use this call, the filesystem options C<sync> "
26169 "and C<noatime> are set implicitly. This was originally done because we "
26170 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26171 "very large negative performance impact and negligible effect on "
26172 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
26173 "in any code that needs performance, and instead use C<guestfs_mount_options> "
26174 "(use an empty string for the first parameter if you don't want any options)."
26178 #: ../src/guestfs-actions.pod:4944
26180 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
26185 #: ../src/guestfs-actions.pod:4953
26186 msgid "guestfs_mount_9p"
26190 #: ../src/guestfs-actions.pod:4955
26194 " guestfs_mount_9p (guestfs_h *g,\n"
26195 " const char *mounttag,\n"
26196 " const char *mountpoint,\n"
26202 #: ../src/guestfs-actions.pod:4966
26205 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26210 #: ../src/guestfs-actions.pod:4979
26211 msgid "guestfs_mount_9p_va"
26215 #: ../src/guestfs-actions.pod:4981
26219 " guestfs_mount_9p_va (guestfs_h *g,\n"
26220 " const char *mounttag,\n"
26221 " const char *mountpoint,\n"
26222 " va_list args);\n"
26227 #: ../src/guestfs-actions.pod:4987
26228 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26232 #: ../src/guestfs-actions.pod:4991
26233 msgid "guestfs_mount_9p_argv"
26237 #: ../src/guestfs-actions.pod:4993
26241 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26242 " const char *mounttag,\n"
26243 " const char *mountpoint,\n"
26244 " const struct guestfs_mount_9p_argv *optargs);\n"
26249 #: ../src/guestfs-actions.pod:4999
26250 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26254 #: ../src/guestfs-actions.pod:5003
26255 msgid "guestfs_mount_loop"
26259 #: ../src/guestfs-actions.pod:5005
26263 " guestfs_mount_loop (guestfs_h *g,\n"
26264 " const char *file,\n"
26265 " const char *mountpoint);\n"
26270 #: ../src/guestfs-actions.pod:5018
26271 msgid "guestfs_mount_options"
26275 #: ../src/guestfs-actions.pod:5020
26279 " guestfs_mount_options (guestfs_h *g,\n"
26280 " const char *options,\n"
26281 " const char *device,\n"
26282 " const char *mountpoint);\n"
26287 #: ../src/guestfs-actions.pod:5026
26289 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26290 "the mount options as for the L<mount(8)> I<-o> flag."
26294 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5050 ../src/guestfs-actions.pod:5067
26295 msgid "(Added in 1.0.10)"
26299 #: ../src/guestfs-actions.pod:5038
26300 msgid "guestfs_mount_ro"
26304 #: ../src/guestfs-actions.pod:5040
26308 " guestfs_mount_ro (guestfs_h *g,\n"
26309 " const char *device,\n"
26310 " const char *mountpoint);\n"
26315 #: ../src/guestfs-actions.pod:5045
26317 "This is the same as the C<guestfs_mount> command, but it mounts the "
26318 "filesystem with the read-only (I<-o ro>) flag."
26322 #: ../src/guestfs-actions.pod:5052
26323 msgid "guestfs_mount_vfs"
26327 #: ../src/guestfs-actions.pod:5054
26331 " guestfs_mount_vfs (guestfs_h *g,\n"
26332 " const char *options,\n"
26333 " const char *vfstype,\n"
26334 " const char *device,\n"
26335 " const char *mountpoint);\n"
26340 #: ../src/guestfs-actions.pod:5061
26342 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26343 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
26348 #: ../src/guestfs-actions.pod:5069
26349 msgid "guestfs_mountpoints"
26353 #: ../src/guestfs-actions.pod:5071
26357 " guestfs_mountpoints (guestfs_h *g);\n"
26362 #: ../src/guestfs-actions.pod:5074
26364 "This call is similar to C<guestfs_mounts>. That call returns a list of "
26365 "devices. This one returns a hash table (map) of device name to directory "
26366 "where the device is mounted."
26370 #: ../src/guestfs-actions.pod:5086
26371 msgid "guestfs_mounts"
26375 #: ../src/guestfs-actions.pod:5088
26379 " guestfs_mounts (guestfs_h *g);\n"
26384 #: ../src/guestfs-actions.pod:5096
26385 msgid "See also: C<guestfs_mountpoints>"
26389 #: ../src/guestfs-actions.pod:5104
26394 #: ../src/guestfs-actions.pod:5106
26398 " guestfs_mv (guestfs_h *g,\n"
26399 " const char *src,\n"
26400 " const char *dest);\n"
26405 #: ../src/guestfs-actions.pod:5118
26406 msgid "guestfs_ntfs_3g_probe"
26410 #: ../src/guestfs-actions.pod:5120
26414 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
26416 " const char *device);\n"
26421 #: ../src/guestfs-actions.pod:5139
26422 msgid "(Added in 1.0.43)"
26426 #: ../src/guestfs-actions.pod:5141
26427 msgid "guestfs_ntfsresize"
26431 #: ../src/guestfs-actions.pod:5143
26435 " guestfs_ntfsresize (guestfs_h *g,\n"
26436 " const char *device);\n"
26441 #: ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5252
26443 "This function is deprecated. In new code, use the "
26444 "L</guestfs_ntfsresize_opts> call instead."
26448 #: ../src/guestfs-actions.pod:5171
26449 msgid "guestfs_ntfsresize_opts"
26453 #: ../src/guestfs-actions.pod:5173
26457 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
26458 " const char *device,\n"
26464 #: ../src/guestfs-actions.pod:5183
26467 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
26468 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
26473 #: ../src/guestfs-actions.pod:5203
26475 "After the resize operation, the filesystem is always marked as requiring a "
26476 "consistency check (for safety). You have to boot into Windows to perform "
26477 "this check and clear this condition. If you I<don't> set the C<force> "
26478 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
26479 "times on a single filesystem without booting into Windows between each "
26484 #: ../src/guestfs-actions.pod:5218
26485 msgid "guestfs_ntfsresize_opts_va"
26489 #: ../src/guestfs-actions.pod:5220
26493 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
26494 " const char *device,\n"
26495 " va_list args);\n"
26500 #: ../src/guestfs-actions.pod:5225
26501 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
26505 #: ../src/guestfs-actions.pod:5229
26506 msgid "guestfs_ntfsresize_opts_argv"
26510 #: ../src/guestfs-actions.pod:5231
26514 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
26515 " const char *device,\n"
26516 " const struct guestfs_ntfsresize_opts_argv "
26522 #: ../src/guestfs-actions.pod:5236
26523 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
26527 #: ../src/guestfs-actions.pod:5240
26528 msgid "guestfs_ntfsresize_size"
26532 #: ../src/guestfs-actions.pod:5242
26536 " guestfs_ntfsresize_size (guestfs_h *g,\n"
26537 " const char *device,\n"
26538 " int64_t size);\n"
26543 #: ../src/guestfs-actions.pod:5247
26545 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
26546 "to specify the new size (in bytes) explicitly."
26550 #: ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:7665
26551 msgid "(Added in 1.3.14)"
26555 #: ../src/guestfs-actions.pod:5261
26556 msgid "guestfs_part_add"
26560 #: ../src/guestfs-actions.pod:5263
26564 " guestfs_part_add (guestfs_h *g,\n"
26565 " const char *device,\n"
26566 " const char *prlogex,\n"
26567 " int64_t startsect,\n"
26568 " int64_t endsect);\n"
26573 #: ../src/guestfs-actions.pod:5270
26575 "This command adds a partition to C<device>. If there is no partition table "
26576 "on the device, call C<guestfs_part_init> first."
26580 #: ../src/guestfs-actions.pod:5282
26582 "Creating a partition which covers the whole disk is not so easy. Use "
26583 "C<guestfs_part_disk> to do that."
26587 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5519 ../src/guestfs-actions.pod:5559
26588 msgid "(Added in 1.0.78)"
26592 #: ../src/guestfs-actions.pod:5289
26593 msgid "guestfs_part_del"
26597 #: ../src/guestfs-actions.pod:5291
26601 " guestfs_part_del (guestfs_h *g,\n"
26602 " const char *device,\n"
26608 #: ../src/guestfs-actions.pod:5306
26609 msgid "guestfs_part_disk"
26613 #: ../src/guestfs-actions.pod:5308
26617 " guestfs_part_disk (guestfs_h *g,\n"
26618 " const char *device,\n"
26619 " const char *parttype);\n"
26624 #: ../src/guestfs-actions.pod:5313
26626 "This command is simply a combination of C<guestfs_part_init> followed by "
26627 "C<guestfs_part_add> to create a single primary partition covering the whole "
26632 #: ../src/guestfs-actions.pod:5317
26634 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26635 "possible values are described in C<guestfs_part_init>."
26639 #: ../src/guestfs-actions.pod:5327
26640 msgid "guestfs_part_get_bootable"
26644 #: ../src/guestfs-actions.pod:5329
26648 " guestfs_part_get_bootable (guestfs_h *g,\n"
26649 " const char *device,\n"
26655 #: ../src/guestfs-actions.pod:5337
26656 msgid "See also C<guestfs_part_set_bootable>."
26660 #: ../src/guestfs-actions.pod:5343
26661 msgid "guestfs_part_get_mbr_id"
26665 #: ../src/guestfs-actions.pod:5345
26669 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
26670 " const char *device,\n"
26676 #: ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5535
26678 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26679 "undefined results for other partition table types (see "
26680 "C<guestfs_part_get_parttype>)."
26684 #: ../src/guestfs-actions.pod:5361
26685 msgid "guestfs_part_get_parttype"
26689 #: ../src/guestfs-actions.pod:5363
26693 " guestfs_part_get_parttype (guestfs_h *g,\n"
26694 " const char *device);\n"
26699 #: ../src/guestfs-actions.pod:5370
26701 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26702 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26703 "possible, although unusual. See C<guestfs_part_init> for a full list."
26707 #: ../src/guestfs-actions.pod:5380
26708 msgid "guestfs_part_init"
26712 #: ../src/guestfs-actions.pod:5382
26716 " guestfs_part_init (guestfs_h *g,\n"
26717 " const char *device,\n"
26718 " const char *parttype);\n"
26723 #: ../src/guestfs-actions.pod:5391
26725 "Initially there are no partitions. Following this, you should call "
26726 "C<guestfs_part_add> for each partition required."
26730 #: ../src/guestfs-actions.pod:5464
26731 msgid "guestfs_part_list"
26735 #: ../src/guestfs-actions.pod:5466
26738 " struct guestfs_partition_list *\n"
26739 " guestfs_part_list (guestfs_h *g,\n"
26740 " const char *device);\n"
26745 #: ../src/guestfs-actions.pod:5483
26747 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26748 "the device's sector size, see C<guestfs_blockdev_getss>."
26752 #: ../src/guestfs-actions.pod:5496
26754 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
26755 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
26760 #: ../src/guestfs-actions.pod:5502
26761 msgid "guestfs_part_set_bootable"
26765 #: ../src/guestfs-actions.pod:5504
26769 " guestfs_part_set_bootable (guestfs_h *g,\n"
26770 " const char *device,\n"
26772 " int bootable);\n"
26777 #: ../src/guestfs-actions.pod:5521
26778 msgid "guestfs_part_set_mbr_id"
26782 #: ../src/guestfs-actions.pod:5523
26786 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
26787 " const char *device,\n"
26794 #: ../src/guestfs-actions.pod:5543
26795 msgid "guestfs_part_set_name"
26799 #: ../src/guestfs-actions.pod:5545
26803 " guestfs_part_set_name (guestfs_h *g,\n"
26804 " const char *device,\n"
26806 " const char *name);\n"
26811 #: ../src/guestfs-actions.pod:5561
26812 msgid "guestfs_part_to_dev"
26816 #: ../src/guestfs-actions.pod:5563
26820 " guestfs_part_to_dev (guestfs_h *g,\n"
26821 " const char *partition);\n"
26826 #: ../src/guestfs-actions.pod:5571
26828 "The named partition must exist, for example as a string returned from "
26829 "C<guestfs_list_partitions>."
26833 #: ../src/guestfs-actions.pod:5579
26834 msgid "guestfs_ping_daemon"
26838 #: ../src/guestfs-actions.pod:5581
26842 " guestfs_ping_daemon (guestfs_h *g);\n"
26847 #: ../src/guestfs-actions.pod:5593
26848 msgid "guestfs_pread"
26852 #: ../src/guestfs-actions.pod:5595
26856 " guestfs_pread (guestfs_h *g,\n"
26857 " const char *path,\n"
26859 " int64_t offset,\n"
26860 " size_t *size_r);\n"
26865 #: ../src/guestfs-actions.pod:5608
26866 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
26870 #: ../src/guestfs-actions.pod:5619
26871 msgid "guestfs_pread_device"
26875 #: ../src/guestfs-actions.pod:5621
26879 " guestfs_pread_device (guestfs_h *g,\n"
26880 " const char *device,\n"
26882 " int64_t offset,\n"
26883 " size_t *size_r);\n"
26888 #: ../src/guestfs-actions.pod:5634
26889 msgid "See also C<guestfs_pread>."
26893 #: ../src/guestfs-actions.pod:5643
26894 msgid "(Added in 1.5.21)"
26898 #: ../src/guestfs-actions.pod:5645
26899 msgid "guestfs_pvcreate"
26903 #: ../src/guestfs-actions.pod:5647
26907 " guestfs_pvcreate (guestfs_h *g,\n"
26908 " const char *device);\n"
26913 #: ../src/guestfs-actions.pod:5659
26914 msgid "guestfs_pvremove"
26918 #: ../src/guestfs-actions.pod:5661
26922 " guestfs_pvremove (guestfs_h *g,\n"
26923 " const char *device);\n"
26928 #: ../src/guestfs-actions.pod:5676
26929 msgid "guestfs_pvresize"
26933 #: ../src/guestfs-actions.pod:5678
26937 " guestfs_pvresize (guestfs_h *g,\n"
26938 " const char *device);\n"
26943 #: ../src/guestfs-actions.pod:5689
26944 msgid "guestfs_pvresize_size"
26948 #: ../src/guestfs-actions.pod:5691
26952 " guestfs_pvresize_size (guestfs_h *g,\n"
26953 " const char *device,\n"
26954 " int64_t size);\n"
26959 #: ../src/guestfs-actions.pod:5696
26961 "This command is the same as C<guestfs_pvresize> except that it allows you to "
26962 "specify the new size (in bytes) explicitly."
26966 #: ../src/guestfs-actions.pod:5703
26967 msgid "guestfs_pvs"
26971 #: ../src/guestfs-actions.pod:5705
26975 " guestfs_pvs (guestfs_h *g);\n"
26980 #: ../src/guestfs-actions.pod:5714
26981 msgid "See also C<guestfs_pvs_full>."
26985 #: ../src/guestfs-actions.pod:5722
26986 msgid "guestfs_pvs_full"
26990 #: ../src/guestfs-actions.pod:5724
26993 " struct guestfs_lvm_pv_list *\n"
26994 " guestfs_pvs_full (guestfs_h *g);\n"
26999 #: ../src/guestfs-actions.pod:5730
27001 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27002 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
27007 #: ../src/guestfs-actions.pod:5736
27008 msgid "guestfs_pvuuid"
27012 #: ../src/guestfs-actions.pod:5738
27016 " guestfs_pvuuid (guestfs_h *g,\n"
27017 " const char *device);\n"
27022 #: ../src/guestfs-actions.pod:5749
27023 msgid "guestfs_pwrite"
27027 #: ../src/guestfs-actions.pod:5751
27031 " guestfs_pwrite (guestfs_h *g,\n"
27032 " const char *path,\n"
27033 " const char *content,\n"
27034 " size_t content_size,\n"
27035 " int64_t offset);\n"
27040 #: ../src/guestfs-actions.pod:5767
27041 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27045 #: ../src/guestfs-actions.pod:5776
27046 msgid "guestfs_pwrite_device"
27050 #: ../src/guestfs-actions.pod:5778
27054 " guestfs_pwrite_device (guestfs_h *g,\n"
27055 " const char *device,\n"
27056 " const char *content,\n"
27057 " size_t content_size,\n"
27058 " int64_t offset);\n"
27063 #: ../src/guestfs-actions.pod:5793
27064 msgid "See also C<guestfs_pwrite>."
27068 #: ../src/guestfs-actions.pod:5800
27069 msgid "(Added in 1.5.20)"
27073 #: ../src/guestfs-actions.pod:5802
27074 msgid "guestfs_read_file"
27078 #: ../src/guestfs-actions.pod:5804
27082 " guestfs_read_file (guestfs_h *g,\n"
27083 " const char *path,\n"
27084 " size_t *size_r);\n"
27089 #: ../src/guestfs-actions.pod:5812
27091 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27092 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27093 "function is limited in the total size of file that can be handled."
27097 #: ../src/guestfs-actions.pod:5824
27098 msgid "(Added in 1.0.63)"
27102 #: ../src/guestfs-actions.pod:5826
27103 msgid "guestfs_read_lines"
27107 #: ../src/guestfs-actions.pod:5828
27111 " guestfs_read_lines (guestfs_h *g,\n"
27112 " const char *path);\n"
27117 #: ../src/guestfs-actions.pod:5837
27119 "Note that this function cannot correctly handle binary files (specifically, "
27120 "files containing C<\\0> character which is treated as end of line). For "
27121 "those you need to use the C<guestfs_read_file> function which has a more "
27122 "complex interface."
27126 #: ../src/guestfs-actions.pod:5848
27127 msgid "guestfs_readdir"
27131 #: ../src/guestfs-actions.pod:5850
27134 " struct guestfs_dirent_list *\n"
27135 " guestfs_readdir (guestfs_h *g,\n"
27136 " const char *dir);\n"
27141 #: ../src/guestfs-actions.pod:5904
27143 "This function is primarily intended for use by programs. To get a simple "
27144 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27145 "consumption, use C<guestfs_ll>."
27149 #: ../src/guestfs-actions.pod:5908
27151 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27152 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
27157 #: ../src/guestfs-actions.pod:5914
27158 msgid "guestfs_readlink"
27162 #: ../src/guestfs-actions.pod:5916
27166 " guestfs_readlink (guestfs_h *g,\n"
27167 " const char *path);\n"
27172 #: ../src/guestfs-actions.pod:5927
27173 msgid "guestfs_readlinklist"
27177 #: ../src/guestfs-actions.pod:5929
27181 " guestfs_readlinklist (guestfs_h *g,\n"
27182 " const char *path,\n"
27183 " char *const *names);\n"
27188 #: ../src/guestfs-actions.pod:5962
27189 msgid "guestfs_realpath"
27193 #: ../src/guestfs-actions.pod:5964
27197 " guestfs_realpath (guestfs_h *g,\n"
27198 " const char *path);\n"
27203 #: ../src/guestfs-actions.pod:5976
27204 msgid "guestfs_removexattr"
27208 #: ../src/guestfs-actions.pod:5978
27212 " guestfs_removexattr (guestfs_h *g,\n"
27213 " const char *xattr,\n"
27214 " const char *path);\n"
27219 #: ../src/guestfs-actions.pod:5986
27220 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27224 #: ../src/guestfs-actions.pod:5992
27225 msgid "guestfs_resize2fs"
27229 #: ../src/guestfs-actions.pod:5994
27233 " guestfs_resize2fs (guestfs_h *g,\n"
27234 " const char *device);\n"
27239 #: ../src/guestfs-actions.pod:6001
27241 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27242 "C<device> before calling this command. For unknown reasons C<resize2fs> "
27243 "sometimes gives an error about this and sometimes not. In any case, it is "
27244 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27248 #: ../src/guestfs-actions.pod:6011
27249 msgid "guestfs_resize2fs_M"
27253 #: ../src/guestfs-actions.pod:6013
27257 " guestfs_resize2fs_M (guestfs_h *g,\n"
27258 " const char *device);\n"
27263 #: ../src/guestfs-actions.pod:6017
27265 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
27266 "resized to its minimum size. This works like the I<-M> option to the "
27267 "C<resize2fs> command."
27271 #: ../src/guestfs-actions.pod:6021
27273 "To get the resulting size of the filesystem you should call "
27274 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
27275 "These two numbers, multiplied together, give the resulting size of the "
27276 "minimal filesystem in bytes."
27280 #: ../src/guestfs-actions.pod:6030
27281 msgid "guestfs_resize2fs_size"
27285 #: ../src/guestfs-actions.pod:6032
27289 " guestfs_resize2fs_size (guestfs_h *g,\n"
27290 " const char *device,\n"
27291 " int64_t size);\n"
27296 #: ../src/guestfs-actions.pod:6037
27298 "This command is the same as C<guestfs_resize2fs> except that it allows you "
27299 "to specify the new size (in bytes) explicitly."
27303 #: ../src/guestfs-actions.pod:6044
27308 #: ../src/guestfs-actions.pod:6046
27312 " guestfs_rm (guestfs_h *g,\n"
27313 " const char *path);\n"
27318 #: ../src/guestfs-actions.pod:6056
27319 msgid "guestfs_rm_rf"
27323 #: ../src/guestfs-actions.pod:6058
27327 " guestfs_rm_rf (guestfs_h *g,\n"
27328 " const char *path);\n"
27333 #: ../src/guestfs-actions.pod:6070
27334 msgid "guestfs_rmdir"
27338 #: ../src/guestfs-actions.pod:6072
27342 " guestfs_rmdir (guestfs_h *g,\n"
27343 " const char *path);\n"
27348 #: ../src/guestfs-actions.pod:6082
27349 msgid "guestfs_rmmountpoint"
27353 #: ../src/guestfs-actions.pod:6084
27357 " guestfs_rmmountpoint (guestfs_h *g,\n"
27358 " const char *exemptpath);\n"
27363 #: ../src/guestfs-actions.pod:6088
27365 "This calls removes a mountpoint that was previously created with "
27366 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
27370 #: ../src/guestfs-actions.pod:6096
27371 msgid "guestfs_scrub_device"
27375 #: ../src/guestfs-actions.pod:6098
27379 " guestfs_scrub_device (guestfs_h *g,\n"
27380 " const char *device);\n"
27385 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6150
27386 msgid "(Added in 1.0.52)"
27390 #: ../src/guestfs-actions.pod:6115
27391 msgid "guestfs_scrub_file"
27395 #: ../src/guestfs-actions.pod:6117
27399 " guestfs_scrub_file (guestfs_h *g,\n"
27400 " const char *file);\n"
27405 #: ../src/guestfs-actions.pod:6133
27406 msgid "guestfs_scrub_freespace"
27410 #: ../src/guestfs-actions.pod:6135
27414 " guestfs_scrub_freespace (guestfs_h *g,\n"
27415 " const char *dir);\n"
27420 #: ../src/guestfs-actions.pod:6139
27422 "This command creates the directory C<dir> and then fills it with files until "
27423 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
27424 "and deletes them. The intention is to scrub any free space on the partition "
27425 "containing C<dir>."
27429 #: ../src/guestfs-actions.pod:6152
27430 msgid "guestfs_set_append"
27434 #: ../src/guestfs-actions.pod:6154
27438 " guestfs_set_append (guestfs_h *g,\n"
27439 " const char *append);\n"
27444 #: ../src/guestfs-actions.pod:6171
27445 msgid "guestfs_set_attach_method"
27449 #: ../src/guestfs-actions.pod:6173
27453 " guestfs_set_attach_method (guestfs_h *g,\n"
27454 " const char *attachmethod);\n"
27459 #: ../src/guestfs-actions.pod:6201
27460 msgid "guestfs_set_autosync"
27464 #: ../src/guestfs-actions.pod:6203
27468 " guestfs_set_autosync (guestfs_h *g,\n"
27469 " int autosync);\n"
27474 #: ../src/guestfs-actions.pod:6219
27475 msgid "guestfs_set_direct"
27479 #: ../src/guestfs-actions.pod:6221
27483 " guestfs_set_direct (guestfs_h *g,\n"
27489 #: ../src/guestfs-actions.pod:6229
27491 "One consequence of this is that log messages aren't caught by the library "
27492 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
27497 #: ../src/guestfs-actions.pod:6242
27498 msgid "guestfs_set_e2label"
27502 #: ../src/guestfs-actions.pod:6244
27506 " guestfs_set_e2label (guestfs_h *g,\n"
27507 " const char *device,\n"
27508 " const char *label);\n"
27513 #: ../src/guestfs-actions.pod:6253
27515 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
27516 "the existing label on a filesystem."
27520 #: ../src/guestfs-actions.pod:6260
27521 msgid "guestfs_set_e2uuid"
27525 #: ../src/guestfs-actions.pod:6262
27529 " guestfs_set_e2uuid (guestfs_h *g,\n"
27530 " const char *device,\n"
27531 " const char *uuid);\n"
27536 #: ../src/guestfs-actions.pod:6272
27538 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
27539 "the existing UUID of a filesystem."
27543 #: ../src/guestfs-actions.pod:6279
27544 msgid "guestfs_set_memsize"
27548 #: ../src/guestfs-actions.pod:6281
27552 " guestfs_set_memsize (guestfs_h *g,\n"
27558 #: ../src/guestfs-actions.pod:6285
27560 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27561 "This only has any effect if called before C<guestfs_launch>."
27565 #: ../src/guestfs-actions.pod:6300
27566 msgid "guestfs_set_network"
27570 #: ../src/guestfs-actions.pod:6302
27574 " guestfs_set_network (guestfs_h *g,\n"
27580 #: ../src/guestfs-actions.pod:6312
27582 "You must call this before calling C<guestfs_launch>, otherwise it has no "
27587 #: ../src/guestfs-actions.pod:6319
27588 msgid "guestfs_set_path"
27592 #: ../src/guestfs-actions.pod:6321
27596 " guestfs_set_path (guestfs_h *g,\n"
27597 " const char *searchpath);\n"
27602 #: ../src/guestfs-actions.pod:6336
27603 msgid "guestfs_set_pgroup"
27607 #: ../src/guestfs-actions.pod:6338
27611 " guestfs_set_pgroup (guestfs_h *g,\n"
27617 #: ../src/guestfs-actions.pod:6355
27618 msgid "guestfs_set_qemu"
27622 #: ../src/guestfs-actions.pod:6357
27626 " guestfs_set_qemu (guestfs_h *g,\n"
27627 " const char *qemu);\n"
27632 #: ../src/guestfs-actions.pod:6383
27633 msgid "guestfs_set_recovery_proc"
27637 #: ../src/guestfs-actions.pod:6385
27641 " guestfs_set_recovery_proc (guestfs_h *g,\n"
27642 " int recoveryproc);\n"
27647 #: ../src/guestfs-actions.pod:6389
27649 "If this is called with the parameter C<false> then C<guestfs_launch> does "
27650 "not create a recovery process. The purpose of the recovery process is to "
27651 "stop runaway qemu processes in the case where the main program aborts "
27656 #: ../src/guestfs-actions.pod:6394
27658 "This only has any effect if called before C<guestfs_launch>, and the default "
27663 #: ../src/guestfs-actions.pod:6407
27664 msgid "guestfs_set_selinux"
27668 #: ../src/guestfs-actions.pod:6409
27672 " guestfs_set_selinux (guestfs_h *g,\n"
27678 #: ../src/guestfs-actions.pod:6426
27679 msgid "guestfs_set_trace"
27683 #: ../src/guestfs-actions.pod:6428
27687 " guestfs_set_trace (guestfs_h *g,\n"
27693 #: ../src/guestfs-actions.pod:6442
27695 "Trace messages are normally sent to C<stderr>, unless you register a "
27696 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27700 #: ../src/guestfs-actions.pod:6450
27701 msgid "guestfs_set_verbose"
27705 #: ../src/guestfs-actions.pod:6452
27709 " guestfs_set_verbose (guestfs_h *g,\n"
27715 #: ../src/guestfs-actions.pod:6461
27717 "Verbose messages are normally sent to C<stderr>, unless you register a "
27718 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27722 #: ../src/guestfs-actions.pod:6469
27723 msgid "guestfs_setcon"
27727 #: ../src/guestfs-actions.pod:6471
27731 " guestfs_setcon (guestfs_h *g,\n"
27732 " const char *context);\n"
27737 #: ../src/guestfs-actions.pod:6484
27738 msgid "guestfs_setxattr"
27742 #: ../src/guestfs-actions.pod:6486
27746 " guestfs_setxattr (guestfs_h *g,\n"
27747 " const char *xattr,\n"
27748 " const char *val,\n"
27750 " const char *path);\n"
27755 #: ../src/guestfs-actions.pod:6497
27756 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
27760 #: ../src/guestfs-actions.pod:6503
27761 msgid "guestfs_sfdisk"
27765 #: ../src/guestfs-actions.pod:6505
27769 " guestfs_sfdisk (guestfs_h *g,\n"
27770 " const char *device,\n"
27774 " char *const *lines);\n"
27779 #: ../src/guestfs-actions.pod:6533
27780 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
27784 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6604
27786 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
27791 #: ../src/guestfs-actions.pod:6550
27792 msgid "guestfs_sfdiskM"
27796 #: ../src/guestfs-actions.pod:6552
27800 " guestfs_sfdiskM (guestfs_h *g,\n"
27801 " const char *device,\n"
27802 " char *const *lines);\n"
27807 #: ../src/guestfs-actions.pod:6557
27809 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
27810 "partition sizes are specified in megabytes only (rounded to the nearest "
27811 "cylinder) and you don't need to specify the cyls, heads and sectors "
27812 "parameters which were rarely if ever used anyway."
27816 #: ../src/guestfs-actions.pod:6563
27818 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
27819 "C<guestfs_part_disk>"
27823 #: ../src/guestfs-actions.pod:6580
27824 msgid "guestfs_sfdisk_N"
27828 #: ../src/guestfs-actions.pod:6582
27832 " guestfs_sfdisk_N (guestfs_h *g,\n"
27833 " const char *device,\n"
27838 " const char *line);\n"
27843 #: ../src/guestfs-actions.pod:6594
27845 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
27846 "for the cyls/heads/sectors parameters."
27850 #: ../src/guestfs-actions.pod:6597
27851 msgid "See also: C<guestfs_part_add>"
27855 #: ../src/guestfs-actions.pod:6613
27856 msgid "guestfs_sfdisk_disk_geometry"
27860 #: ../src/guestfs-actions.pod:6615
27864 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
27865 " const char *device);\n"
27870 #: ../src/guestfs-actions.pod:6619
27872 "This displays the disk geometry of C<device> read from the partition table. "
27873 "Especially in the case where the underlying block device has been resized, "
27874 "this can be different from the kernel's idea of the geometry (see "
27875 "C<guestfs_sfdisk_kernel_geometry>)."
27879 #: ../src/guestfs-actions.pod:6632
27880 msgid "guestfs_sfdisk_kernel_geometry"
27884 #: ../src/guestfs-actions.pod:6634
27888 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
27889 " const char *device);\n"
27894 #: ../src/guestfs-actions.pod:6648
27895 msgid "guestfs_sfdisk_l"
27899 #: ../src/guestfs-actions.pod:6650
27903 " guestfs_sfdisk_l (guestfs_h *g,\n"
27904 " const char *device);\n"
27909 #: ../src/guestfs-actions.pod:6658
27910 msgid "See also: C<guestfs_part_list>"
27914 #: ../src/guestfs-actions.pod:6663
27916 "This function is deprecated. In new code, use the L</guestfs_part_list> "
27921 #: ../src/guestfs-actions.pod:6672
27926 #: ../src/guestfs-actions.pod:6674
27930 " guestfs_sh (guestfs_h *g,\n"
27931 " const char *command);\n"
27936 #: ../src/guestfs-actions.pod:6681
27937 msgid "This is like C<guestfs_command>, but passes the command to:"
27941 #: ../src/guestfs-actions.pod:6689
27942 msgid "All the provisos about C<guestfs_command> apply to this call."
27946 #: ../src/guestfs-actions.pod:6696
27947 msgid "guestfs_sh_lines"
27951 #: ../src/guestfs-actions.pod:6698
27955 " guestfs_sh_lines (guestfs_h *g,\n"
27956 " const char *command);\n"
27961 #: ../src/guestfs-actions.pod:6702
27963 "This is the same as C<guestfs_sh>, but splits the result into a list of "
27968 #: ../src/guestfs-actions.pod:6705
27969 msgid "See also: C<guestfs_command_lines>"
27973 #: ../src/guestfs-actions.pod:6713
27974 msgid "guestfs_sleep"
27978 #: ../src/guestfs-actions.pod:6715
27982 " guestfs_sleep (guestfs_h *g,\n"
27988 #: ../src/guestfs-actions.pod:6723
27989 msgid "(Added in 1.0.41)"
27993 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-structs.pod:109
27994 msgid "guestfs_stat"
27998 #: ../src/guestfs-actions.pod:6727
28001 " struct guestfs_stat *\n"
28002 " guestfs_stat (guestfs_h *g,\n"
28003 " const char *path);\n"
28008 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-structs.pod:135
28009 msgid "guestfs_statvfs"
28013 #: ../src/guestfs-actions.pod:6743
28016 " struct guestfs_statvfs *\n"
28017 " guestfs_statvfs (guestfs_h *g,\n"
28018 " const char *path);\n"
28023 #: ../src/guestfs-actions.pod:6753
28025 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28026 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28030 #: ../src/guestfs-actions.pod:6759
28031 msgid "guestfs_strings"
28035 #: ../src/guestfs-actions.pod:6761
28039 " guestfs_strings (guestfs_h *g,\n"
28040 " const char *path);\n"
28045 #: ../src/guestfs-actions.pod:6777
28046 msgid "guestfs_strings_e"
28050 #: ../src/guestfs-actions.pod:6779
28054 " guestfs_strings_e (guestfs_h *g,\n"
28055 " const char *encoding,\n"
28056 " const char *path);\n"
28061 #: ../src/guestfs-actions.pod:6784
28063 "This is like the C<guestfs_strings> command, but allows you to specify the "
28064 "encoding of strings that are looked for in the source file C<path>."
28068 #: ../src/guestfs-actions.pod:6794
28070 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28071 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28075 #: ../src/guestfs-actions.pod:6832
28076 msgid "guestfs_swapoff_device"
28080 #: ../src/guestfs-actions.pod:6834
28084 " guestfs_swapoff_device (guestfs_h *g,\n"
28085 " const char *device);\n"
28090 #: ../src/guestfs-actions.pod:6838
28092 "This command disables the libguestfs appliance swap device or partition "
28093 "named C<device>. See C<guestfs_swapon_device>."
28097 #: ../src/guestfs-actions.pod:6846
28098 msgid "guestfs_swapoff_file"
28102 #: ../src/guestfs-actions.pod:6848
28106 " guestfs_swapoff_file (guestfs_h *g,\n"
28107 " const char *file);\n"
28112 #: ../src/guestfs-actions.pod:6858
28113 msgid "guestfs_swapoff_label"
28117 #: ../src/guestfs-actions.pod:6860
28121 " guestfs_swapoff_label (guestfs_h *g,\n"
28122 " const char *label);\n"
28127 #: ../src/guestfs-actions.pod:6871
28128 msgid "guestfs_swapoff_uuid"
28132 #: ../src/guestfs-actions.pod:6873
28136 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28137 " const char *uuid);\n"
28142 #: ../src/guestfs-actions.pod:6884
28143 msgid "guestfs_swapon_device"
28147 #: ../src/guestfs-actions.pod:6886
28151 " guestfs_swapon_device (guestfs_h *g,\n"
28152 " const char *device);\n"
28157 #: ../src/guestfs-actions.pod:6890
28159 "This command enables the libguestfs appliance to use the swap device or "
28160 "partition named C<device>. The increased memory is made available for all "
28161 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28165 #: ../src/guestfs-actions.pod:6906
28166 msgid "guestfs_swapon_file"
28170 #: ../src/guestfs-actions.pod:6908
28174 " guestfs_swapon_file (guestfs_h *g,\n"
28175 " const char *file);\n"
28180 #: ../src/guestfs-actions.pod:6912
28182 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28187 #: ../src/guestfs-actions.pod:6919
28188 msgid "guestfs_swapon_label"
28192 #: ../src/guestfs-actions.pod:6921
28196 " guestfs_swapon_label (guestfs_h *g,\n"
28197 " const char *label);\n"
28202 #: ../src/guestfs-actions.pod:6925
28204 "This command enables swap to a labeled swap partition. See "
28205 "C<guestfs_swapon_device> for other notes."
28209 #: ../src/guestfs-actions.pod:6932
28210 msgid "guestfs_swapon_uuid"
28214 #: ../src/guestfs-actions.pod:6934
28218 " guestfs_swapon_uuid (guestfs_h *g,\n"
28219 " const char *uuid);\n"
28224 #: ../src/guestfs-actions.pod:6938
28226 "This command enables swap to a swap partition with the given UUID. See "
28227 "C<guestfs_swapon_device> for other notes."
28231 #: ../src/guestfs-actions.pod:6945
28232 msgid "guestfs_sync"
28236 #: ../src/guestfs-actions.pod:6947
28240 " guestfs_sync (guestfs_h *g);\n"
28245 #: ../src/guestfs-actions.pod:6960
28246 msgid "guestfs_tail"
28250 #: ../src/guestfs-actions.pod:6962
28254 " guestfs_tail (guestfs_h *g,\n"
28255 " const char *path);\n"
28260 #: ../src/guestfs-actions.pod:6978
28261 msgid "guestfs_tail_n"
28265 #: ../src/guestfs-actions.pod:6980
28269 " guestfs_tail_n (guestfs_h *g,\n"
28271 " const char *path);\n"
28276 #: ../src/guestfs-actions.pod:7002
28277 msgid "guestfs_tar_in"
28281 #: ../src/guestfs-actions.pod:7004
28285 " guestfs_tar_in (guestfs_h *g,\n"
28286 " const char *tarfile,\n"
28287 " const char *directory);\n"
28292 #: ../src/guestfs-actions.pod:7012
28293 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
28297 #: ../src/guestfs-actions.pod:7017 ../src/guestfs-actions.pod:7034 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7066
28298 msgid "(Added in 1.0.3)"
28302 #: ../src/guestfs-actions.pod:7019
28303 msgid "guestfs_tar_out"
28307 #: ../src/guestfs-actions.pod:7021
28311 " guestfs_tar_out (guestfs_h *g,\n"
28312 " const char *directory,\n"
28313 " const char *tarfile);\n"
28318 #: ../src/guestfs-actions.pod:7029
28320 "To download a compressed tarball, use C<guestfs_tgz_out> or "
28321 "C<guestfs_txz_out>."
28325 #: ../src/guestfs-actions.pod:7036
28326 msgid "guestfs_tgz_in"
28330 #: ../src/guestfs-actions.pod:7038
28334 " guestfs_tgz_in (guestfs_h *g,\n"
28335 " const char *tarball,\n"
28336 " const char *directory);\n"
28341 #: ../src/guestfs-actions.pod:7046
28342 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
28346 #: ../src/guestfs-actions.pod:7052
28347 msgid "guestfs_tgz_out"
28351 #: ../src/guestfs-actions.pod:7054
28355 " guestfs_tgz_out (guestfs_h *g,\n"
28356 " const char *directory,\n"
28357 " const char *tarball);\n"
28362 #: ../src/guestfs-actions.pod:7062
28363 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
28367 #: ../src/guestfs-actions.pod:7068
28368 msgid "guestfs_touch"
28372 #: ../src/guestfs-actions.pod:7070
28376 " guestfs_touch (guestfs_h *g,\n"
28377 " const char *path);\n"
28382 #: ../src/guestfs-actions.pod:7085
28383 msgid "guestfs_truncate"
28387 #: ../src/guestfs-actions.pod:7087
28391 " guestfs_truncate (guestfs_h *g,\n"
28392 " const char *path);\n"
28397 #: ../src/guestfs-actions.pod:7098
28398 msgid "guestfs_truncate_size"
28402 #: ../src/guestfs-actions.pod:7100
28406 " guestfs_truncate_size (guestfs_h *g,\n"
28407 " const char *path,\n"
28408 " int64_t size);\n"
28413 #: ../src/guestfs-actions.pod:7108
28415 "If the current file size is less than C<size> then the file is extended to "
28416 "the required size with zero bytes. This creates a sparse file (ie. disk "
28417 "blocks are not allocated for the file until you write to it). To create a "
28418 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
28422 #: ../src/guestfs-actions.pod:7118
28423 msgid "guestfs_tune2fs_l"
28427 #: ../src/guestfs-actions.pod:7120
28431 " guestfs_tune2fs_l (guestfs_h *g,\n"
28432 " const char *device);\n"
28437 #: ../src/guestfs-actions.pod:7140
28438 msgid "guestfs_txz_in"
28442 #: ../src/guestfs-actions.pod:7142
28446 " guestfs_txz_in (guestfs_h *g,\n"
28447 " const char *tarball,\n"
28448 " const char *directory);\n"
28453 #: ../src/guestfs-actions.pod:7154
28454 msgid "guestfs_txz_out"
28458 #: ../src/guestfs-actions.pod:7156
28462 " guestfs_txz_out (guestfs_h *g,\n"
28463 " const char *directory,\n"
28464 " const char *tarball);\n"
28469 #: ../src/guestfs-actions.pod:7168
28470 msgid "guestfs_umask"
28474 #: ../src/guestfs-actions.pod:7170
28478 " guestfs_umask (guestfs_h *g,\n"
28484 #: ../src/guestfs-actions.pod:7186
28486 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
28487 "C<guestfs_mkdir>."
28491 #: ../src/guestfs-actions.pod:7195
28492 msgid "guestfs_umount"
28496 #: ../src/guestfs-actions.pod:7197
28500 " guestfs_umount (guestfs_h *g,\n"
28501 " const char *pathordevice);\n"
28506 #: ../src/guestfs-actions.pod:7209
28507 msgid "guestfs_umount_all"
28511 #: ../src/guestfs-actions.pod:7211
28515 " guestfs_umount_all (guestfs_h *g);\n"
28520 #: ../src/guestfs-actions.pod:7222
28521 msgid "guestfs_upload"
28525 #: ../src/guestfs-actions.pod:7224
28529 " guestfs_upload (guestfs_h *g,\n"
28530 " const char *filename,\n"
28531 " const char *remotefilename);\n"
28536 #: ../src/guestfs-actions.pod:7234
28537 msgid "See also C<guestfs_download>."
28541 #: ../src/guestfs-actions.pod:7245
28542 msgid "guestfs_upload_offset"
28546 #: ../src/guestfs-actions.pod:7247
28550 " guestfs_upload_offset (guestfs_h *g,\n"
28551 " const char *filename,\n"
28552 " const char *remotefilename,\n"
28553 " int64_t offset);\n"
28558 #: ../src/guestfs-actions.pod:7263
28560 "Note that there is no limit on the amount of data that can be uploaded with "
28561 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
28562 "full amount unless an error occurs."
28566 #: ../src/guestfs-actions.pod:7268
28567 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
28571 #: ../src/guestfs-actions.pod:7279
28572 msgid "guestfs_utimens"
28576 #: ../src/guestfs-actions.pod:7281
28580 " guestfs_utimens (guestfs_h *g,\n"
28581 " const char *path,\n"
28582 " int64_t atsecs,\n"
28583 " int64_t atnsecs,\n"
28584 " int64_t mtsecs,\n"
28585 " int64_t mtnsecs);\n"
28590 #: ../src/guestfs-actions.pod:7310 ../src/guestfs-structs.pod:175
28591 msgid "guestfs_version"
28595 #: ../src/guestfs-actions.pod:7312
28598 " struct guestfs_version *\n"
28599 " guestfs_version (guestfs_h *g);\n"
28604 #: ../src/guestfs-actions.pod:7340
28606 "I<Note:> Don't use this call to test for availability of features. In "
28607 "enterprise distributions we backport features from later versions into "
28608 "earlier versions, making this an unreliable way to test for features. Use "
28609 "C<guestfs_available> instead."
28613 #: ../src/guestfs-actions.pod:7346
28615 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
28616 "error. I<The caller must call C<guestfs_free_version> after use>."
28620 #: ../src/guestfs-actions.pod:7350
28621 msgid "(Added in 1.0.58)"
28625 #: ../src/guestfs-actions.pod:7352
28626 msgid "guestfs_vfs_label"
28630 #: ../src/guestfs-actions.pod:7354
28634 " guestfs_vfs_label (guestfs_h *g,\n"
28635 " const char *device);\n"
28640 #: ../src/guestfs-actions.pod:7363
28641 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
28645 #: ../src/guestfs-actions.pod:7368 ../src/guestfs-actions.pod:7405
28646 msgid "(Added in 1.3.18)"
28650 #: ../src/guestfs-actions.pod:7370
28651 msgid "guestfs_vfs_type"
28655 #: ../src/guestfs-actions.pod:7372
28659 " guestfs_vfs_type (guestfs_h *g,\n"
28660 " const char *device);\n"
28665 #: ../src/guestfs-actions.pod:7389
28666 msgid "guestfs_vfs_uuid"
28670 #: ../src/guestfs-actions.pod:7391
28674 " guestfs_vfs_uuid (guestfs_h *g,\n"
28675 " const char *device);\n"
28680 #: ../src/guestfs-actions.pod:7400
28681 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
28685 #: ../src/guestfs-actions.pod:7407
28686 msgid "guestfs_vg_activate"
28690 #: ../src/guestfs-actions.pod:7409
28694 " guestfs_vg_activate (guestfs_h *g,\n"
28696 " char *const *volgroups);\n"
28701 #: ../src/guestfs-actions.pod:7426
28702 msgid "guestfs_vg_activate_all"
28706 #: ../src/guestfs-actions.pod:7428
28710 " guestfs_vg_activate_all (guestfs_h *g,\n"
28711 " int activate);\n"
28716 #: ../src/guestfs-actions.pod:7441
28717 msgid "guestfs_vgcreate"
28721 #: ../src/guestfs-actions.pod:7443
28725 " guestfs_vgcreate (guestfs_h *g,\n"
28726 " const char *volgroup,\n"
28727 " char *const *physvols);\n"
28732 #: ../src/guestfs-actions.pod:7455
28733 msgid "guestfs_vglvuuids"
28737 #: ../src/guestfs-actions.pod:7457
28741 " guestfs_vglvuuids (guestfs_h *g,\n"
28742 " const char *vgname);\n"
28747 #: ../src/guestfs-actions.pod:7464
28749 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
28750 "associate logical volumes and volume groups."
28754 #: ../src/guestfs-actions.pod:7467
28755 msgid "See also C<guestfs_vgpvuuids>."
28759 #: ../src/guestfs-actions.pod:7475
28760 msgid "guestfs_vgpvuuids"
28764 #: ../src/guestfs-actions.pod:7477
28768 " guestfs_vgpvuuids (guestfs_h *g,\n"
28769 " const char *vgname);\n"
28774 #: ../src/guestfs-actions.pod:7484
28776 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
28777 "associate physical volumes and volume groups."
28781 #: ../src/guestfs-actions.pod:7487
28782 msgid "See also C<guestfs_vglvuuids>."
28786 #: ../src/guestfs-actions.pod:7495
28787 msgid "guestfs_vgremove"
28791 #: ../src/guestfs-actions.pod:7497
28795 " guestfs_vgremove (guestfs_h *g,\n"
28796 " const char *vgname);\n"
28801 #: ../src/guestfs-actions.pod:7510
28802 msgid "guestfs_vgrename"
28806 #: ../src/guestfs-actions.pod:7512
28810 " guestfs_vgrename (guestfs_h *g,\n"
28811 " const char *volgroup,\n"
28812 " const char *newvolgroup);\n"
28817 #: ../src/guestfs-actions.pod:7523
28818 msgid "guestfs_vgs"
28822 #: ../src/guestfs-actions.pod:7525
28826 " guestfs_vgs (guestfs_h *g);\n"
28831 #: ../src/guestfs-actions.pod:7534
28832 msgid "See also C<guestfs_vgs_full>."
28836 #: ../src/guestfs-actions.pod:7542
28837 msgid "guestfs_vgs_full"
28841 #: ../src/guestfs-actions.pod:7544
28844 " struct guestfs_lvm_vg_list *\n"
28845 " guestfs_vgs_full (guestfs_h *g);\n"
28850 #: ../src/guestfs-actions.pod:7550
28852 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
28853 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
28858 #: ../src/guestfs-actions.pod:7556
28859 msgid "guestfs_vgscan"
28863 #: ../src/guestfs-actions.pod:7558
28867 " guestfs_vgscan (guestfs_h *g);\n"
28872 #: ../src/guestfs-actions.pod:7568
28873 msgid "guestfs_vguuid"
28877 #: ../src/guestfs-actions.pod:7570
28881 " guestfs_vguuid (guestfs_h *g,\n"
28882 " const char *vgname);\n"
28887 #: ../src/guestfs-actions.pod:7581
28888 msgid "guestfs_wait_ready"
28892 #: ../src/guestfs-actions.pod:7583
28896 " guestfs_wait_ready (guestfs_h *g);\n"
28901 #: ../src/guestfs-actions.pod:7586
28902 msgid "This function is a no op."
28906 #: ../src/guestfs-actions.pod:7588
28908 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
28909 "calling C<guestfs_launch> to wait for the launch to complete. However this "
28910 "is no longer necessary because C<guestfs_launch> now does the waiting."
28914 #: ../src/guestfs-actions.pod:7593
28916 "If you see any calls to this function in code then you can just remove them, "
28917 "unless you want to retain compatibility with older versions of the API."
28921 #: ../src/guestfs-actions.pod:7599
28923 "This function is deprecated. In new code, use the L</guestfs_launch> call "
28928 #: ../src/guestfs-actions.pod:7608
28929 msgid "guestfs_wc_c"
28933 #: ../src/guestfs-actions.pod:7610
28937 " guestfs_wc_c (guestfs_h *g,\n"
28938 " const char *path);\n"
28943 #: ../src/guestfs-actions.pod:7621
28944 msgid "guestfs_wc_l"
28948 #: ../src/guestfs-actions.pod:7623
28952 " guestfs_wc_l (guestfs_h *g,\n"
28953 " const char *path);\n"
28958 #: ../src/guestfs-actions.pod:7634
28959 msgid "guestfs_wc_w"
28963 #: ../src/guestfs-actions.pod:7636
28967 " guestfs_wc_w (guestfs_h *g,\n"
28968 " const char *path);\n"
28973 #: ../src/guestfs-actions.pod:7647
28974 msgid "guestfs_write"
28978 #: ../src/guestfs-actions.pod:7649
28982 " guestfs_write (guestfs_h *g,\n"
28983 " const char *path,\n"
28984 " const char *content,\n"
28985 " size_t content_size);\n"
28990 #: ../src/guestfs-actions.pod:7658
28991 msgid "See also C<guestfs_write_append>."
28995 #: ../src/guestfs-actions.pod:7667
28996 msgid "guestfs_write_append"
29000 #: ../src/guestfs-actions.pod:7669
29004 " guestfs_write_append (guestfs_h *g,\n"
29005 " const char *path,\n"
29006 " const char *content,\n"
29007 " size_t content_size);\n"
29012 #: ../src/guestfs-actions.pod:7678
29013 msgid "See also C<guestfs_write>."
29017 #: ../src/guestfs-actions.pod:7687
29018 msgid "guestfs_write_file"
29022 #: ../src/guestfs-actions.pod:7689
29026 " guestfs_write_file (guestfs_h *g,\n"
29027 " const char *path,\n"
29028 " const char *content,\n"
29034 #: ../src/guestfs-actions.pod:7711
29036 "This function is deprecated. In new code, use the L</guestfs_write> call "
29041 #: ../src/guestfs-actions.pod:7720
29042 msgid "guestfs_zegrep"
29046 #: ../src/guestfs-actions.pod:7722
29050 " guestfs_zegrep (guestfs_h *g,\n"
29051 " const char *regex,\n"
29052 " const char *path);\n"
29057 #: ../src/guestfs-actions.pod:7739
29058 msgid "guestfs_zegrepi"
29062 #: ../src/guestfs-actions.pod:7741
29066 " guestfs_zegrepi (guestfs_h *g,\n"
29067 " const char *regex,\n"
29068 " const char *path);\n"
29073 #: ../src/guestfs-actions.pod:7758
29074 msgid "guestfs_zero"
29078 #: ../src/guestfs-actions.pod:7760
29082 " guestfs_zero (guestfs_h *g,\n"
29083 " const char *device);\n"
29088 #: ../src/guestfs-actions.pod:7770
29090 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29091 "C<guestfs_is_zero_device>"
29095 #: ../src/guestfs-actions.pod:7782
29096 msgid "guestfs_zero_device"
29100 #: ../src/guestfs-actions.pod:7784
29104 " guestfs_zero_device (guestfs_h *g,\n"
29105 " const char *device);\n"
29110 #: ../src/guestfs-actions.pod:7788
29112 "This command writes zeroes over the entire C<device>. Compare with "
29113 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29117 #: ../src/guestfs-actions.pod:7802
29118 msgid "(Added in 1.3.1)"
29122 #: ../src/guestfs-actions.pod:7804
29123 msgid "guestfs_zerofree"
29127 #: ../src/guestfs-actions.pod:7806
29131 " guestfs_zerofree (guestfs_h *g,\n"
29132 " const char *device);\n"
29137 #: ../src/guestfs-actions.pod:7825
29138 msgid "guestfs_zfgrep"
29142 #: ../src/guestfs-actions.pod:7827
29146 " guestfs_zfgrep (guestfs_h *g,\n"
29147 " const char *pattern,\n"
29148 " const char *path);\n"
29153 #: ../src/guestfs-actions.pod:7844
29154 msgid "guestfs_zfgrepi"
29158 #: ../src/guestfs-actions.pod:7846
29162 " guestfs_zfgrepi (guestfs_h *g,\n"
29163 " const char *pattern,\n"
29164 " const char *path);\n"
29169 #: ../src/guestfs-actions.pod:7863
29170 msgid "guestfs_zfile"
29174 #: ../src/guestfs-actions.pod:7865
29178 " guestfs_zfile (guestfs_h *g,\n"
29179 " const char *meth,\n"
29180 " const char *path);\n"
29185 #: ../src/guestfs-actions.pod:7875
29187 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29192 #: ../src/guestfs-actions.pod:7881
29194 "This function is deprecated. In new code, use the L</guestfs_file> call "
29199 #: ../src/guestfs-actions.pod:7890
29200 msgid "guestfs_zgrep"
29204 #: ../src/guestfs-actions.pod:7892
29208 " guestfs_zgrep (guestfs_h *g,\n"
29209 " const char *regex,\n"
29210 " const char *path);\n"
29215 #: ../src/guestfs-actions.pod:7909
29216 msgid "guestfs_zgrepi"
29220 #: ../src/guestfs-actions.pod:7911
29224 " guestfs_zgrepi (guestfs_h *g,\n"
29225 " const char *regex,\n"
29226 " const char *path);\n"
29231 #: ../src/guestfs-availability.pod:3
29236 #: ../src/guestfs-availability.pod:5
29238 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29239 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29240 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29241 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29242 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29246 #: ../src/guestfs-availability.pod:21
29251 #: ../src/guestfs-availability.pod:23
29252 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
29256 #: ../src/guestfs-availability.pod:26
29261 #: ../src/guestfs-availability.pod:28
29263 "The following functions: L</guestfs_inotify_add_watch> "
29264 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
29265 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
29269 #: ../src/guestfs-availability.pod:36
29270 msgid "B<linuxfsuuid>"
29274 #: ../src/guestfs-availability.pod:38
29276 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
29277 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
29281 #: ../src/guestfs-availability.pod:45
29282 msgid "B<linuxmodules>"
29286 #: ../src/guestfs-availability.pod:47
29287 msgid "The following functions: L</guestfs_modprobe>"
29291 #: ../src/guestfs-availability.pod:50
29292 msgid "B<linuxxattrs>"
29296 #: ../src/guestfs-availability.pod:52
29298 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
29299 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
29300 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
29301 "L</guestfs_setxattr>"
29305 #: ../src/guestfs-availability.pod:63
29310 #: ../src/guestfs-availability.pod:65
29312 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
29313 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
29314 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
29318 #: ../src/guestfs-availability.pod:74
29323 #: ../src/guestfs-availability.pod:76
29325 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
29326 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
29327 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
29328 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
29329 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
29330 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
29331 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
29332 "L</guestfs_vgs_full>"
29336 #: ../src/guestfs-availability.pod:99
29341 #: ../src/guestfs-availability.pod:101
29343 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
29344 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
29348 #: ../src/guestfs-availability.pod:107
29353 #: ../src/guestfs-availability.pod:109
29354 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
29358 #: ../src/guestfs-availability.pod:112
29359 msgid "B<ntfsprogs>"
29363 #: ../src/guestfs-availability.pod:114
29365 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
29366 "L</guestfs_ntfsresize_size>"
29370 #: ../src/guestfs-availability.pod:119
29371 msgid "B<realpath>"
29375 #: ../src/guestfs-availability.pod:121
29376 msgid "The following functions: L</guestfs_realpath>"
29380 #: ../src/guestfs-availability.pod:124
29385 #: ../src/guestfs-availability.pod:126
29387 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
29388 "L</guestfs_scrub_freespace>"
29392 #: ../src/guestfs-availability.pod:131
29397 #: ../src/guestfs-availability.pod:133
29398 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
29402 #: ../src/guestfs-availability.pod:137
29407 #: ../src/guestfs-availability.pod:139
29408 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
29412 #: ../src/guestfs-availability.pod:143
29413 msgid "B<zerofree>"
29417 #: ../src/guestfs-availability.pod:145
29418 msgid "The following functions: L</guestfs_zerofree>"
29422 #: ../src/guestfs-structs.pod:1
29423 msgid "guestfs_int_bool"
29427 #: ../src/guestfs-structs.pod:3
29430 " struct guestfs_int_bool {\n"
29438 #: ../src/guestfs-structs.pod:8
29441 " struct guestfs_int_bool_list {\n"
29442 " uint32_t len; /* Number of elements in list. */\n"
29443 " struct guestfs_int_bool *val; /* Elements. */\n"
29449 #: ../src/guestfs-structs.pod:13
29452 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
29453 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
29458 #: ../src/guestfs-structs.pod:16
29459 msgid "guestfs_lvm_pv"
29463 #: ../src/guestfs-structs.pod:18
29466 " struct guestfs_lvm_pv {\n"
29467 " char *pv_name;\n"
29468 " /* The next field is NOT nul-terminated, be careful when printing it: "
29470 " char pv_uuid[32];\n"
29472 " uint64_t pv_size;\n"
29473 " uint64_t dev_size;\n"
29474 " uint64_t pv_free;\n"
29475 " uint64_t pv_used;\n"
29476 " char *pv_attr;\n"
29477 " int64_t pv_pe_count;\n"
29478 " int64_t pv_pe_alloc_count;\n"
29479 " char *pv_tags;\n"
29480 " uint64_t pe_start;\n"
29481 " int64_t pv_mda_count;\n"
29482 " uint64_t pv_mda_free;\n"
29488 #: ../src/guestfs-structs.pod:36
29491 " struct guestfs_lvm_pv_list {\n"
29492 " uint32_t len; /* Number of elements in list. */\n"
29493 " struct guestfs_lvm_pv *val; /* Elements. */\n"
29499 #: ../src/guestfs-structs.pod:41
29502 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
29503 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
29508 #: ../src/guestfs-structs.pod:44
29509 msgid "guestfs_lvm_vg"
29513 #: ../src/guestfs-structs.pod:46
29516 " struct guestfs_lvm_vg {\n"
29517 " char *vg_name;\n"
29518 " /* The next field is NOT nul-terminated, be careful when printing it: "
29520 " char vg_uuid[32];\n"
29522 " char *vg_attr;\n"
29523 " uint64_t vg_size;\n"
29524 " uint64_t vg_free;\n"
29525 " char *vg_sysid;\n"
29526 " uint64_t vg_extent_size;\n"
29527 " int64_t vg_extent_count;\n"
29528 " int64_t vg_free_count;\n"
29529 " int64_t max_lv;\n"
29530 " int64_t max_pv;\n"
29531 " int64_t pv_count;\n"
29532 " int64_t lv_count;\n"
29533 " int64_t snap_count;\n"
29534 " int64_t vg_seqno;\n"
29535 " char *vg_tags;\n"
29536 " int64_t vg_mda_count;\n"
29537 " uint64_t vg_mda_free;\n"
29543 #: ../src/guestfs-structs.pod:69
29546 " struct guestfs_lvm_vg_list {\n"
29547 " uint32_t len; /* Number of elements in list. */\n"
29548 " struct guestfs_lvm_vg *val; /* Elements. */\n"
29554 #: ../src/guestfs-structs.pod:74
29557 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
29558 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
29563 #: ../src/guestfs-structs.pod:77
29564 msgid "guestfs_lvm_lv"
29568 #: ../src/guestfs-structs.pod:79
29571 " struct guestfs_lvm_lv {\n"
29572 " char *lv_name;\n"
29573 " /* The next field is NOT nul-terminated, be careful when printing it: "
29575 " char lv_uuid[32];\n"
29576 " char *lv_attr;\n"
29577 " int64_t lv_major;\n"
29578 " int64_t lv_minor;\n"
29579 " int64_t lv_kernel_major;\n"
29580 " int64_t lv_kernel_minor;\n"
29581 " uint64_t lv_size;\n"
29582 " int64_t seg_count;\n"
29584 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29585 " float snap_percent;\n"
29586 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29587 " float copy_percent;\n"
29588 " char *move_pv;\n"
29589 " char *lv_tags;\n"
29590 " char *mirror_log;\n"
29591 " char *modules;\n"
29597 #: ../src/guestfs-structs.pod:101
29600 " struct guestfs_lvm_lv_list {\n"
29601 " uint32_t len; /* Number of elements in list. */\n"
29602 " struct guestfs_lvm_lv *val; /* Elements. */\n"
29608 #: ../src/guestfs-structs.pod:106
29611 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
29612 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
29617 #: ../src/guestfs-structs.pod:111
29620 " struct guestfs_stat {\n"
29624 " int64_t nlink;\n"
29629 " int64_t blksize;\n"
29630 " int64_t blocks;\n"
29631 " int64_t atime;\n"
29632 " int64_t mtime;\n"
29633 " int64_t ctime;\n"
29639 #: ../src/guestfs-structs.pod:127
29642 " struct guestfs_stat_list {\n"
29643 " uint32_t len; /* Number of elements in list. */\n"
29644 " struct guestfs_stat *val; /* Elements. */\n"
29650 #: ../src/guestfs-structs.pod:132
29653 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
29654 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
29659 #: ../src/guestfs-structs.pod:137
29662 " struct guestfs_statvfs {\n"
29663 " int64_t bsize;\n"
29664 " int64_t frsize;\n"
29665 " int64_t blocks;\n"
29666 " int64_t bfree;\n"
29667 " int64_t bavail;\n"
29668 " int64_t files;\n"
29669 " int64_t ffree;\n"
29670 " int64_t favail;\n"
29673 " int64_t namemax;\n"
29679 #: ../src/guestfs-structs.pod:151
29682 " struct guestfs_statvfs_list {\n"
29683 " uint32_t len; /* Number of elements in list. */\n"
29684 " struct guestfs_statvfs *val; /* Elements. */\n"
29690 #: ../src/guestfs-structs.pod:156
29693 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
29694 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
29699 #: ../src/guestfs-structs.pod:159
29700 msgid "guestfs_dirent"
29704 #: ../src/guestfs-structs.pod:161
29707 " struct guestfs_dirent {\n"
29716 #: ../src/guestfs-structs.pod:167
29719 " struct guestfs_dirent_list {\n"
29720 " uint32_t len; /* Number of elements in list. */\n"
29721 " struct guestfs_dirent *val; /* Elements. */\n"
29727 #: ../src/guestfs-structs.pod:172
29730 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
29731 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
29736 #: ../src/guestfs-structs.pod:177
29739 " struct guestfs_version {\n"
29740 " int64_t major;\n"
29741 " int64_t minor;\n"
29742 " int64_t release;\n"
29749 #: ../src/guestfs-structs.pod:184
29752 " struct guestfs_version_list {\n"
29753 " uint32_t len; /* Number of elements in list. */\n"
29754 " struct guestfs_version *val; /* Elements. */\n"
29760 #: ../src/guestfs-structs.pod:189
29763 " void guestfs_free_version (struct guestfs_free_version *);\n"
29764 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
29769 #: ../src/guestfs-structs.pod:192
29770 msgid "guestfs_xattr"
29774 #: ../src/guestfs-structs.pod:194
29777 " struct guestfs_xattr {\n"
29778 " char *attrname;\n"
29779 " /* The next two fields describe a byte array. */\n"
29780 " uint32_t attrval_len;\n"
29781 " char *attrval;\n"
29787 #: ../src/guestfs-structs.pod:201
29790 " struct guestfs_xattr_list {\n"
29791 " uint32_t len; /* Number of elements in list. */\n"
29792 " struct guestfs_xattr *val; /* Elements. */\n"
29798 #: ../src/guestfs-structs.pod:206
29801 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
29802 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
29807 #: ../src/guestfs-structs.pod:209
29808 msgid "guestfs_inotify_event"
29812 #: ../src/guestfs-structs.pod:211
29815 " struct guestfs_inotify_event {\n"
29816 " int64_t in_wd;\n"
29817 " uint32_t in_mask;\n"
29818 " uint32_t in_cookie;\n"
29819 " char *in_name;\n"
29825 #: ../src/guestfs-structs.pod:218
29828 " struct guestfs_inotify_event_list {\n"
29829 " uint32_t len; /* Number of elements in list. */\n"
29830 " struct guestfs_inotify_event *val; /* Elements. */\n"
29836 #: ../src/guestfs-structs.pod:223
29839 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
29840 " void guestfs_free_inotify_event_list (struct "
29841 "guestfs_free_inotify_event_list *);\n"
29846 #: ../src/guestfs-structs.pod:226
29847 msgid "guestfs_partition"
29851 #: ../src/guestfs-structs.pod:228
29854 " struct guestfs_partition {\n"
29855 " int32_t part_num;\n"
29856 " uint64_t part_start;\n"
29857 " uint64_t part_end;\n"
29858 " uint64_t part_size;\n"
29864 #: ../src/guestfs-structs.pod:235
29867 " struct guestfs_partition_list {\n"
29868 " uint32_t len; /* Number of elements in list. */\n"
29869 " struct guestfs_partition *val; /* Elements. */\n"
29875 #: ../src/guestfs-structs.pod:240
29878 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
29879 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
29884 #: ../src/guestfs-structs.pod:243
29885 msgid "guestfs_application"
29889 #: ../src/guestfs-structs.pod:245
29892 " struct guestfs_application {\n"
29893 " char *app_name;\n"
29894 " char *app_display_name;\n"
29895 " int32_t app_epoch;\n"
29896 " char *app_version;\n"
29897 " char *app_release;\n"
29898 " char *app_install_path;\n"
29899 " char *app_trans_path;\n"
29900 " char *app_publisher;\n"
29901 " char *app_url;\n"
29902 " char *app_source_package;\n"
29903 " char *app_summary;\n"
29904 " char *app_description;\n"
29910 #: ../src/guestfs-structs.pod:260
29913 " struct guestfs_application_list {\n"
29914 " uint32_t len; /* Number of elements in list. */\n"
29915 " struct guestfs_application *val; /* Elements. */\n"
29921 #: ../src/guestfs-structs.pod:265
29924 " void guestfs_free_application (struct guestfs_free_application *);\n"
29925 " void guestfs_free_application_list (struct guestfs_free_application_list "
29931 #: ../src/guestfs.pod:5
29932 msgid "guestfs - Library for accessing and modifying virtual machine images"
29936 #: ../src/guestfs.pod:11
29939 " guestfs_h *g = guestfs_create ();\n"
29940 " guestfs_add_drive (g, \"guest.img\");\n"
29941 " guestfs_launch (g);\n"
29942 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
29943 " guestfs_touch (g, \"/hello\");\n"
29944 " guestfs_umount (g, \"/\");\n"
29945 " guestfs_close (g);\n"
29950 #: ../src/guestfs.pod:25
29952 "Libguestfs is a library for accessing and modifying guest disk images. "
29953 "Amongst the things this is good for: making batch configuration changes to "
29954 "guests, getting disk used/free statistics (see also: virt-df), migrating "
29955 "between virtualization systems (see also: virt-p2v), performing partial "
29956 "backups, performing partial guest clones, cloning guests and changing "
29957 "registry/UUID/hostname info, and much else besides."
29961 #: ../src/guestfs.pod:33
29963 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
29964 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
29965 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
29970 #: ../src/guestfs.pod:38
29972 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
29973 "what filesystem is in each LV, etc.). It can also run commands in the "
29974 "context of the guest. Also you can access filesystems over FUSE."
29978 #: ../src/guestfs.pod:43
29980 "Libguestfs is a library that can be linked with C and C++ management "
29981 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
29982 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
29987 #: ../src/guestfs.pod:48
29989 "You don't need to be root to use libguestfs, although obviously you do need "
29990 "enough permissions to access the disk images."
29994 #: ../src/guestfs.pod:51
29996 "Libguestfs is a large API because it can do many things. For a gentle "
29997 "introduction, please read the L</API OVERVIEW> section next."
30001 #: ../src/guestfs.pod:54
30003 "There are also some example programs in the L<guestfs-examples(3)> manual "
30008 #: ../src/guestfs.pod:57
30009 msgid "API OVERVIEW"
30013 #: ../src/guestfs.pod:59
30015 "This section provides a gentler overview of the libguestfs API. We also try "
30016 "to group API calls together, where that may not be obvious from reading "
30017 "about the individual calls in the main section of this manual."
30021 #: ../src/guestfs.pod:64
30026 #: ../src/guestfs.pod:66
30028 "Before you can use libguestfs calls, you have to create a handle. Then you "
30029 "must add at least one disk image to the handle, followed by launching the "
30030 "handle, then performing whatever operations you want, and finally closing "
30031 "the handle. By convention we use the single letter C<g> for the name of the "
30032 "handle variable, although of course you can use any name you want."
30036 #: ../src/guestfs.pod:73
30037 msgid "The general structure of all libguestfs-using programs looks like this:"
30041 #: ../src/guestfs.pod:76
30044 " guestfs_h *g = guestfs_create ();\n"
30049 #: ../src/guestfs.pod:78
30052 " /* Call guestfs_add_drive additional times if there are\n"
30053 " * multiple disk images.\n"
30055 " guestfs_add_drive (g, \"guest.img\");\n"
30060 #: ../src/guestfs.pod:83
30063 " /* Most manipulation calls won't work until you've launched\n"
30064 " * the handle 'g'. You have to do this _after_ adding drives\n"
30065 " * and _before_ other commands.\n"
30067 " guestfs_launch (g);\n"
30072 #: ../src/guestfs.pod:89
30075 " /* Now you can examine what partitions, LVs etc are available.\n"
30077 " char **partitions = guestfs_list_partitions (g);\n"
30078 " char **logvols = guestfs_lvs (g);\n"
30083 #: ../src/guestfs.pod:94
30086 " /* To access a filesystem in the image, you must mount it.\n"
30088 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30093 #: ../src/guestfs.pod:98
30096 " /* Now you can perform filesystem actions on the guest\n"
30099 " guestfs_touch (g, \"/hello\");\n"
30104 #: ../src/guestfs.pod:103
30107 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30108 " * it is done automatically when you close the handle. See\n"
30109 " * discussion of autosync in this page.\n"
30111 " guestfs_sync (g);\n"
30116 #: ../src/guestfs.pod:109
30119 " /* Close the handle 'g'. */\n"
30120 " guestfs_close (g);\n"
30125 #: ../src/guestfs.pod:112
30127 "The code above doesn't include any error checking. In real code you should "
30128 "check return values carefully for errors. In general all functions that "
30129 "return integers return C<-1> on error, and all functions that return "
30130 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30131 "how to handle errors, and consult the documentation for each function call "
30132 "below to see precisely how they return error indications. See "
30133 "L<guestfs-examples(3)> for fully worked examples."
30137 #: ../src/guestfs.pod:121
30138 msgid "DISK IMAGES"
30142 #: ../src/guestfs.pod:123
30144 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30145 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30146 "actual block device, or simply an empty file of zeroes that you have created "
30147 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30152 #: ../src/guestfs.pod:129
30154 "The call you should use in modern code for adding drives is "
30155 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30156 "specifying that the format is raw, do:"
30160 #: ../src/guestfs.pod:133
30163 " guestfs_add_drive_opts (g, filename,\n"
30164 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30170 #: ../src/guestfs.pod:137
30171 msgid "You can add a disk read-only using:"
30175 #: ../src/guestfs.pod:139
30178 " guestfs_add_drive_opts (g, filename,\n"
30179 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30180 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30186 #: ../src/guestfs.pod:144
30188 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30189 "libguestfs won't modify the file."
30193 #: ../src/guestfs.pod:147
30195 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30196 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30197 "corruption, but adding it read-only is safe."
30201 #: ../src/guestfs.pod:151
30203 "You must add at least one disk image, and you may add multiple disk images. "
30204 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30205 "first one you added), C</dev/sdb> (for the second one you added), etc."
30209 #: ../src/guestfs.pod:156
30211 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30212 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30213 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
30217 #: ../src/guestfs.pod:161
30222 #: ../src/guestfs.pod:163
30224 "Before you can read or write files, create directories and so on in a disk "
30225 "image that contains filesystems, you have to mount those filesystems using "
30226 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
30227 "a disk image contains (for example) one partition with a filesystem on that "
30228 "partition, then you can mount it directly:"
30232 #: ../src/guestfs.pod:170
30235 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
30240 #: ../src/guestfs.pod:172
30242 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
30243 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
30244 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
30245 "that these are libguestfs virtual devices, and are nothing to do with host "
30250 #: ../src/guestfs.pod:178
30252 "If you are given a disk image and you don't know what it contains then you "
30253 "have to find out. Libguestfs can do that too: use "
30254 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
30255 "and LVs, and either try mounting each to see what is mountable, or else "
30256 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
30257 "filesystems, use L</guestfs_list_filesystems>."
30261 #: ../src/guestfs.pod:186
30263 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
30264 "L</INSPECTION> below). But you might find it easier to look at higher level "
30265 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
30269 #: ../src/guestfs.pod:191
30271 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
30272 "several other variations of the C<guestfs_mount_*> call."
30276 #: ../src/guestfs.pod:194
30277 msgid "FILESYSTEM ACCESS AND MODIFICATION"
30281 #: ../src/guestfs.pod:196
30283 "The majority of the libguestfs API consists of fairly low-level calls for "
30284 "accessing and modifying the files, directories, symlinks etc on mounted "
30285 "filesystems. There are over a hundred such calls which you can find listed "
30286 "in detail below in this man page, and we don't even pretend to cover them "
30287 "all in this overview."
30291 #: ../src/guestfs.pod:202
30293 "Specify filenames as full paths, starting with C<\"/\"> and including the "
30298 #: ../src/guestfs.pod:205
30300 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
30301 "the file called C<\"etc/passwd\"> then you could do:"
30305 #: ../src/guestfs.pod:208
30308 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
30313 #: ../src/guestfs.pod:210
30315 "This would return C<data> as a newly allocated buffer containing the full "
30316 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
30317 "or C<NULL> if there was an error."
30321 #: ../src/guestfs.pod:214
30323 "As another example, to create a top-level directory on that filesystem "
30324 "called C<\"var\"> you would do:"
30328 #: ../src/guestfs.pod:217
30331 " guestfs_mkdir (g, \"/var\");\n"
30336 #: ../src/guestfs.pod:219
30337 msgid "To create a symlink you could do:"
30341 #: ../src/guestfs.pod:221
30344 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
30345 " \"/etc/rc3.d/S30portmap\");\n"
30350 #: ../src/guestfs.pod:224
30352 "Libguestfs will reject attempts to use relative paths and there is no "
30353 "concept of a current working directory."
30357 #: ../src/guestfs.pod:227
30359 "Libguestfs can return errors in many situations: for example if the "
30360 "filesystem isn't writable, or if a file or directory that you requested "
30361 "doesn't exist. If you are using the C API (documented here) you have to "
30362 "check for those error conditions after each call. (Other language bindings "
30363 "turn these errors into exceptions)."
30367 #: ../src/guestfs.pod:233
30369 "File writes are affected by the per-handle umask, set by calling "
30370 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
30374 #: ../src/guestfs.pod:236
30375 msgid "PARTITIONING"
30379 #: ../src/guestfs.pod:238
30381 "Libguestfs contains API calls to read, create and modify partition tables on "
30386 #: ../src/guestfs.pod:241
30388 "In the common case where you want to create a single partition covering the "
30389 "whole disk, you should use the L</guestfs_part_disk> call:"
30393 #: ../src/guestfs.pod:245
30396 " const char *parttype = \"mbr\";\n"
30397 " if (disk_is_larger_than_2TB)\n"
30398 " parttype = \"gpt\";\n"
30399 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
30404 #: ../src/guestfs.pod:250
30406 "Obviously this effectively wipes anything that was on that disk image "
30411 #: ../src/guestfs.pod:253
30416 #: ../src/guestfs.pod:255
30418 "Libguestfs provides access to a large part of the LVM2 API, such as "
30419 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
30420 "unless you familiarize yourself with the concepts of physical volumes, "
30421 "volume groups and logical volumes."
30425 #: ../src/guestfs.pod:260
30427 "This author strongly recommends reading the LVM HOWTO, online at "
30428 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
30432 #: ../src/guestfs.pod:263
30433 msgid "DOWNLOADING"
30437 #: ../src/guestfs.pod:265
30439 "Use L</guestfs_cat> to download small, text only files. This call is "
30440 "limited to files which are less than 2 MB and which cannot contain any ASCII "
30441 "NUL (C<\\0>) characters. However the API is very simple to use."
30445 #: ../src/guestfs.pod:269
30447 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
30448 "bit data, since it returns a (pointer, size) pair. However it is still "
30449 "limited to \"small\" files, less than 2 MB."
30453 #: ../src/guestfs.pod:273
30455 "L</guestfs_download> can be used to download any file, with no limits on "
30456 "content or size (even files larger than 4 GB)."
30460 #: ../src/guestfs.pod:276
30461 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
30465 #: ../src/guestfs.pod:279
30470 #: ../src/guestfs.pod:281
30472 "It's often the case that you want to write a file or files to the disk "
30477 #: ../src/guestfs.pod:284
30479 "To write a small file with fixed content, use L</guestfs_write>. To create "
30480 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
30481 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
30482 "variety of other functions for creating test files, for example "
30483 "L</guestfs_fill> and L</guestfs_fill_pattern>."
30487 #: ../src/guestfs.pod:290
30489 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
30490 "file content or size (even files larger than 4 GB)."
30494 #: ../src/guestfs.pod:293
30495 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
30499 #: ../src/guestfs.pod:295
30501 "However the fastest way to upload I<large numbers of arbitrary files> is to "
30502 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
30503 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
30504 "the drive in a predictable way (eg. adding it last after all other drives) "
30505 "then you can get the device name from L</guestfs_list_devices> and mount it "
30506 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
30507 "sometimes non-portable between kernel versions, and they don't support "
30508 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
30509 "using a label or UUID, use an ISO image instead."
30513 #: ../src/guestfs.pod:306
30518 #: ../src/guestfs.pod:308
30520 "There are various different commands for copying between files and devices "
30521 "and in and out of the guest filesystem. These are summarised in the table "
30526 #: ../src/guestfs.pod:314
30527 msgid "B<file> to B<file>"
30531 #: ../src/guestfs.pod:316
30533 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
30534 "directories recursively."
30538 #: ../src/guestfs.pod:319
30539 msgid "B<file or device> to B<file or device>"
30543 #: ../src/guestfs.pod:321
30545 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
30546 "devices in the guest."
30550 #: ../src/guestfs.pod:324
30551 msgid "Example: duplicate the contents of an LV:"
30555 #: ../src/guestfs.pod:326
30558 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
30563 #: ../src/guestfs.pod:328
30565 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
30566 "(C</dev/VG/Original>). To copy less than the whole source device, use "
30567 "L</guestfs_copy_size>."
30571 #: ../src/guestfs.pod:332
30572 msgid "B<file on the host> to B<file or device>"
30576 #: ../src/guestfs.pod:334
30577 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
30581 #: ../src/guestfs.pod:336
30582 msgid "B<file or device> to B<file on the host>"
30586 #: ../src/guestfs.pod:338
30587 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
30591 #: ../src/guestfs.pod:342
30592 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
30596 #: ../src/guestfs.pod:344
30598 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
30599 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
30600 "appears you can only upload and download to files. However many Un*x-like "
30601 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
30602 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
30603 "stderr, and arbitrary file descriptor N."
30607 #: ../src/guestfs.pod:352
30608 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
30612 #: ../src/guestfs.pod:355
30615 " guestfs_download (g, filename, \"/dev/stdout\");\n"
30620 #: ../src/guestfs.pod:357
30621 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
30625 #: ../src/guestfs.pod:359
30628 " char devfd[64];\n"
30629 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
30630 " guestfs_tar_out (g, \"/\", devfd);\n"
30635 #: ../src/guestfs.pod:363
30636 msgid "LISTING FILES"
30640 #: ../src/guestfs.pod:365
30642 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
30643 "L<guestfish(1)>-equivalent command C<ll>)."
30647 #: ../src/guestfs.pod:368
30649 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
30650 "programs, as a flat list of strings."
30654 #: ../src/guestfs.pod:371
30656 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
30657 "directory, plus additional information about each one. It is more "
30658 "equivalent to using the L<readdir(3)> call on a local filesystem."
30662 #: ../src/guestfs.pod:375
30664 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
30669 #: ../src/guestfs.pod:378
30670 msgid "RUNNING COMMANDS"
30674 #: ../src/guestfs.pod:380
30676 "Although libguestfs is primarily an API for manipulating files inside guest "
30677 "images, we also provide some limited facilities for running commands inside "
30682 #: ../src/guestfs.pod:384
30683 msgid "There are many limitations to this:"
30687 #: ../src/guestfs.pod:390
30689 "The kernel version that the command runs under will be different from what "
30694 #: ../src/guestfs.pod:395
30696 "If the command needs to communicate with daemons, then most likely they "
30697 "won't be running."
30701 #: ../src/guestfs.pod:400
30702 msgid "The command will be running in limited memory."
30706 #: ../src/guestfs.pod:404
30708 "The network may not be available unless you enable it (see "
30709 "L</guestfs_set_network>)."
30713 #: ../src/guestfs.pod:409
30714 msgid "Only supports Linux guests (not Windows, BSD, etc)."
30718 #: ../src/guestfs.pod:413
30719 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
30723 #: ../src/guestfs.pod:418
30725 "For SELinux guests, you may need to enable SELinux and load policy first. "
30726 "See L</SELINUX> in this manpage."
30730 #: ../src/guestfs.pod:423
30732 "I<Security:> It is not safe to run commands from untrusted, possibly "
30733 "malicious guests. These commands may attempt to exploit your program by "
30734 "sending unexpected output. They could also try to exploit the Linux kernel "
30735 "or qemu provided by the libguestfs appliance. They could use the network "
30736 "provided by the libguestfs appliance to bypass ordinary network partitions "
30737 "and firewalls. They could use the elevated privileges or different SELinux "
30738 "context of your program to their advantage."
30742 #: ../src/guestfs.pod:432
30744 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
30745 "(a script which runs when the guest next boots normally), and to have this "
30746 "script run the commands you want in the normal context of the running guest, "
30747 "network security and so on. For information about other security issues, "
30748 "see L</SECURITY>."
30752 #: ../src/guestfs.pod:440
30754 "The two main API calls to run commands are L</guestfs_command> and "
30755 "L</guestfs_sh> (there are also variations)."
30759 #: ../src/guestfs.pod:443
30761 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
30762 "shell globs, redirections, etc will work."
30766 #: ../src/guestfs.pod:446
30767 msgid "CONFIGURATION FILES"
30771 #: ../src/guestfs.pod:448
30773 "To read and write configuration files in Linux guest filesystems, we "
30774 "strongly recommend using Augeas. For example, Augeas understands how to "
30775 "read and write, say, a Linux shadow password file or X.org configuration "
30776 "file, and so avoids you having to write that code."
30780 #: ../src/guestfs.pod:453
30782 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
30783 "document Augeas itself here because there is excellent documentation on the "
30784 "L<http://augeas.net/> website."
30788 #: ../src/guestfs.pod:457
30790 "If you don't want to use Augeas (you fool!) then try calling "
30791 "L</guestfs_read_lines> to get the file as a list of lines which you can "
30796 #: ../src/guestfs.pod:461
30801 #: ../src/guestfs.pod:463
30803 "We support SELinux guests. To ensure that labeling happens correctly in "
30804 "SELinux guests, you need to enable SELinux and load the guest's policy:"
30808 #: ../src/guestfs.pod:471
30809 msgid "Before launching, do:"
30813 #: ../src/guestfs.pod:473
30816 " guestfs_set_selinux (g, 1);\n"
30821 #: ../src/guestfs.pod:477
30823 "After mounting the guest's filesystem(s), load the policy. This is best "
30824 "done by running the L<load_policy(8)> command in the guest itself:"
30828 #: ../src/guestfs.pod:481
30831 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
30836 #: ../src/guestfs.pod:483
30838 "(Older versions of C<load_policy> require you to specify the name of the "
30843 #: ../src/guestfs.pod:488
30845 "Optionally, set the security context for the API. The correct security "
30846 "context to use can only be known by inspecting the guest. As an example:"
30850 #: ../src/guestfs.pod:492
30853 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
30858 #: ../src/guestfs.pod:496
30859 msgid "This will work for running commands and editing existing files."
30863 #: ../src/guestfs.pod:498
30865 "When new files are created, you may need to label them explicitly, for "
30866 "example by running the external command C<restorecon pathname>."
30870 #: ../src/guestfs.pod:502
30875 #: ../src/guestfs.pod:504
30877 "Certain calls are affected by the current file mode creation mask (the "
30878 "\"umask\"). In particular ones which create files or directories, such as "
30879 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
30880 "either the default mode that the file is created with or modifies the mode "
30885 #: ../src/guestfs.pod:510
30887 "The default umask is C<022>, so files are created with modes such as C<0644> "
30888 "and directories with C<0755>."
30892 #: ../src/guestfs.pod:513
30894 "There are two ways to avoid being affected by umask. Either set umask to 0 "
30895 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
30896 "L</guestfs_chmod> after creating each file or directory."
30900 #: ../src/guestfs.pod:517
30901 msgid "For more information about umask, see L<umask(2)>."
30905 #: ../src/guestfs.pod:521
30907 "Libguestfs allows you to access Linux guests which have been encrypted using "
30908 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
30909 "standard. This includes nearly all whole disk encryption systems used by "
30910 "modern Linux guests."
30914 #: ../src/guestfs.pod:527
30916 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
30917 "returns the string C<crypto_LUKS>)."
30921 #: ../src/guestfs.pod:530
30923 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
30924 "will require the passphrase!"
30928 #: ../src/guestfs.pod:533
30930 "Opening a LUKS device creates a new device mapper device called "
30931 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
30932 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
30933 "decrypted from and encrypted to the underlying block device respectively."
30937 #: ../src/guestfs.pod:539
30939 "LVM volume groups on the device can be made visible by calling "
30940 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
30941 "volume(s) can now be mounted in the usual way."
30945 #: ../src/guestfs.pod:543
30947 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
30948 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
30949 "[\"/dev/VG\"])>. Then close the mapper device by calling "
30950 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
30951 "underlying encrypted block device)."
30955 #: ../src/guestfs.pod:550
30960 #: ../src/guestfs.pod:552
30962 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
30963 "contains operating systems, an install CD or a live CD. (These APIs used to "
30964 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
30965 "version 1.5.3 the most frequently used part of this library has been "
30966 "rewritten in C and moved into the core code)."
30970 #: ../src/guestfs.pod:559
30972 "Add all disks belonging to the unknown virtual machine and call "
30973 "L</guestfs_launch> in the usual way."
30977 #: ../src/guestfs.pod:562
30979 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
30980 "and certain heuristics, and returns a list of operating systems that were "
30981 "found. An empty list means none were found. A single element is the root "
30982 "filesystem of the operating system. For dual- or multi-boot guests, "
30983 "multiple roots can be returned, each one corresponding to a separate "
30984 "operating system. (Multi-boot virtual machines are extremely rare in the "
30985 "world of virtualization, but since this scenario can happen, we have built "
30986 "libguestfs to deal with it.)"
30990 #: ../src/guestfs.pod:571
30992 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
30993 "to get additional details about that operating system. For example, call "
30994 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
30995 "Windows and Linux-based operating systems respectively."
30999 #: ../src/guestfs.pod:577
31001 "Un*x-like and Linux-based operating systems usually consist of several "
31002 "filesystems which are mounted at boot time (for example, a separate boot "
31003 "partition mounted on C</boot>). The inspection rules are able to detect how "
31004 "filesystems correspond to mount points. Call "
31005 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31006 "hash table like this example:"
31010 #: ../src/guestfs.pod:584
31013 " /boot => /dev/sda1\n"
31014 " / => /dev/vg_guest/lv_root\n"
31015 " /usr => /dev/vg_guest/lv_usr\n"
31020 #: ../src/guestfs.pod:588
31022 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31023 "filesystems as suggested."
31027 #: ../src/guestfs.pod:591
31029 "Be careful to mount filesystems in the right order (eg. C</> before "
31030 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
31035 #: ../src/guestfs.pod:595
31037 "Inspection currently only works for some common operating systems. "
31038 "Contributors are welcome to send patches for other operating systems that we "
31039 "currently cannot detect."
31043 #: ../src/guestfs.pod:599
31045 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31046 "for more details. The L</guestfs_inspect_os> function just ignores any "
31047 "encrypted devices."
31051 #: ../src/guestfs.pod:603
31053 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31054 "inspection and caches the results in the guest handle. Subsequent calls to "
31055 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31056 "re-read the disks. If you change the content of the guest disks, you can "
31057 "redo inspection by calling L</guestfs_inspect_os> again. "
31058 "(L</guestfs_inspect_list_applications> works a little differently from the "
31059 "other calls and does read the disks. See documentation for that function "
31064 #: ../src/guestfs.pod:612
31065 msgid "INSPECTING INSTALL DISKS"
31069 #: ../src/guestfs.pod:614
31071 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31076 #: ../src/guestfs.pod:617
31078 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31079 "system, which currently can be C<installed> (a regular operating system) or "
31080 "C<installer> (some sort of install disk)."
31084 #: ../src/guestfs.pod:621
31086 "Further information is available about the operating system that can be "
31087 "installed using the regular inspection APIs like "
31088 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31093 #: ../src/guestfs.pod:626
31095 "Some additional information specific to installer disks is also available "
31096 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31097 "L</guestfs_inspect_is_multipart> calls."
31101 #: ../src/guestfs.pod:631
31102 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31106 #: ../src/guestfs.pod:633
31108 "Libguestfs can mount NTFS partitions. It does this using the "
31109 "L<http://www.ntfs-3g.org/> driver."
31113 #: ../src/guestfs.pod:636
31114 msgid "DRIVE LETTERS AND PATHS"
31118 #: ../src/guestfs.pod:638
31120 "DOS and Windows still use drive letters, and the filesystems are always "
31121 "treated as case insensitive by Windows itself, and therefore you might find "
31122 "a Windows configuration file referring to a path like "
31123 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
31124 "that directory might be referred to as C</WINDOWS/System32>."
31128 #: ../src/guestfs.pod:644
31130 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31131 "L</guestfs_inspect_get_drive_mappings>)"
31135 #: ../src/guestfs.pod:647
31137 "Dealing with separator characters (backslash vs forward slash) is outside "
31138 "the scope of libguestfs, but usually a simple character replacement will "
31143 #: ../src/guestfs.pod:651
31145 "To resolve the case insensitivity of paths, call "
31146 "L</guestfs_case_sensitive_path>."
31150 #: ../src/guestfs.pod:654
31151 msgid "ACCESSING THE WINDOWS REGISTRY"
31155 #: ../src/guestfs.pod:656
31157 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31158 "files, through the library C<hivex> which is part of the libguestfs project "
31159 "although ships as a separate tarball. You have to locate and download the "
31160 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31161 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31162 "L<virt-win-reg(1)> for more help on this issue."
31166 #: ../src/guestfs.pod:664
31167 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31171 #: ../src/guestfs.pod:666
31173 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31174 "provide something which looks like a Linux symlink. The way it tries to do "
31175 "the rewriting is described here:"
31179 #: ../src/guestfs.pod:670
31180 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31184 #: ../src/guestfs.pod:672
31186 "The essential problem is that ntfs-3g simply does not have enough "
31187 "information to do a correct job. NTFS links can contain drive letters and "
31188 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31189 "It is almost certainly the case that libguestfs callers should ignore what "
31190 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31194 #: ../src/guestfs.pod:679
31196 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31197 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31198 "attribute, and read the raw reparse data from that (you can find the format "
31199 "documented in various places around the web)."
31203 #: ../src/guestfs.pod:684
31204 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31208 #: ../src/guestfs.pod:686
31210 "There are other useful extended attributes that can be read from ntfs-3g "
31211 "filesystems (using L</guestfs_getxattr>). See:"
31215 #: ../src/guestfs.pod:689
31216 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31220 #: ../src/guestfs.pod:691
31221 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31225 #: ../src/guestfs.pod:693
31227 "Although we don't want to discourage you from using the C API, we will "
31228 "mention here that the same API is also available in other languages."
31232 #: ../src/guestfs.pod:696
31234 "The API is broadly identical in all supported languages. This means that "
31235 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
31236 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
31237 "OCaml. In other words, a straightforward, predictable isomorphism between "
31242 #: ../src/guestfs.pod:702
31244 "Error messages are automatically transformed into exceptions if the language "
31249 #: ../src/guestfs.pod:705
31251 "We don't try to \"object orientify\" parts of the API in OO languages, "
31252 "although contributors are welcome to write higher level APIs above what we "
31253 "provide in their favourite languages if they wish."
31257 #: ../src/guestfs.pod:711
31262 #: ../src/guestfs.pod:713
31264 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
31265 "identical to the C API. C++ classes and exceptions are not used."
31269 #: ../src/guestfs.pod:717
31274 #: ../src/guestfs.pod:719
31276 "The C# bindings are highly experimental. Please read the warnings at the "
31277 "top of C<csharp/Libguestfs.cs>."
31281 #: ../src/guestfs.pod:722
31286 #: ../src/guestfs.pod:724
31288 "This is the only language binding that is working but incomplete. Only "
31289 "calls which return simple integers have been bound in Haskell, and we are "
31290 "looking for help to complete this binding."
31294 #: ../src/guestfs.pod:728
31299 #: ../src/guestfs.pod:730
31301 "Full documentation is contained in the Javadoc which is distributed with "
31302 "libguestfs. For examples, see L<guestfs-java(3)>."
31306 #: ../src/guestfs.pod:733
31311 #: ../src/guestfs.pod:735
31312 msgid "See L<guestfs-ocaml(3)>."
31316 #: ../src/guestfs.pod:737
31321 #: ../src/guestfs.pod:739
31322 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
31326 #: ../src/guestfs.pod:741
31331 #: ../src/guestfs.pod:743
31333 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
31334 "the php-libguestfs package for your distribution."
31338 #: ../src/guestfs.pod:746
31339 msgid "The PHP binding only works correctly on 64 bit machines."
31343 #: ../src/guestfs.pod:748
31348 #: ../src/guestfs.pod:750
31349 msgid "See L<guestfs-python(3)>."
31353 #: ../src/guestfs.pod:752
31358 #: ../src/guestfs.pod:754
31359 msgid "See L<guestfs-ruby(3)>."
31363 #: ../src/guestfs.pod:756
31364 msgid "B<shell scripts>"
31368 #: ../src/guestfs.pod:758
31369 msgid "See L<guestfish(1)>."
31373 #: ../src/guestfs.pod:762
31374 msgid "LIBGUESTFS GOTCHAS"
31378 #: ../src/guestfs.pod:764
31380 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
31381 "system [...] that works in the way it is documented but is counterintuitive "
31382 "and almost invites mistakes.\""
31386 #: ../src/guestfs.pod:768
31388 "Since we developed libguestfs and the associated tools, there are several "
31389 "things we would have designed differently, but are now stuck with for "
31390 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
31391 "release, you can expect these to change. Beware of them."
31395 #: ../src/guestfs.pod:776
31396 msgid "Autosync / forgetting to sync."
31400 #: ../src/guestfs.pod:778
31402 "I<Update:> Autosync is enabled by default for all API users starting from "
31403 "libguestfs 1.5.24. This section only applies to older versions."
31407 #: ../src/guestfs.pod:781
31409 "When modifying a filesystem from C or another language, you B<must> unmount "
31410 "all filesystems and call L</guestfs_sync> explicitly before you close the "
31411 "libguestfs handle. You can also call:"
31415 #: ../src/guestfs.pod:785
31418 " guestfs_set_autosync (g, 1);\n"
31423 #: ../src/guestfs.pod:787
31425 "to have the unmount/sync done automatically for you when the handle 'g' is "
31426 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
31431 #: ../src/guestfs.pod:791
31433 "If you forget to do this, then it is entirely possible that your changes "
31434 "won't be written out, or will be partially written, or (very rarely) that "
31435 "you'll get disk corruption."
31439 #: ../src/guestfs.pod:795
31441 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
31442 "guestfish scripts that forget to sync will work just fine, which can make "
31443 "this very puzzling if you are trying to debug a problem."
31447 #: ../src/guestfs.pod:799
31448 msgid "Mount option C<-o sync> should not be the default."
31452 #: ../src/guestfs.pod:801
31454 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
31455 "However C<-o sync> does not add any reliability benefit, but does have a "
31456 "very large performance impact."
31460 #: ../src/guestfs.pod:805
31462 "The work around is to use L</guestfs_mount_options> and set the mount "
31463 "options that you actually want to use."
31467 #: ../src/guestfs.pod:808
31468 msgid "Read-only should be the default."
31472 #: ../src/guestfs.pod:810
31474 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
31475 "specify I<--rw> if you want to make changes to the image."
31479 #: ../src/guestfs.pod:813
31480 msgid "This would reduce the potential to corrupt live VM images."
31484 #: ../src/guestfs.pod:815
31486 "Note that many filesystems change the disk when you just mount and unmount, "
31487 "even if you didn't perform any writes. You need to use "
31488 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
31492 #: ../src/guestfs.pod:819
31493 msgid "guestfish command line is hard to use."
31497 #: ../src/guestfs.pod:821
31499 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
31500 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
31501 "exist, so it fails. In earlier versions of guestfish the error message was "
31502 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
31503 "we should have used C<guestfish -c command> to run commands."
31507 #: ../src/guestfs.pod:828
31508 msgid "guestfish megabyte modifiers don't work right on all commands"
31512 #: ../src/guestfs.pod:830
31514 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
31515 "other modifiers). What guestfish actually does is to multiply the number "
31516 "part by the modifier part and pass the result to the C API. However this "
31517 "doesn't work for a few APIs which aren't expecting bytes, but are already "
31518 "expecting some other unit (eg. megabytes)."
31522 #: ../src/guestfs.pod:837
31523 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
31527 #: ../src/guestfs.pod:839
31530 " lvcreate LV VG 100M\n"
31535 #: ../src/guestfs.pod:841
31537 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
31538 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
31539 "megabytes * megabytes) logical volume. The error message you get from this "
31540 "is also a little obscure."
31544 #: ../src/guestfs.pod:846
31546 "This could be fixed in the generator by specially marking parameters and "
31547 "return values which take bytes or other units."
31551 #: ../src/guestfs.pod:849
31552 msgid "Ambiguity between devices and paths"
31556 #: ../src/guestfs.pod:851
31558 "There is a subtle ambiguity in the API between a device name "
31559 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
31560 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
31564 #: ../src/guestfs.pod:856
31566 "In the current API we usually resolve this ambiguity by having two separate "
31567 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
31568 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
31569 "detecting if the path supplied begins with C</dev/>."
31573 #: ../src/guestfs.pod:862
31575 "To avoid both the ambiguity and the need to duplicate some calls, we could "
31576 "make paths/devices into structured names. One way to do this would be to "
31577 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
31578 "aspect of grub. Another way would be to use a structured type, equivalent "
31579 "to this OCaml type:"
31583 #: ../src/guestfs.pod:868
31586 " type path = Path of string | Device of int | Partition of int * int\n"
31591 #: ../src/guestfs.pod:870
31592 msgid "which would allow you to pass arguments like:"
31596 #: ../src/guestfs.pod:872
31599 " Path \"/foo/bar\"\n"
31600 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
31601 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
31602 " Path \"/dev/sdb2\" (* not a device *)\n"
31607 #: ../src/guestfs.pod:877
31609 "As you can see there are still problems to resolve even with this "
31610 "representation. Also consider how it might work in guestfish."
31614 #: ../src/guestfs.pod:882
31615 msgid "KEYS AND PASSPHRASES"
31619 #: ../src/guestfs.pod:884
31621 "Certain libguestfs calls take a parameter that contains sensitive key "
31622 "material, passed in as a C string."
31626 #: ../src/guestfs.pod:887
31628 "In the future we would hope to change the libguestfs implementation so that "
31629 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
31630 "swap. However this is I<not> done at the moment, because of the complexity "
31631 "of such an implementation."
31635 #: ../src/guestfs.pod:892
31637 "Therefore you should be aware that any key parameter you pass to libguestfs "
31638 "might end up being written out to the swap partition. If this is a concern, "
31639 "scrub the swap partition or don't use libguestfs on encrypted devices."
31643 #: ../src/guestfs.pod:897
31644 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
31648 #: ../src/guestfs.pod:899
31650 "All high-level libguestfs actions are synchronous. If you want to use "
31651 "libguestfs asynchronously then you must create a thread."
31655 #: ../src/guestfs.pod:902
31657 "Only use the handle from a single thread. Either use the handle exclusively "
31658 "from one thread, or provide your own mutex so that two threads cannot issue "
31659 "calls on the same handle at the same time."
31663 #: ../src/guestfs.pod:906
31665 "See the graphical program guestfs-browser for one possible architecture for "
31666 "multithreaded programs using libvirt and libguestfs."
31670 #: ../src/guestfs.pod:909
31675 #: ../src/guestfs.pod:911
31677 "Libguestfs needs a supermin appliance, which it finds by looking along an "
31682 #: ../src/guestfs.pod:914
31684 "By default it looks for these in the directory C<$libdir/guestfs> "
31685 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
31689 #: ../src/guestfs.pod:917
31691 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
31692 "to change the directories that libguestfs will search in. The value is a "
31693 "colon-separated list of paths. The current directory is I<not> searched "
31694 "unless the path contains an empty element or C<.>. For example "
31695 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
31696 "then C</usr/lib/guestfs>."
31700 #: ../src/guestfs.pod:924
31701 msgid "QEMU WRAPPERS"
31705 #: ../src/guestfs.pod:926
31707 "If you want to compile your own qemu, run qemu from a non-standard location, "
31708 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
31713 #: ../src/guestfs.pod:930
31715 "There is one important rule to remember: you I<must C<exec qemu>> as the "
31716 "last command in the shell script (so that qemu replaces the shell and "
31717 "becomes the direct child of the libguestfs-using program). If you don't do "
31718 "this, then the qemu process won't be cleaned up correctly."
31722 #: ../src/guestfs.pod:935
31724 "Here is an example of a wrapper, where I have built my own copy of qemu from "
31729 #: ../src/guestfs.pod:938
31733 " qemudir=/home/rjones/d/qemu\n"
31734 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
31740 #: ../src/guestfs.pod:942
31742 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
31743 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
31748 #: ../src/guestfs.pod:946
31751 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
31756 #: ../src/guestfs.pod:948
31758 "Note that libguestfs also calls qemu with the -help and -version options in "
31759 "order to determine features."
31763 #: ../src/guestfs.pod:951
31764 msgid "ATTACHING TO RUNNING DAEMONS"
31768 #: ../src/guestfs.pod:953
31770 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
31771 "babies. Use with caution."
31775 #: ../src/guestfs.pod:956
31777 "I<Note (2):> This section explains how to attach to a running daemon from a "
31778 "low level perspective. For most users, simply using virt tools such as "
31779 "L<guestfish(1)> with the I<--live> option will \"just work\"."
31783 #: ../src/guestfs.pod:960
31784 msgid "Using guestfs_set_attach_method"
31788 #: ../src/guestfs.pod:962
31790 "By calling L</guestfs_set_attach_method> you can change how the library "
31791 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
31792 "L</ARCHITECTURE> for some background)."
31796 #: ../src/guestfs.pod:966
31798 "The normal attach method is C<appliance>, where a small appliance is created "
31799 "containing the daemon, and then the library connects to this."
31803 #: ../src/guestfs.pod:969
31805 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
31806 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
31807 "daemon over the Unix domain socket."
31811 #: ../src/guestfs.pod:973
31813 "The normal use for this is to connect to a running virtual machine that "
31814 "contains a C<guestfsd> daemon, and send commands so you can read and write "
31815 "files inside the live virtual machine."
31819 #: ../src/guestfs.pod:977
31820 msgid "Using guestfs_add_domain with live flag"
31824 #: ../src/guestfs.pod:979
31826 "L</guestfs_add_domain> provides some help for getting the correct attach "
31827 "method. If you pass the C<live> option to this function, then (if the "
31828 "virtual machine is running) it will examine the libvirt XML looking for a "
31829 "virtio-serial channel to connect to:"
31833 #: ../src/guestfs.pod:985
31840 " <channel type='unix'>\n"
31841 " <source mode='bind' path='/path/to/socket'/>\n"
31842 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
31851 #: ../src/guestfs.pod:997
31853 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
31854 "method to C<unix:/path/to/socket>."
31858 #: ../src/guestfs.pod:1000
31860 "Some of the libguestfs tools (including guestfish) support a I<--live> "
31861 "option which is passed through to L</guestfs_add_domain> thus allowing you "
31862 "to attach to and modify live virtual machines."
31866 #: ../src/guestfs.pod:1004
31868 "The virtual machine needs to have been set up beforehand so that it has the "
31869 "virtio-serial channel and so that guestfsd is running inside it."
31873 #: ../src/guestfs.pod:1008
31874 msgid "ABI GUARANTEE"
31878 #: ../src/guestfs.pod:1010
31880 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
31881 "actions as outlined in this section. Although we will deprecate some "
31882 "actions, for example if they get replaced by newer calls, we will keep the "
31883 "old actions forever. This allows you the developer to program in confidence "
31884 "against the libguestfs API."
31888 #: ../src/guestfs.pod:1016
31889 msgid "BLOCK DEVICE NAMING"
31893 #: ../src/guestfs.pod:1018
31895 "In the kernel there is now quite a profusion of schemata for naming block "
31896 "devices (in this context, by I<block device> I mean a physical or virtual "
31897 "hard drive). The original Linux IDE driver used names starting with "
31898 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
31899 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
31900 "replacement for the old IDE driver (particularly for SATA devices) those "
31901 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
31902 "machines with paravirtualized drivers. This has created several different "
31903 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
31908 #: ../src/guestfs.pod:1030
31910 "As discussed above, libguestfs uses a qemu appliance running an embedded "
31911 "Linux kernel to access block devices. We can run a variety of appliances "
31912 "based on a variety of Linux kernels."
31916 #: ../src/guestfs.pod:1034
31918 "This causes a problem for libguestfs because many API calls use device or "
31919 "partition names. Working scripts and the recipe (example) scripts that we "
31920 "make available over the internet could fail if the naming scheme changes."
31924 #: ../src/guestfs.pod:1039
31926 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
31927 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
31928 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
31929 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
31933 #: ../src/guestfs.pod:1045
31935 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
31936 "L</guestfs_list_partitions> and similar calls return the true names of the "
31937 "devices and partitions as known to the appliance."
31941 #: ../src/guestfs.pod:1050
31942 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
31946 #: ../src/guestfs.pod:1052
31948 "Usually this translation is transparent. However in some (very rare) cases "
31949 "you may need to know the exact algorithm. Such cases include where you use "
31950 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
31951 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
31956 #: ../src/guestfs.pod:1058
31958 "The algorithm is applied only to I<parameters> which are known to be either "
31959 "device or partition names. Return values from functions such as "
31960 "L</guestfs_list_devices> are never changed."
31964 #: ../src/guestfs.pod:1066
31965 msgid "Is the string a parameter which is a device or partition name?"
31969 #: ../src/guestfs.pod:1070
31970 msgid "Does the string begin with C</dev/sd>?"
31974 #: ../src/guestfs.pod:1074
31976 "Does the named device exist? If so, we use that device. However if I<not> "
31977 "then we continue with this algorithm."
31981 #: ../src/guestfs.pod:1079
31982 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
31986 #: ../src/guestfs.pod:1081
31987 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
31991 #: ../src/guestfs.pod:1083
31992 msgid "If that named device exists, use it. If not, continue."
31996 #: ../src/guestfs.pod:1087
31997 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32001 #: ../src/guestfs.pod:1089
32002 msgid "If that named device exists, use it. If not, return an error."
32006 #: ../src/guestfs.pod:1093
32007 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32011 #: ../src/guestfs.pod:1095
32013 "Although the standard naming scheme and automatic translation is useful for "
32014 "simple programs and guestfish scripts, for larger programs it is best not to "
32015 "rely on this mechanism."
32019 #: ../src/guestfs.pod:1099
32021 "Where possible for maximum future portability programs using libguestfs "
32022 "should use these future-proof techniques:"
32026 #: ../src/guestfs.pod:1106
32028 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32029 "device names, and then use those names directly."
32033 #: ../src/guestfs.pod:1109
32034 msgid "Since those device names exist by definition, they will never be translated."
32038 #: ../src/guestfs.pod:1114
32040 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32041 "filesystem labels."
32045 #: ../src/guestfs.pod:1119
32050 #: ../src/guestfs.pod:1121
32052 "This section discusses security implications of using libguestfs, "
32053 "particularly with untrusted or malicious guests or disk images."
32057 #: ../src/guestfs.pod:1124
32058 msgid "GENERAL SECURITY CONSIDERATIONS"
32062 #: ../src/guestfs.pod:1126
32064 "Be careful with any files or data that you download from a guest (by "
32065 "\"download\" we mean not just the L</guestfs_download> command but any "
32066 "command that reads files, filenames, directories or anything else from a "
32067 "disk image). An attacker could manipulate the data to fool your program "
32068 "into doing the wrong thing. Consider cases such as:"
32072 #: ../src/guestfs.pod:1136
32073 msgid "the data (file etc) not being present"
32077 #: ../src/guestfs.pod:1140
32078 msgid "being present but empty"
32082 #: ../src/guestfs.pod:1144
32083 msgid "being much larger than normal"
32087 #: ../src/guestfs.pod:1148
32088 msgid "containing arbitrary 8 bit data"
32092 #: ../src/guestfs.pod:1152
32093 msgid "being in an unexpected character encoding"
32097 #: ../src/guestfs.pod:1156
32098 msgid "containing homoglyphs."
32102 #: ../src/guestfs.pod:1160
32103 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32107 #: ../src/guestfs.pod:1162
32109 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32110 "(VFS) module can sometimes be escalated into exploits by deliberately "
32111 "creating a malicious, malformed filesystem. These exploits are very severe "
32112 "for two reasons. Firstly there are very many filesystem drivers in the "
32113 "kernel, and many of them are infrequently used and not much developer "
32114 "attention has been paid to the code. Linux userspace helps potential "
32115 "crackers by detecting the filesystem type and automatically choosing the "
32116 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32117 "the administrator. Secondly, a kernel-level exploit is like a local root "
32118 "exploit (worse in some ways), giving immediate and total access to the "
32119 "system right down to the hardware level."
32123 #: ../src/guestfs.pod:1175
32125 "That explains why you should never mount a filesystem from an untrusted "
32126 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32127 "inside a qemu virtual machine, usually running as a non-root user. The "
32128 "attacker would need to write a filesystem which first exploited the kernel, "
32129 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32130 "the libguestfs protocol, and finally to be as serious as the host kernel "
32131 "exploit it would need to escalate its privileges to root. This multi-step "
32132 "escalation, performed by a static piece of data, is thought to be extremely "
32133 "hard to do, although we never say 'never' about security issues."
32137 #: ../src/guestfs.pod:1186
32139 "In any case callers can reduce the attack surface by forcing the filesystem "
32140 "type when mounting (use L</guestfs_mount_vfs>)."
32144 #: ../src/guestfs.pod:1189
32145 msgid "PROTOCOL SECURITY"
32149 #: ../src/guestfs.pod:1191
32151 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32152 "defined upper message size. However a program that uses libguestfs must "
32153 "also take care - for example you can write a program that downloads a binary "
32154 "from a disk image and executes it locally, and no amount of protocol "
32155 "security will save you from the consequences."
32159 #: ../src/guestfs.pod:1197
32160 msgid "INSPECTION SECURITY"
32164 #: ../src/guestfs.pod:1199
32166 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32167 "directly from the guest, and these could contain any 8 bit data. Callers "
32168 "should be careful to escape these before printing them to a structured file "
32169 "(for example, use HTML escaping if creating a web page)."
32173 #: ../src/guestfs.pod:1205
32175 "Guest configuration may be altered in unusual ways by the administrator of "
32176 "the virtual machine, and may not reflect reality (particularly for untrusted "
32177 "or actively malicious guests). For example we parse the hostname from "
32178 "configuration files like C</etc/sysconfig/network> that we find in the "
32179 "guest, but the guest administrator can easily manipulate these files to "
32180 "provide the wrong hostname."
32184 #: ../src/guestfs.pod:1213
32186 "The inspection API parses guest configuration using two external libraries: "
32187 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32188 "designed to be robust in the face of malicious data, although denial of "
32189 "service attacks are still possible, for example with oversized configuration "
32194 #: ../src/guestfs.pod:1219
32195 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
32199 #: ../src/guestfs.pod:1221
32201 "Be very cautious about running commands from the guest. By running a "
32202 "command in the guest, you are giving CPU time to a binary that you do not "
32203 "control, under the same user account as the library, albeit wrapped in qemu "
32204 "virtualization. More information and alternatives can be found in the "
32205 "section L</RUNNING COMMANDS>."
32209 #: ../src/guestfs.pod:1227
32210 msgid "CVE-2010-3851"
32214 #: ../src/guestfs.pod:1229
32215 msgid "https://bugzilla.redhat.com/642934"
32219 #: ../src/guestfs.pod:1231
32221 "This security bug concerns the automatic disk format detection that qemu "
32222 "does on disk images."
32226 #: ../src/guestfs.pod:1234
32228 "A raw disk image is just the raw bytes, there is no header. Other disk "
32229 "images like qcow2 contain a special header. Qemu deals with this by looking "
32230 "for one of the known headers, and if none is found then assuming the disk "
32231 "image must be raw."
32235 #: ../src/guestfs.pod:1239
32237 "This allows a guest which has been given a raw disk image to write some "
32238 "other header. At next boot (or when the disk image is accessed by "
32239 "libguestfs) qemu would do autodetection and think the disk image format was, "
32240 "say, qcow2 based on the header written by the guest."
32244 #: ../src/guestfs.pod:1244
32246 "This in itself would not be a problem, but qcow2 offers many features, one "
32247 "of which is to allow a disk image to refer to another image (called the "
32248 "\"backing disk\"). It does this by placing the path to the backing disk "
32249 "into the qcow2 header. This path is not validated and could point to any "
32250 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
32251 "\"holes\" in the qcow2 disk image, which of course is completely under the "
32252 "control of the attacker."
32256 #: ../src/guestfs.pod:1252
32257 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
32261 #: ../src/guestfs.pod:1259
32262 msgid "You have enabled the network or have opened the disk in write mode."
32266 #: ../src/guestfs.pod:1263
32268 "You are also running untrusted code from the guest (see L</RUNNING "
32273 #: ../src/guestfs.pod:1268
32275 "The way to avoid this is to specify the expected disk format when adding "
32276 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
32277 "should always do this if the disk is raw format, and it's a good idea for "
32282 #: ../src/guestfs.pod:1273
32284 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
32285 "format is fetched from libvirt and passed through."
32289 #: ../src/guestfs.pod:1276
32291 "For libguestfs tools, use the I<--format> command line parameter as "
32296 #: ../src/guestfs.pod:1279
32297 msgid "CONNECTION MANAGEMENT"
32301 #: ../src/guestfs.pod:1281
32302 msgid "guestfs_h *"
32306 #: ../src/guestfs.pod:1283
32308 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
32309 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
32310 "handle and release all resources used."
32314 #: ../src/guestfs.pod:1287
32316 "For information on using multiple handles and threads, see the section "
32317 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
32321 #: ../src/guestfs.pod:1290
32322 msgid "guestfs_create"
32326 #: ../src/guestfs.pod:1292
32329 " guestfs_h *guestfs_create (void);\n"
32334 #: ../src/guestfs.pod:1294
32335 msgid "Create a connection handle."
32339 #: ../src/guestfs.pod:1296
32341 "On success this returns a non-NULL pointer to a handle. On error it returns "
32346 #: ../src/guestfs.pod:1299
32348 "You have to \"configure\" the handle after creating it. This includes "
32349 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
32350 "handle at least once."
32354 #: ../src/guestfs.pod:1303
32355 msgid "After configuring the handle, you have to call L</guestfs_launch>."
32359 #: ../src/guestfs.pod:1305
32361 "You may also want to configure error handling for the handle. See the "
32362 "L</ERROR HANDLING> section below."
32366 #: ../src/guestfs.pod:1308
32367 msgid "guestfs_close"
32371 #: ../src/guestfs.pod:1310
32374 " void guestfs_close (guestfs_h *g);\n"
32379 #: ../src/guestfs.pod:1312
32380 msgid "This closes the connection handle and frees up all resources used."
32384 #: ../src/guestfs.pod:1314
32386 "If autosync was set on the handle and the handle was launched, then this "
32387 "implicitly calls various functions to unmount filesystems and sync the "
32388 "disk. See L</guestfs_set_autosync> for more details."
32392 #: ../src/guestfs.pod:1318
32393 msgid "If a close callback was set on the handle, then it is called."
32397 #: ../src/guestfs.pod:1320
32398 msgid "ERROR HANDLING"
32402 #: ../src/guestfs.pod:1322
32404 "API functions can return errors. For example, almost all functions that "
32405 "return C<int> will return C<-1> to indicate an error."
32409 #: ../src/guestfs.pod:1325
32411 "Additional information is available for errors: an error message string and "
32412 "optionally an error number (errno) if the thing that failed was a system "
32417 #: ../src/guestfs.pod:1329
32419 "You can get at the additional information about the last error on the handle "
32420 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
32421 "up an error handler with L</guestfs_set_error_handler>."
32425 #: ../src/guestfs.pod:1334
32427 "When the handle is created, a default error handler is installed which "
32428 "prints the error message string to C<stderr>. For small short-running "
32429 "command line programs it is sufficient to do:"
32433 #: ../src/guestfs.pod:1338
32436 " if (guestfs_launch (g) == -1)\n"
32437 " exit (EXIT_FAILURE);\n"
32442 #: ../src/guestfs.pod:1341
32444 "since the default error handler will ensure that an error message has been "
32445 "printed to C<stderr> before the program exits."
32449 #: ../src/guestfs.pod:1344
32451 "For other programs the caller will almost certainly want to install an "
32452 "alternate error handler or do error handling in-line like this:"
32456 #: ../src/guestfs.pod:1347
32459 " g = guestfs_create ();\n"
32464 #: ../src/guestfs.pod:1349
32467 " /* This disables the default behaviour of printing errors\n"
32469 " guestfs_set_error_handler (g, NULL, NULL);\n"
32474 #: ../src/guestfs.pod:1353
32477 " if (guestfs_launch (g) == -1) {\n"
32478 " /* Examine the error message and print it etc. */\n"
32479 " char *msg = guestfs_last_error (g);\n"
32480 " int errnum = guestfs_last_errno (g);\n"
32481 " fprintf (stderr, \"%s\\n\", msg);\n"
32488 #: ../src/guestfs.pod:1361
32490 "Out of memory errors are handled differently. The default action is to call "
32491 "L<abort(3)>. If this is undesirable, then you can set a handler using "
32492 "L</guestfs_set_out_of_memory_handler>."
32496 #: ../src/guestfs.pod:1365
32498 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
32499 "because there is no handle if this happens there is no way to get additional "
32500 "error information. However L</guestfs_create> is supposed to be a "
32501 "lightweight operation which can only fail because of insufficient memory (it "
32502 "returns NULL in this case)."
32506 #: ../src/guestfs.pod:1371
32507 msgid "guestfs_last_error"
32511 #: ../src/guestfs.pod:1373
32514 " const char *guestfs_last_error (guestfs_h *g);\n"
32519 #: ../src/guestfs.pod:1375
32521 "This returns the last error message that happened on C<g>. If there has not "
32522 "been an error since the handle was created, then this returns C<NULL>."
32526 #: ../src/guestfs.pod:1379
32528 "The lifetime of the returned string is until the next error occurs, or "
32529 "L</guestfs_close> is called."
32533 #: ../src/guestfs.pod:1382
32534 msgid "guestfs_last_errno"
32538 #: ../src/guestfs.pod:1384
32541 " int guestfs_last_errno (guestfs_h *g);\n"
32546 #: ../src/guestfs.pod:1386
32547 msgid "This returns the last error number (errno) that happened on C<g>."
32551 #: ../src/guestfs.pod:1388
32552 msgid "If successful, an errno integer not equal to zero is returned."
32556 #: ../src/guestfs.pod:1390
32557 msgid "If no error, this returns 0. This call can return 0 in three situations:"
32561 #: ../src/guestfs.pod:1397
32562 msgid "There has not been any error on the handle."
32566 #: ../src/guestfs.pod:1401
32568 "There has been an error but the errno was meaningless. This corresponds to "
32569 "the case where the error did not come from a failed system call, but for "
32570 "some other reason."
32574 #: ../src/guestfs.pod:1407
32576 "There was an error from a failed system call, but for some reason the errno "
32577 "was not captured and returned. This usually indicates a bug in libguestfs."
32581 #: ../src/guestfs.pod:1413
32583 "Libguestfs tries to convert the errno from inside the applicance into a "
32584 "corresponding errno for the caller (not entirely trivial: the appliance "
32585 "might be running a completely different operating system from the library "
32586 "and error numbers are not standardized across Un*xen). If this could not be "
32587 "done, then the error is translated to C<EINVAL>. In practice this should "
32588 "only happen in very rare circumstances."
32592 #: ../src/guestfs.pod:1421
32593 msgid "guestfs_set_error_handler"
32597 #: ../src/guestfs.pod:1423
32600 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
32602 " const char *msg);\n"
32603 " void guestfs_set_error_handler (guestfs_h *g,\n"
32604 " guestfs_error_handler_cb cb,\n"
32605 " void *opaque);\n"
32610 #: ../src/guestfs.pod:1430
32612 "The callback C<cb> will be called if there is an error. The parameters "
32613 "passed to the callback are an opaque data pointer and the error message "
32618 #: ../src/guestfs.pod:1434
32620 "C<errno> is not passed to the callback. To get that the callback must call "
32621 "L</guestfs_last_errno>."
32625 #: ../src/guestfs.pod:1437
32627 "Note that the message string C<msg> is freed as soon as the callback "
32628 "function returns, so if you want to stash it somewhere you must make your "
32633 #: ../src/guestfs.pod:1441
32634 msgid "The default handler prints messages on C<stderr>."
32638 #: ../src/guestfs.pod:1443
32639 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
32643 #: ../src/guestfs.pod:1445
32644 msgid "guestfs_get_error_handler"
32648 #: ../src/guestfs.pod:1447
32651 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
32652 " void **opaque_rtn);\n"
32657 #: ../src/guestfs.pod:1450
32658 msgid "Returns the current error handler callback."
32662 #: ../src/guestfs.pod:1452
32663 msgid "guestfs_set_out_of_memory_handler"
32667 #: ../src/guestfs.pod:1454
32670 " typedef void (*guestfs_abort_cb) (void);\n"
32671 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
32672 " guestfs_abort_cb);\n"
32677 #: ../src/guestfs.pod:1458
32679 "The callback C<cb> will be called if there is an out of memory situation. "
32680 "I<Note this callback must not return>."
32684 #: ../src/guestfs.pod:1461
32685 msgid "The default is to call L<abort(3)>."
32689 #: ../src/guestfs.pod:1463
32690 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
32694 #: ../src/guestfs.pod:1466
32695 msgid "guestfs_get_out_of_memory_handler"
32699 #: ../src/guestfs.pod:1468
32702 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
32707 #: ../src/guestfs.pod:1470
32708 msgid "This returns the current out of memory handler."
32712 #: ../src/guestfs.pod:1472
32717 #: ../src/guestfs.pod:1476
32722 #: ../src/guestfs.pod:1478
32727 #: ../src/guestfs.pod:1480
32728 msgid "AVAILABILITY"
32732 #: ../src/guestfs.pod:1482
32733 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
32737 #: ../src/guestfs.pod:1484
32739 "Using L</guestfs_available> you can test availability of the following "
32740 "groups of functions. This test queries the appliance to see if the "
32741 "appliance you are currently using supports the functionality."
32745 #: ../src/guestfs.pod:1489
32746 msgid "@AVAILABILITY@"
32750 #: ../src/guestfs.pod:1491
32751 msgid "GUESTFISH supported COMMAND"
32755 #: ../src/guestfs.pod:1493
32757 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
32758 "prints out the available groups and whether they are supported by this build "
32759 "of libguestfs. Note however that you have to do C<run> first."
32763 #: ../src/guestfs.pod:1498
32764 msgid "SINGLE CALLS AT COMPILE TIME"
32768 #: ../src/guestfs.pod:1500
32770 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
32771 "function, such as:"
32775 #: ../src/guestfs.pod:1503
32778 " #define LIBGUESTFS_HAVE_DD 1\n"
32783 #: ../src/guestfs.pod:1505
32784 msgid "if L</guestfs_dd> is available."
32788 #: ../src/guestfs.pod:1507
32790 "Before version 1.5.8, if you needed to test whether a single libguestfs "
32791 "function is available at compile time, we recommended using build tools such "
32792 "as autoconf or cmake. For example in autotools you could use:"
32796 #: ../src/guestfs.pod:1512
32799 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
32800 " AC_CHECK_FUNCS([guestfs_dd])\n"
32805 #: ../src/guestfs.pod:1515
32807 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
32812 #: ../src/guestfs.pod:1518
32813 msgid "SINGLE CALLS AT RUN TIME"
32817 #: ../src/guestfs.pod:1520
32819 "Testing at compile time doesn't guarantee that a function really exists in "
32820 "the library. The reason is that you might be dynamically linked against a "
32821 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
32822 "This situation unfortunately results in a segmentation fault, which is a "
32823 "shortcoming of the C dynamic linking system itself."
32827 #: ../src/guestfs.pod:1527
32829 "You can use L<dlopen(3)> to test if a function is available at run time, as "
32830 "in this example program (note that you still need the compile time check as "
32835 #: ../src/guestfs.pod:1531
32838 " #include <stdio.h>\n"
32839 " #include <stdlib.h>\n"
32840 " #include <unistd.h>\n"
32841 " #include <dlfcn.h>\n"
32842 " #include <guestfs.h>\n"
32847 #: ../src/guestfs.pod:1537
32852 " #ifdef LIBGUESTFS_HAVE_DD\n"
32854 " int has_function;\n"
32859 #: ../src/guestfs.pod:1543
32862 " /* Test if the function guestfs_dd is really available. */\n"
32863 " dl = dlopen (NULL, RTLD_LAZY);\n"
32865 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
32866 " exit (EXIT_FAILURE);\n"
32868 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
32874 #: ../src/guestfs.pod:1552
32877 " if (!has_function)\n"
32878 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
32880 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
32881 " /* Now it's safe to call\n"
32882 " guestfs_dd (g, \"foo\", \"bar\");\n"
32886 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
32893 #: ../src/guestfs.pod:1565
32895 "You may think the above is an awful lot of hassle, and it is. There are "
32896 "other ways outside of the C linking system to ensure that this kind of "
32897 "incompatibility never arises, such as using package versioning:"
32901 #: ../src/guestfs.pod:1570
32904 " Requires: libguestfs >= 1.0.80\n"
32909 #: ../src/guestfs.pod:1572
32910 msgid "CALLS WITH OPTIONAL ARGUMENTS"
32914 #: ../src/guestfs.pod:1574
32916 "A recent feature of the API is the introduction of calls which take optional "
32917 "arguments. In C these are declared 3 ways. The main way is as a call which "
32918 "takes variable arguments (ie. C<...>), as in this example:"
32922 #: ../src/guestfs.pod:1579
32925 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
32930 #: ../src/guestfs.pod:1581
32932 "Call this with a list of optional arguments, terminated by C<-1>. So to "
32933 "call with no optional arguments specified:"
32937 #: ../src/guestfs.pod:1584
32940 " guestfs_add_drive_opts (g, filename, -1);\n"
32945 #: ../src/guestfs.pod:1586
32946 msgid "With a single optional argument:"
32950 #: ../src/guestfs.pod:1588
32953 " guestfs_add_drive_opts (g, filename,\n"
32954 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
32960 #: ../src/guestfs.pod:1592
32965 #: ../src/guestfs.pod:1594
32968 " guestfs_add_drive_opts (g, filename,\n"
32969 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
32970 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
32976 #: ../src/guestfs.pod:1599
32978 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
32983 #: ../src/guestfs.pod:1602
32984 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
32988 #: ../src/guestfs.pod:1604
32990 "The second variant has the same name with the suffix C<_va>, which works the "
32991 "same way but takes a C<va_list>. See the C manual for details. For the "
32992 "example function, this is declared:"
32996 #: ../src/guestfs.pod:1608
32999 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33000 " va_list args);\n"
33005 #: ../src/guestfs.pod:1611
33006 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33010 #: ../src/guestfs.pod:1613
33012 "The third variant is useful where you need to construct these calls. You "
33013 "pass in a structure where you fill in the optional fields. The structure "
33014 "has a bitmask as the first element which you must set to indicate which "
33015 "fields you have filled in. For our example function the structure and call "
33020 #: ../src/guestfs.pod:1619
33023 " struct guestfs_add_drive_opts_argv {\n"
33024 " uint64_t bitmask;\n"
33026 " const char *format;\n"
33029 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33030 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33035 #: ../src/guestfs.pod:1628
33036 msgid "You could call it like this:"
33040 #: ../src/guestfs.pod:1630
33043 " struct guestfs_add_drive_opts_argv optargs = {\n"
33044 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33045 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33046 " .readonly = 1,\n"
33047 " .format = \"qcow2\"\n"
33053 #: ../src/guestfs.pod:1637
33056 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33061 #: ../src/guestfs.pod:1645
33062 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33066 #: ../src/guestfs.pod:1650
33067 msgid "You do not need to fill in all fields of the structure."
33071 #: ../src/guestfs.pod:1654
33073 "There must be a one-to-one correspondence between fields of the structure "
33074 "that are filled in, and bits set in the bitmask."
33078 #: ../src/guestfs.pod:1659
33079 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33083 #: ../src/guestfs.pod:1661
33085 "In other languages, optional arguments are expressed in the way that is "
33086 "natural for that language. We refer you to the language-specific "
33087 "documentation for more details on that."
33091 #: ../src/guestfs.pod:1665
33092 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33096 #: ../src/guestfs.pod:1667
33097 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33101 #: ../src/guestfs.pod:1669
33103 "B<Note:> This section documents the generic event mechanism introduced in "
33104 "libguestfs 1.10, which you should use in new code if possible. The old "
33105 "functions C<guestfs_set_log_message_callback>, "
33106 "C<guestfs_set_subprocess_quit_callback>, "
33107 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33108 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33109 "page. Because of the ABI guarantee, the old functions continue to work."
33113 #: ../src/guestfs.pod:1678
33115 "Handles generate events when certain things happen, such as log messages "
33116 "being generated, progress messages during long-running operations, or the "
33117 "handle being closed. The API calls described below let you register a "
33118 "callback to be called when events happen. You can register multiple "
33119 "callbacks (for the same, different or overlapping sets of events), and "
33120 "individually remove callbacks. If callbacks are not removed, then they "
33121 "remain in force until the handle is closed."
33125 #: ../src/guestfs.pod:1686
33127 "In the current implementation, events are only generated synchronously: that "
33128 "means that events (and hence callbacks) can only happen while you are in the "
33129 "middle of making another libguestfs call. The callback is called in the "
33134 #: ../src/guestfs.pod:1691
33136 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33137 "unsigned integers, or a message buffer. Payloads are discussed later on."
33141 #: ../src/guestfs.pod:1695
33142 msgid "CLASSES OF EVENTS"
33146 #: ../src/guestfs.pod:1699
33147 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33151 #: ../src/guestfs.pod:1702
33153 "The callback function will be called while the handle is being closed "
33154 "(synchronously from L</guestfs_close>)."
33158 #: ../src/guestfs.pod:1705
33160 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33161 "handles that are open when the program exits. This means that this callback "
33162 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33163 "problems in higher-level languages (eg. if your HLL interpreter has already "
33164 "been cleaned up by the time this is called, and if your callback then jumps "
33165 "into some HLL function)."
33169 #: ../src/guestfs.pod:1712
33171 "If no callback is registered: the handle is closed without any callback "
33176 #: ../src/guestfs.pod:1715
33177 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33181 #: ../src/guestfs.pod:1718
33183 "The callback function will be called when the child process quits, either "
33184 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33185 "corresponds to a transition from any state to the CONFIG state)."
33189 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
33190 msgid "If no callback is registered: the event is ignored."
33194 #: ../src/guestfs.pod:1724
33195 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
33199 #: ../src/guestfs.pod:1727
33201 "The callback function will be called when the child process becomes ready "
33202 "first time after it has been launched. (This corresponds to a transition "
33203 "from LAUNCHING to the READY state)."
33207 #: ../src/guestfs.pod:1733
33208 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
33212 #: ../src/guestfs.pod:1736
33214 "Some long-running operations can generate progress messages. If this "
33215 "callback is registered, then it will be called each time a progress message "
33216 "is generated (usually two seconds after the operation started, and three "
33217 "times per second thereafter until it completes, although the frequency may "
33218 "change in future versions)."
33222 #: ../src/guestfs.pod:1742
33224 "The callback receives in the payload four unsigned 64 bit numbers which are "
33225 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
33229 #: ../src/guestfs.pod:1745
33231 "The units of C<total> are not defined, although for some operations C<total> "
33232 "may relate in some way to the amount of data to be transferred (eg. in bytes "
33233 "or megabytes), and C<position> may be the portion which has been "
33238 #: ../src/guestfs.pod:1750
33239 msgid "The only defined and stable parts of the API are:"
33243 #: ../src/guestfs.pod:1756
33245 "The callback can display to the user some type of progress bar or indicator "
33246 "which shows the ratio of C<position>:C<total>."
33250 #: ../src/guestfs.pod:1761
33251 msgid "0 E<lt>= C<position> E<lt>= C<total>"
33255 #: ../src/guestfs.pod:1765
33257 "If any progress notification is sent during a call, then a final progress "
33258 "notification is always sent when C<position> = C<total> (I<unless> the call "
33259 "fails with an error)."
33263 #: ../src/guestfs.pod:1769
33265 "This is to simplify caller code, so callers can easily set the progress "
33266 "indicator to \"100%\" at the end of the operation, without requiring special "
33267 "code to detect this case."
33271 #: ../src/guestfs.pod:1775
33273 "For some calls we are unable to estimate the progress of the call, but we "
33274 "can still generate progress messages to indicate activity. This is known as "
33275 "\"pulse mode\", and is directly supported by certain progress bar "
33276 "implementations (eg. GtkProgressBar)."
33280 #: ../src/guestfs.pod:1780
33282 "For these calls, zero or more progress messages are generated with "
33283 "C<position = 0> and C<total = 1>, followed by a final message with "
33284 "C<position = total = 1>."
33288 #: ../src/guestfs.pod:1784
33290 "As noted above, if the call fails with an error then the final message may "
33291 "not be generated."
33295 #: ../src/guestfs.pod:1789
33297 "The callback also receives the procedure number (C<proc_nr>) and serial "
33298 "number (C<serial>) of the call. These are only useful for debugging "
33299 "protocol issues, and the callback can normally ignore them. The callback "
33300 "may want to print these numbers in error messages or debugging messages."
33304 #: ../src/guestfs.pod:1795
33305 msgid "If no callback is registered: progress messages are discarded."
33309 #: ../src/guestfs.pod:1797
33310 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
33314 #: ../src/guestfs.pod:1800
33316 "The callback function is called whenever a log message is generated by qemu, "
33317 "the appliance kernel, guestfsd (daemon), or utility programs."
33321 #: ../src/guestfs.pod:1803
33323 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
33324 "(L</guestfs_launch>) then additional debug messages are generated."
33328 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
33330 "If no callback is registered: the messages are discarded unless the verbose "
33331 "flag is set in which case they are sent to stderr. You can override the "
33332 "printing of verbose messages to stderr by setting up a callback."
33336 #: ../src/guestfs.pod:1811
33337 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
33341 #: ../src/guestfs.pod:1814
33343 "The callback function is called whenever a log message is generated by the "
33344 "library part of libguestfs."
33348 #: ../src/guestfs.pod:1817
33350 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
33351 "messages are generated."
33355 #: ../src/guestfs.pod:1825
33356 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
33360 #: ../src/guestfs.pod:1828
33362 "The callback function is called whenever a trace message is generated. This "
33363 "only applies if the trace flag (L</guestfs_set_trace>) is set."
33367 #: ../src/guestfs.pod:1831
33369 "If no callback is registered: the messages are sent to stderr. You can "
33370 "override the printing of trace messages to stderr by setting up a callback."
33374 #: ../src/guestfs.pod:1837
33375 msgid "guestfs_set_event_callback"
33379 #: ../src/guestfs.pod:1839
33382 " int guestfs_set_event_callback (guestfs_h *g,\n"
33383 " guestfs_event_callback cb,\n"
33384 " uint64_t event_bitmask,\n"
33386 " void *opaque);\n"
33391 #: ../src/guestfs.pod:1845
33393 "This function registers a callback (C<cb>) for all event classes in the "
33394 "C<event_bitmask>."
33398 #: ../src/guestfs.pod:1848
33400 "For example, to register for all log message events, you could call this "
33401 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
33402 "To register a single callback for all possible classes of events, use "
33403 "C<GUESTFS_EVENT_ALL>."
33407 #: ../src/guestfs.pod:1854
33408 msgid "C<flags> should always be passed as 0."
33412 #: ../src/guestfs.pod:1856
33414 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
33415 "it for any purpose."
33419 #: ../src/guestfs.pod:1859
33421 "The return value is the event handle (an integer) which you can use to "
33422 "delete the callback (see below)."
33426 #: ../src/guestfs.pod:1862
33428 "If there is an error, this function returns C<-1>, and sets the error in the "
33429 "handle in the usual way (see L</guestfs_last_error> etc.)"
33433 #: ../src/guestfs.pod:1865
33435 "Callbacks remain in effect until they are deleted, or until the handle is "
33440 #: ../src/guestfs.pod:1868
33442 "In the case where multiple callbacks are registered for a particular event "
33443 "class, all of the callbacks are called. The order in which multiple "
33444 "callbacks are called is not defined."
33448 #: ../src/guestfs.pod:1872
33449 msgid "guestfs_delete_event_callback"
33453 #: ../src/guestfs.pod:1874
33456 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
33461 #: ../src/guestfs.pod:1876
33463 "Delete a callback that was previously registered. C<event_handle> should be "
33464 "the integer that was returned by a previous call to "
33465 "C<guestfs_set_event_callback> on the same handle."
33469 #: ../src/guestfs.pod:1880
33470 msgid "guestfs_event_callback"
33474 #: ../src/guestfs.pod:1882
33477 " typedef void (*guestfs_event_callback) (\n"
33480 " uint64_t event,\n"
33481 " int event_handle,\n"
33483 " const char *buf, size_t buf_len,\n"
33484 " const uint64_t *array, size_t array_len);\n"
33489 #: ../src/guestfs.pod:1891
33490 msgid "This is the type of the event callback function that you have to provide."
33494 #: ../src/guestfs.pod:1894
33496 "The basic parameters are: the handle (C<g>), the opaque user pointer "
33497 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
33498 "handle, and C<flags> which in the current API you should ignore."
33502 #: ../src/guestfs.pod:1898
33504 "The remaining parameters contain the event payload (if any). Each event may "
33505 "contain a payload, which usually relates to the event class, but for future "
33506 "proofing your code should be written to handle any payload for any event "
33511 #: ../src/guestfs.pod:1903
33513 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
33514 "there is no message buffer). Note that this message buffer can contain "
33515 "arbitrary 8 bit data, including NUL bytes."
33519 #: ../src/guestfs.pod:1907
33521 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
33522 "moment this is only used for progress messages."
33526 #: ../src/guestfs.pod:1910
33527 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
33531 #: ../src/guestfs.pod:1912
33533 "One motivation for the generic event API was to allow GUI programs to "
33534 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
33535 "unconditionally to C<stderr>."
33539 #: ../src/guestfs.pod:1916
33541 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
33542 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
33543 "messages are not events; you must capture error messages separately)."
33547 #: ../src/guestfs.pod:1921
33549 "Programs have to set up a callback to capture the classes of events of "
33554 #: ../src/guestfs.pod:1924
33558 " guestfs_set_event_callback\n"
33559 " (g, message_callback,\n"
33560 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
33561 " GUESTFS_EVENT_TRACE,\n"
33562 " 0, NULL) == -1)\n"
33563 " if (eh == -1) {\n"
33564 " // handle error in the usual way\n"
33570 #: ../src/guestfs.pod:1934
33572 "The callback can then direct messages to the appropriate place. In this "
33573 "example, messages are directed to syslog:"
33577 #: ../src/guestfs.pod:1937
33581 " message_callback (\n"
33584 " uint64_t event,\n"
33585 " int event_handle,\n"
33587 " const char *buf, size_t buf_len,\n"
33588 " const uint64_t *array, size_t array_len)\n"
33590 " const int priority = LOG_USER|LOG_INFO;\n"
33591 " if (buf_len > 0)\n"
33592 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
33598 #: ../src/guestfs.pod:1952
33599 msgid "CANCELLING LONG TRANSFERS"
33603 #: ../src/guestfs.pod:1954
33605 "Some operations can be cancelled by the caller while they are in progress. "
33606 "Currently only operations that involve uploading or downloading data can be "
33607 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
33608 "parameters in the generator)."
33612 #: ../src/guestfs.pod:1959
33613 msgid "guestfs_user_cancel"
33617 #: ../src/guestfs.pod:1961
33620 " void guestfs_user_cancel (guestfs_h *g);\n"
33625 #: ../src/guestfs.pod:1963
33626 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
33630 #: ../src/guestfs.pod:1966
33632 "Unlike most other libguestfs calls, this function is signal safe and thread "
33633 "safe. You can call it from a signal handler or from another thread, without "
33634 "needing to do any locking."
33638 #: ../src/guestfs.pod:1970
33640 "The transfer that was in progress (if there is one) will stop shortly "
33641 "afterwards, and will return an error. The errno (see "
33642 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
33643 "out if the operation was cancelled or failed because of another error."
33647 #: ../src/guestfs.pod:1976
33649 "No cleanup is performed: for example, if a file was being uploaded then "
33650 "after cancellation there may be a partially uploaded file. It is the "
33651 "caller's responsibility to clean up if necessary."
33655 #: ../src/guestfs.pod:1980
33656 msgid "There are two common places that you might call C<guestfs_user_cancel>."
33660 #: ../src/guestfs.pod:1982
33662 "In an interactive text-based program, you might call it from a C<SIGINT> "
33663 "signal handler so that pressing C<^C> cancels the current operation. (You "
33664 "also need to call L</guestfs_set_pgroup> so that child processes don't "
33665 "receive the C<^C> signal)."
33669 #: ../src/guestfs.pod:1987
33671 "In a graphical program, when the main thread is displaying a progress bar "
33672 "with a cancel button, wire up the cancel button to call this function."
33676 #: ../src/guestfs.pod:1991
33677 msgid "PRIVATE DATA AREA"
33681 #: ../src/guestfs.pod:1993
33683 "You can attach named pieces of private data to the libguestfs handle, fetch "
33684 "them by name, and walk over them, for the lifetime of the handle. This is "
33685 "called the private data area and is only available from the C API."
33689 #: ../src/guestfs.pod:1998
33690 msgid "To attach a named piece of data, use the following call:"
33694 #: ../src/guestfs.pod:2000
33697 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
33702 #: ../src/guestfs.pod:2002
33704 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
33705 "pointer (which can be C<NULL>). Any previous item with the same key is "
33710 #: ../src/guestfs.pod:2006
33712 "You can use any C<key> you want, but your key should I<not> start with an "
33713 "underscore character. Keys beginning with an underscore character are "
33714 "reserved for internal libguestfs purposes (eg. for implementing language "
33715 "bindings). It is recommended that you prefix the key with some unique "
33716 "string to avoid collisions with other users."
33720 #: ../src/guestfs.pod:2012
33721 msgid "To retrieve the pointer, use:"
33725 #: ../src/guestfs.pod:2014
33728 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
33733 #: ../src/guestfs.pod:2016
33735 "This function returns C<NULL> if either no data is found associated with "
33736 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
33741 #: ../src/guestfs.pod:2020
33743 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
33744 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
33745 "all. In particular, libguestfs does I<not> try to free the data when the "
33746 "handle is closed. If the data must be freed, then the caller must either "
33747 "free it before calling L</guestfs_close> or must set up a close callback to "
33748 "do it (see L</GUESTFS_EVENT_CLOSE>)."
33752 #: ../src/guestfs.pod:2027
33753 msgid "To walk over all entries, use these two functions:"
33757 #: ../src/guestfs.pod:2029
33760 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
33765 #: ../src/guestfs.pod:2031
33768 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
33773 #: ../src/guestfs.pod:2033
33775 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
33776 "not have any particular meaning -- keys are not returned in any defined "
33777 "order). A pointer to the key is returned in C<*key_rtn> and the "
33778 "corresponding data pointer is returned from the function. C<NULL> is "
33779 "returned if there are no keys stored in the handle."
33783 #: ../src/guestfs.pod:2039
33785 "C<guestfs_next_private> returns the next key, pointer pair. The return "
33786 "value of this function is also C<NULL> is there are no further entries to "
33791 #: ../src/guestfs.pod:2043
33792 msgid "Notes about walking over entries:"
33796 #: ../src/guestfs.pod:2049
33797 msgid "You must not call C<guestfs_set_private> while walking over the entries."
33801 #: ../src/guestfs.pod:2054
33803 "The handle maintains an internal iterator which is reset when you call "
33804 "C<guestfs_first_private>. This internal iterator is invalidated when you "
33805 "call C<guestfs_set_private>."
33809 #: ../src/guestfs.pod:2060
33810 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
33814 #: ../src/guestfs.pod:2062
33817 " guestfs_set_private (g, key, NULL);\n"
33822 #: ../src/guestfs.pod:2064
33823 msgid "then that C<key> is not returned when walking."
33827 #: ../src/guestfs.pod:2068
33829 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
33830 "C<guestfs_next_private> or C<guestfs_set_private>."
33834 #: ../src/guestfs.pod:2074
33836 "The following example code shows how to print all keys and data pointers "
33837 "that are associated with the handle C<g>:"
33841 #: ../src/guestfs.pod:2077
33844 " const char *key;\n"
33845 " void *data = guestfs_first_private (g, &key);\n"
33846 " while (data != NULL)\n"
33848 " printf (\"key = %s, data = %p\\n\", key, data);\n"
33849 " data = guestfs_next_private (g, &key);\n"
33855 #: ../src/guestfs.pod:2085
33857 "More commonly you are only interested in keys that begin with an "
33858 "application-specific prefix C<foo_>. Modify the loop like so:"
33862 #: ../src/guestfs.pod:2088
33865 " const char *key;\n"
33866 " void *data = guestfs_first_private (g, &key);\n"
33867 " while (data != NULL)\n"
33869 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
33870 " printf (\"key = %s, data = %p\\n\", key, data);\n"
33871 " data = guestfs_next_private (g, &key);\n"
33877 #: ../src/guestfs.pod:2097
33879 "If you need to modify keys while walking, then you have to jump back to the "
33880 "beginning of the loop. For example, to delete all keys prefixed with "
33885 #: ../src/guestfs.pod:2101
33888 " const char *key;\n"
33891 " data = guestfs_first_private (g, &key);\n"
33892 " while (data != NULL)\n"
33894 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
33896 " guestfs_set_private (g, key, NULL);\n"
33897 " /* note that 'key' pointer is now invalid, and so is\n"
33898 " the internal iterator */\n"
33901 " data = guestfs_next_private (g, &key);\n"
33907 #: ../src/guestfs.pod:2117
33909 "Note that the above loop is guaranteed to terminate because the keys are "
33910 "being deleted, but other manipulations of keys within the loop might not "
33911 "terminate unless you also maintain an indication of which keys have been "
33916 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
33921 #: ../src/guestfs.pod:2124
33923 "<!-- old anchor for the next section --> <a "
33924 "name=\"state_machine_and_low_level_event_api\"/>"
33928 #: ../src/guestfs.pod:2129
33929 msgid "ARCHITECTURE"
33933 #: ../src/guestfs.pod:2131
33935 "Internally, libguestfs is implemented by running an appliance (a special "
33936 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
33937 "process of the main program."
33941 #: ../src/guestfs.pod:2135
33944 " ___________________\n"
33946 " | main program |\n"
33948 " | | child process / appliance\n"
33949 " | | __________________________\n"
33951 " +-------------------+ RPC | +-----------------+ |\n"
33952 " | libguestfs <--------------------> guestfsd | |\n"
33953 " | | | +-----------------+ |\n"
33954 " \\___________________/ | | Linux kernel | |\n"
33955 " | +--^--------------+ |\n"
33956 " \\_________|________________/\n"
33958 " _______v______\n"
33961 " | disk image |\n"
33962 " \\______________/\n"
33967 #: ../src/guestfs.pod:2155
33969 "The library, linked to the main program, creates the child process and hence "
33970 "the appliance in the L</guestfs_launch> function."
33974 #: ../src/guestfs.pod:2158
33976 "Inside the appliance is a Linux kernel and a complete stack of userspace "
33977 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
33978 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
33979 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
33980 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
33981 "attached to the qemu process which translates device access by the "
33982 "appliance's Linux kernel into accesses to the image."
33986 #: ../src/guestfs.pod:2167
33988 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
33989 "Although the disk image you are attached to might also be used by some "
33990 "virtual machine, libguestfs doesn't know or care about this. (But you will "
33991 "care if both libguestfs's qemu process and your virtual machine are trying "
33992 "to update the disk image at the same time, since these usually results in "
33993 "massive disk corruption)."
33997 #: ../src/guestfs.pod:2174
33998 msgid "STATE MACHINE"
34002 #: ../src/guestfs.pod:2176
34003 msgid "libguestfs uses a state machine to model the child process:"
34007 #: ../src/guestfs.pod:2178
34011 " guestfs_create\n"
34019 " / | \\ \\ guestfs_launch\n"
34020 " / | _\\__V______\n"
34022 " / | | LAUNCHING |\n"
34023 " / | \\___________/\n"
34025 " / | guestfs_launch\n"
34027 " ______ / __|____V\n"
34028 " / \\ ------> / \\\n"
34029 " | BUSY | | READY |\n"
34030 " \\______/ <------ \\________/\n"
34035 #: ../src/guestfs.pod:2200
34037 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34038 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34039 "(3) alternating between READY and BUSY as commands are issued to, and "
34040 "carried out by, the child process."
34044 #: ../src/guestfs.pod:2205
34046 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34047 "asynchronously at any time (eg. due to some internal error), and that causes "
34048 "the state to transition back to CONFIG."
34052 #: ../src/guestfs.pod:2209
34054 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34055 "issued when in the CONFIG state."
34059 #: ../src/guestfs.pod:2212
34061 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34062 "L</guestfs_launch> blocks until the child process is READY to accept "
34063 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34064 "moves the state from CONFIG to LAUNCHING while it is running."
34068 #: ../src/guestfs.pod:2218
34070 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34071 "state. These API calls block waiting for the command to be carried out "
34072 "(ie. the state to transition to BUSY and then back to READY). There are no "
34073 "non-blocking versions, and no way to issue more than one command per handle "
34074 "at the same time."
34078 #: ../src/guestfs.pod:2224
34080 "Finally, the child process sends asynchronous messages back to the main "
34081 "program, such as kernel log messages. You can register a callback to "
34082 "receive these messages."
34086 #: ../src/guestfs.pod:2228
34091 #: ../src/guestfs.pod:2230
34092 msgid "COMMUNICATION PROTOCOL"
34096 #: ../src/guestfs.pod:2232
34098 "Don't rely on using this protocol directly. This section documents how it "
34099 "currently works, but it may change at any time."
34103 #: ../src/guestfs.pod:2235
34105 "The protocol used to talk between the library and the daemon running inside "
34106 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
34107 "1014, RFC 1832, RFC 4506)."
34111 #: ../src/guestfs.pod:2239
34113 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
34114 "this file is automatically generated)."
34118 #: ../src/guestfs.pod:2242
34120 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
34121 "and C<FileOut> parameters, which are handled with very simple request/reply "
34122 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
34123 "parameters, which use the same request and reply messages, but they may also "
34124 "be followed by files sent using a chunked encoding."
34128 #: ../src/guestfs.pod:2249
34129 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
34133 #: ../src/guestfs.pod:2251
34134 msgid "For ordinary functions, the request message is:"
34138 #: ../src/guestfs.pod:2253
34141 " total length (header + arguments,\n"
34142 " but not including the length word itself)\n"
34143 " struct guestfs_message_header (encoded as XDR)\n"
34144 " struct guestfs_<foo>_args (encoded as XDR)\n"
34149 #: ../src/guestfs.pod:2258
34151 "The total length field allows the daemon to allocate a fixed size buffer "
34152 "into which it slurps the rest of the message. As a result, the total length "
34153 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
34154 "effective size of any request is limited to somewhere under this size."
34158 #: ../src/guestfs.pod:2264
34160 "Note also that many functions don't take any arguments, in which case the "
34161 "C<guestfs_I<foo>_args> is completely omitted."
34165 #: ../src/guestfs.pod:2267
34167 "The header contains the procedure number (C<guestfs_proc>) which is how the "
34168 "receiver knows what type of args structure to expect, or none at all."
34172 #: ../src/guestfs.pod:2271
34174 "For functions that take optional arguments, the optional arguments are "
34175 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
34176 "arguments. A bitmask in the header indicates which optional arguments are "
34177 "meaningful. The bitmask is also checked to see if it contains bits set "
34178 "which the daemon does not know about (eg. if more optional arguments were "
34179 "added in a later version of the library), and this causes the call to be "
34184 #: ../src/guestfs.pod:2279
34185 msgid "The reply message for ordinary functions is:"
34189 #: ../src/guestfs.pod:2281
34192 " total length (header + ret,\n"
34193 " but not including the length word itself)\n"
34194 " struct guestfs_message_header (encoded as XDR)\n"
34195 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34200 #: ../src/guestfs.pod:2286
34202 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
34203 "functions that return no formal return values."
34207 #: ../src/guestfs.pod:2289
34208 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
34212 #: ../src/guestfs.pod:2292
34214 "In the case of an error, a flag is set in the header, and the reply message "
34215 "is slightly changed:"
34219 #: ../src/guestfs.pod:2295
34222 " total length (header + error,\n"
34223 " but not including the length word itself)\n"
34224 " struct guestfs_message_header (encoded as XDR)\n"
34225 " struct guestfs_message_error (encoded as XDR)\n"
34230 #: ../src/guestfs.pod:2300
34232 "The C<guestfs_message_error> structure contains the error message as a "
34237 #: ../src/guestfs.pod:2303
34238 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
34242 #: ../src/guestfs.pod:2305
34244 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
34245 "The normal request message is sent (see above). However this is followed by "
34246 "a sequence of file chunks."
34250 #: ../src/guestfs.pod:2309
34253 " total length (header + arguments,\n"
34254 " but not including the length word itself,\n"
34255 " and not including the chunks)\n"
34256 " struct guestfs_message_header (encoded as XDR)\n"
34257 " struct guestfs_<foo>_args (encoded as XDR)\n"
34258 " sequence of chunks for FileIn param #0\n"
34259 " sequence of chunks for FileIn param #1 etc.\n"
34264 #: ../src/guestfs.pod:2317
34265 msgid "The \"sequence of chunks\" is:"
34269 #: ../src/guestfs.pod:2319
34272 " length of chunk (not including length word itself)\n"
34273 " struct guestfs_chunk (encoded as XDR)\n"
34274 " length of chunk\n"
34275 " struct guestfs_chunk (encoded as XDR)\n"
34277 " length of chunk\n"
34278 " struct guestfs_chunk (with data.data_len == 0)\n"
34283 #: ../src/guestfs.pod:2327
34285 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
34286 "is set in the final chunk to indicate either successful completion or early "
34291 #: ../src/guestfs.pod:2331
34293 "At time of writing there are no functions that have more than one FileIn "
34294 "parameter. However this is (theoretically) supported, by sending the "
34295 "sequence of chunks for each FileIn parameter one after another (from left to "
34300 #: ../src/guestfs.pod:2336
34302 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
34303 "transfer. The library does this by sending a chunk with a special flag set "
34304 "to indicate cancellation. When the daemon sees this, it cancels the whole "
34305 "RPC, does I<not> send any reply, and goes back to reading the next request."
34309 #: ../src/guestfs.pod:2342
34311 "The daemon may also cancel. It does this by writing a special word "
34312 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
34313 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
34314 "cancel chunk). The special word is chosen so that even if cancellation "
34315 "happens right at the end of the transfer (after the library has finished "
34316 "writing and has started listening for the reply), the \"spurious\" cancel "
34317 "flag will not be confused with the reply message."
34321 #: ../src/guestfs.pod:2351
34323 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
34324 "limit), and also files where the size is not known in advance (eg. from "
34325 "pipes or sockets). However the chunks are rather small "
34326 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
34327 "to keep much in memory."
34331 #: ../src/guestfs.pod:2357
34332 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
34336 #: ../src/guestfs.pod:2359
34338 "The protocol for FileOut parameters is exactly the same as for FileIn "
34339 "parameters, but with the roles of daemon and library reversed."
34343 #: ../src/guestfs.pod:2362
34346 " total length (header + ret,\n"
34347 " but not including the length word itself,\n"
34348 " and not including the chunks)\n"
34349 " struct guestfs_message_header (encoded as XDR)\n"
34350 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34351 " sequence of chunks for FileOut param #0\n"
34352 " sequence of chunks for FileOut param #1 etc.\n"
34357 #: ../src/guestfs.pod:2370
34358 msgid "INITIAL MESSAGE"
34362 #: ../src/guestfs.pod:2372
34364 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
34365 "which indicates that the guest and daemon is alive. This is what "
34366 "L</guestfs_launch> waits for."
34370 #: ../src/guestfs.pod:2376
34371 msgid "PROGRESS NOTIFICATION MESSAGES"
34375 #: ../src/guestfs.pod:2378
34377 "The daemon may send progress notification messages at any time. These are "
34378 "distinguished by the normal length word being replaced by "
34379 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
34383 #: ../src/guestfs.pod:2382
34385 "The library turns them into progress callbacks (see "
34386 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
34391 #: ../src/guestfs.pod:2386
34393 "The daemon self-limits the frequency of progress messages it sends (see "
34394 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
34399 #: ../src/guestfs.pod:2390
34400 msgid "LIBGUESTFS VERSION NUMBERS"
34404 #: ../src/guestfs.pod:2392
34406 "Since April 2010, libguestfs has started to make separate development and "
34407 "stable releases, along with corresponding branches in our git repository. "
34408 "These separate releases can be identified by version number:"
34412 #: ../src/guestfs.pod:2397
34415 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
34416 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
34422 " | `-------- sub-version\n"
34424 " `------ always '1' because we don't change the ABI\n"
34429 #: ../src/guestfs.pod:2408
34430 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
34434 #: ../src/guestfs.pod:2410
34436 "As time passes we cherry pick fixes from the development branch and backport "
34437 "those into the stable branch, the effect being that the stable branch should "
34438 "get more stable and less buggy over time. So the stable releases are ideal "
34439 "for people who don't need new features but would just like the software to "
34444 #: ../src/guestfs.pod:2416
34445 msgid "Our criteria for backporting changes are:"
34449 #: ../src/guestfs.pod:2422
34451 "Documentation changes which don't affect any code are backported unless the "
34452 "documentation refers to a future feature which is not in stable."
34456 #: ../src/guestfs.pod:2428
34458 "Bug fixes which are not controversial, fix obvious problems, and have been "
34459 "well tested are backported."
34463 #: ../src/guestfs.pod:2433
34465 "Simple rearrangements of code which shouldn't affect how it works get "
34466 "backported. This is so that the code in the two branches doesn't get too "
34467 "far out of step, allowing us to backport future fixes more easily."
34471 #: ../src/guestfs.pod:2439
34473 "We I<don't> backport new features, new APIs, new tools etc, except in one "
34474 "exceptional case: the new feature is required in order to implement an "
34475 "important bug fix."
34479 #: ../src/guestfs.pod:2445
34481 "A new stable branch starts when we think the new features in development are "
34482 "substantial and compelling enough over the current stable branch to warrant "
34483 "it. When that happens we create new stable and development versions 1.N.0 "
34484 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
34485 "stable at this point, but by backporting fixes from development, that branch "
34486 "will stabilize over time."
34490 #: ../src/guestfs.pod:2453
34491 msgid "EXTENDING LIBGUESTFS"
34495 #: ../src/guestfs.pod:2455
34496 msgid "ADDING A NEW API ACTION"
34500 #: ../src/guestfs.pod:2457
34502 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
34503 "documentation) are generated, and this makes it easy to extend the "
34508 #: ../src/guestfs.pod:2461
34509 msgid "To add a new API action there are two changes:"
34513 #: ../src/guestfs.pod:2467
34515 "You need to add a description of the call (name, parameters, return type, "
34516 "tests, documentation) to C<generator/generator_actions.ml>."
34520 #: ../src/guestfs.pod:2470
34522 "There are two sorts of API action, depending on whether the call goes "
34523 "through to the daemon in the appliance, or is serviced entirely by the "
34524 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
34525 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
34526 "an example of the latter, since a trace flag is maintained in the handle and "
34527 "all tracing is done on the library side."
34531 #: ../src/guestfs.pod:2478
34533 "Most new actions are of the first type, and get added to the "
34534 "C<daemon_functions> list. Each function has a unique procedure number used "
34535 "in the RPC protocol which is assigned to that action when we publish "
34536 "libguestfs and cannot be reused. Take the latest procedure number and "
34541 #: ../src/guestfs.pod:2484
34543 "For library-only actions of the second type, add to the "
34544 "C<non_daemon_functions> list. Since these functions are serviced by the "
34545 "library and do not travel over the RPC mechanism to the daemon, these "
34546 "functions do not need a procedure number, and so the procedure number is set "
34551 #: ../src/guestfs.pod:2492
34552 msgid "Implement the action (in C):"
34556 #: ../src/guestfs.pod:2494
34558 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
34559 "C<daemon/> directory."
34563 #: ../src/guestfs.pod:2497
34565 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
34566 "(note: double underscore) in the C<src/> directory."
34570 #: ../src/guestfs.pod:2500
34571 msgid "In either case, use another function as an example of what to do."
34575 #: ../src/guestfs.pod:2504
34576 msgid "After making these changes, use C<make> to compile."
34580 #: ../src/guestfs.pod:2506
34582 "Note that you don't need to implement the RPC, language bindings, manual "
34583 "pages or anything else. It's all automatically generated from the OCaml "
34588 #: ../src/guestfs.pod:2510
34589 msgid "ADDING TESTS FOR AN API ACTION"
34593 #: ../src/guestfs.pod:2512
34595 "You can supply zero or as many tests as you want per API call. The tests "
34596 "can either be added as part of the API description "
34597 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
34598 "drop a script into C<regressions/>. Note that adding a script to "
34599 "C<regressions/> is slower, so if possible use the first method."
34603 #: ../src/guestfs.pod:2518
34605 "The following describes the test environment used when you add an API test "
34606 "in C<generator_actions.ml>."
34610 #: ../src/guestfs.pod:2521
34611 msgid "The test environment has 4 block devices:"
34615 #: ../src/guestfs.pod:2525
34616 msgid "C</dev/sda> 500MB"
34620 #: ../src/guestfs.pod:2527
34621 msgid "General block device for testing."
34625 #: ../src/guestfs.pod:2529
34626 msgid "C</dev/sdb> 50MB"
34630 #: ../src/guestfs.pod:2531
34632 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
34637 #: ../src/guestfs.pod:2534
34638 msgid "C</dev/sdc> 10MB"
34642 #: ../src/guestfs.pod:2536
34643 msgid "Used in a few tests where two block devices are needed."
34647 #: ../src/guestfs.pod:2538
34648 msgid "C</dev/sdd>"
34652 #: ../src/guestfs.pod:2540
34653 msgid "ISO with fixed content (see C<images/test.iso>)."
34657 #: ../src/guestfs.pod:2544
34659 "To be able to run the tests in a reasonable amount of time, the libguestfs "
34660 "appliance and block devices are reused between tests. So don't try testing "
34661 "L</guestfs_kill_subprocess> :-x"
34665 #: ../src/guestfs.pod:2548
34667 "Each test starts with an initial scenario, selected using one of the "
34668 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
34669 "initialize the disks mentioned above in a particular way as documented in "
34670 "C<generator_types.ml>. You should not assume anything about the previous "
34671 "contents of other disks that are not initialized."
34675 #: ../src/guestfs.pod:2554
34677 "You can add a prerequisite clause to any individual test. This is a "
34678 "run-time check, which, if it fails, causes the test to be skipped. Useful "
34679 "if testing a command which might not work on all variations of libguestfs "
34680 "builds. A test that has prerequisite of C<Always> means to run "
34685 #: ../src/guestfs.pod:2560
34687 "In addition, packagers can skip individual tests by setting environment "
34688 "variables before running C<make check>."
34692 #: ../src/guestfs.pod:2563
34695 " SKIP_TEST_<CMD>_<NUM>=1\n"
34700 #: ../src/guestfs.pod:2565
34701 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
34705 #: ../src/guestfs.pod:2567
34710 #: ../src/guestfs.pod:2569
34713 " SKIP_TEST_<CMD>=1\n"
34718 #: ../src/guestfs.pod:2571
34719 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
34723 #: ../src/guestfs.pod:2573
34724 msgid "Packagers can run only certain tests by setting for example:"
34728 #: ../src/guestfs.pod:2575
34731 " TEST_ONLY=\"vfs_type zerofree\"\n"
34736 #: ../src/guestfs.pod:2577
34738 "See C<capitests/tests.c> for more details of how these environment variables "
34743 #: ../src/guestfs.pod:2580
34744 msgid "DEBUGGING NEW API ACTIONS"
34748 #: ../src/guestfs.pod:2582
34749 msgid "Test new actions work before submitting them."
34753 #: ../src/guestfs.pod:2584
34754 msgid "You can use guestfish to try out new commands."
34758 #: ../src/guestfs.pod:2586
34760 "Debugging the daemon is a problem because it runs inside a minimal "
34761 "environment. However you can fprintf messages in the daemon to stderr, and "
34762 "they will show up if you use C<guestfish -v>."
34766 #: ../src/guestfs.pod:2590
34767 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
34771 #: ../src/guestfs.pod:2592
34773 "Our C source code generally adheres to some basic code-formatting "
34774 "conventions. The existing code base is not totally consistent on this "
34775 "front, but we do prefer that contributed code be formatted similarly. In "
34776 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
34777 "indentation level, and other than that, follow the K&R style."
34781 #: ../src/guestfs.pod:2598
34783 "If you use Emacs, add the following to one of one of your start-up files "
34784 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
34788 #: ../src/guestfs.pod:2601
34791 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
34792 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
34793 " (add-hook 'find-file-hook\n"
34794 " '(lambda () (if (and buffer-file-name\n"
34795 " (string-match \"/libguestfs\\\\>\"\n"
34796 " (buffer-file-name))\n"
34797 " (not (string-equal mode-name \"Change Log\"))\n"
34798 " (not (string-equal mode-name \"Makefile\")))\n"
34799 " (setq indent-tabs-mode nil))))\n"
34804 #: ../src/guestfs.pod:2611
34807 " ;;; When editing C sources in libguestfs, use this style.\n"
34808 " (defun libguestfs-c-mode ()\n"
34809 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
34811 " (c-set-style \"K&R\")\n"
34812 " (setq c-indent-level 2)\n"
34813 " (setq c-basic-offset 2))\n"
34814 " (add-hook 'c-mode-hook\n"
34815 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
34816 " (buffer-file-name))\n"
34817 " (libguestfs-c-mode))))\n"
34822 #: ../src/guestfs.pod:2623
34823 msgid "Enable warnings when compiling (and fix any problems this finds):"
34827 #: ../src/guestfs.pod:2626
34830 " ./configure --enable-gcc-warnings\n"
34835 #: ../src/guestfs.pod:2628
34836 msgid "Useful targets are:"
34840 #: ../src/guestfs.pod:2630
34843 " make syntax-check # checks the syntax of the C code\n"
34844 " make check # runs the test suite\n"
34849 #: ../src/guestfs.pod:2633
34850 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
34854 #: ../src/guestfs.pod:2635
34856 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
34857 "which are used to do shell quoting."
34861 #: ../src/guestfs.pod:2640
34866 #: ../src/guestfs.pod:2642
34868 "Simple shell quoted string. Any spaces or other shell characters are "
34873 #: ../src/guestfs.pod:2645
34878 #: ../src/guestfs.pod:2647
34880 "Same as C<%Q> except the string is treated as a path which is prefixed by "
34885 #: ../src/guestfs.pod:2654
34888 " asprintf (&cmd, \"cat %R\", path);\n"
34893 #: ../src/guestfs.pod:2656
34894 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
34898 #: ../src/guestfs.pod:2658
34900 "I<Note:> Do I<not> use these when you are passing parameters to the "
34901 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
34902 "because they are not passed via the shell (instead, straight to exec). You "
34903 "probably want to use the C<sysroot_path()> function however."
34907 #: ../src/guestfs.pod:2664
34908 msgid "SUBMITTING YOUR NEW API ACTIONS"
34912 #: ../src/guestfs.pod:2666
34914 "Submit patches to the mailing list: "
34915 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
34916 "L<rjones@redhat.com>."
34920 #: ../src/guestfs.pod:2670
34921 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
34925 #: ../src/guestfs.pod:2672
34926 msgid "We support i18n (gettext anyhow) in the library."
34930 #: ../src/guestfs.pod:2674
34932 "However many messages come from the daemon, and we don't translate those at "
34933 "the moment. One reason is that the appliance generally has all locale files "
34934 "removed from it, because they take up a lot of space. So we'd have to readd "
34935 "some of those, as well as copying our PO files into the appliance."
34939 #: ../src/guestfs.pod:2680
34941 "Debugging messages are never translated, since they are intended for the "
34946 #: ../src/guestfs.pod:2683
34947 msgid "SOURCE CODE SUBDIRECTORIES"
34951 #: ../src/guestfs.pod:2689
34952 msgid "The libguestfs appliance, build scripts and so on."
34956 #: ../src/guestfs.pod:2691
34957 msgid "C<capitests>"
34961 #: ../src/guestfs.pod:2693
34962 msgid "Automated tests of the C API."
34966 #: ../src/guestfs.pod:2695
34971 #: ../src/guestfs.pod:2697
34973 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
34978 #: ../src/guestfs.pod:2700
34983 #: ../src/guestfs.pod:2702
34985 "Safety and liveness tests of components that libguestfs depends upon (not of "
34986 "libguestfs itself). Mainly this is for qemu and the kernel."
34990 #: ../src/guestfs.pod:2705
34995 #: ../src/guestfs.pod:2707
34996 msgid "Outside contributions, experimental parts."
35000 #: ../src/guestfs.pod:2709
35005 #: ../src/guestfs.pod:2711
35007 "The daemon that runs inside the libguestfs appliance and carries out "
35012 #: ../src/guestfs.pod:2714
35017 #: ../src/guestfs.pod:2716
35018 msgid "L<virt-df(1)> command and documentation."
35022 #: ../src/guestfs.pod:2718
35027 #: ../src/guestfs.pod:2720
35028 msgid "L<virt-edit(1)> command and documentation."
35032 #: ../src/guestfs.pod:2722
35033 msgid "C<examples>"
35037 #: ../src/guestfs.pod:2724
35038 msgid "C API example code."
35042 #: ../src/guestfs.pod:2726
35047 #: ../src/guestfs.pod:2728
35049 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
35050 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
35051 "L<virt-tar-out(1)>."
35055 #: ../src/guestfs.pod:2732
35060 #: ../src/guestfs.pod:2734
35061 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
35065 #: ../src/guestfs.pod:2736
35066 msgid "C<generator>"
35070 #: ../src/guestfs.pod:2738
35072 "The crucially important generator, used to automatically generate large "
35073 "amounts of boilerplate C code for things like RPC and bindings."
35077 #: ../src/guestfs.pod:2741
35082 #: ../src/guestfs.pod:2743
35083 msgid "Files used by the test suite."
35087 #: ../src/guestfs.pod:2745
35088 msgid "Some \"phony\" guest images which we test against."
35092 #: ../src/guestfs.pod:2747
35093 msgid "C<inspector>"
35097 #: ../src/guestfs.pod:2749
35098 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
35102 #: ../src/guestfs.pod:2751
35107 #: ../src/guestfs.pod:2753
35108 msgid "Logo used on the website. The fish is called Arthur by the way."
35112 #: ../src/guestfs.pod:2755
35117 #: ../src/guestfs.pod:2757
35118 msgid "M4 macros used by autoconf."
35122 #: ../src/guestfs.pod:2759
35127 #: ../src/guestfs.pod:2761
35128 msgid "Translations of simple gettext strings."
35132 #: ../src/guestfs.pod:2763
35137 #: ../src/guestfs.pod:2765
35139 "The build infrastructure and PO files for translations of manpages and POD "
35140 "files. Eventually this will be combined with the C<po> directory, but that "
35141 "is rather complicated."
35145 #: ../src/guestfs.pod:2769
35146 msgid "C<regressions>"
35150 #: ../src/guestfs.pod:2771
35151 msgid "Regression tests."
35155 #: ../src/guestfs.pod:2773
35160 #: ../src/guestfs.pod:2775
35161 msgid "L<virt-rescue(1)> command and documentation."
35165 #: ../src/guestfs.pod:2777
35170 #: ../src/guestfs.pod:2779
35171 msgid "Source code to the C library."
35175 #: ../src/guestfs.pod:2781
35180 #: ../src/guestfs.pod:2783
35181 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
35185 #: ../src/guestfs.pod:2785
35186 msgid "C<test-tool>"
35190 #: ../src/guestfs.pod:2787
35192 "Test tool for end users to test if their qemu/kernel combination will work "
35197 #: ../src/guestfs.pod:2790
35202 #: ../src/guestfs.pod:2792
35207 #: ../src/guestfs.pod:2794
35212 #: ../src/guestfs.pod:2796
35217 #: ../src/guestfs.pod:2798
35222 #: ../src/guestfs.pod:2800
35227 #: ../src/guestfs.pod:2802
35232 #: ../src/guestfs.pod:2804
35237 #: ../src/guestfs.pod:2806
35238 msgid "Language bindings."
35242 #: ../src/guestfs.pod:2810
35243 msgid "MAKING A STABLE RELEASE"
35247 #: ../src/guestfs.pod:2812
35249 "When we make a stable release, there are several steps documented here. See "
35250 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
35255 #: ../src/guestfs.pod:2820
35256 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
35260 #: ../src/guestfs.pod:2825
35261 msgid "Finalize RELEASE-NOTES."
35265 #: ../src/guestfs.pod:2829
35266 msgid "Update ROADMAP."
35270 #: ../src/guestfs.pod:2833
35271 msgid "Run C<src/api-support/update-from-tarballs.sh>."
35275 #: ../src/guestfs.pod:2837
35276 msgid "Push and pull from Transifex."
35280 #: ../src/guestfs.pod:2839
35285 #: ../src/guestfs.pod:2841
35293 #: ../src/guestfs.pod:2843
35294 msgid "to push the latest POT files to Transifex. Then run:"
35298 #: ../src/guestfs.pod:2845
35306 #: ../src/guestfs.pod:2847
35307 msgid "which is a wrapper to pull the latest translated C<*.po> files."
35311 #: ../src/guestfs.pod:2851
35313 "Create new stable and development directories under "
35314 "L<http://libguestfs.org/download>."
35318 #: ../src/guestfs.pod:2856
35319 msgid "Create the branch in git:"
35323 #: ../src/guestfs.pod:2858
35326 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
35327 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
35328 " git branch stable-1.XX\n"
35329 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
35334 #: ../src/guestfs.pod:2865
35339 #: ../src/guestfs.pod:2867
35340 msgid "PROTOCOL LIMITS"
35344 #: ../src/guestfs.pod:2869
35346 "Internally libguestfs uses a message-based protocol to pass API calls and "
35347 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
35348 "plenty more detail about this). The maximum message size used by the "
35349 "protocol is slightly less than 4 MB. For some API calls you may need to be "
35350 "aware of this limit. The API calls which may be affected are individually "
35351 "documented, with a link back to this section of the documentation."
35355 #: ../src/guestfs.pod:2877
35357 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
35358 "a simple string. Because this string is at some point internally encoded as "
35359 "a message, the maximum size that it can return is slightly under 4 MB. If "
35360 "the requested file is larger than this then you will get an error."
35364 #: ../src/guestfs.pod:2883
35366 "In order to transfer large files into and out of the guest filesystem, you "
35367 "need to use particular calls that support this. The sections L</UPLOADING> "
35368 "and L</DOWNLOADING> document how to do this."
35372 #: ../src/guestfs.pod:2887
35374 "You might also consider mounting the disk image using our FUSE filesystem "
35375 "support (L<guestmount(1)>)."
35379 #: ../src/guestfs.pod:2890
35380 msgid "MAXIMUM NUMBER OF DISKS"
35384 #: ../src/guestfs.pod:2892
35385 msgid "When using virtio disks (the default) the current limit is B<25> disks."
35389 #: ../src/guestfs.pod:2895
35391 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
35392 "slots. However febootstrap only understands disks with names C</dev/vda> "
35393 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
35398 #: ../src/guestfs.pod:2900
35400 "We are working to substantially raise this limit in future versions but it "
35401 "requires complex changes to qemu."
35405 #: ../src/guestfs.pod:2903
35407 "In future versions of libguestfs it should also be possible to \"hot plug\" "
35408 "disks (add and remove disks after calling L</guestfs_launch>). This also "
35409 "requires changes to qemu."
35413 #: ../src/guestfs.pod:2907
35414 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
35418 #: ../src/guestfs.pod:2909
35419 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
35423 #: ../src/guestfs.pod:2911
35425 "This is because it reserves 4 bits for the minor device number (thus "
35426 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
35430 #: ../src/guestfs.pod:2914
35432 "If you attach a disk with more than 15 partitions, the extra partitions are "
35433 "ignored by libguestfs."
35437 #: ../src/guestfs.pod:2917
35438 msgid "MAXIMUM SIZE OF A DISK"
35442 #: ../src/guestfs.pod:2919
35443 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
35447 #: ../src/guestfs.pod:2921
35449 "We have tested block devices up to 1 exabyte (2**60 or "
35450 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
35455 #: ../src/guestfs.pod:2925
35457 "Although libguestfs probably does not impose any limit, the underlying host "
35458 "storage will. If you store disk images on a host ext4 filesystem, then the "
35459 "maximum size will be limited by the maximum ext4 file size (currently 16 "
35460 "TB). If you store disk images as host logical volumes then you are limited "
35461 "by the maximum size of an LV."
35465 #: ../src/guestfs.pod:2931
35467 "For the hugest disk image files, we recommend using XFS on the host for "
35472 #: ../src/guestfs.pod:2934
35473 msgid "MAXIMUM SIZE OF A PARTITION"
35477 #: ../src/guestfs.pod:2936
35479 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
35480 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
35481 "address a partition located beyond 2 TB on the disk."
35485 #: ../src/guestfs.pod:2940
35487 "It is recommended that you use GPT partitions on disks which are larger than "
35488 "this size. GPT uses 64 bit sector numbers and so can address partitions "
35489 "which are theoretically larger than the largest disk we could support."
35493 #: ../src/guestfs.pod:2945
35494 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
35498 #: ../src/guestfs.pod:2947
35500 "This depends on the filesystem type. libguestfs itself does not impose any "
35501 "known limit. Consult Wikipedia or the filesystem documentation to find out "
35502 "what these limits are."
35506 #: ../src/guestfs.pod:2951
35507 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
35511 #: ../src/guestfs.pod:2953
35513 "The API functions L</guestfs_upload>, L</guestfs_download>, "
35514 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
35515 "uploads and downloads."
35519 #: ../src/guestfs.pod:2957
35520 msgid "INSPECTION LIMITS"
35524 #: ../src/guestfs.pod:2959
35526 "The inspection code has several arbitrary limits on things like the size of "
35527 "Windows Registry hive it will read, and the length of product name. These "
35528 "are intended to stop a malicious guest from consuming arbitrary amounts of "
35529 "memory and disk space on the host, and should not be reached in practice. "
35530 "See the source code for more information."
35534 #: ../src/guestfs.pod:2985
35536 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
35537 "effect as calling C<guestfs_set_verbose (g, 1)>."
35541 #: ../src/guestfs.pod:2997
35543 "Set the path that libguestfs uses to search for a supermin appliance. See "
35544 "the discussion of paths in section L</PATH> above."
35548 #: ../src/guestfs.pod:3006
35549 msgid "See also L</QEMU WRAPPERS> above."
35553 #: ../src/guestfs.pod:3010
35555 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
35556 "effect as calling C<guestfs_set_trace (g, 1)>."
35560 #: ../src/guestfs.pod:3028
35562 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
35563 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
35564 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
35565 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
35566 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
35567 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
35568 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
35569 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
35570 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
35574 #: ../src/guestfs.pod:3058
35576 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
35577 "L<lvm(8)>, L<disktype(1)>."
35581 #: ../src/guestfs.pod:3065 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
35586 #: ../src/guestfs.pod:3067
35587 msgid "To get a list of bugs against libguestfs use this link:"
35591 #: ../src/guestfs.pod:3069
35592 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
35596 #: ../src/guestfs.pod:3071
35597 msgid "To report a new bug against libguestfs use this link:"
35601 #: ../src/guestfs.pod:3073
35602 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
35606 #: ../src/guestfs.pod:3075
35607 msgid "When reporting a bug, please check:"
35611 #: ../src/guestfs.pod:3081
35612 msgid "That the bug hasn't been reported already."
35616 #: ../src/guestfs.pod:3085
35617 msgid "That you are testing a recent version."
35621 #: ../src/guestfs.pod:3089
35622 msgid "Describe the bug accurately, and give a way to reproduce it."
35626 #: ../src/guestfs.pod:3093
35628 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
35633 #: ../test-tool/libguestfs-test-tool.pod:5
35634 msgid "libguestfs-test-tool - End user tests for libguestfs"
35638 #: ../test-tool/libguestfs-test-tool.pod:9
35641 " libguestfs-test-tool [--options]\n"
35646 #: ../test-tool/libguestfs-test-tool.pod:13
35648 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
35649 "and developers, to allow them to check basic libguestfs functionality is "
35650 "working. This is needed because libguestfs occasionally breaks for reasons "
35651 "beyond our control: usually because of changes in the underlying qemu or "
35652 "kernel packages, or the host environment."
35656 #: ../test-tool/libguestfs-test-tool.pod:20
35657 msgid "If you suspect a problem in libguestfs, then just run:"
35661 #: ../test-tool/libguestfs-test-tool.pod:22
35664 " libguestfs-test-tool\n"
35669 #: ../test-tool/libguestfs-test-tool.pod:24
35670 msgid "It will print lots of diagnostic messages."
35674 #: ../test-tool/libguestfs-test-tool.pod:26
35675 msgid "If it runs to completion successfully, you will see this near the end:"
35679 #: ../test-tool/libguestfs-test-tool.pod:28
35682 " ===== TEST FINISHED OK =====\n"
35687 #: ../test-tool/libguestfs-test-tool.pod:30
35688 msgid "and the test tool will exit with code 0."
35692 #: ../test-tool/libguestfs-test-tool.pod:32
35694 "If it fails (and/or exits with non-zero error code), please paste the "
35695 "B<complete, unedited> output of the test tool into a bug report. More "
35696 "information about reporting bugs can be found on the "
35697 "L<http://libguestfs.org/> website."
35701 #: ../test-tool/libguestfs-test-tool.pod:41
35706 #: ../test-tool/libguestfs-test-tool.pod:43
35707 msgid "Display short usage information and exit."
35711 #: ../test-tool/libguestfs-test-tool.pod:45
35712 msgid "I<--qemu qemu_binary>"
35716 #: ../test-tool/libguestfs-test-tool.pod:47
35718 "If you have downloaded another qemu binary, point this option at the full "
35719 "path of the binary to try it."
35723 #: ../test-tool/libguestfs-test-tool.pod:50
35724 msgid "I<--qemudir qemu_source_dir>"
35728 #: ../test-tool/libguestfs-test-tool.pod:52
35730 "If you have compiled qemu from source, point this option at the source "
35731 "directory to try it."
35735 #: ../test-tool/libguestfs-test-tool.pod:55
35736 msgid "I<--timeout N>"
35740 #: ../test-tool/libguestfs-test-tool.pod:57
35742 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
35743 "does not usually need to be adjusted unless your machine is very slow."
35747 #: ../test-tool/libguestfs-test-tool.pod:63
35748 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
35752 #: ../test-tool/libguestfs-test-tool.pod:65
35754 "If you have compiled another version of qemu from source and would like to "
35755 "try that, then you can use the I<--qemudir> option to point to the qemu "
35756 "source directory."
35760 #: ../test-tool/libguestfs-test-tool.pod:69
35762 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
35763 "option to point to the binary."
35767 #: ../test-tool/libguestfs-test-tool.pod:72
35769 "When using an alternate qemu with libguestfs, usually you would need to "
35770 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
35771 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
35772 "when you use either of the I<--qemudir> or I<--qemu> options."
35776 #: ../test-tool/libguestfs-test-tool.pod:79
35778 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
35779 "I<1> if there was an error."
35783 #: ../test-tool/libguestfs-test-tool.pod:84
35785 "For the full list of environment variables which may affect libguestfs, "
35786 "please see the L<guestfs(3)> manual page."
35790 #: ../test-tool/libguestfs-test-tool.pod:89
35791 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
35795 #: ../tools/virt-list-filesystems.pl:32
35796 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
35800 #: ../tools/virt-list-filesystems.pl:36
35803 " virt-list-filesystems [--options] domname\n"
35808 #: ../tools/virt-list-filesystems.pl:38
35811 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
35816 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
35818 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
35823 #: ../tools/virt-list-filesystems.pl:45
35825 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
35826 "are contained in a virtual machine or disk image."
35830 #: ../tools/virt-list-filesystems.pl:49
35832 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
35833 "functionality. For more complex cases you should look at the "
35834 "L<guestfish(1)> tool."
35838 #: ../tools/virt-list-filesystems.pl:112
35840 "With this option, C<virt-list-filesystems> displays the type of each "
35841 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
35845 #: ../tools/virt-list-filesystems.pl:119
35850 #: ../tools/virt-list-filesystems.pl:123
35852 "Normally we only show mountable filesystems. If this option is given then "
35853 "swap devices are shown too."
35857 #: ../tools/virt-list-filesystems.pl:197
35859 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
35860 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
35861 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35865 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
35866 msgid "Copyright (C) 2009 Red Hat Inc."
35870 #: ../tools/virt-list-partitions.pl:32
35871 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
35875 #: ../tools/virt-list-partitions.pl:36
35878 " virt-list-partitions [--options] domname\n"
35883 #: ../tools/virt-list-partitions.pl:38
35886 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35891 #: ../tools/virt-list-partitions.pl:45
35893 "C<virt-list-partitions> is a command line tool to list the partitions that "
35894 "are contained in a virtual machine or disk image. It is mainly useful as a "
35895 "first step to using L<virt-resize(1)>."
35899 #: ../tools/virt-list-partitions.pl:50
35901 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35902 "functionality. For more complex cases you should look at the "
35903 "L<guestfish(1)> tool."
35907 #: ../tools/virt-list-partitions.pl:113
35908 msgid "Show sizes in human-readable form (eg. \"1G\")."
35912 #: ../tools/virt-list-partitions.pl:123
35914 "With this option, C<virt-list-partitions> displays the type and size of each "
35915 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35919 #: ../tools/virt-list-partitions.pl:130
35924 #: ../tools/virt-list-partitions.pl:132
35929 #: ../tools/virt-list-partitions.pl:134
35930 msgid "Display the total size of each block device (as a separate row or rows)."
35934 #: ../tools/virt-list-partitions.pl:267
35936 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
35937 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
35938 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35942 #: ../tools/virt-list-partitions.pl:283
35943 msgid "Copyright (C) 2009-2010 Red Hat Inc."
35947 #: ../tools/virt-make-fs.pl:37
35948 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
35952 #: ../tools/virt-make-fs.pl:41
35955 " virt-make-fs [--options] input.tar output.img\n"
35960 #: ../tools/virt-make-fs.pl:43
35963 " virt-make-fs [--options] input.tar.gz output.img\n"
35968 #: ../tools/virt-make-fs.pl:45
35971 " virt-make-fs [--options] directory output.img\n"
35976 #: ../tools/virt-make-fs.pl:49
35978 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
35979 "archive or some files in a directory. It is similar to tools like "
35980 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
35981 "it can create common filesystem types like ext2/3 or NTFS, which can be "
35982 "useful if you want to attach these filesystems to existing virtual machines "
35983 "(eg. to import large amounts of read-only data to a VM)."
35987 #: ../tools/virt-make-fs.pl:57
35988 msgid "Basic usage is:"
35992 #: ../tools/virt-make-fs.pl:59
35995 " virt-make-fs input output\n"
36000 #: ../tools/virt-make-fs.pl:61
36002 "where C<input> is either a directory containing files that you want to add, "
36003 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
36004 "C<output> is a disk image. The input type is detected automatically. The "
36005 "output disk image defaults to a raw ext2 image unless you specify extra "
36006 "flags (see L</OPTIONS> below)."
36010 #: ../tools/virt-make-fs.pl:67
36011 msgid "EXTRA SPACE"
36015 #: ../tools/virt-make-fs.pl:69
36017 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
36018 "the files that it contains, but might have extra space. Depending on how "
36019 "you are going to use the output, you might think this extra space is wasted "
36020 "and want to minimize it, or you might want to leave space so that more files "
36021 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
36022 "but you can use the I<--size> flag to leave space in the filesystem if you "
36027 #: ../tools/virt-make-fs.pl:77
36029 "An alternative way to leave extra space but not make the output image any "
36030 "bigger is to use an alternative disk image format (instead of the default "
36031 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
36032 "image format (check your hypervisor supports this before using it). This "
36033 "allows you to choose a large I<--size> but the extra space won't actually be "
36034 "allocated in the image until you try to store something in it."
36038 #: ../tools/virt-make-fs.pl:85
36040 "Don't forget that you can also use local commands including L<resize2fs(8)> "
36041 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
36042 "to build another image from scratch."
36046 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
36051 #: ../tools/virt-make-fs.pl:91
36054 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
36059 #: ../tools/virt-make-fs.pl:93
36060 msgid "FILESYSTEM TYPE"
36064 #: ../tools/virt-make-fs.pl:95
36066 "The default filesystem type is C<ext2>. Just about any filesystem type that "
36067 "libguestfs supports can be used (but I<not> read-only formats like "
36068 "ISO9660). Here are some of the more common choices:"
36072 #: ../tools/virt-make-fs.pl:101
36077 #: ../tools/virt-make-fs.pl:103
36079 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
36080 "you are not going to use the filesystem in a way that requires the journal, "
36081 "then this is just wasted overhead."
36085 #: ../tools/virt-make-fs.pl:107
36086 msgid "I<ntfs> or I<vfat>"
36090 #: ../tools/virt-make-fs.pl:109
36091 msgid "Useful if exporting data to a Windows guest."
36095 #: ../tools/virt-make-fs.pl:111
36097 "I<Note for vfat>: The tar archive or local directory must only contain files "
36098 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
36099 "program running within libguestfs is unable to change the ownership of "
36100 "non-root files, since vfat itself does not support this."
36104 #: ../tools/virt-make-fs.pl:116
36109 #: ../tools/virt-make-fs.pl:118
36111 "Lower overhead than C<ext2>, but certain limitations on filename length and "
36112 "total filesystem size."
36116 #: ../tools/virt-make-fs.pl:125
36119 " virt-make-fs --type=minix input minixfs.img\n"
36124 #: ../tools/virt-make-fs.pl:127
36125 msgid "TO PARTITION OR NOT TO PARTITION"
36129 #: ../tools/virt-make-fs.pl:129
36130 msgid "Optionally virt-make-fs can add a partition table to the output disk."
36134 #: ../tools/virt-make-fs.pl:131
36136 "Adding a partition can make the disk image more compatible with certain "
36137 "virtualized operating systems which don't expect to see a filesystem "
36138 "directly located on a block device (Linux doesn't care and will happily "
36139 "handle both types)."
36143 #: ../tools/virt-make-fs.pl:136
36145 "On the other hand, if you have a partition table then the output image is no "
36146 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
36147 "directly on a partitioned disk image. (However libguestfs tools such as "
36148 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
36152 #: ../tools/virt-make-fs.pl:144
36153 msgid "Add an MBR partition:"
36157 #: ../tools/virt-make-fs.pl:146
36160 " virt-make-fs --partition -- input disk.img\n"
36165 #: ../tools/virt-make-fs.pl:148
36167 "If the output disk image could be terabyte-sized or larger, it's better to "
36168 "use an EFI/GPT-compatible partition table:"
36172 #: ../tools/virt-make-fs.pl:151
36175 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
36180 #: ../tools/virt-make-fs.pl:179
36181 msgid "Enable debugging information."
36185 #: ../tools/virt-make-fs.pl:185
36186 msgid "B<--size=E<lt>NE<gt>>"
36190 #: ../tools/virt-make-fs.pl:187
36191 msgid "B<--size=+E<lt>NE<gt>>"
36195 #: ../tools/virt-make-fs.pl:189
36196 msgid "B<-s E<lt>NE<gt>>"
36200 #: ../tools/virt-make-fs.pl:191
36201 msgid "B<-s +E<lt>NE<gt>>"
36205 #: ../tools/virt-make-fs.pl:193
36206 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
36210 #: ../tools/virt-make-fs.pl:196
36212 "If this option is I<not> given, then the output image will be just large "
36213 "enough to contain all the files, with not much wasted space."
36217 #: ../tools/virt-make-fs.pl:199
36219 "To choose a fixed size output disk, specify an absolute number followed by "
36220 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36221 "Petabytes or Exabytes. This must be large enough to contain all the input "
36222 "files, else you will get an error."
36226 #: ../tools/virt-make-fs.pl:204
36228 "To leave extra space, specify C<+> (plus sign) and a number followed by "
36229 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36230 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
36231 "the input files, and (approximately) an extra 200 MB free space."
36235 #: ../tools/virt-make-fs.pl:210
36237 "Note that virt-make-fs estimates free space, and therefore will not produce "
36238 "filesystems containing precisely the free space requested. (It is much more "
36239 "expensive and time-consuming to produce a filesystem which has precisely the "
36240 "desired free space)."
36244 #: ../tools/virt-make-fs.pl:219
36245 msgid "B<--format=E<lt>fmtE<gt>>"
36249 #: ../tools/virt-make-fs.pl:221
36250 msgid "B<-F E<lt>fmtE<gt>>"
36254 #: ../tools/virt-make-fs.pl:223
36255 msgid "Choose the output disk image format."
36259 #: ../tools/virt-make-fs.pl:225
36260 msgid "The default is C<raw> (raw disk image)."
36264 #: ../tools/virt-make-fs.pl:227
36266 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
36267 "that would really make sense here is C<qcow2>."
36271 #: ../tools/virt-make-fs.pl:234
36272 msgid "B<--type=E<lt>fsE<gt>>"
36276 #: ../tools/virt-make-fs.pl:236
36277 msgid "B<-t E<lt>fsE<gt>>"
36281 #: ../tools/virt-make-fs.pl:238
36282 msgid "Choose the output filesystem type."
36286 #: ../tools/virt-make-fs.pl:240
36287 msgid "The default is C<ext2>."
36291 #: ../tools/virt-make-fs.pl:242
36292 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
36296 #: ../tools/virt-make-fs.pl:249
36297 msgid "B<--partition>"
36301 #: ../tools/virt-make-fs.pl:251
36302 msgid "B<--partition=E<lt>parttypeE<gt>>"
36306 #: ../tools/virt-make-fs.pl:253
36308 "If specified, this flag adds an MBR partition table to the output disk "
36313 #: ../tools/virt-make-fs.pl:256
36315 "You can change the partition table type, eg. I<--partition=gpt> for large "
36320 #: ../tools/virt-make-fs.pl:259
36322 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
36323 "might consider the next parameter to be the partition type. For example:"
36327 #: ../tools/virt-make-fs.pl:263
36330 " virt-make-fs --partition input.tar ...\n"
36335 #: ../tools/virt-make-fs.pl:265
36337 "would cause virt-make-fs to think you wanted to use a partition type of "
36338 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
36339 "dash) between options and the input file argument:"
36343 #: ../tools/virt-make-fs.pl:269
36346 " virt-make-fs --partition -- input.tar ...\n"
36351 #: ../tools/virt-make-fs.pl:541
36353 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
36354 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
36355 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
36359 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
36361 "When reporting bugs, please enable debugging and capture the I<complete> "
36366 #: ../tools/virt-make-fs.pl:558
36369 " export LIBGUESTFS_DEBUG=1\n"
36370 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
36375 #: ../tools/virt-make-fs.pl:561
36377 "Attach /tmp/virt-make-fs.log to a new bug report at "
36378 "L<https://bugzilla.redhat.com/>"
36382 #: ../tools/virt-tar.pl:33
36383 msgid "virt-tar - Extract or upload files to a virtual machine"
36387 #: ../tools/virt-tar.pl:37
36390 " virt-tar [--options] -x domname directory tarball\n"
36395 #: ../tools/virt-tar.pl:39
36398 " virt-tar [--options] -u domname tarball directory\n"
36403 #: ../tools/virt-tar.pl:41
36406 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
36411 #: ../tools/virt-tar.pl:43
36414 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
36419 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
36424 #: ../tools/virt-tar.pl:47
36426 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36427 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
36431 #: ../tools/virt-tar.pl:52
36432 msgid "Download C</home> from the VM into a local tarball:"
36436 #: ../tools/virt-tar.pl:54
36439 " virt-tar -x domname /home home.tar\n"
36444 #: ../tools/virt-tar.pl:56
36447 " virt-tar -zx domname /home home.tar.gz\n"
36452 #: ../tools/virt-tar.pl:58
36453 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
36457 #: ../tools/virt-tar.pl:60
36460 " virt-tar -u domname uploadstuff.tar /tmp\n"
36465 #: ../tools/virt-tar.pl:62
36468 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
36473 #: ../tools/virt-tar.pl:66
36475 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
36476 "virtual machines. If you do this, you risk disk corruption in the VM. "
36477 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
36481 #: ../tools/virt-tar.pl:71
36483 "You can use I<-x> (extract) on live virtual machines, but you might get "
36484 "inconsistent results or errors if there is filesystem activity inside the "
36485 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
36486 "work, but the only way to guarantee consistent results is if the virtual "
36487 "machine is shut down."
36491 #: ../tools/virt-tar.pl:79
36493 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
36494 "parts of a guest filesystem. There are many possibilities: making backups, "
36495 "uploading data files, snooping on guest activity, fixing or customizing "
36500 #: ../tools/virt-tar.pl:84
36502 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
36503 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
36504 "should look at the L<guestfish(1)> tool."
36508 #: ../tools/virt-tar.pl:88
36510 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
36511 "its contents (recursively) from the virtual machine into a local tarball. "
36512 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
36513 "virtual machine. You cannot use these two options together."
36517 #: ../tools/virt-tar.pl:94
36519 "In addition, you may need to use the I<-z> (gZip) option to enable "
36520 "compression. When uploading, you have to specify I<-z> if the upload file "
36521 "is compressed because virt-tar won't detect this on its own."
36525 #: ../tools/virt-tar.pl:98
36527 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
36528 "example it cannot do PKZip files or bzip2 compression. If you want that "
36529 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
36530 "the L<libguestfs(3)> API)."
36534 #: ../tools/virt-tar.pl:160
36535 msgid "B<--extract>"
36539 #: ../tools/virt-tar.pl:162
36540 msgid "B<--download>"
36544 #: ../tools/virt-tar.pl:164
36549 #: ../tools/virt-tar.pl:166
36550 msgid "B<--upload>"
36554 #: ../tools/virt-tar.pl:168
36556 "Use I<-x> to extract (download) a directory from a virtual machine to a "
36561 #: ../tools/virt-tar.pl:171
36563 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
36564 "Please read the L</WARNING> section above before using this option."
36568 #: ../tools/virt-tar.pl:175
36569 msgid "You must specify exactly one of these options."
36573 #: ../tools/virt-tar.pl:181
36578 #: ../tools/virt-tar.pl:183
36583 #: ../tools/virt-tar.pl:185
36584 msgid "Specify that the input or output tarball is gzip-compressed."
36588 #: ../tools/virt-tar.pl:298
36590 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
36591 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36592 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
36593 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36597 #: ../tools/virt-win-reg.pl:37
36599 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
36604 #: ../tools/virt-win-reg.pl:41
36607 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
36612 #: ../tools/virt-win-reg.pl:43
36615 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
36620 #: ../tools/virt-win-reg.pl:45
36623 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
36628 #: ../tools/virt-win-reg.pl:47
36631 " virt-win-reg --merge domname [input.reg ...]\n"
36636 #: ../tools/virt-win-reg.pl:49
36639 " virt-win-reg [--options] disk.img ... # instead of domname\n"
36644 #: ../tools/virt-win-reg.pl:53
36646 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
36647 "virtual machines. If you do this, you I<will> get irreversible disk "
36648 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
36649 "but doesn't catch all cases."
36653 #: ../tools/virt-win-reg.pl:58
36655 "Modifying the Windows Registry is an inherently risky operation. The format "
36656 "is deliberately obscure and undocumented, and Registry changes can leave the "
36657 "system unbootable. Therefore when using the I<--merge> option, make sure "
36658 "you have a reliable backup first."
36662 #: ../tools/virt-win-reg.pl:65
36664 "This program can export and merge Windows Registry entries from a Windows "
36669 #: ../tools/virt-win-reg.pl:68
36671 "The first parameter is the libvirt guest name or the raw disk image of a "
36676 #: ../tools/virt-win-reg.pl:71
36678 "If I<--merge> is I<not> specified, then the chosen registry key is "
36679 "displayed/exported (recursively). For example:"
36683 #: ../tools/virt-win-reg.pl:74
36686 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
36691 #: ../tools/virt-win-reg.pl:76
36692 msgid "You can also display single values from within registry keys, for example:"
36696 #: ../tools/virt-win-reg.pl:79
36699 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
36700 " $ virt-win-reg Windows7 $cvkey ProductName\n"
36701 " Windows 7 Enterprise\n"
36706 #: ../tools/virt-win-reg.pl:83
36708 "With I<--merge>, you can merge a textual regedit file into the Windows "
36713 #: ../tools/virt-win-reg.pl:86
36716 " $ virt-win-reg --merge Windows7 changes.reg\n"
36721 #: ../tools/virt-win-reg.pl:90
36723 "This program is only meant for simple access to the registry. If you want "
36724 "to do complicated things with the registry, we suggest you download the "
36725 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
36726 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
36727 "L<hivexregedit(1)>."
36731 #: ../tools/virt-win-reg.pl:159
36736 #: ../tools/virt-win-reg.pl:161
36738 "In merge mode, this merges a textual regedit file into the Windows Registry "
36739 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
36740 "displays or exports Registry entries instead."
36744 #: ../tools/virt-win-reg.pl:165
36746 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
36747 "result in disk corruption. However exporting (without this flag) is always "
36752 #: ../tools/virt-win-reg.pl:173
36753 msgid "B<--encoding> UTF-16LE|ASCII"
36757 #: ../tools/virt-win-reg.pl:175
36759 "When merging (only), you may need to specify the encoding for strings to be "
36760 "used in the hive file. This is explained in detail in "
36761 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
36765 #: ../tools/virt-win-reg.pl:179
36767 "The default is to use UTF-16LE, which should work with recent versions of "
36772 #: ../tools/virt-win-reg.pl:186
36773 msgid "B<--unsafe-printable-strings>"
36777 #: ../tools/virt-win-reg.pl:188
36779 "When exporting (only), assume strings are UTF-16LE and print them as strings "
36780 "instead of hex sequences. Remove the final zero codepoint from strings if "
36785 #: ../tools/virt-win-reg.pl:192
36787 "This is unsafe and does not preserve the fidelity of strings in the original "
36788 "Registry for various reasons:"
36792 #: ../tools/virt-win-reg.pl:199
36794 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
36795 "other encodings will be corrupted by this transformation."
36799 #: ../tools/virt-win-reg.pl:204
36801 "Assumes that everything which has type 1 or 2 is really a string and that "
36802 "everything else is not a string, but the type field in real Registries is "
36807 #: ../tools/virt-win-reg.pl:210
36809 "Loses information about whether a zero codepoint followed the string in the "
36814 #: ../tools/virt-win-reg.pl:215
36816 "This all happens because the Registry itself contains no information about "
36817 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
36821 #: ../tools/virt-win-reg.pl:219
36823 "You should only use this option for quick hacking and debugging of the "
36824 "Registry contents, and I<never> use it if the output is going to be passed "
36825 "into another program or stored in another Registry."
36829 #: ../tools/virt-win-reg.pl:556
36830 msgid "SUPPORTED SYSTEMS"
36834 #: ../tools/virt-win-reg.pl:558
36836 "The program currently supports Windows NT-derived guests starting with "
36837 "Windows XP through to at least Windows 7."
36841 #: ../tools/virt-win-reg.pl:561
36842 msgid "The following Registry keys are supported:"
36846 #: ../tools/virt-win-reg.pl:565
36847 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
36851 #: ../tools/virt-win-reg.pl:567
36852 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
36856 #: ../tools/virt-win-reg.pl:569
36857 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
36861 #: ../tools/virt-win-reg.pl:571
36862 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
36866 #: ../tools/virt-win-reg.pl:573
36867 msgid "C<HKEY_USERS\\.DEFAULT>"
36871 #: ../tools/virt-win-reg.pl:575
36872 msgid "C<HKEY_USERS\\I<SID>>"
36876 #: ../tools/virt-win-reg.pl:577
36877 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
36881 #: ../tools/virt-win-reg.pl:579
36882 msgid "C<HKEY_USERS\\I<username>>"
36886 #: ../tools/virt-win-reg.pl:581
36887 msgid "where I<username> is a local user name (this is a libguestfs extension)."
36891 #: ../tools/virt-win-reg.pl:585
36893 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
36898 #: ../tools/virt-win-reg.pl:588
36900 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
36901 "supported (there is no \"current user\")."
36905 #: ../tools/virt-win-reg.pl:591
36910 #: ../tools/virt-win-reg.pl:593
36912 "C<virt-win-reg> expects that regedit files have already been reencoded in "
36913 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
36914 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
36915 "with Windows-style line endings, you may need to reencode the whole file "
36916 "before or after processing."
36920 #: ../tools/virt-win-reg.pl:599
36922 "To reencode a file from Windows format to Linux (before processing it with "
36923 "the I<--merge> option), you would do something like this:"
36927 #: ../tools/virt-win-reg.pl:602
36930 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
36935 #: ../tools/virt-win-reg.pl:604
36937 "To go in the opposite direction, after exporting and before sending the file "
36938 "to a Windows user, do something like this:"
36942 #: ../tools/virt-win-reg.pl:607
36945 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
36950 #: ../tools/virt-win-reg.pl:609
36951 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
36955 #: ../tools/virt-win-reg.pl:611
36957 "If you are unsure about the current encoding, use the L<file(1)> command. "
36958 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
36959 "Windows-style (CRLF) line endings, like this:"
36963 #: ../tools/virt-win-reg.pl:615
36966 " $ file software.reg\n"
36967 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
36968 " with CRLF line terminators\n"
36973 #: ../tools/virt-win-reg.pl:619
36974 msgid "This file would need conversion before you could I<--merge> it."
36978 #: ../tools/virt-win-reg.pl:621
36979 msgid "CurrentControlSet etc."
36983 #: ../tools/virt-win-reg.pl:623
36985 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
36986 "Registry at the level of the hive file, and therefore you cannot modify "
36991 #: ../tools/virt-win-reg.pl:627
36993 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
36994 "circumstances it might refer to another control set. The way to find out is "
36995 "to look at the C<HKLM\\SYSTEM\\Select> key:"
36999 #: ../tools/virt-win-reg.pl:631
37002 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
37003 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
37004 " \"Current\"=dword:00000001\n"
37005 " \"Default\"=dword:00000001\n"
37006 " \"Failed\"=dword:00000000\n"
37007 " \"LastKnownGood\"=dword:00000002\n"
37012 #: ../tools/virt-win-reg.pl:638
37013 msgid "\"Current\" is the one which Windows will choose when it boots."
37017 #: ../tools/virt-win-reg.pl:640
37018 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
37022 #: ../tools/virt-win-reg.pl:643
37023 msgid "WINDOWS TIPS"
37027 #: ../tools/virt-win-reg.pl:645
37029 "Note that some of these tips modify the guest disk image. The guest I<must> "
37030 "be shut off, else you will get disk corruption."
37034 #: ../tools/virt-win-reg.pl:648
37035 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
37039 #: ../tools/virt-win-reg.pl:650
37041 "Prepare a DOS batch script, VBScript or executable. Upload this using "
37042 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
37043 "is uploaded into C<C:\\>:"
37047 #: ../tools/virt-win-reg.pl:654
37050 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
37055 #: ../tools/virt-win-reg.pl:656
37056 msgid "Prepare a regedit file containing the registry change:"
37060 #: ../tools/virt-win-reg.pl:658
37063 " cat > test.reg <<'EOF'\n"
37064 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
37065 " \"Test\"=\"c:\\\\test.bat\"\n"
37071 #: ../tools/virt-win-reg.pl:663
37073 "In this example we use the key C<RunOnce> which means that the script will "
37074 "run precisely once when the first user logs in. If you want it to run every "
37075 "time a user logs in, replace C<RunOnce> with C<Run>."
37079 #: ../tools/virt-win-reg.pl:667
37080 msgid "Now update the registry:"
37084 #: ../tools/virt-win-reg.pl:669
37087 " virt-win-reg --merge WindowsGuest test.reg\n"
37092 #: ../tools/virt-win-reg.pl:671
37093 msgid "INSTALLING A SERVICE"
37097 #: ../tools/virt-win-reg.pl:673
37099 "This section assumes you are familiar with Windows services, and you either "
37100 "have a program which handles the Windows Service Control Protocol directly "
37101 "or you want to run any program using a service wrapper like SrvAny or the "
37106 #: ../tools/virt-win-reg.pl:678
37108 "First upload the program and optionally the service wrapper. In this case "
37109 "the test program is called C<test.exe> and we are using the RHSrvAny "
37114 #: ../tools/virt-win-reg.pl:682
37117 " guestfish -i -d WindowsGuest <<EOF\n"
37118 " upload rhsrvany.exe /rhsrvany.exe\n"
37119 " upload test.exe /test.exe\n"
37125 #: ../tools/virt-win-reg.pl:687
37127 "Prepare a regedit file containing the registry changes. In this example, "
37128 "the first registry change is needed for the service itself or the service "
37129 "wrapper (if used). The second registry change is only needed because I am "
37130 "using the RHSrvAny service wrapper."
37134 #: ../tools/virt-win-reg.pl:692
37137 " cat > service.reg <<'EOF'\n"
37138 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
37139 " \"Type\"=dword:00000010\n"
37140 " \"Start\"=dword:00000002\n"
37141 " \"ErrorControl\"=dword:00000001\n"
37142 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
37143 " \"DisplayName\"=\"RHSrvAny\"\n"
37144 " \"ObjectName\"=\"NetworkService\"\n"
37149 #: ../tools/virt-win-reg.pl:701
37152 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
37153 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
37154 " \"PWD\"=\"c:\\\\Temp\"\n"
37160 #: ../tools/virt-win-reg.pl:712
37162 "For use of C<ControlSet001> see the section above in this manual page. You "
37163 "may need to adjust this according to the control set that is in use by the "
37168 #: ../tools/virt-win-reg.pl:718
37170 "C<\"ObjectName\"> controls the privileges that the service will have. An "
37171 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
37172 "privileged account."
37176 #: ../tools/virt-win-reg.pl:724
37178 "For the meaning of the magic numbers, see this Microsoft KB article: "
37179 "L<http://support.microsoft.com/kb/103000>."
37183 #: ../tools/virt-win-reg.pl:729
37184 msgid "Update the registry:"
37188 #: ../tools/virt-win-reg.pl:731
37191 " virt-win-reg --merge WindowsGuest service.reg\n"
37196 #: ../tools/virt-win-reg.pl:735
37198 "Be careful when passing parameters containing C<\\> (backslash) in the "
37199 "shell. Usually you will have to use 'single quotes' or double backslashes "
37200 "(but not both) to protect them from the shell."
37204 #: ../tools/virt-win-reg.pl:739
37205 msgid "Paths and value names are case-insensitive."
37209 #: ../tools/virt-win-reg.pl:748
37211 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
37212 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
37213 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
37214 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37218 #: ../tools/virt-win-reg.pl:766
37221 " export LIBGUESTFS_DEBUG=1\n"
37222 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
37227 #: ../tools/virt-win-reg.pl:769
37229 "Attach /tmp/virt-win-reg.log to a new bug report at "
37230 "L<https://bugzilla.redhat.com/>"