1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.13.13\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-09-21 15:11+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3 ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3 ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31 ../tools/virt-win-reg.pl:35
26 #: ../cat/virt-cat.pod:5
27 msgid "virt-cat - Display files in a virtual machine"
31 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7 ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7 ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35 ../tools/virt-win-reg.pl:39
36 #: ../cat/virt-cat.pod:9
39 " virt-cat [--options] -d domname file [file ...]\n"
44 #: ../cat/virt-cat.pod:11
47 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
52 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 ../inspector/virt-inspector.pod:13
57 #: ../cat/virt-cat.pod:15
60 " virt-cat domname file\n"
65 #: ../cat/virt-cat.pod:17
68 " virt-cat disk.img file\n"
73 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27 ../erlang/examples/guestfs-erlang.pod:16 ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18 ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19 ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21 ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15 ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18 ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29 ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15 ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77 ../tools/virt-win-reg.pl:63
78 #: ../cat/virt-cat.pod:21
80 "C<virt-cat> is a command line tool to display the contents of C<file> where "
81 "C<file> exists in the named virtual machine (or disk image)."
85 #: ../cat/virt-cat.pod:24
87 "Multiple filenames can be given, in which case they are concatenated "
88 "together. Each filename must be a full path, starting at the root directory "
89 "(starting with '/')."
93 #: ../cat/virt-cat.pod:28
95 "C<virt-cat> can be used to quickly view a file. To edit a file, use "
96 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
97 "tool (see L</USING GUESTFISH> below)."
101 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43 ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41 ../fish/guestfish.pod:1018 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
106 #: ../cat/virt-cat.pod:34
107 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
111 #: ../cat/virt-cat.pod:37
114 " virt-cat -d mydomain /etc/fstab\n"
119 #: ../cat/virt-cat.pod:39
120 msgid "List syslog messages from a VM disk image file:"
124 #: ../cat/virt-cat.pod:41
127 " virt-cat -a disk.img /var/log/messages | tail\n"
132 #: ../cat/virt-cat.pod:43
133 msgid "Find out what DHCP IP address a VM acquired:"
137 #: ../cat/virt-cat.pod:45
140 " virt-cat -d mydomain /var/log/messages | \\\n"
141 " grep 'dhclient: bound to' | tail\n"
146 #: ../cat/virt-cat.pod:48
147 msgid "Find out what packages were recently installed:"
151 #: ../cat/virt-cat.pod:50
154 " virt-cat -d mydomain /var/log/yum.log | tail\n"
159 #: ../cat/virt-cat.pod:52
160 msgid "Find out who is logged on inside a virtual machine:"
164 #: ../cat/virt-cat.pod:54
167 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
173 #: ../cat/virt-cat.pod:57
174 msgid "or who was logged on:"
178 #: ../cat/virt-cat.pod:59
181 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
182 " last -f /tmp/wtmp\n"
187 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:36 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
192 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245 ../test-tool/libguestfs-test-tool.pod:40 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
197 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
198 msgid "Display brief help."
202 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
207 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
208 msgid "B<--add> file"
212 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
214 "Add I<file> which should be a disk image from a virtual machine. If the "
215 "virtual machine has multiple block devices, you must supply all of them with "
216 "separate I<-a> options."
220 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
222 "The format of the disk image is auto-detected. To override this and force a "
223 "particular format use the I<--format=..> option."
227 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
232 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
233 msgid "B<--connect> URI"
237 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
239 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
240 "to the default libvirt hypervisor."
244 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
246 "If you specify guest block devices directly (I<-a>), then libvirt is not "
251 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
256 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
257 msgid "B<--domain> guest"
261 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
263 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
268 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
269 msgid "B<--echo-keys>"
273 #: ../cat/virt-cat.pod:100
275 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
276 "so you cannot see what you are typing. If you are not worried about Tempest "
277 "attacks and there is no one else in the room you can specify this flag to "
278 "see what you are typing."
282 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
283 msgid "B<--format=raw|qcow2|..>"
287 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
292 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137 ../rescue/virt-rescue.pod:128
294 "The default for the I<-a> option is to auto-detect the format of the disk "
295 "image. Using this forces the disk format for I<-a> options which follow on "
296 "the command line. Using I<--format> with no argument switches back to "
297 "auto-detection for subsequent I<-a> options."
301 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:336 ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2765
306 #: ../cat/virt-cat.pod:116
309 " virt-cat --format=raw -a disk.img file\n"
314 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
315 msgid "forces raw format (no auto-detection) for C<disk.img>."
319 #: ../cat/virt-cat.pod:120
322 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
327 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
329 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
330 "auto-detection for C<another.img>."
334 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
336 "If you have untrusted raw-format guest disk images, you should use this "
337 "option to specify the disk format. This avoids a possible security problem "
338 "with malicious guests (CVE-2010-3851)."
342 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
343 msgid "B<--keys-from-stdin>"
347 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
349 "Read key or passphrase parameters from stdin. The default is to try to read "
350 "passphrases from the user by opening C</dev/tty>."
354 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:178
359 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:180
364 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:182
365 msgid "Enable verbose messages for debugging."
369 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184 ../resize/virt-resize.pod:484
374 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186 ../resize/virt-resize.pod:486 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
379 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:488 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
380 msgid "Display version number and exit."
384 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:199 ../tools/virt-tar.pl:158
389 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:201
390 msgid "Enable tracing of libguestfs API calls."
394 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:205
395 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
399 #: ../cat/virt-cat.pod:154
400 msgid "Previous versions of virt-cat allowed you to write either:"
404 #: ../cat/virt-cat.pod:156
407 " virt-cat disk.img [disk.img ...] file\n"
412 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:211
417 #: ../cat/virt-cat.pod:160
420 " virt-cat guestname file\n"
425 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:215
427 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
428 "the confusing case where a disk image might have the same name as a guest."
432 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:219
433 msgid "For compatibility the old style is still supported."
437 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
438 msgid "USING GUESTFISH"
442 #: ../cat/virt-cat.pod:170
444 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
445 "C<virt-cat> doesn't work."
449 #: ../cat/virt-cat.pod:173
450 msgid "Using C<virt-cat> is approximately equivalent to doing:"
454 #: ../cat/virt-cat.pod:175
457 " guestfish --ro -i -d domname download file -\n"
462 #: ../cat/virt-cat.pod:177
464 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
465 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
469 #: ../cat/virt-cat.pod:181
471 "The command above uses libguestfs's guest inspection feature and so does not "
472 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
473 "disk images that don't contain guests. To display a file from a disk image "
478 #: ../cat/virt-cat.pod:186
481 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
486 #: ../cat/virt-cat.pod:188
488 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
489 "the disk image, and C<file> is the full path to the file."
493 #: ../cat/virt-cat.pod:191 ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:262 ../resize/virt-resize.pod:601 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
494 msgid "SHELL QUOTING"
498 #: ../cat/virt-cat.pod:193 ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:264 ../resize/virt-resize.pod:603 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
500 "Libvirt guest names can contain arbitrary characters, some of which have "
501 "meaning to the shell such as C<#> and space. You may need to quote or "
502 "escape these characters on the command line. See the shell manual page "
503 "L<sh(1)> for details."
507 #: ../cat/virt-cat.pod:198 ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:608 ../test-tool/libguestfs-test-tool.pod:90
512 #: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377 ../resize/virt-resize.pod:610
513 msgid "This program returns 0 if successful, or non-zero if there was an error."
517 #: ../cat/virt-cat.pod:203 ../cat/virt-filesystems.pod:377 ../cat/virt-ls.pod:495 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:308 ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284 ../resize/virt-resize.pod:613 ../ruby/examples/guestfs-ruby.pod:36 ../src/guestfs.pod:3141 ../test-tool/libguestfs-test-tool.pod:100 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:746
522 #: ../cat/virt-cat.pod:205
524 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
525 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
529 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:388 ../cat/virt-ls.pod:507 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:634 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:772
534 #: ../cat/virt-cat.pod:214 ../cat/virt-filesystems.pod:390 ../cat/virt-ls.pod:509 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:294 ../resize/virt-resize.pod:636 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
535 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
539 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:392 ../cat/virt-ls.pod:511 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114 ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401 ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:323 ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56 ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:638 ../ruby/examples/guestfs-ruby.pod:52 ../src/guestfs.pod:3218 ../test-tool/libguestfs-test-tool.pod:110 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:776
544 #: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405 ../resize/virt-resize.pod:640
545 msgid "Copyright (C) 2010-2011 Red Hat Inc."
549 #: ../cat/virt-cat.pod:220 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:642 ../test-tool/libguestfs-test-tool.pod:115 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:780
551 "This program is free software; you can redistribute it and/or modify it "
552 "under the terms of the GNU General Public License as published by the Free "
553 "Software Foundation; either version 2 of the License, or (at your option) "
558 #: ../cat/virt-cat.pod:225 ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:333 ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:647 ../test-tool/libguestfs-test-tool.pod:120 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:785
560 "This program is distributed in the hope that it will be useful, but WITHOUT "
561 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
562 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
567 #: ../cat/virt-cat.pod:230 ../cat/virt-filesystems.pod:406 ../cat/virt-ls.pod:525 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:338 ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:652 ../test-tool/libguestfs-test-tool.pod:125 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:790
569 "You should have received a copy of the GNU General Public License along with "
570 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
571 "Ave, Cambridge, MA 02139, USA."
575 #: ../cat/virt-filesystems.pod:5
577 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
578 "virtual machine or disk image"
582 #: ../cat/virt-filesystems.pod:9
585 " virt-filesystems [--options] -d domname\n"
590 #: ../cat/virt-filesystems.pod:11
593 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
598 #: ../cat/virt-filesystems.pod:15
600 "This tool allows you to discover filesystems, partitions, logical volumes, "
601 "and their sizes in a disk image or virtual machine. It is a replacement for "
602 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
606 #: ../cat/virt-filesystems.pod:20
608 "One use for this tool is from shell scripts to iterate over all filesystems "
613 #: ../cat/virt-filesystems.pod:23
616 " for fs in $(virt-filesystems -a disk.img); do\n"
623 #: ../cat/virt-filesystems.pod:27
625 "Another use is to list partitions before using another tool to modify those "
626 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
627 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
631 #: ../cat/virt-filesystems.pod:32
633 "Various command line options control what this program displays. You need "
634 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
635 "guest respectively. If you just specify that then the program shows "
636 "filesystems found, one per line, like this:"
640 #: ../cat/virt-filesystems.pod:37
643 " $ virt-filesystems -a disk.img\n"
645 " /dev/vg_guest/lv_root\n"
650 #: ../cat/virt-filesystems.pod:41
651 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
655 #: ../cat/virt-filesystems.pod:44
658 " $ virt-filesystems -a disk.img -l\n"
659 " Name Type VFS Label Size\n"
660 " /dev/sda1 filesystem ext4 boot 524288000\n"
661 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
666 #: ../cat/virt-filesystems.pod:49
668 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
673 #: ../cat/virt-filesystems.pod:52
676 " $ virt-filesystems -a disk.img --extra\n"
678 " /dev/vg_guest/lv_root\n"
679 " /dev/vg_guest/lv_swap\n"
680 " /dev/vg_guest/lv_data\n"
685 #: ../cat/virt-filesystems.pod:58
686 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
690 #: ../cat/virt-filesystems.pod:60
693 " $ virt-filesystems -a disk.img --partitions\n"
700 #: ../cat/virt-filesystems.pod:64
702 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
703 "I<--physical-volumes>, I<--block-devices> to list those items."
707 #: ../cat/virt-filesystems.pod:67
709 "You can use these options in combination as well (if you want a combination "
710 "including filesystems, you have to add I<--filesystems>). Notice that some "
711 "items fall into several categories (eg. C</dev/sda1> might be both a "
712 "partition and a filesystem). These items are listed several times. To get "
713 "a list which includes absolutely everything that virt-filesystems knows "
714 "about, use the I<--all> option."
718 #: ../cat/virt-filesystems.pod:74
720 "UUIDs (because they are quite long) are not shown by default. Add the "
721 "I<--uuid> option to display device and filesystem UUIDs in the long output."
725 #: ../cat/virt-filesystems.pod:78
727 "I<--all --long --uuid> is a useful combination to display all possible "
728 "information about everything."
732 #: ../cat/virt-filesystems.pod:81
735 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
736 " Name Type VFS Label Size Parent UUID\n"
737 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
738 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
739 " /dev/sda1 partition - - 100M /dev/sda -\n"
740 " /dev/sda2 partition - - 20G /dev/sda -\n"
741 " /dev/sda device - - 20G - -\n"
746 #: ../cat/virt-filesystems.pod:89
747 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
751 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
756 #: ../cat/virt-filesystems.pod:112
758 "Display everything. This is currently the same as specifying these options: "
759 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
760 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may "
761 "be added to this list in future)."
765 #: ../cat/virt-filesystems.pod:117
766 msgid "See also I<--long>."
770 #: ../cat/virt-filesystems.pod:119
775 #: ../cat/virt-filesystems.pod:121
776 msgid "B<--block-devices>"
780 #: ../cat/virt-filesystems.pod:123
781 msgid "Display block devices."
785 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
790 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
792 "Write out the results in CSV format (comma-separated values). This format "
793 "can be imported easily into databases and spreadsheets, but read L</NOTE "
794 "ABOUT CSV FORMAT> below."
798 #: ../cat/virt-filesystems.pod:150
800 "When prompting for keys and passphrases, virt-filesystems normally turns "
801 "echoing off so you cannot see what you are typing. If you are not worried "
802 "about Tempest attacks and there is no one else in the room you can specify "
803 "this flag to see what you are typing."
807 #: ../cat/virt-filesystems.pod:155
812 #: ../cat/virt-filesystems.pod:157
814 "This causes filesystems that are not ordinary, mountable filesystems to be "
815 "displayed. This category includes swapspace, and filesystems that are empty "
816 "or contain unknown data."
820 #: ../cat/virt-filesystems.pod:161
821 msgid "This option implies I<--filesystems>."
825 #: ../cat/virt-filesystems.pod:163
826 msgid "B<--filesystems>"
830 #: ../cat/virt-filesystems.pod:165
832 "Display mountable filesystems. If no display option was selected then this "
837 #: ../cat/virt-filesystems.pod:168
838 msgid "With I<--extra>, non-mountable filesystems are shown too."
842 #: ../cat/virt-filesystems.pod:181
845 " virt-filesystems --format=raw -a disk.img\n"
850 #: ../cat/virt-filesystems.pod:185
853 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
858 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
863 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
864 msgid "B<--human-readable>"
868 #: ../cat/virt-filesystems.pod:198
869 msgid "In I<--long> mode, display sizes in human-readable format."
873 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
878 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
883 #: ../cat/virt-filesystems.pod:209
884 msgid "Display extra columns of data (\"long format\")."
888 #: ../cat/virt-filesystems.pod:211
889 msgid "A title row is added unless you also specify I<--no-title>."
893 #: ../cat/virt-filesystems.pod:213
895 "The extra columns displayed depend on what output you select, and the "
896 "ordering of columns may change in future versions. Use the title row, "
897 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
902 #: ../cat/virt-filesystems.pod:218
904 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
905 "default is to show raw numbers of I<bytes>."
909 #: ../cat/virt-filesystems.pod:221
910 msgid "Use I<--uuid> to display UUIDs too."
914 #: ../cat/virt-filesystems.pod:223
919 #: ../cat/virt-filesystems.pod:225
924 #: ../cat/virt-filesystems.pod:227
925 msgid "B<--logical-volumes>"
929 #: ../cat/virt-filesystems.pod:229
931 "Display LVM logical volumes. In this mode, these are displayed irrespective "
932 "of whether the LVs contain filesystems."
936 #: ../cat/virt-filesystems.pod:232
937 msgid "B<--no-title>"
941 #: ../cat/virt-filesystems.pod:234
942 msgid "In I<--long> mode, don't add a title row."
946 #: ../cat/virt-filesystems.pod:236
948 "Note that the order of the columns is not fixed, and may change in future "
949 "versions of virt-filesystems, so using this option may give you unexpected "
954 #: ../cat/virt-filesystems.pod:240
959 #: ../cat/virt-filesystems.pod:242
960 msgid "B<--partitions>"
964 #: ../cat/virt-filesystems.pod:244
966 "Display partitions. In this mode, these are displayed irrespective of "
967 "whether the partitions contain filesystems."
971 #: ../cat/virt-filesystems.pod:247
976 #: ../cat/virt-filesystems.pod:249
977 msgid "B<--physvols>"
981 #: ../cat/virt-filesystems.pod:251
982 msgid "B<--physical-volumes>"
986 #: ../cat/virt-filesystems.pod:253
987 msgid "Display LVM physical volumes."
991 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
996 #: ../cat/virt-filesystems.pod:257
1001 #: ../cat/virt-filesystems.pod:259
1002 msgid "In I<--long> mode, display UUIDs as well."
1006 #: ../cat/virt-filesystems.pod:273
1011 #: ../cat/virt-filesystems.pod:275
1012 msgid "B<--volgroups>"
1016 #: ../cat/virt-filesystems.pod:277
1017 msgid "B<--volume-groups>"
1021 #: ../cat/virt-filesystems.pod:279
1022 msgid "Display LVM volume groups."
1026 #: ../cat/virt-filesystems.pod:287
1031 #: ../cat/virt-filesystems.pod:289
1033 "Note that columns in the output are subject to reordering and change in "
1034 "future versions of this tool."
1038 #: ../cat/virt-filesystems.pod:294
1043 #: ../cat/virt-filesystems.pod:296
1044 msgid "The filesystem, partition, block device or LVM name."
1048 #: ../cat/virt-filesystems.pod:298
1050 "For device and partition names these are displayed as canonical libguestfs "
1051 "names, so that for example C</dev/sda2> is the second partition on the first "
1056 #: ../cat/virt-filesystems.pod:302
1058 "If the I<--long> option is B<not> specified, then only the name column is "
1059 "shown in the output."
1063 #: ../cat/virt-filesystems.pod:305
1068 #: ../cat/virt-filesystems.pod:307
1069 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1073 #: ../cat/virt-filesystems.pod:309
1078 #: ../cat/virt-filesystems.pod:311
1080 "If there is a filesystem, then this column displays the filesystem type if "
1081 "one could be detected, eg. C<ext4>."
1085 #: ../cat/virt-filesystems.pod:314
1090 #: ../cat/virt-filesystems.pod:316
1092 "If the object has a label (used for identifying and mounting filesystems) "
1093 "then this column contains the label."
1097 #: ../cat/virt-filesystems.pod:319
1102 #: ../cat/virt-filesystems.pod:321
1104 "The size of the object in bytes. If the I<--human> option is used then the "
1105 "size is displayed in a human-readable form."
1109 #: ../cat/virt-filesystems.pod:324
1114 #: ../cat/virt-filesystems.pod:326
1116 "The parent column records the parent relationship between objects. For "
1117 "example, if the object is a partition, then this column contains the name of "
1118 "the containing device. If the object is a logical volume, then this column "
1119 "is the name of the volume group."
1123 #: ../cat/virt-filesystems.pod:331
1128 #: ../cat/virt-filesystems.pod:333
1130 "If the object has a UUID (used for identifying and mounting filesystems and "
1131 "block devices) then this column contains the UUID as a string."
1135 #: ../cat/virt-filesystems.pod:337
1136 msgid "The UUID is only displayed if the I<--uuid> option is given."
1140 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1141 msgid "NOTE ABOUT CSV FORMAT"
1145 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1147 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1148 "should be easy to parse, but it is definitely not easy to parse."
1152 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1154 "Myth: Just split fields at commas. Reality: This does I<not> work "
1155 "reliably. This example has two columns:"
1159 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1162 " \"foo,bar\",baz\n"
1167 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1169 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1170 "reliably. This example has one row:"
1174 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1183 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1185 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1186 "packaged in major Linux distributions)."
1190 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1192 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1193 "or Python's built-in csv library)."
1197 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1198 msgid "Most spreadsheets and databases can import CSV directly."
1202 #: ../cat/virt-filesystems.pod:379
1204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1205 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1206 "L<http://libguestfs.org/>."
1210 #: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
1211 msgid "Copyright (C) 2010 Red Hat Inc."
1215 #: ../cat/virt-ls.pod:5
1216 msgid "virt-ls - List files in a virtual machine"
1220 #: ../cat/virt-ls.pod:9
1223 " virt-ls [--options] -d domname directory [directory ...]\n"
1228 #: ../cat/virt-ls.pod:11
1231 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1237 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1242 #: ../cat/virt-ls.pod:15
1245 " virt-ls [--options] domname directory\n"
1250 #: ../cat/virt-ls.pod:17
1253 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1258 #: ../cat/virt-ls.pod:21
1260 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1261 "more from a virtual machine or disk image."
1265 #: ../cat/virt-ls.pod:24
1267 "Multiple directory names can be given, in which case the output from each is "
1272 #: ../cat/virt-ls.pod:27
1274 "To list directories from a libvirt guest use the I<-d> option to specify the "
1275 "name of the guest. For a disk image, use the I<-a> option."
1279 #: ../cat/virt-ls.pod:31
1281 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1282 "may need to use L<guestfish(1)>, or write a program directly to the "
1283 "L<guestfs(3)> API."
1287 #: ../cat/virt-ls.pod:37
1288 msgid "Get a list of all files and directories in a virtual machine:"
1292 #: ../cat/virt-ls.pod:39
1295 " virt-ls -R -d guest /\n"
1300 #: ../cat/virt-ls.pod:41
1301 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1305 #: ../cat/virt-ls.pod:43
1308 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1313 #: ../cat/virt-ls.pod:45
1314 msgid "List all public-writable directories in a Linux virtual machine:"
1318 #: ../cat/virt-ls.pod:47
1321 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1326 #: ../cat/virt-ls.pod:49
1327 msgid "List all Unix domain sockets in a Linux virtual machine:"
1331 #: ../cat/virt-ls.pod:51
1334 " virt-ls -lR -d guest / | grep '^s'\n"
1339 #: ../cat/virt-ls.pod:53
1340 msgid "List all regular files with filenames ending in '.png':"
1344 #: ../cat/virt-ls.pod:55
1347 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1352 #: ../cat/virt-ls.pod:57
1353 msgid "To display files larger than 10MB in home directories:"
1357 #: ../cat/virt-ls.pod:59
1360 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1365 #: ../cat/virt-ls.pod:61
1366 msgid "Find everything modified in the last 7 days:"
1370 #: ../cat/virt-ls.pod:63
1373 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1378 #: ../cat/virt-ls.pod:65
1379 msgid "Find regular files modified in the last 24 hours:"
1383 #: ../cat/virt-ls.pod:67
1386 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1391 #: ../cat/virt-ls.pod:69
1392 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1396 #: ../cat/virt-ls.pod:71
1398 "Find the differences between files in a guest and an earlier snapshot of the "
1403 #: ../cat/virt-ls.pod:74
1406 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1407 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1408 " diff -u old new | less\n"
1413 #: ../cat/virt-ls.pod:78
1415 "The commands above won't find files where the content has changed but the "
1416 "metadata (eg. file size and modification date) is the same. To do that, you "
1417 "need to add the I<--checksum> parameter to both C<virt-ls> commands. "
1418 "I<--checksum> can be quite slow since it has to read and compute a checksum "
1419 "of every regular file in the virtual machine."
1423 #: ../cat/virt-ls.pod:84
1424 msgid "OUTPUT MODES"
1428 #: ../cat/virt-ls.pod:86
1430 "C<virt-ls> has four output modes, controlled by different combinations of "
1431 "the I<-l> and I<-R> options."
1435 #: ../cat/virt-ls.pod:89
1436 msgid "SIMPLE LISTING"
1440 #: ../cat/virt-ls.pod:91
1441 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1445 #: ../cat/virt-ls.pod:93
1448 " $ virt-ls -d guest /\n"
1456 #: ../cat/virt-ls.pod:98
1457 msgid "LONG LISTING"
1461 #: ../cat/virt-ls.pod:100
1463 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1464 "(more specifically, like the C<guestfs_ll> function)."
1468 #: ../cat/virt-ls.pod:103
1471 " $ virt-ls -l -d guest /\n"
1473 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1474 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1480 #: ../cat/virt-ls.pod:109
1482 "Note that while this is useful for displaying a directory, do not try "
1483 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1488 #: ../cat/virt-ls.pod:113
1489 msgid "RECURSIVE LISTING"
1493 #: ../cat/virt-ls.pod:115
1495 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1496 "and directories recursively:"
1500 #: ../cat/virt-ls.pod:118
1503 " $ virt-ls -R -d guest /tmp\n"
1511 #: ../cat/virt-ls.pod:123
1513 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1514 "converts C<\\0> characters to C<\\n>."
1518 #: ../cat/virt-ls.pod:126
1519 msgid "RECURSIVE LONG LISTING"
1523 #: ../cat/virt-ls.pod:128
1525 "Using I<-lR> options together changes the output to display directories "
1526 "recursively, with file stats, and optionally other features such as "
1527 "checksums and extended attributes."
1531 #: ../cat/virt-ls.pod:132
1533 "Most of the interesting features of C<virt-ls> are only available when using "
1538 #: ../cat/virt-ls.pod:135
1540 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1541 "you cannot use the output in another program (because filenames can contain "
1542 "spaces and other unsafe characters). If the guest was untrusted and someone "
1543 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1544 "on you by creating filenames with embedded newline characters. To B<safely> "
1545 "parse the output in another program, use the I<--csv> (Comma-Separated "
1550 #: ../cat/virt-ls.pod:143
1552 "Note that this output format is completely unrelated to the C<ls -lR> "
1557 #: ../cat/virt-ls.pod:146
1560 " $ virt-ls -lR -d guest /bin\n"
1561 " d 0555 4096 /bin\n"
1562 " - 0755 123 /bin/alsaunmute\n"
1563 " - 0755 28328 /bin/arch\n"
1564 " l 0777 4 /bin/awk -> gawk\n"
1565 " - 0755 27216 /bin/basename\n"
1566 " - 0755 943360 /bin/bash\n"
1572 #: ../cat/virt-ls.pod:155
1573 msgid "These basic fields are always shown:"
1577 #: ../cat/virt-ls.pod:159
1582 #: ../cat/virt-ls.pod:161
1584 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1585 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1586 "link), C<s> (socket) or C<u> (unknown)."
1590 #: ../cat/virt-ls.pod:171
1595 #: ../cat/virt-ls.pod:173
1596 msgid "The Unix permissions, displayed as a 4 digit octal number."
1600 #: ../cat/virt-ls.pod:175
1605 #: ../cat/virt-ls.pod:177
1607 "The size of the file. This is shown in bytes unless I<-h> or "
1608 "I<--human-readable> option is given, in which case this is shown as a "
1609 "human-readable number."
1613 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4214
1618 #: ../cat/virt-ls.pod:183
1619 msgid "The full path of the file or directory."
1623 #: ../cat/virt-ls.pod:185
1628 #: ../cat/virt-ls.pod:187
1629 msgid "For symbolic links only, the link target."
1633 #: ../cat/virt-ls.pod:191
1635 "In I<-lR> mode, additional command line options enable the display of more "
1640 #: ../cat/virt-ls.pod:194
1642 "With the I<--uids> flag, these additional fields are displayed before the "
1647 #: ../cat/virt-ls.pod:199
1652 #: ../cat/virt-ls.pod:201
1657 #: ../cat/virt-ls.pod:203
1659 "The UID and GID of the owner of the file (displayed numerically). Note "
1660 "these only make sense in the context of a Unix-like guest."
1664 #: ../cat/virt-ls.pod:208
1665 msgid "With the I<--times> flag, these additional fields are displayed:"
1669 #: ../cat/virt-ls.pod:212
1674 #: ../cat/virt-ls.pod:214
1675 msgid "The time of last access."
1679 #: ../cat/virt-ls.pod:216
1684 #: ../cat/virt-ls.pod:218
1685 msgid "The time of last modification."
1689 #: ../cat/virt-ls.pod:220
1694 #: ../cat/virt-ls.pod:222
1695 msgid "The time of last status change."
1699 #: ../cat/virt-ls.pod:226
1701 "The time fields are displayed as string dates and times, unless one of the "
1702 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1706 #: ../cat/virt-ls.pod:229
1707 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1711 #: ../cat/virt-ls.pod:233
1716 #: ../cat/virt-ls.pod:235
1718 "The device containing the file (displayed as major:minor). This may not "
1719 "match devices as known to the guest."
1723 #: ../cat/virt-ls.pod:238
1728 #: ../cat/virt-ls.pod:240
1729 msgid "The inode number."
1733 #: ../cat/virt-ls.pod:242
1738 #: ../cat/virt-ls.pod:244
1739 msgid "The number of hard links."
1743 #: ../cat/virt-ls.pod:246
1748 #: ../cat/virt-ls.pod:248
1749 msgid "For block and char special files, the device (displayed as major:minor)."
1753 #: ../cat/virt-ls.pod:251
1758 #: ../cat/virt-ls.pod:253
1759 msgid "The number of 512 byte blocks allocated to the file."
1763 #: ../cat/virt-ls.pod:257
1765 "With the I<--checksum> flag, the checksum of the file contents is shown "
1766 "(only for regular files). Computing file checksums can take a considerable "
1771 #: ../cat/virt-ls.pod:280
1772 msgid "B<--checksum>"
1776 #: ../cat/virt-ls.pod:282
1777 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
1781 #: ../cat/virt-ls.pod:284
1783 "Display checksum over file contents for regular files. With no argument, "
1784 "this defaults to using I<md5>. Using an argument, you can select the "
1785 "checksum type to use."
1789 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
1791 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
1796 #: ../cat/virt-ls.pod:316
1798 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
1799 "so you cannot see what you are typing. If you are not worried about Tempest "
1800 "attacks and there is no one else in the room you can specify this flag to "
1801 "see what you are typing."
1805 #: ../cat/virt-ls.pod:321
1806 msgid "B<--extra-stats>"
1810 #: ../cat/virt-ls.pod:323
1811 msgid "Display extra stats."
1815 #: ../cat/virt-ls.pod:339
1818 " virt-ls --format=raw -a disk.img /dir\n"
1823 #: ../cat/virt-ls.pod:343
1826 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
1831 #: ../cat/virt-ls.pod:356
1832 msgid "Display file sizes in human-readable format."
1836 #: ../cat/virt-ls.pod:370
1841 #: ../cat/virt-ls.pod:372
1842 msgid "B<--recursive>"
1846 #: ../cat/virt-ls.pod:374
1848 "Select the mode. With neither of these options, C<virt-ls> produces a "
1849 "simple, flat list of the files in the named directory. See L</SIMPLE "
1854 #: ../cat/virt-ls.pod:378
1856 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See "
1861 #: ../cat/virt-ls.pod:381
1863 "C<virt-ls -R> produces a recursive list of files starting at the named "
1864 "directory. See L</RECURSIVE LISTING>."
1868 #: ../cat/virt-ls.pod:384
1870 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
1871 "parsed. See L</RECURSIVE LONG LISTING>."
1875 #: ../cat/virt-ls.pod:387
1880 #: ../cat/virt-ls.pod:389
1881 msgid "Display time fields."
1885 #: ../cat/virt-ls.pod:394
1886 msgid "B<--time-days>"
1890 #: ../cat/virt-ls.pod:396
1891 msgid "Display time fields as days before now (negative if in the future)."
1895 #: ../cat/virt-ls.pod:398
1897 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
1898 "of the file is between 0 and 86399 seconds."
1902 #: ../cat/virt-ls.pod:404
1903 msgid "B<--time-relative>"
1907 #: ../cat/virt-ls.pod:406
1908 msgid "Display time fields as seconds before now (negative if in the future)."
1912 #: ../cat/virt-ls.pod:411
1917 #: ../cat/virt-ls.pod:413
1918 msgid "Display time fields as seconds since the Unix epoch."
1922 #: ../cat/virt-ls.pod:418
1927 #: ../cat/virt-ls.pod:420
1928 msgid "Display UID and GID fields."
1932 #: ../cat/virt-ls.pod:445
1933 msgid "Previous versions of virt-ls allowed you to write either:"
1937 #: ../cat/virt-ls.pod:447
1940 " virt-ls disk.img [disk.img ...] /dir\n"
1945 #: ../cat/virt-ls.pod:451
1948 " virt-ls guestname /dir\n"
1953 #: ../cat/virt-ls.pod:497
1955 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
1956 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
1957 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
1961 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:298
1962 msgid "Copyright (C) 2009-2011 Red Hat Inc."
1966 #: ../df/virt-df.pod:5
1967 msgid "virt-df - Display free space on virtual filesystems"
1971 #: ../df/virt-df.pod:9
1974 " virt-df [--options]\n"
1979 #: ../df/virt-df.pod:11
1982 " virt-df [--options] -d domname\n"
1987 #: ../df/virt-df.pod:13
1990 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
1995 #: ../df/virt-df.pod:17
1998 " virt-df [--options] domname\n"
2003 #: ../df/virt-df.pod:19
2006 " virt-df [--options] disk.img [disk.img ...]\n"
2011 #: ../df/virt-df.pod:23
2013 "C<virt-df> is a command line tool to display free space on virtual machine "
2014 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2015 "allocated to a virtual machine, but can look inside disk images to see how "
2016 "much space is really being used."
2020 #: ../df/virt-df.pod:28
2022 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2023 "to get a list of all active and inactive guests, and performs a C<df>-type "
2024 "operation on each one in turn, printing out the results."
2028 #: ../df/virt-df.pod:32
2030 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
2031 "C<df>-type operation on either the single named libvirt domain, or on the "
2032 "disk image(s) listed on the command line (which must all belong to a single "
2033 "VM). In this mode (with arguments), C<virt-df> will I<only work for a "
2034 "single guest>. If you want to run on multiple guests, then you have to "
2035 "invoke C<virt-df> multiple times."
2039 #: ../df/virt-df.pod:39
2041 "Use the I<--csv> option to get a format which can be easily parsed by other "
2042 "programs. Other options are similar to the standard L<df(1)> command."
2046 #: ../df/virt-df.pod:45
2048 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2049 "output human-readable:"
2053 #: ../df/virt-df.pod:48
2056 " # virt-df -d F14x64 -h\n"
2057 " Filesystem Size Used Available Use%\n"
2058 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2059 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2064 #: ../df/virt-df.pod:53
2065 msgid "Show disk usage for a disk image file called C<test.img>:"
2069 #: ../df/virt-df.pod:55
2072 " $ virt-df -a test1.img\n"
2073 " Filesystem 1K-blocks Used Available Use%\n"
2074 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2079 #: ../df/virt-df.pod:112
2082 " virt-df --format=raw -a disk.img\n"
2087 #: ../df/virt-df.pod:116
2090 " virt-df --format=raw -a disk.img --format -a another.img\n"
2095 #: ../df/virt-df.pod:129
2096 msgid "Print sizes in human-readable format."
2100 #: ../df/virt-df.pod:131
2101 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2105 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2110 #: ../df/virt-df.pod:135
2115 #: ../df/virt-df.pod:137
2116 msgid "Print inodes instead of blocks."
2120 #: ../df/virt-df.pod:139
2121 msgid "B<--one-per-guest>"
2125 #: ../df/virt-df.pod:141
2127 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2128 "disks from several guests to a single libguestfs appliance."
2132 #: ../df/virt-df.pod:144
2133 msgid "You might use this option in the following circumstances:"
2137 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398 ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412 ../fish/guestfish-actions.pod:1104 ../fish/guestfish-actions.pod:1108 ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1124 ../fish/guestfish-actions.pod:1128 ../fish/guestfish-actions.pod:1132 ../fish/guestfish-actions.pod:1142 ../fish/guestfish-actions.pod:1146 ../fish/guestfish-actions.pod:1150 ../fish/guestfish-actions.pod:1240 ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1254 ../fish/guestfish-actions.pod:1296 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1305 ../fish/guestfish-actions.pod:1555 ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:1569 ../fish/guestfish-actions.pod:1964 ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1985 ../fish/guestfish-actions.pod:1992 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:393 ../inspector/virt-inspector.pod:397 ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1679 ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1709 ../src/guestfs-actions.pod:1713 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1926 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:2890 ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:2904 ../src/guestfs-actions.pod:2911 ../src/guestfs-actions.pod:2918 ../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:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1076 ../src/guestfs.pod:1081 ../src/guestfs.pod:1089 ../src/guestfs.pod:1108 ../src/guestfs.pod:1116 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1158 ../src/guestfs.pod:1648 ../src/guestfs.pod:1653 ../src/guestfs.pod:1657 ../src/guestfs.pod:1759 ../src/guestfs.pod:1764 ../src/guestfs.pod:1768 ../src/guestfs.pod:1778 ../src/guestfs.pod:2067 ../src/guestfs.pod:2072 ../src/guestfs.pod:2078 ../src/guestfs.pod:2086 ../src/guestfs.pod:2533 ../src/guestfs.pod:2539 ../src/guestfs.pod:2544 ../src/guestfs.pod:2550 ../src/guestfs.pod:2933 ../src/guestfs.pod:2938 ../src/guestfs.pod:2942 ../src/guestfs.pod:2946 ../src/guestfs.pod:2950 ../src/guestfs.pod:2964 ../src/guestfs.pod:2969 ../src/guestfs.pod:3195 ../src/guestfs.pod:3199 ../src/guestfs.pod:3203 ../src/guestfs.pod:3207 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710 ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2142 #: ../df/virt-df.pod:150
2144 "If you think an untrusted guest might actively try to exploit the libguestfs "
2145 "appliance kernel, then this prevents one guest from interfering with the "
2146 "stats printed for another guest."
2150 #: ../df/virt-df.pod:156
2152 "If the kernel has a bug which stops it from accessing a filesystem in one "
2153 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2154 "and report stats for further guests."
2158 #: ../df/virt-df.pod:165
2160 "Print UUIDs instead of names. This is useful for following a guest even "
2161 "when the guest is migrated or renamed, or when two guests happen to have the "
2166 #: ../df/virt-df.pod:169
2168 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2169 "images, we still print the disk image name even when this option is "
2174 #: ../df/virt-df.pod:229
2176 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
2177 "L<http://libguestfs.org/>."
2181 #: ../edit/virt-edit.pod:5
2182 msgid "virt-edit - Edit a file in a virtual machine"
2186 #: ../edit/virt-edit.pod:9
2189 " virt-edit [--options] -d domname file [file ...]\n"
2194 #: ../edit/virt-edit.pod:11
2197 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2202 #: ../edit/virt-edit.pod:13
2205 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2210 #: ../edit/virt-edit.pod:17
2213 " virt-edit domname file\n"
2218 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2221 " virt-edit disk.img [disk.img ...] file\n"
2226 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2231 #: ../edit/virt-edit.pod:23
2233 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2234 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2235 "doing this, but doesn't catch all cases."
2239 #: ../edit/virt-edit.pod:29
2241 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2242 "exists in the named virtual machine (or disk image)."
2246 #: ../edit/virt-edit.pod:32
2248 "Multiple filenames can be given, in which case they are each edited in "
2249 "turn. Each filename must be a full path, starting at the root directory "
2250 "(starting with '/')."
2254 #: ../edit/virt-edit.pod:36
2255 msgid "If you want to just view a file, use L<virt-cat(1)>."
2259 #: ../edit/virt-edit.pod:38
2261 "For more complex cases you should look at the L<guestfish(1)> tool (see "
2262 "L</USING GUESTFISH> below)."
2266 #: ../edit/virt-edit.pod:41
2268 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2269 "that and much more."
2273 #: ../edit/virt-edit.pod:46
2274 msgid "Edit the named files interactively:"
2278 #: ../edit/virt-edit.pod:48
2281 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2286 #: ../edit/virt-edit.pod:50
2289 " virt-edit -d mydomain /etc/passwd\n"
2294 #: ../edit/virt-edit.pod:52
2295 msgid "For Windows guests, some Windows paths are understood:"
2299 #: ../edit/virt-edit.pod:54
2302 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2307 #: ../edit/virt-edit.pod:56
2309 "If Perl is installed, you can also edit files non-interactively (see "
2310 "L</NON-INTERACTIVE EDITING> below). To change the init default level to 5:"
2314 #: ../edit/virt-edit.pod:60
2317 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2322 #: ../edit/virt-edit.pod:81
2323 msgid "B<-b> extension"
2327 #: ../edit/virt-edit.pod:83
2328 msgid "B<--backup> extension"
2332 #: ../edit/virt-edit.pod:85
2334 "Create a backup of the original file I<in the guest disk image>. The backup "
2335 "has the original filename with C<extension> added."
2339 #: ../edit/virt-edit.pod:88
2341 "Usually the first character of C<extension> would be a dot C<.> so you would "
2346 #: ../edit/virt-edit.pod:91
2349 " virt-edit -b .orig [etc]\n"
2354 #: ../edit/virt-edit.pod:93
2355 msgid "By default, no backup file is made."
2359 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2364 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2365 msgid "B<--connect URI>"
2369 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
2371 "If you specify guest block devices directly, then libvirt is not used at "
2376 #: ../edit/virt-edit.pod:114
2378 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2379 "off so you cannot see what you are typing. If you are not worried about "
2380 "Tempest attacks and there is no one else in the room you can specify this "
2381 "flag to see what you are typing."
2385 #: ../edit/virt-edit.pod:119
2390 #: ../edit/virt-edit.pod:121
2391 msgid "B<--expr> EXPR"
2395 #: ../edit/virt-edit.pod:123
2397 "Instead of launching the external editor, non-interactively apply the Perl "
2398 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2403 #: ../edit/virt-edit.pod:127
2405 "Be careful to properly quote the expression to prevent it from being altered "
2410 #: ../edit/virt-edit.pod:130
2411 msgid "Note that this option is only available when Perl 5 is installed."
2415 #: ../edit/virt-edit.pod:132
2416 msgid "B<--format> raw|qcow2|..."
2420 #: ../edit/virt-edit.pod:143
2423 " virt-edit --format=raw -a disk.img file\n"
2428 #: ../edit/virt-edit.pod:147
2431 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2436 #: ../edit/virt-edit.pod:181
2437 msgid "Previous versions of virt-edit allowed you to write either:"
2441 #: ../edit/virt-edit.pod:187
2444 " virt-edit guestname file\n"
2449 #: ../edit/virt-edit.pod:195
2450 msgid "NON-INTERACTIVE EDITING"
2454 #: ../edit/virt-edit.pod:197
2456 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2457 "administrator can interactively edit the file."
2461 #: ../edit/virt-edit.pod:200
2463 "There are two ways also to use C<virt-edit> from scripts in order to make "
2464 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2465 "like this, it's less error-prone to write scripts directly using the "
2466 "libguestfs API and Augeas for configuration file editing.)"
2470 #: ../edit/virt-edit.pod:206
2472 "The first method is to temporarily set C<$EDITOR> to any script or program "
2473 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2474 "update C<tmpfile> in place however it likes."
2478 #: ../edit/virt-edit.pod:210
2480 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2481 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2482 "instances of C<foo> with C<bar> in a file:"
2486 #: ../edit/virt-edit.pod:214
2489 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2494 #: ../edit/virt-edit.pod:216
2496 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2497 "For example to delete root's password you could do:"
2501 #: ../edit/virt-edit.pod:219
2504 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2509 #: ../edit/virt-edit.pod:221
2511 "What really happens is that the snippet is evaluated as a Perl expression "
2512 "for each line of the file. The line, including the final C<\\n>, is passed "
2513 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2517 #: ../edit/virt-edit.pod:226
2519 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2520 "C<apache> user account from the password file you can do:"
2524 #: ../edit/virt-edit.pod:229
2527 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2532 #: ../edit/virt-edit.pod:231
2534 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2535 "the end of the file is rather difficult this way since there is no concept "
2536 "of \"last line of the file\" - your expression just doesn't get called "
2537 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2542 #: ../edit/virt-edit.pod:237
2544 "The variable C<$lineno> contains the current line number. As is "
2545 "traditional, the first line in the file is number C<1>."
2549 #: ../edit/virt-edit.pod:240
2551 "The return value from the expression is ignored, but the expression may call "
2552 "C<die> in order to abort the whole program, leaving the original file "
2557 #: ../edit/virt-edit.pod:244
2559 "Remember when matching the end of a line that C<$_> may contain the final "
2560 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2561 "newline then neither of these. Thus to match or substitute some text at the "
2562 "end of a line, use this regular expression:"
2566 #: ../edit/virt-edit.pod:249
2569 " /some text(\\r?\\n)?$/\n"
2574 #: ../edit/virt-edit.pod:251
2576 "Alternately, use the perl C<chomp> function, being careful not to chomp "
2577 "C<$_> itself (since that would remove all newlines from the file):"
2581 #: ../edit/virt-edit.pod:255
2584 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2589 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2590 msgid "WINDOWS PATHS"
2594 #: ../edit/virt-edit.pod:259
2596 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2597 "paths (eg. C<E:\\foo\\bar.txt>)."
2601 #: ../edit/virt-edit.pod:262
2602 msgid "If and only if the guest is running Windows then:"
2606 #: ../edit/virt-edit.pod:268
2608 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2609 "to the correct filesystem."
2613 #: ../edit/virt-edit.pod:273
2615 "Any backslash (C<\\>) characters in the path are replaced with forward "
2616 "slashes so that libguestfs can process it."
2620 #: ../edit/virt-edit.pod:278
2622 "The path is resolved case insensitively to locate the file that should be "
2627 #: ../edit/virt-edit.pod:283
2628 msgid "There are some known shortcomings:"
2632 #: ../edit/virt-edit.pod:289
2633 msgid "Some NTFS symbolic links may not be followed correctly."
2637 #: ../edit/virt-edit.pod:293
2638 msgid "NTFS junction points that cross filesystems are not followed."
2642 #: ../edit/virt-edit.pod:299
2644 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2645 "C<virt-edit> doesn't work."
2649 #: ../edit/virt-edit.pod:302
2650 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2654 #: ../edit/virt-edit.pod:304
2657 " guestfish --rw -i -d domname edit /file\n"
2662 #: ../edit/virt-edit.pod:306
2664 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2669 #: ../edit/virt-edit.pod:309
2671 "The command above uses libguestfs's guest inspection feature and so does not "
2672 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2673 "disk images that don't contain guests. To edit a file on a disk image "
2678 #: ../edit/virt-edit.pod:314
2681 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2686 #: ../edit/virt-edit.pod:316
2688 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2689 "the disk image to edit, and C</file> is the full path to the file."
2693 #: ../edit/virt-edit.pod:320
2695 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2696 "C<write> or C<upload> instead:"
2700 #: ../edit/virt-edit.pod:323
2703 " guestfish --rw -i -d domname touch /newfile\n"
2708 #: ../edit/virt-edit.pod:325
2711 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
2716 #: ../edit/virt-edit.pod:327
2719 " guestfish --rw -i -d domname upload localfile /newfile\n"
2724 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:3080 ../test-tool/libguestfs-test-tool.pod:95
2725 msgid "ENVIRONMENT VARIABLES"
2729 #: ../edit/virt-edit.pod:333
2734 #: ../edit/virt-edit.pod:335
2736 "If set, this string is used as the editor. It may contain arguments, "
2737 "eg. C<\"emacs -nw\">"
2741 #: ../edit/virt-edit.pod:338
2742 msgid "If not set, C<vi> is used."
2746 #: ../edit/virt-edit.pod:356
2748 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
2749 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2750 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
2754 #: ../erlang/examples/guestfs-erlang.pod:5
2755 msgid "guestfs-erlang - How to use libguestfs from Erlang"
2759 #: ../erlang/examples/guestfs-erlang.pod:9
2762 " {ok, G} = guestfs:create(),\n"
2763 " ok = guestfs:add_drive_opts(G, Disk,\n"
2764 " [{format, \"raw\"}, {readonly, true}]),\n"
2765 " ok = guestfs:launch(G),\n"
2766 " [Device] = guestfs:list_devices(G),\n"
2767 " ok = guestfs:close(G).\n"
2772 #: ../erlang/examples/guestfs-erlang.pod:18
2774 "This manual page documents how to call libguestfs from the Erlang "
2775 "programming language. This page just documents the differences from the C "
2776 "API and gives some examples. If you are not familiar with using libguestfs, "
2777 "you also need to read L<guestfs(3)>."
2781 #: ../erlang/examples/guestfs-erlang.pod:23
2782 msgid "OPENING AND CLOSING THE HANDLE"
2786 #: ../erlang/examples/guestfs-erlang.pod:25
2788 "The Erlang bindings are implemented using an external program called "
2789 "C<erl-guestfs>. This program must be on the current PATH, or else you "
2790 "should specify the full path to the program:"
2794 #: ../erlang/examples/guestfs-erlang.pod:29
2797 " {ok, G} = guestfs:create().\n"
2802 #: ../erlang/examples/guestfs-erlang.pod:31
2805 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
2810 #: ../erlang/examples/guestfs-erlang.pod:33
2811 msgid "C<G> is the libguestfs handle which you should pass to other functions."
2815 #: ../erlang/examples/guestfs-erlang.pod:36
2816 msgid "To close the handle:"
2820 #: ../erlang/examples/guestfs-erlang.pod:38
2823 " ok = guestfs:close(G).\n"
2828 #: ../erlang/examples/guestfs-erlang.pod:40
2829 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
2833 #: ../erlang/examples/guestfs-erlang.pod:42
2835 "For functions that take optional arguments, the first arguments are the "
2836 "non-optional ones. The last argument is a list of tuples supplying the "
2837 "remaining optional arguments."
2841 #: ../erlang/examples/guestfs-erlang.pod:46
2844 " ok = guestfs:add_drive_opts(G, Disk,\n"
2845 " [{format, \"raw\"}, {readonly, true}]).\n"
2850 #: ../erlang/examples/guestfs-erlang.pod:49
2851 msgid "If the last argument would be an empty list, you can also omit it:"
2855 #: ../erlang/examples/guestfs-erlang.pod:51
2858 " ok = guestfs:add_drive_opts(G, Disk).\n"
2863 #: ../erlang/examples/guestfs-erlang.pod:53
2864 msgid "RETURN VALUES AND ERRORS"
2868 #: ../erlang/examples/guestfs-erlang.pod:55
2870 "On success, most functions return a C<Result> term (which could be a list, "
2871 "string, tuple etc.). If there is nothing for the function to return, then "
2872 "the atom C<ok> is returned."
2876 #: ../erlang/examples/guestfs-erlang.pod:59
2877 msgid "On error, you would see one of the following tuples:"
2881 #: ../erlang/examples/guestfs-erlang.pod:63
2882 msgid "C<{error, Msg, Errno}>"
2886 #: ../erlang/examples/guestfs-erlang.pod:65
2887 msgid "This indicates an ordinary error from the function."
2891 #: ../erlang/examples/guestfs-erlang.pod:67
2893 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
2898 #: ../erlang/examples/guestfs-erlang.pod:70
2899 msgid "C<Errno> can be zero. See L<guestfs(3)/guestfs_last_errno>."
2903 #: ../erlang/examples/guestfs-erlang.pod:72
2904 msgid "C<{unknown, Function}>"
2908 #: ../erlang/examples/guestfs-erlang.pod:74
2910 "This indicates that the function you called is not known. Generally this "
2911 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
2912 "which you should not do."
2916 #: ../erlang/examples/guestfs-erlang.pod:78
2917 msgid "C<Function> is the name of the unknown function."
2921 #: ../erlang/examples/guestfs-erlang.pod:80
2922 msgid "C<{unknownarg, Arg}>"
2926 #: ../erlang/examples/guestfs-erlang.pod:82
2928 "This indicates that you called a function with optional arguments, with an "
2929 "unknown argument name."
2933 #: ../erlang/examples/guestfs-erlang.pod:85
2934 msgid "C<Arg> is the name of the unknown argument."
2938 #: ../erlang/examples/guestfs-erlang.pod:89 ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
2939 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2943 #: ../erlang/examples/guestfs-erlang.pod:91 ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
2948 #: ../erlang/examples/guestfs-erlang.pod:93 ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
2949 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2953 #: ../erlang/examples/guestfs-erlang.pod:95 ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
2958 #: ../erlang/examples/guestfs-erlang.pod:99
2960 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
2961 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
2962 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>. "
2963 "L<http://libguestfs.org/>."
2967 #: ../erlang/examples/guestfs-erlang.pod:110 ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:319 ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:58 ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52 ../python/examples/guestfs-python.pod:54 ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3214 ../test-tool/libguestfs-test-tool.pod:106
2972 #: ../erlang/examples/guestfs-erlang.pod:112 ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:321 ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54 ../python/examples/guestfs-python.pod:56 ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3216 ../test-tool/libguestfs-test-tool.pod:108
2973 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2977 #: ../erlang/examples/guestfs-erlang.pod:116 ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
2978 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
2982 #: ../erlang/examples/guestfs-erlang.pod:118 ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405 ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99 ../perl/examples/guestfs-perl.pod:60 ../python/examples/guestfs-python.pod:62 ../ruby/examples/guestfs-ruby.pod:56
2984 "The examples in this manual page may be freely copied, modified and "
2985 "distributed without any restrictions."
2989 #: ../erlang/examples/guestfs-erlang.pod:121 ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408 ../java/examples/guestfs-java.pod:69 ../ocaml/examples/guestfs-ocaml.pod:102 ../perl/examples/guestfs-perl.pod:63 ../python/examples/guestfs-python.pod:65 ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3223
2991 "This library is free software; you can redistribute it and/or modify it "
2992 "under the terms of the GNU Lesser General Public License as published by the "
2993 "Free Software Foundation; either version 2 of the License, or (at your "
2994 "option) any later version."
2998 #: ../erlang/examples/guestfs-erlang.pod:126 ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413 ../java/examples/guestfs-java.pod:74 ../ocaml/examples/guestfs-ocaml.pod:107 ../perl/examples/guestfs-perl.pod:68 ../python/examples/guestfs-python.pod:70 ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3228
3000 "This library is distributed in the hope that it will be useful, but WITHOUT "
3001 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3002 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3007 #: ../erlang/examples/guestfs-erlang.pod:131 ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418 ../java/examples/guestfs-java.pod:79 ../ocaml/examples/guestfs-ocaml.pod:112 ../perl/examples/guestfs-perl.pod:73 ../python/examples/guestfs-python.pod:75 ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3233
3009 "You should have received a copy of the GNU Lesser General Public License "
3010 "along with this library; if not, write to the Free Software Foundation, "
3011 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3015 #: ../examples/guestfs-examples.pod:5
3016 msgid "guestfs-examples - Examples of using libguestfs from C"
3020 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3023 " #include <guestfs.h>\n"
3028 #: ../examples/guestfs-examples.pod:11
3031 " guestfs_h *g = guestfs_create ();\n"
3032 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3033 " guestfs_launch (g);\n"
3038 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3041 " cc prog.c -o prog -lguestfs\n"
3043 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3048 #: ../examples/guestfs-examples.pod:21
3050 "This manual page contains examples of calling libguestfs from the C "
3051 "programming language. If you are not familiar with using libguestfs, you "
3052 "also need to read L<guestfs(3)>."
3056 #: ../examples/guestfs-examples.pod:35
3058 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
3059 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3060 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3064 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 ../python/examples/guestfs-python.pod:60 ../ruby/examples/guestfs-ruby.pod:54
3065 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3069 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3074 #: ../examples/guestfs-recipes.pod:5
3076 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3077 "here. The only way which works for both sorts of output is to just write "
3078 "the URL directly. Do NOT use L<...> for URLs."
3082 #: ../examples/guestfs-recipes.pod:9
3084 "We break with tradition here and don't use ALL CAPS for the section "
3085 "headings, as this makes them much easier to read."
3089 #: ../examples/guestfs-recipes.pod:16
3090 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3094 #: ../examples/guestfs-recipes.pod:20
3096 "This page contains recipes for and links to things you can do using "
3097 "libguestfs, L<guestfish(1)> and the virt tools."
3101 #: ../examples/guestfs-recipes.pod:23
3102 msgid "Audit a virtual machine for setuid files"
3106 #: ../examples/guestfs-recipes.pod:25
3108 "The link below contains a small program which can be used to audit a Linux "
3109 "virtual machine to see what setuid and setgid files it contains."
3113 #: ../examples/guestfs-recipes.pod:28
3114 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
3118 #: ../examples/guestfs-recipes.pod:30
3119 msgid "Change the background image in a Windows XP VM"
3123 #: ../examples/guestfs-recipes.pod:32
3125 "The links below explain how to use L<guestfish(1)> to change the background "
3126 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3127 "be substantially different for each version of Windows."
3131 #: ../examples/guestfs-recipes.pod:37
3133 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
3134 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3138 #: ../examples/guestfs-recipes.pod:40
3139 msgid "Cloning a virtual machine (Linux)"
3143 #: ../examples/guestfs-recipes.pod:42
3145 "The guestfish technique described in the link below works well for most "
3146 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3151 #: ../examples/guestfs-recipes.pod:46
3152 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
3156 #: ../examples/guestfs-recipes.pod:48
3158 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3163 #: ../examples/guestfs-recipes.pod:51
3164 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3168 #: ../examples/guestfs-recipes.pod:53
3169 msgid "Cloning a virtual machine (Windows)"
3173 #: ../examples/guestfs-recipes.pod:55
3175 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3176 "straightforward. Currently there is code in the Aeolus Oz project which "
3177 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3178 "we may add sysprepping ability."
3182 #: ../examples/guestfs-recipes.pod:60
3184 "https://github.com/clalancette/oz "
3185 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3189 #: ../examples/guestfs-recipes.pod:63
3190 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3194 #: ../examples/guestfs-recipes.pod:65
3195 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3199 #: ../examples/guestfs-recipes.pod:67
3202 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3207 #: ../examples/guestfs-recipes.pod:69
3208 msgid "To export just a subdirectory, eg. C</files>, do:"
3212 #: ../examples/guestfs-recipes.pod:71
3215 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3220 #: ../examples/guestfs-recipes.pod:73
3221 msgid "Create empty disk images"
3225 #: ../examples/guestfs-recipes.pod:75
3227 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3228 "The useful guide below explains the options available."
3232 #: ../examples/guestfs-recipes.pod:78
3233 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3237 #: ../examples/guestfs-recipes.pod:80
3238 msgid "Dump raw filesystem content from inside a disk image or VM"
3242 #: ../examples/guestfs-recipes.pod:82
3244 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3245 "filesystem content from any filesystem in a disk image or a VM (even one "
3246 "which is encrypted or buried inside an LV):"
3250 #: ../examples/guestfs-recipes.pod:86
3253 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3258 #: ../examples/guestfs-recipes.pod:88
3261 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3266 #: ../examples/guestfs-recipes.pod:90
3267 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3271 #: ../examples/guestfs-recipes.pod:92
3272 msgid "Edit grub configuration in a VM"
3276 #: ../examples/guestfs-recipes.pod:94
3277 msgid "You can use this to:"
3281 #: ../examples/guestfs-recipes.pod:100
3282 msgid "Fix a virtual machine that does not boot."
3286 #: ../examples/guestfs-recipes.pod:104
3287 msgid "Change which kernel is used to boot the VM."
3291 #: ../examples/guestfs-recipes.pod:108
3292 msgid "Change kernel command line options."
3296 #: ../examples/guestfs-recipes.pod:112
3297 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3301 #: ../examples/guestfs-recipes.pod:114
3304 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3309 #: ../examples/guestfs-recipes.pod:116
3311 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3316 #: ../examples/guestfs-recipes.pod:119
3319 " virt-rescue -d BrokenGuest\n"
3324 #: ../examples/guestfs-recipes.pod:121
3325 msgid "Export any directory from a VM"
3329 #: ../examples/guestfs-recipes.pod:123
3330 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3334 #: ../examples/guestfs-recipes.pod:126
3337 " virt-copy-out -d Guest /home .\n"
3342 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:2335 ../src/guestfs-actions.pod:2886 ../src/guestfs.pod:1644 ../tools/virt-win-reg.pl:706
3347 #: ../examples/guestfs-recipes.pod:134
3349 "The final dot of the command is not a printing error. It means we want to "
3350 "copy out to the current directory."
3354 #: ../examples/guestfs-recipes.pod:139
3355 msgid "This creates a directory called C<home> under the current directory."
3359 #: ../examples/guestfs-recipes.pod:143
3361 "If the guest is a Windows guest then you can use drive letters and "
3362 "backslashes, but you must prefix the path with C<win:> and quote it to "
3363 "protect it from the shell, like this:"
3367 #: ../examples/guestfs-recipes.pod:147
3370 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3375 #: ../examples/guestfs-recipes.pod:149
3376 msgid "To get the output as a compressed tarball, do:"
3380 #: ../examples/guestfs-recipes.pod:151
3383 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3388 #: ../examples/guestfs-recipes.pod:153
3390 "Although it sounds tempting, this is usually not a reliable way to get a "
3391 "backup from a running guest. See the entry in the FAQ: "
3392 "http://libguestfs.org/FAQ.html#backup"
3396 #: ../examples/guestfs-recipes.pod:157
3397 msgid "Find out which user is using the most space"
3401 #: ../examples/guestfs-recipes.pod:159
3403 "This simple script examines a Linux guest to find out which user is using "
3404 "the most space in their home directory:"
3408 #: ../examples/guestfs-recipes.pod:162
3416 #: ../examples/guestfs-recipes.pod:164
3424 #: ../examples/guestfs-recipes.pod:166
3433 #: ../examples/guestfs-recipes.pod:169
3436 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3441 #: ../examples/guestfs-recipes.pod:171
3444 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3445 " echo -n \"$dir/$d\"\n"
3447 " guestfish --remote du \"$dir/$d\";\n"
3448 " done | sort -nr -k 2\n"
3453 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3456 " guestfish --remote exit\n"
3461 #: ../examples/guestfs-recipes.pod:179
3462 msgid "Get DHCP address from a VM"
3466 #: ../examples/guestfs-recipes.pod:181
3468 "The link below explains the many different possible techniques for getting "
3469 "the last assigned DHCP address of a virtual machine."
3473 #: ../examples/guestfs-recipes.pod:184
3474 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3478 #: ../examples/guestfs-recipes.pod:186
3480 "In the libguestfs source examples directory you will find the latest version "
3481 "of the C<virt-dhcp-address.c> program."
3485 #: ../examples/guestfs-recipes.pod:189
3486 msgid "Get the operating system product name string"
3490 #: ../examples/guestfs-recipes.pod:191
3491 msgid "Save the following script into a file called C<product-name.sh>:"
3495 #: ../examples/guestfs-recipes.pod:193
3500 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3501 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3502 " guestfish --remote inspect-get-product-name \"$root\"\n"
3503 " guestfish --remote exit\n"
3508 #: ../examples/guestfs-recipes.pod:200
3509 msgid "Make the script executable and run it on a named guest:"
3513 #: ../examples/guestfs-recipes.pod:202
3516 " # product-name.sh RHEL60x64\n"
3517 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3522 #: ../examples/guestfs-recipes.pod:205
3524 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3525 "C<xpath> command line tool or from your favourite programming language:"
3529 #: ../examples/guestfs-recipes.pod:209
3532 " # virt-inspector RHEL60x64 > xml\n"
3533 " # xpath '//product_name' < xml\n"
3536 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3537 "(Santiago)</product_name>\n"
3542 #: ../examples/guestfs-recipes.pod:215
3543 msgid "Get the default boot kernel for a Linux VM"
3547 #: ../examples/guestfs-recipes.pod:217
3549 "The link below contains a program to print the default boot kernel for a "
3554 #: ../examples/guestfs-recipes.pod:220
3555 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3559 #: ../examples/guestfs-recipes.pod:222
3561 "It uses Augeas, and the technique is generally applicable for many different "
3566 #: ../examples/guestfs-recipes.pod:229
3567 msgid "listing the user accounts in the guest"
3571 #: ../examples/guestfs-recipes.pod:233
3572 msgid "what repositories is it configured to use"
3576 #: ../examples/guestfs-recipes.pod:237
3577 msgid "what NTP servers does it connect to"
3581 #: ../examples/guestfs-recipes.pod:241
3582 msgid "what were the boot messages last time it booted"
3586 #: ../examples/guestfs-recipes.pod:245
3587 msgid "listing who was logged in recently"
3591 #: ../examples/guestfs-recipes.pod:249
3592 msgid "http://augeas.net/"
3596 #: ../examples/guestfs-recipes.pod:251
3597 msgid "Install RPMs in a guest"
3601 #: ../examples/guestfs-recipes.pod:253
3603 "The link below contains a method to install RPMs in a guest. In fact the "
3604 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3605 "installs them next time the guest is booted. You could use this technique "
3606 "to install vital security updates in an offline guest."
3610 #: ../examples/guestfs-recipes.pod:259
3611 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3615 #: ../examples/guestfs-recipes.pod:261
3616 msgid "List applications installed in a VM"
3620 #: ../examples/guestfs-recipes.pod:263
3621 msgid "Save the following to a file C<list-apps.sh>:"
3625 #: ../examples/guestfs-recipes.pod:265
3630 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3631 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3632 " guestfish --remote inspect-list-applications \"$root\"\n"
3633 " guestfish --remote exit\n"
3638 #: ../examples/guestfs-recipes.pod:272
3640 "Make the file executable and then you can run it on any named virtual "
3645 #: ../examples/guestfs-recipes.pod:275
3648 " # list-apps.sh WinGuest\n"
3650 " app_name: Mozilla Firefox (3.6.12)\n"
3651 " app_display_name: Mozilla Firefox (3.6.12)\n"
3653 " app_version: 3.6.12 (en-GB)\n"
3655 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3656 " app_trans_path:\n"
3657 " app_publisher: Mozilla\n"
3658 " app_url: http://www.mozilla.com/en-GB/\n"
3659 " app_source_package:\n"
3661 " app_description: Mozilla Firefox\n"
3664 " app_name: VLC media player\n"
3665 " app_display_name: VLC media player 1.1.5\n"
3667 " app_version: 1.1.5\n"
3669 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3670 " app_trans_path:\n"
3671 " app_publisher: VideoLAN\n"
3672 " app_url: http://www.videolan.org/\n"
3673 " app_source_package:\n"
3675 " app_description:\n"
3681 #: ../examples/guestfs-recipes.pod:305
3683 "If you want to run the script on disk images (instead of libvirt virtual "
3684 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
3685 "L<virt-inspector(1)>."
3689 #: ../examples/guestfs-recipes.pod:309
3690 msgid "List files and directories in a VM"
3694 #: ../examples/guestfs-recipes.pod:311
3695 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3699 #: ../examples/guestfs-recipes.pod:313
3702 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3707 #: ../examples/guestfs-recipes.pod:315
3708 msgid "List services in a Windows VM"
3712 #: ../examples/guestfs-recipes.pod:317
3714 "The link below contains a script that can be used to list out the services "
3715 "from a Windows VM, and whether those services run at boot time or are loaded "
3720 #: ../examples/guestfs-recipes.pod:321
3721 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3725 #: ../examples/guestfs-recipes.pod:323
3726 msgid "Make a disk image sparse"
3730 #: ../examples/guestfs-recipes.pod:325
3732 "The link below contains some guides for making a disk image sparse (or "
3733 "reintroducing sparseness)."
3737 #: ../examples/guestfs-recipes.pod:328
3738 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3742 #: ../examples/guestfs-recipes.pod:330
3743 msgid "Monitor disk usage over time"
3747 #: ../examples/guestfs-recipes.pod:332
3749 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3750 "The link below contains a guide."
3754 #: ../examples/guestfs-recipes.pod:335
3755 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3759 #: ../examples/guestfs-recipes.pod:337
3760 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3764 #: ../examples/guestfs-recipes.pod:339
3766 "L<guestfish(1)> plus the tools described in the link below can be used to "
3767 "read out the Windows Event Log from any virtual machine running Windows "
3768 "Vista or a later version."
3772 #: ../examples/guestfs-recipes.pod:343
3773 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3777 #: ../examples/guestfs-recipes.pod:345
3778 msgid "Remove root password (Linux)"
3782 #: ../examples/guestfs-recipes.pod:347
3784 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3785 "files. One use is to remove the root password from a Linux guest:"
3789 #: ../examples/guestfs-recipes.pod:350
3792 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3797 #: ../examples/guestfs-recipes.pod:352
3798 msgid "Remove Administrator password (Windows)"
3802 #: ../examples/guestfs-recipes.pod:354
3804 "The link below contains one technique for removing the Administrator "
3805 "password from a Windows VM, or to be more precise, it gives you a command "
3806 "prompt the next time you log in which you can use to bypass any security:"
3810 #: ../examples/guestfs-recipes.pod:359
3811 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3815 #: ../examples/guestfs-recipes.pod:361
3816 msgid "Unpack a live CD"
3820 #: ../examples/guestfs-recipes.pod:363
3822 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3823 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
3824 "layers, as outlined in the guide below."
3828 #: ../examples/guestfs-recipes.pod:367
3829 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3833 #: ../examples/guestfs-recipes.pod:369
3834 msgid "Uploading and downloading files"
3838 #: ../examples/guestfs-recipes.pod:371
3840 "The link below contains general tips on uploading (copying in) and "
3841 "downloading (copying out) files from VMs."
3845 #: ../examples/guestfs-recipes.pod:374
3846 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3850 #: ../examples/guestfs-recipes.pod:376
3851 msgid "Use libguestfs tools on VMware ESX guests"
3855 #: ../examples/guestfs-recipes.pod:378
3857 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3858 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3862 #: ../examples/guestfs-recipes.pod:382
3863 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3867 #: ../examples/guestfs-recipes.pod:386
3869 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, "
3870 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
3871 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
3872 "L<http://libguestfs.org/>."
3876 #: ../examples/guestfs-recipes.pod:403
3877 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3881 #: ../fish/guestfish-actions.pod:1
3886 #: ../fish/guestfish-actions.pod:3
3889 " add-cdrom filename\n"
3894 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
3895 msgid "This function adds a virtual CD-ROM disk image to the guest."
3899 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
3900 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3904 #: ../fish/guestfish-actions.pod:15
3906 "This call checks for the existence of C<filename>. This stops you from "
3907 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3908 "and C<http:> URLs. To specify those, use the general L</config> call "
3913 #: ../fish/guestfish-actions.pod:22
3915 "If you just want to add an ISO file (often you use this as an efficient way "
3916 "to transfer large files into the guest), then you should probably use "
3917 "L</add-drive-ro> instead."
3921 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3923 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
3928 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:991 ../fish/guestfish-actions.pod:1351 ../fish/guestfish-actions.pod:1365 ../fish/guestfish-actions.pod:3116 ../fish/guestfish-actions.pod:3323 ../fish/guestfish-actions.pod:3437 ../fish/guestfish-actions.pod:3485 ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:4409 ../fish/guestfish-actions.pod:4431 ../fish/guestfish-actions.pod:4469 ../fish/guestfish-actions.pod:5118 ../fish/guestfish-actions.pod:5224 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:1508 ../src/guestfs-actions.pod:2007 ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5281 ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7729 ../src/guestfs-actions.pod:7912
3930 "Deprecated functions will not be removed from the API, but the fact that "
3931 "they are deprecated indicates that there are problems with correct use of "
3936 #: ../fish/guestfish-actions.pod:35
3941 #: ../fish/guestfish-actions.pod:37
3946 #: ../fish/guestfish-actions.pod:39
3949 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3955 #: ../fish/guestfish-actions.pod:41
3957 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3958 "It works by connecting to libvirt, requesting the domain and domain XML from "
3959 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3963 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3965 "The number of disks added is returned. This operation is atomic: if an "
3966 "error is returned, then no disks are added."
3970 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3972 "This function does some minimal checks to make sure the libvirt domain is "
3973 "not running (unless C<readonly> is true). In a future version we will try "
3974 "to acquire the libvirt lock on each disk."
3978 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3980 "Disks must be accessible locally. This often means that adding disks from a "
3981 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3982 "unless those disks are accessible via the same device path locally too."
3986 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3988 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3989 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
3990 "default libvirt URI (or one set through an environment variable, see the "
3991 "libvirt documentation for full details)."
3995 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3997 "The optional C<live> flag controls whether this call will try to connect to "
3998 "a running virtual machine C<guestfsd> process if it sees a suitable "
3999 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4000 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4001 "DAEMONS> for more information."
4005 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4007 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4008 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4009 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4014 #: ../fish/guestfish-actions.pod:76
4016 "The other optional parameters are passed directly through to "
4017 "L</add-drive-opts>."
4021 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1999 ../fish/guestfish-actions.pod:3165 ../fish/guestfish-actions.pod:3338 ../fish/guestfish-actions.pod:3473
4023 "This command has one or more optional arguments. See L</OPTIONAL "
4028 #: ../fish/guestfish-actions.pod:81
4033 #: ../fish/guestfish-actions.pod:83
4036 " add-drive filename\n"
4041 #: ../fish/guestfish-actions.pod:85
4043 "This function is the equivalent of calling L</add-drive-opts> with no "
4044 "optional parameters, so the disk is added writable, with the format being "
4045 "detected automatically."
4049 #: ../fish/guestfish-actions.pod:89
4051 "Automatic detection of the format opens you up to a potential security hole "
4052 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4053 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4054 "you should think about replacing calls to this function with calls to "
4055 "L</add-drive-opts>, and specifying the format."
4059 #: ../fish/guestfish-actions.pod:96
4060 msgid "add-drive-opts"
4064 #: ../fish/guestfish-actions.pod:98
4069 #: ../fish/guestfish-actions.pod:100
4072 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4077 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4079 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4080 "The first time you call this function, the disk appears as C</dev/sda>, the "
4081 "second time as C</dev/sdb>, and so on."
4085 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4087 "You don't necessarily need to be root when using libguestfs. However you "
4088 "obviously do need sufficient permissions to access the filename for whatever "
4089 "operations you want to perform (ie. read access if you just want to read the "
4090 "image or write access if you want to modify the image)."
4094 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4095 msgid "This call checks that C<filename> exists."
4099 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4686
4100 msgid "The optional arguments are:"
4104 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4109 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4111 "If true then the image is treated as read-only. Writes are still allowed, "
4112 "but they are stored in a temporary snapshot overlay which is discarded at "
4113 "the end. The disk that you add is not modified."
4117 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4122 #: ../fish/guestfish-actions.pod:127
4124 "This forces the image format. If you omit this (or use L</add-drive> or "
4125 "L</add-drive-ro>) then the format is automatically detected. Possible "
4126 "formats include C<raw> and C<qcow2>."
4130 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4132 "Automatic detection of the format opens you up to a potential security hole "
4133 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4134 "RHBZ#642934. Specifying the format closes this security hole."
4138 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4143 #: ../fish/guestfish-actions.pod:138
4145 "This rarely-used option lets you emulate the behaviour of the deprecated "
4146 "L</add-drive-with-if> call (q.v.)"
4150 #: ../fish/guestfish-actions.pod:145
4151 msgid "add-drive-ro"
4155 #: ../fish/guestfish-actions.pod:147
4160 #: ../fish/guestfish-actions.pod:149
4163 " add-drive-ro filename\n"
4168 #: ../fish/guestfish-actions.pod:151
4170 "This function is the equivalent of calling L</add-drive-opts> with the "
4171 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4172 "is added read-only, with the format being detected automatically."
4176 #: ../fish/guestfish-actions.pod:156
4177 msgid "add-drive-ro-with-if"
4181 #: ../fish/guestfish-actions.pod:158
4184 " add-drive-ro-with-if filename iface\n"
4189 #: ../fish/guestfish-actions.pod:160
4191 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4192 "interface emulation to use at run time."
4196 #: ../fish/guestfish-actions.pod:170
4197 msgid "add-drive-with-if"
4201 #: ../fish/guestfish-actions.pod:172
4204 " add-drive-with-if filename iface\n"
4209 #: ../fish/guestfish-actions.pod:174
4211 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4212 "interface emulation to use at run time."
4216 #: ../fish/guestfish-actions.pod:184
4221 #: ../fish/guestfish-actions.pod:186
4224 " aug-clear augpath\n"
4229 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4231 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4232 "L<augtool(1)> C<clear> command."
4236 #: ../fish/guestfish-actions.pod:191
4241 #: ../fish/guestfish-actions.pod:193
4249 #: ../fish/guestfish-actions.pod:195
4251 "Close the current Augeas handle and free up any resources used by it. After "
4252 "calling this, you have to call L</aug-init> again before you can use any "
4253 "other Augeas functions."
4257 #: ../fish/guestfish-actions.pod:200
4262 #: ../fish/guestfish-actions.pod:202
4265 " aug-defnode name expr val\n"
4270 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4271 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4275 #: ../fish/guestfish-actions.pod:207
4277 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4278 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4279 "containing that single node."
4283 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4285 "On success this returns a pair containing the number of nodes in the "
4286 "nodeset, and a boolean flag if a node was created."
4290 #: ../fish/guestfish-actions.pod:215
4295 #: ../fish/guestfish-actions.pod:217
4298 " aug-defvar name expr\n"
4303 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4305 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4306 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4310 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4312 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4313 "evaluates to something which is not a nodeset."
4317 #: ../fish/guestfish-actions.pod:226
4322 #: ../fish/guestfish-actions.pod:228
4325 " aug-get augpath\n"
4330 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4332 "Look up the value associated with C<path>. If C<path> matches exactly one "
4333 "node, the C<value> is returned."
4337 #: ../fish/guestfish-actions.pod:233
4342 #: ../fish/guestfish-actions.pod:235
4345 " aug-init root flags\n"
4350 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4352 "Create a new Augeas handle for editing configuration files. If there was "
4353 "any previous Augeas handle associated with this guestfs session, then it is "
4358 #: ../fish/guestfish-actions.pod:241
4359 msgid "You must call this before using any other L</aug-*> commands."
4363 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4364 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4368 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4370 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4371 "logical I<or> of the following integers:"
4375 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4376 msgid "C<AUG_SAVE_BACKUP> = 1"
4380 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4381 msgid "Keep the original file with a C<.augsave> extension."
4385 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4386 msgid "C<AUG_SAVE_NEWFILE> = 2"
4390 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4392 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4393 "original. Overrides C<AUG_SAVE_BACKUP>."
4397 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4398 msgid "C<AUG_TYPE_CHECK> = 4"
4402 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4403 msgid "Typecheck lenses."
4407 #: ../fish/guestfish-actions.pod:266
4409 "This option is only useful when debugging Augeas lenses. Use of this option "
4410 "may require additional memory for the libguestfs appliance. You may need to "
4411 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4415 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4416 msgid "C<AUG_NO_STDINC> = 8"
4420 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4421 msgid "Do not use standard load path for modules."
4425 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4426 msgid "C<AUG_SAVE_NOOP> = 16"
4430 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4431 msgid "Make save a no-op, just record what would have been changed."
4435 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4436 msgid "C<AUG_NO_LOAD> = 32"
4440 #: ../fish/guestfish-actions.pod:281
4441 msgid "Do not load the tree in L</aug-init>."
4445 #: ../fish/guestfish-actions.pod:285
4446 msgid "To close the handle, you can call L</aug-close>."
4450 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4451 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4455 #: ../fish/guestfish-actions.pod:289
4460 #: ../fish/guestfish-actions.pod:291
4463 " aug-insert augpath label true|false\n"
4468 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4470 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4471 "or after C<path> (depending on the boolean flag C<before>)."
4475 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4477 "C<path> must match exactly one existing node in the tree, and C<label> must "
4478 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4482 #: ../fish/guestfish-actions.pod:301
4487 #: ../fish/guestfish-actions.pod:303
4495 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4496 msgid "Load files into the tree."
4500 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4501 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4505 #: ../fish/guestfish-actions.pod:310
4510 #: ../fish/guestfish-actions.pod:312
4518 #: ../fish/guestfish-actions.pod:314
4520 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4521 "resulting nodes into alphabetical order."
4525 #: ../fish/guestfish-actions.pod:317
4530 #: ../fish/guestfish-actions.pod:319
4533 " aug-match augpath\n"
4538 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4540 "Returns a list of paths which match the path expression C<path>. The "
4541 "returned paths are sufficiently qualified so that they match exactly one "
4542 "node in the current tree."
4546 #: ../fish/guestfish-actions.pod:325
4551 #: ../fish/guestfish-actions.pod:327
4554 " aug-mv src dest\n"
4559 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4561 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4562 "C<dest> is overwritten if it exists."
4566 #: ../fish/guestfish-actions.pod:332
4571 #: ../fish/guestfish-actions.pod:334
4579 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4580 msgid "Remove C<path> and all of its children."
4584 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4585 msgid "On success this returns the number of entries which were removed."
4589 #: ../fish/guestfish-actions.pod:340
4594 #: ../fish/guestfish-actions.pod:342
4602 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4603 msgid "This writes all pending changes to disk."
4607 #: ../fish/guestfish-actions.pod:346
4609 "The flags which were passed to L</aug-init> affect exactly how files are "
4614 #: ../fish/guestfish-actions.pod:349
4619 #: ../fish/guestfish-actions.pod:351
4622 " aug-set augpath val\n"
4627 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4628 msgid "Set the value associated with C<path> to C<val>."
4632 #: ../fish/guestfish-actions.pod:355
4634 "In the Augeas API, it is possible to clear a node by setting the value to "
4635 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4636 "this call. Instead you must use the L</aug-clear> call."
4640 #: ../fish/guestfish-actions.pod:360
4645 #: ../fish/guestfish-actions.pod:362
4648 " available 'groups ...'\n"
4653 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4655 "This command is used to check the availability of some groups of "
4656 "functionality in the appliance, which not all builds of the libguestfs "
4657 "appliance will be able to provide."
4661 #: ../fish/guestfish-actions.pod:368
4663 "The libguestfs groups, and the functions that those groups correspond to, "
4664 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4665 "runtime by calling L</available-all-groups>."
4669 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4671 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4672 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4673 "and Augeas (configuration file editing) functions."
4677 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4678 msgid "The command returns no error if I<all> requested groups are available."
4682 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4684 "It fails with an error if one or more of the requested groups is unavailable "
4689 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4691 "If an unknown group name is included in the list of groups then an error is "
4696 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4701 #: ../fish/guestfish-actions.pod:392
4702 msgid "You must call L</launch> before calling this function."
4706 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4708 "The reason is because we don't know what groups are supported by the "
4709 "appliance/daemon until it is running and can be queried."
4713 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4715 "If a group of functions is available, this does not necessarily mean that "
4716 "they will work. You still have to check for errors when calling individual "
4717 "API functions even if they are available."
4721 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4723 "It is usually the job of distro packagers to build complete functionality "
4724 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4725 "with all requirements satisfied, will support everything."
4729 #: ../fish/guestfish-actions.pod:414
4731 "This call was added in version C<1.0.80>. In previous versions of "
4732 "libguestfs all you could do would be to speculatively execute a command to "
4733 "find out if the daemon implemented it. See also L</version>."
4737 #: ../fish/guestfish-actions.pod:421
4738 msgid "available-all-groups"
4742 #: ../fish/guestfish-actions.pod:423
4745 " available-all-groups\n"
4750 #: ../fish/guestfish-actions.pod:425
4752 "This command returns a list of all optional groups that this daemon knows "
4753 "about. Note this returns both supported and unsupported groups. To find "
4754 "out which ones the daemon can actually support you have to call "
4755 "L</available> on each member of the returned list."
4759 #: ../fish/guestfish-actions.pod:431
4760 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4764 #: ../fish/guestfish-actions.pod:433
4769 #: ../fish/guestfish-actions.pod:435
4772 " base64-in (base64file|-) filename\n"
4777 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4778 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4782 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:867 ../fish/guestfish-actions.pod:886 ../fish/guestfish-actions.pod:1260 ../fish/guestfish-actions.pod:4689 ../fish/guestfish-actions.pod:4701 ../fish/guestfish-actions.pod:4712 ../fish/guestfish-actions.pod:4723 ../fish/guestfish-actions.pod:4775 ../fish/guestfish-actions.pod:4784 ../fish/guestfish-actions.pod:4838 ../fish/guestfish-actions.pod:4861
4783 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4787 #: ../fish/guestfish-actions.pod:442
4792 #: ../fish/guestfish-actions.pod:444
4795 " base64-out filename (base64file|-)\n"
4800 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
4802 "This command downloads the contents of C<filename>, writing it out to local "
4803 "file C<base64file> encoded as base64."
4807 #: ../fish/guestfish-actions.pod:451
4808 msgid "blockdev-flushbufs"
4812 #: ../fish/guestfish-actions.pod:453
4815 " blockdev-flushbufs device\n"
4820 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
4821 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4825 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513 ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532 ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
4826 msgid "This uses the L<blockdev(8)> command."
4830 #: ../fish/guestfish-actions.pod:460
4831 msgid "blockdev-getbsz"
4835 #: ../fish/guestfish-actions.pod:462
4838 " blockdev-getbsz device\n"
4843 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
4844 msgid "This returns the block size of a device."
4848 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
4850 "(Note this is different from both I<size in blocks> and I<filesystem block "
4855 #: ../fish/guestfish-actions.pod:471
4856 msgid "blockdev-getro"
4860 #: ../fish/guestfish-actions.pod:473
4863 " blockdev-getro device\n"
4868 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
4870 "Returns a boolean indicating if the block device is read-only (true if "
4871 "read-only, false if not)."
4875 #: ../fish/guestfish-actions.pod:480
4876 msgid "blockdev-getsize64"
4880 #: ../fish/guestfish-actions.pod:482
4883 " blockdev-getsize64 device\n"
4888 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
4889 msgid "This returns the size of the device in bytes."
4893 #: ../fish/guestfish-actions.pod:486
4894 msgid "See also L</blockdev-getsz>."
4898 #: ../fish/guestfish-actions.pod:490
4899 msgid "blockdev-getss"
4903 #: ../fish/guestfish-actions.pod:492
4906 " blockdev-getss device\n"
4911 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
4913 "This returns the size of sectors on a block device. Usually 512, but can be "
4914 "larger for modern devices."
4918 #: ../fish/guestfish-actions.pod:497
4919 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4923 #: ../fish/guestfish-actions.pod:502
4924 msgid "blockdev-getsz"
4928 #: ../fish/guestfish-actions.pod:504
4931 " blockdev-getsz device\n"
4936 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
4938 "This returns the size of the device in units of 512-byte sectors (even if "
4939 "the sectorsize isn't 512 bytes ... weird)."
4943 #: ../fish/guestfish-actions.pod:509
4945 "See also L</blockdev-getss> for the real sector size of the device, and "
4946 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4950 #: ../fish/guestfish-actions.pod:515
4951 msgid "blockdev-rereadpt"
4955 #: ../fish/guestfish-actions.pod:517
4958 " blockdev-rereadpt device\n"
4963 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
4964 msgid "Reread the partition table on C<device>."
4968 #: ../fish/guestfish-actions.pod:523
4969 msgid "blockdev-setbsz"
4973 #: ../fish/guestfish-actions.pod:525
4976 " blockdev-setbsz device blocksize\n"
4981 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
4982 msgid "This sets the block size of a device."
4986 #: ../fish/guestfish-actions.pod:534
4987 msgid "blockdev-setro"
4991 #: ../fish/guestfish-actions.pod:536
4994 " blockdev-setro device\n"
4999 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
5000 msgid "Sets the block device named C<device> to read-only."
5004 #: ../fish/guestfish-actions.pod:542
5005 msgid "blockdev-setrw"
5009 #: ../fish/guestfish-actions.pod:544
5012 " blockdev-setrw device\n"
5017 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
5018 msgid "Sets the block device named C<device> to read-write."
5022 #: ../fish/guestfish-actions.pod:550
5023 msgid "btrfs-filesystem-resize"
5027 #: ../fish/guestfish-actions.pod:552
5030 " btrfs-filesystem-resize mountpoint [size:..]\n"
5035 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
5036 msgid "This command resizes a btrfs filesystem."
5040 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
5042 "Note that unlike other resize calls, the filesystem has to be mounted and "
5043 "the parameter is the mountpoint not the device (this is a requirement of "
5048 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3448 ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5220
5049 msgid "The optional parameters are:"
5053 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3452 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5224
5058 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5060 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
5061 "resized to the maximum size."
5065 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
5066 msgid "See also L<btrfs(8)>."
5070 #: ../fish/guestfish-actions.pod:575
5071 msgid "case-sensitive-path"
5075 #: ../fish/guestfish-actions.pod:577
5078 " case-sensitive-path path\n"
5083 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5085 "This can be used to resolve case insensitive paths on a filesystem which is "
5086 "case sensitive. The use case is to resolve paths which you have read from "
5087 "Windows configuration files or the Windows Registry, to the true path."
5091 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5093 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5094 "(and probably others), which is that although the underlying filesystem is "
5095 "case-insensitive, the driver exports the filesystem to Linux as "
5100 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
5102 "One consequence of this is that special directories such as C<c:\\windows> "
5103 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5104 "precise details of how they were created. In Windows itself this would not "
5109 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
5111 "Bug or feature? You decide: "
5112 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5116 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
5118 "This function resolves the true case of each element in the path and returns "
5119 "the case-sensitive path."
5123 #: ../fish/guestfish-actions.pod:601
5125 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
5126 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5127 "how the directories were originally created under Windows)."
5131 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
5132 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5136 #: ../fish/guestfish-actions.pod:609
5137 msgid "See also L</realpath>."
5141 #: ../fish/guestfish-actions.pod:611
5146 #: ../fish/guestfish-actions.pod:613
5154 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3868 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5863
5155 msgid "Return the contents of the file named C<path>."
5159 #: ../fish/guestfish-actions.pod:617
5161 "Note that this function cannot correctly handle binary files (specifically, "
5162 "files containing C<\\0> character which is treated as end of string). For "
5163 "those you need to use the L</read-file> or L</download> functions which have "
5164 "a more complex interface."
5168 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757 ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:955 ../fish/guestfish-actions.pod:1022 ../fish/guestfish-actions.pod:1032 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:1591 ../fish/guestfish-actions.pod:1606 ../fish/guestfish-actions.pod:1616 ../fish/guestfish-actions.pod:1635 ../fish/guestfish-actions.pod:3738 ../fish/guestfish-actions.pod:3753 ../fish/guestfish-actions.pod:3829 ../fish/guestfish-actions.pod:3846 ../fish/guestfish-actions.pod:3861 ../fish/guestfish-actions.pod:4530 ../fish/guestfish-actions.pod:4576 ../fish/guestfish-actions.pod:4661 ../fish/guestfish-actions.pod:4676 ../fish/guestfish-actions.pod:5082 ../fish/guestfish-actions.pod:5094 ../fish/guestfish-actions.pod:5112 ../fish/guestfish-actions.pod:5129 ../fish/guestfish-actions.pod:5139 ../fish/guestfish-actions.pod:5196 ../fish/guestfish-actions.pod:5206 ../fish/guestfish-actions.pod:5235 ../fish/guestfish-actions.pod:5245 ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1462 ../src/guestfs-actions.pod:1565 ../src/guestfs-actions.pod:1584 ../src/guestfs-actions.pod:1830 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2320 ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5671 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5828 ../src/guestfs-actions.pod:5852 ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:7004 ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7693 ../src/guestfs-actions.pod:7713 ../src/guestfs-actions.pod:7746 ../src/guestfs-actions.pod:7765 ../src/guestfs-actions.pod:7784 ../src/guestfs-actions.pod:7878 ../src/guestfs-actions.pod:7897 ../src/guestfs-actions.pod:7943 ../src/guestfs-actions.pod:7962
5170 "Because of the message protocol, there is a transfer limit of somewhere "
5171 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5175 #: ../fish/guestfish-actions.pod:625
5180 #: ../fish/guestfish-actions.pod:627
5183 " checksum csumtype path\n"
5188 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
5189 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5193 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5195 "The type of checksum to compute is given by the C<csumtype> parameter which "
5196 "must have one of the following values:"
5200 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5205 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5207 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5212 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5217 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5218 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5222 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5227 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5228 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5232 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5237 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5238 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5242 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5247 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5248 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5252 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5257 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5258 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5262 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5267 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5268 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5272 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5273 msgid "The checksum is returned as a printable string."
5277 #: ../fish/guestfish-actions.pod:670
5278 msgid "To get the checksum for a device, use L</checksum-device>."
5282 #: ../fish/guestfish-actions.pod:672
5283 msgid "To get the checksums for many files, use L</checksums-out>."
5287 #: ../fish/guestfish-actions.pod:674
5288 msgid "checksum-device"
5292 #: ../fish/guestfish-actions.pod:676
5295 " checksum-device csumtype device\n"
5300 #: ../fish/guestfish-actions.pod:678
5302 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5303 "device named C<device>. For the types of checksums supported see the "
5304 "L</checksum> command."
5308 #: ../fish/guestfish-actions.pod:682
5309 msgid "checksums-out"
5313 #: ../fish/guestfish-actions.pod:684
5316 " checksums-out csumtype directory (sumsfile|-)\n"
5321 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5323 "This command computes the checksums of all regular files in C<directory> and "
5324 "then emits a list of those checksums to the local output file C<sumsfile>."
5328 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5330 "This can be used for verifying the integrity of a virtual machine. However "
5331 "to be properly secure you should pay attention to the output of the checksum "
5332 "command (it uses the ones from GNU coreutils). In particular when the "
5333 "filename is not printable, coreutils uses a special backslash syntax. For "
5334 "more information, see the GNU coreutils info file."
5338 #: ../fish/guestfish-actions.pod:700
5343 #: ../fish/guestfish-actions.pod:702
5346 " chmod mode path\n"
5351 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5353 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5358 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5360 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5361 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5366 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3091 ../fish/guestfish-actions.pod:3230 ../fish/guestfish-actions.pod:3240 ../fish/guestfish-actions.pod:3250 ../src/guestfs-actions.pod:1064 ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4826 ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4864
5367 msgid "The mode actually set is affected by the umask."
5371 #: ../fish/guestfish-actions.pod:713
5376 #: ../fish/guestfish-actions.pod:715
5379 " chown owner group path\n"
5384 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5385 msgid "Change the file owner to C<owner> and group to C<group>."
5389 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2526 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3688
5391 "Only numeric uid and gid are supported. If you want to use names, you will "
5392 "need to locate and parse the password file yourself (Augeas support makes "
5393 "this relatively easy)."
5397 #: ../fish/guestfish-actions.pod:723
5402 #: ../fish/guestfish-actions.pod:725
5405 " command 'arguments ...'\n"
5410 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5412 "This call runs a command from the guest filesystem. The filesystem must be "
5413 "mounted, and must contain a compatible operating system (ie. something "
5414 "Linux, with the same or compatible processor architecture)."
5418 #: ../fish/guestfish-actions.pod:732
5420 "The single parameter is an argv-style list of arguments. The first element "
5421 "is the name of the program to run. Subsequent elements are parameters. The "
5422 "list must be non-empty (ie. must contain a program name). Note that the "
5423 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5427 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5428 msgid "The return value is anything printed to I<stdout> by the command."
5432 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5434 "If the command returns a non-zero exit status, then this function returns an "
5435 "error message. The error message string is the content of I<stderr> from "
5440 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5442 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5443 "C</bin>. If you require a program from another location, you should provide "
5444 "the full path in the first parameter."
5448 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5450 "Shared libraries and data files required by the program must be available on "
5451 "filesystems which are mounted in the correct places. It is the caller's "
5452 "responsibility to ensure all filesystems that are needed are mounted at the "
5457 #: ../fish/guestfish-actions.pod:760
5458 msgid "command-lines"
5462 #: ../fish/guestfish-actions.pod:762
5465 " command-lines 'arguments ...'\n"
5470 #: ../fish/guestfish-actions.pod:764
5471 msgid "This is the same as L</command>, but splits the result into a list of lines."
5475 #: ../fish/guestfish-actions.pod:767
5476 msgid "See also: L</sh-lines>"
5480 #: ../fish/guestfish-actions.pod:772
5485 #: ../fish/guestfish-actions.pod:774
5488 " config qemuparam qemuvalue\n"
5493 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5495 "This can be used to add arbitrary qemu command line parameters of the form "
5496 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5497 "setting some parameters which would interfere with parameters that we use."
5501 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5502 msgid "The first character of C<param> string must be a C<-> (dash)."
5506 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
5507 msgid "C<value> can be NULL."
5511 #: ../fish/guestfish-actions.pod:785
5516 #: ../fish/guestfish-actions.pod:787
5519 " copy-size src dest size\n"
5524 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
5526 "This command copies exactly C<size> bytes from one source device or file "
5527 "C<src> to another destination device or file C<dest>."
5531 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
5533 "Note this will fail if the source is too short or if the destination is not "
5538 #: ../fish/guestfish-actions.pod:795
5543 #: ../fish/guestfish-actions.pod:797
5551 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
5553 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5554 "destination filename or destination directory."
5558 #: ../fish/guestfish-actions.pod:802
5563 #: ../fish/guestfish-actions.pod:804
5571 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
5573 "This copies a file or directory from C<src> to C<dest> recursively using the "
5578 #: ../fish/guestfish-actions.pod:809
5583 #: ../fish/guestfish-actions.pod:811
5591 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
5593 "This command copies from one source device or file C<src> to another "
5594 "destination device or file C<dest>. Normally you would use this to copy to "
5595 "or from a device or partition, for example to duplicate a filesystem."
5599 #: ../fish/guestfish-actions.pod:818
5601 "If the destination is a device, it must be as large or larger than the "
5602 "source file or device, otherwise the copy will fail. This command cannot do "
5603 "partial copies (see L</copy-size>)."
5607 #: ../fish/guestfish-actions.pod:822
5612 #: ../fish/guestfish-actions.pod:824
5620 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
5621 msgid "This command runs the C<df> command to report disk space used."
5625 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
5627 "This command is mostly useful for interactive sessions. It is I<not> "
5628 "intended that you try to parse the output string. Use L</statvfs> from "
5633 #: ../fish/guestfish-actions.pod:832
5638 #: ../fish/guestfish-actions.pod:834
5646 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
5648 "This command runs the C<df -h> command to report disk space used in "
5649 "human-readable format."
5653 #: ../fish/guestfish-actions.pod:843
5658 #: ../fish/guestfish-actions.pod:845
5666 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
5668 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5669 "This is sometimes useful for extended debugging of problems."
5673 #: ../fish/guestfish-actions.pod:851
5675 "Another way to get the same information is to enable verbose messages with "
5676 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5677 "before running the program."
5681 #: ../fish/guestfish-actions.pod:856
5686 #: ../fish/guestfish-actions.pod:858
5689 " download remotefilename (filename|-)\n"
5694 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873 ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
5696 "Download file C<remotefilename> and save it as C<filename> on the local "
5701 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4834 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7263
5702 msgid "C<filename> can also be a named pipe."
5706 #: ../fish/guestfish-actions.pod:865
5707 msgid "See also L</upload>, L</cat>."
5711 #: ../fish/guestfish-actions.pod:869
5712 msgid "download-offset"
5716 #: ../fish/guestfish-actions.pod:871
5719 " download-offset remotefilename (filename|-) offset size\n"
5724 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
5726 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5727 "region must be within the file or device)."
5731 #: ../fish/guestfish-actions.pod:879
5733 "Note that there is no limit on the amount of data that can be downloaded "
5734 "with this call, unlike with L</pread>, and this call always reads the full "
5735 "amount unless an error occurs."
5739 #: ../fish/guestfish-actions.pod:884
5740 msgid "See also L</download>, L</pread>."
5744 #: ../fish/guestfish-actions.pod:888
5749 #: ../fish/guestfish-actions.pod:890
5752 " drop-caches whattodrop\n"
5757 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
5759 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5760 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5761 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5765 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
5766 msgid "Setting C<whattodrop> to 3 should drop everything."
5770 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
5772 "This automatically calls L<sync(2)> before the operation, so that the "
5773 "maximum guest memory is freed."
5777 #: ../fish/guestfish-actions.pod:902
5782 #: ../fish/guestfish-actions.pod:904
5790 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
5792 "This command runs the C<du -s> command to estimate file space usage for "
5797 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
5799 "C<path> can be a file or a directory. If C<path> is a directory then the "
5800 "estimate includes the contents of the directory and all subdirectories "
5805 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
5806 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5810 #: ../fish/guestfish-actions.pod:916
5815 #: ../fish/guestfish-actions.pod:918
5818 " e2fsck-f device\n"
5823 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
5825 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5826 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5831 #: ../fish/guestfish-actions.pod:924
5833 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
5834 "should use L</fsck>."
5838 #: ../fish/guestfish-actions.pod:927
5843 #: ../fish/guestfish-actions.pod:929
5846 " echo-daemon 'words ...'\n"
5851 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
5853 "This command concatenates the list of C<words> passed with single spaces "
5854 "between them and returns the resulting string."
5858 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
5859 msgid "You can use this command to test the connection through to the daemon."
5863 #: ../fish/guestfish-actions.pod:936
5864 msgid "See also L</ping-daemon>."
5868 #: ../fish/guestfish-actions.pod:938
5873 #: ../fish/guestfish-actions.pod:940
5876 " egrep regex path\n"
5881 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
5882 msgid "This calls the external C<egrep> program and returns the matching lines."
5886 #: ../fish/guestfish-actions.pod:948
5891 #: ../fish/guestfish-actions.pod:950
5894 " egrepi regex path\n"
5899 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
5900 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5904 #: ../fish/guestfish-actions.pod:958
5909 #: ../fish/guestfish-actions.pod:960
5912 " equal file1 file2\n"
5917 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
5919 "This compares the two files C<file1> and C<file2> and returns true if their "
5920 "content is exactly equal, or false otherwise."
5924 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
5925 msgid "The external L<cmp(1)> program is used for the comparison."
5929 #: ../fish/guestfish-actions.pod:967
5934 #: ../fish/guestfish-actions.pod:969
5942 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
5944 "This returns C<true> if and only if there is a file, directory (or anything) "
5945 "with the given C<path> name."
5949 #: ../fish/guestfish-actions.pod:974
5950 msgid "See also L</is-file>, L</is-dir>, L</stat>."
5954 #: ../fish/guestfish-actions.pod:976
5959 #: ../fish/guestfish-actions.pod:978
5962 " fallocate path len\n"
5967 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999 ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:1531
5969 "This command preallocates a file (containing zero bytes) named C<path> of "
5970 "size C<len> bytes. If the file exists already, it is overwritten."
5974 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1516
5976 "Do not confuse this with the guestfish-specific C<alloc> command which "
5977 "allocates a file in the host and attaches it as a device."
5981 #: ../fish/guestfish-actions.pod:988
5983 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
5988 #: ../fish/guestfish-actions.pod:995
5993 #: ../fish/guestfish-actions.pod:997
5996 " fallocate64 path len\n"
6001 #: ../fish/guestfish-actions.pod:1003
6003 "Note that this call allocates disk blocks for the file. To create a sparse "
6004 "file use L</truncate-size> instead."
6008 #: ../fish/guestfish-actions.pod:1006
6010 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6011 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6012 "maximum size of files created through that call to 1GB."
6016 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
6018 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6019 "commands which create a file in the host and attach it as a device."
6023 #: ../fish/guestfish-actions.pod:1015
6028 #: ../fish/guestfish-actions.pod:1017
6031 " fgrep pattern path\n"
6036 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
6037 msgid "This calls the external C<fgrep> program and returns the matching lines."
6041 #: ../fish/guestfish-actions.pod:1025
6046 #: ../fish/guestfish-actions.pod:1027
6049 " fgrepi pattern path\n"
6054 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
6055 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6059 #: ../fish/guestfish-actions.pod:1035
6064 #: ../fish/guestfish-actions.pod:1037
6072 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
6074 "This call uses the standard L<file(1)> command to determine the type or "
6075 "contents of the file."
6079 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
6081 "This call will also transparently look inside various types of compressed "
6086 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
6088 "The exact command which runs is C<file -zb path>. Note in particular that "
6089 "the filename is not prepended to the output (the I<-b> option)."
6093 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
6095 "The output depends on the output of the underlying L<file(1)> command and it "
6096 "can change in future in ways beyond our control. In other words, the output "
6097 "is not guaranteed by the ABI."
6101 #: ../fish/guestfish-actions.pod:1053
6103 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6104 "(etc), L</is-zero>."
6108 #: ../fish/guestfish-actions.pod:1056
6109 msgid "file-architecture"
6113 #: ../fish/guestfish-actions.pod:1058
6116 " file-architecture filename\n"
6121 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
6123 "This detects the architecture of the binary C<filename>, and returns it if "
6128 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
6129 msgid "Currently defined architectures are:"
6133 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
6138 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
6140 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6141 "irrespective of the precise processor requirements of the binary."
6145 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
6150 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
6151 msgid "64 bit x86-64."
6155 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
6160 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
6161 msgid "32 bit SPARC."
6165 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
6170 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
6171 msgid "64 bit SPARC V9 and above."
6175 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
6180 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
6181 msgid "Intel Itanium."
6185 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
6190 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
6191 msgid "32 bit Power PC."
6195 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
6200 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
6201 msgid "64 bit Power PC."
6205 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
6206 msgid "Libguestfs may return other architecture strings in future."
6210 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6211 msgid "The function works on at least the following types of files:"
6215 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6216 msgid "many types of Un*x and Linux binary"
6220 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6221 msgid "many types of Un*x and Linux shared library"
6225 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6226 msgid "Windows Win32 and Win64 binaries"
6230 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6231 msgid "Windows Win32 and Win64 DLLs"
6235 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6236 msgid "Win32 binaries and DLLs return C<i386>."
6240 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6241 msgid "Win64 binaries and DLLs return C<x86_64>."
6245 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6246 msgid "Linux kernel modules"
6250 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6251 msgid "Linux new-style initrd images"
6255 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6256 msgid "some non-x86 Linux vmlinuz kernels"
6260 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6261 msgid "What it can't do currently:"
6265 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6266 msgid "static libraries (libfoo.a)"
6270 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6271 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6275 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6276 msgid "x86 Linux vmlinuz kernels"
6280 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6282 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6283 "compressed code, and are horribly hard to unpack. If you want to find the "
6284 "architecture of a kernel, use the architecture of the associated initrd or "
6285 "kernel module(s) instead."
6289 #: ../fish/guestfish-actions.pod:1161
6294 #: ../fish/guestfish-actions.pod:1163
6302 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6303 msgid "This command returns the size of C<file> in bytes."
6307 #: ../fish/guestfish-actions.pod:1167
6309 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6310 "L</is-file> etc. To get the size of block devices, use "
6311 "L</blockdev-getsize64>."
6315 #: ../fish/guestfish-actions.pod:1171
6320 #: ../fish/guestfish-actions.pod:1173
6323 " fill c len path\n"
6328 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6330 "This command creates a new file called C<path>. The initial content of the "
6331 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6336 #: ../fish/guestfish-actions.pod:1179
6338 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6339 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6344 #: ../fish/guestfish-actions.pod:1184
6345 msgid "fill-pattern"
6349 #: ../fish/guestfish-actions.pod:1186
6352 " fill-pattern pattern len path\n"
6357 #: ../fish/guestfish-actions.pod:1188
6359 "This function is like L</fill> except that it creates a new file of length "
6360 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6361 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6366 #: ../fish/guestfish-actions.pod:1193
6371 #: ../fish/guestfish-actions.pod:1195
6379 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6381 "This command lists out all files and directories, recursively, starting at "
6382 "C<directory>. It is essentially equivalent to running the shell command "
6383 "C<find directory -print> but some post-processing happens on the output, "
6388 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6390 "This returns a list of strings I<without any prefix>. Thus if the directory "
6395 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6405 #: ../fish/guestfish-actions.pod:1209
6406 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6410 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6421 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6422 msgid "If C<directory> is not a directory, then this command returns an error."
6426 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6427 msgid "The returned list is sorted."
6431 #: ../fish/guestfish-actions.pod:1222
6432 msgid "See also L</find0>."
6436 #: ../fish/guestfish-actions.pod:1227
6441 #: ../fish/guestfish-actions.pod:1229
6444 " find0 directory (files|-)\n"
6449 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6451 "This command lists out all files and directories, recursively, starting at "
6452 "C<directory>, placing the resulting list in the external file called "
6457 #: ../fish/guestfish-actions.pod:1235
6458 msgid "This command works the same way as L</find> with the following exceptions:"
6462 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6463 msgid "The resulting list is written to an external file."
6467 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6469 "Items (filenames) in the result are separated by C<\\0> characters. See "
6470 "L<find(1)> option I<-print0>."
6474 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6475 msgid "This command is not limited in the number of names that it can return."
6479 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6480 msgid "The result list is not sorted."
6484 #: ../fish/guestfish-actions.pod:1262
6485 msgid "findfs-label"
6489 #: ../fish/guestfish-actions.pod:1264
6492 " findfs-label label\n"
6497 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
6499 "This command searches the filesystems and returns the one which has the "
6500 "given label. An error is returned if no such filesystem can be found."
6504 #: ../fish/guestfish-actions.pod:1270
6505 msgid "To find the label of a filesystem, use L</vfs-label>."
6509 #: ../fish/guestfish-actions.pod:1272
6514 #: ../fish/guestfish-actions.pod:1274
6517 " findfs-uuid uuid\n"
6522 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
6524 "This command searches the filesystems and returns the one which has the "
6525 "given UUID. An error is returned if no such filesystem can be found."
6529 #: ../fish/guestfish-actions.pod:1280
6530 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6534 #: ../fish/guestfish-actions.pod:1282
6539 #: ../fish/guestfish-actions.pod:1284
6542 " fsck fstype device\n"
6547 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
6549 "This runs the filesystem checker (fsck) on C<device> which should have "
6550 "filesystem type C<fstype>."
6554 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
6556 "The returned integer is the status. See L<fsck(8)> for the list of status "
6557 "codes from C<fsck>."
6561 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
6562 msgid "Multiple status codes can be summed together."
6566 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6568 "A non-zero return code can mean \"success\", for example if errors have been "
6569 "corrected on the filesystem."
6573 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6574 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6578 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
6579 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6583 #: ../fish/guestfish-actions.pod:1314
6588 #: ../fish/guestfish-actions.pod:1316
6596 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
6598 "Return the additional kernel options which are added to the guest kernel "
6603 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
6604 msgid "If C<NULL> then no options are added."
6608 #: ../fish/guestfish-actions.pod:1323
6609 msgid "get-attach-method"
6613 #: ../fish/guestfish-actions.pod:1325
6616 " get-attach-method\n"
6621 #: ../fish/guestfish-actions.pod:1327
6622 msgid "Return the current attach method. See L</set-attach-method>."
6626 #: ../fish/guestfish-actions.pod:1329
6627 msgid "get-autosync"
6631 #: ../fish/guestfish-actions.pod:1331
6639 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
6640 msgid "Get the autosync flag."
6644 #: ../fish/guestfish-actions.pod:1335
6649 #: ../fish/guestfish-actions.pod:1337
6657 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
6658 msgid "Return the direct appliance mode flag."
6662 #: ../fish/guestfish-actions.pod:1341
6667 #: ../fish/guestfish-actions.pod:1343
6670 " get-e2label device\n"
6675 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2011
6676 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6680 #: ../fish/guestfish-actions.pod:1348
6682 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
6687 #: ../fish/guestfish-actions.pod:1355
6692 #: ../fish/guestfish-actions.pod:1357
6695 " get-e2uuid device\n"
6700 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2032
6701 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6705 #: ../fish/guestfish-actions.pod:1362
6707 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
6712 #: ../fish/guestfish-actions.pod:1369
6717 #: ../fish/guestfish-actions.pod:1371
6725 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
6726 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6730 #: ../fish/guestfish-actions.pod:1376
6732 "If L</set-memsize> was not called on this handle, and if "
6733 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6734 "value for memsize."
6738 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437 ../fish/guestfish-actions.pod:4194 ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6450
6739 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6743 #: ../fish/guestfish-actions.pod:1383
6748 #: ../fish/guestfish-actions.pod:1385
6756 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
6757 msgid "This returns the enable network flag."
6761 #: ../fish/guestfish-actions.pod:1389
6766 #: ../fish/guestfish-actions.pod:1391
6774 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
6775 msgid "Return the current search path."
6779 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
6781 "This is always non-NULL. If it wasn't set already, then this will return "
6786 #: ../fish/guestfish-actions.pod:1398
6791 #: ../fish/guestfish-actions.pod:1400
6799 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
6800 msgid "This returns the process group flag."
6804 #: ../fish/guestfish-actions.pod:1404
6809 #: ../fish/guestfish-actions.pod:1406
6814 #: ../fish/guestfish-actions.pod:1408
6822 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
6824 "Return the process ID of the qemu subprocess. If there is no qemu "
6825 "subprocess, then this will return an error."
6829 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
6830 msgid "This is an internal call used for debugging and testing."
6834 #: ../fish/guestfish-actions.pod:1415
6839 #: ../fish/guestfish-actions.pod:1417
6847 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
6848 msgid "Return the current qemu binary."
6852 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
6854 "This is always non-NULL. If it wasn't set already, then this will return "
6855 "the default qemu binary name."
6859 #: ../fish/guestfish-actions.pod:1424
6860 msgid "get-recovery-proc"
6864 #: ../fish/guestfish-actions.pod:1426
6867 " get-recovery-proc\n"
6872 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
6873 msgid "Return the recovery process enabled flag."
6877 #: ../fish/guestfish-actions.pod:1430
6882 #: ../fish/guestfish-actions.pod:1432
6890 #: ../fish/guestfish-actions.pod:1434
6892 "This returns the current setting of the selinux flag which is passed to the "
6893 "appliance at boot time. See L</set-selinux>."
6897 #: ../fish/guestfish-actions.pod:1440
6902 #: ../fish/guestfish-actions.pod:1442
6910 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
6912 "This returns the current state as an opaque integer. This is only useful "
6913 "for printing debug and internal error messages."
6917 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2393 ../fish/guestfish-actions.pod:2411 ../fish/guestfish-actions.pod:2449 ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3582
6918 msgid "For more information on states, see L<guestfs(3)>."
6922 #: ../fish/guestfish-actions.pod:1449
6927 #: ../fish/guestfish-actions.pod:1451
6935 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
6936 msgid "Return the command trace flag."
6940 #: ../fish/guestfish-actions.pod:1455
6945 #: ../fish/guestfish-actions.pod:1457
6953 #: ../fish/guestfish-actions.pod:1459
6955 "Return the current umask. By default the umask is C<022> unless it has been "
6956 "set by calling L</umask>."
6960 #: ../fish/guestfish-actions.pod:1462
6965 #: ../fish/guestfish-actions.pod:1464
6973 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
6974 msgid "This returns the verbose messages flag."
6978 #: ../fish/guestfish-actions.pod:1468
6983 #: ../fish/guestfish-actions.pod:1470
6991 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
6992 msgid "This gets the SELinux security context of the daemon."
6996 #: ../fish/guestfish-actions.pod:1474
6997 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7001 #: ../fish/guestfish-actions.pod:1477
7006 #: ../fish/guestfish-actions.pod:1479
7009 " getxattr path name\n"
7014 #: ../fish/guestfish-actions.pod:1481
7016 "Get a single extended attribute from file C<path> named C<name>. This call "
7017 "follows symlinks. If you want to lookup an extended attribute for the "
7018 "symlink itself, use L</lgetxattr>."
7022 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2538
7024 "Normally it is better to get all extended attributes from a file in one go "
7025 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7026 "buggy and do not provide a way to list out attributes. For these "
7027 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7028 "attributes you want in advance and call this function."
7032 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3715
7034 "Extended attribute values are blobs of binary data. If there is no extended "
7035 "attribute named C<name>, this returns an error."
7039 #: ../fish/guestfish-actions.pod:1495
7040 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7044 #: ../fish/guestfish-actions.pod:1497
7049 #: ../fish/guestfish-actions.pod:1499
7057 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
7058 msgid "This call lists the extended attributes of the file or directory C<path>."
7062 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
7064 "At the system call level, this is a combination of the L<listxattr(2)> and "
7065 "L<getxattr(2)> calls."
7069 #: ../fish/guestfish-actions.pod:1507
7070 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7074 #: ../fish/guestfish-actions.pod:1509
7079 #: ../fish/guestfish-actions.pod:1511
7082 " glob-expand pattern\n"
7087 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
7089 "This command searches for all the pathnames matching C<pattern> according to "
7090 "the wildcard expansion rules used by the shell."
7094 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
7095 msgid "If no paths match, then this returns an empty list (note: not an error)."
7099 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
7101 "It is just a wrapper around the C L<glob(3)> function with flags "
7102 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7106 #: ../fish/guestfish-actions.pod:1524
7111 #: ../fish/guestfish-actions.pod:1526
7114 " grep regex path\n"
7119 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
7120 msgid "This calls the external C<grep> program and returns the matching lines."
7124 #: ../fish/guestfish-actions.pod:1534
7129 #: ../fish/guestfish-actions.pod:1536
7132 " grepi regex path\n"
7137 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
7138 msgid "This calls the external C<grep -i> program and returns the matching lines."
7142 #: ../fish/guestfish-actions.pod:1544
7143 msgid "grub-install"
7147 #: ../fish/guestfish-actions.pod:1546
7150 " grub-install root device\n"
7155 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
7157 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
7158 "with the root directory being C<root>."
7162 #: ../fish/guestfish-actions.pod:1557 ../src/guestfs-actions.pod:2341
7164 "There is currently no way in the API to install grub2, which is used by most "
7165 "modern Linux guests. It is possible to run the grub2 command from the "
7166 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
7170 #: ../fish/guestfish-actions.pod:1564 ../src/guestfs-actions.pod:2348
7172 "This uses C<grub-install> from the host. Unfortunately grub is not always "
7173 "compatible with itself, so this only works in rather narrow circumstances. "
7174 "Careful testing with each guest version is advisable."
7178 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2355
7180 "If grub-install reports the error \"No suitable drive was found in the "
7181 "generated device map.\" it may be that you need to create a "
7182 "C</boot/grub/device.map> file first that contains the mapping between grub "
7183 "device names and Linux device names. It is usually sufficient to create a "
7188 #: ../fish/guestfish-actions.pod:1578 ../src/guestfs-actions.pod:2362
7196 #: ../fish/guestfish-actions.pod:1580 ../src/guestfs-actions.pod:2364
7197 msgid "replacing C</dev/vda> with the name of the installation device."
7201 #: ../fish/guestfish-actions.pod:1584
7206 #: ../fish/guestfish-actions.pod:1586
7214 #: ../fish/guestfish-actions.pod:1588 ../src/guestfs-actions.pod:2378
7216 "This command returns up to the first 10 lines of a file as a list of "
7221 #: ../fish/guestfish-actions.pod:1594
7226 #: ../fish/guestfish-actions.pod:1596
7229 " head-n nrlines path\n"
7234 #: ../fish/guestfish-actions.pod:1598 ../src/guestfs-actions.pod:2397
7236 "If the parameter C<nrlines> is a positive number, this returns the first "
7237 "C<nrlines> lines of the file C<path>."
7241 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2400
7243 "If the parameter C<nrlines> is a negative number, this returns lines from "
7244 "the file C<path>, excluding the last C<nrlines> lines."
7248 #: ../fish/guestfish-actions.pod:1604 ../fish/guestfish-actions.pod:4674 ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:7022
7249 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7253 #: ../fish/guestfish-actions.pod:1609
7258 #: ../fish/guestfish-actions.pod:1611
7266 #: ../fish/guestfish-actions.pod:1613 ../src/guestfs-actions.pod:2420
7268 "This runs C<hexdump -C> on the given C<path>. The result is the "
7269 "human-readable, canonical hex dump of the file."
7273 #: ../fish/guestfish-actions.pod:1619
7278 #: ../fish/guestfish-actions.pod:1621
7281 " initrd-cat initrdpath filename\n"
7286 #: ../fish/guestfish-actions.pod:1623 ../src/guestfs-actions.pod:2439
7288 "This command unpacks the file C<filename> from the initrd file called "
7289 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7294 #: ../fish/guestfish-actions.pod:1627 ../src/guestfs-actions.pod:2443
7296 "For example, in guestfish you could use the following command to examine the "
7297 "boot script (usually called C</init>) contained in a Linux initrd or "
7302 #: ../fish/guestfish-actions.pod:1631 ../src/guestfs-actions.pod:2447
7305 " initrd-cat /boot/initrd-<version>.img init\n"
7310 #: ../fish/guestfish-actions.pod:1633
7311 msgid "See also L</initrd-list>."
7315 #: ../fish/guestfish-actions.pod:1638
7320 #: ../fish/guestfish-actions.pod:1640
7323 " initrd-list path\n"
7328 #: ../fish/guestfish-actions.pod:1642 ../src/guestfs-actions.pod:2466
7329 msgid "This command lists out files contained in an initrd."
7333 #: ../fish/guestfish-actions.pod:1644 ../src/guestfs-actions.pod:2468
7335 "The files are listed without any initial C</> character. The files are "
7336 "listed in the order they appear (not necessarily alphabetical). Directory "
7337 "names are listed as separate items."
7341 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2472
7343 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7344 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7349 #: ../fish/guestfish-actions.pod:1652
7350 msgid "inotify-add-watch"
7354 #: ../fish/guestfish-actions.pod:1654
7357 " inotify-add-watch path mask\n"
7362 #: ../fish/guestfish-actions.pod:1656 ../src/guestfs-actions.pod:2489
7363 msgid "Watch C<path> for the events listed in C<mask>."
7367 #: ../fish/guestfish-actions.pod:1658 ../src/guestfs-actions.pod:2491
7369 "Note that if C<path> is a directory then events within that directory are "
7370 "watched, but this does I<not> happen recursively (in subdirectories)."
7374 #: ../fish/guestfish-actions.pod:1662 ../src/guestfs-actions.pod:2495
7376 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7377 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7381 #: ../fish/guestfish-actions.pod:1666
7382 msgid "inotify-close"
7386 #: ../fish/guestfish-actions.pod:1668
7394 #: ../fish/guestfish-actions.pod:1670 ../src/guestfs-actions.pod:2508
7396 "This closes the inotify handle which was previously opened by inotify_init. "
7397 "It removes all watches, throws away any pending events, and deallocates all "
7402 #: ../fish/guestfish-actions.pod:1674
7403 msgid "inotify-files"
7407 #: ../fish/guestfish-actions.pod:1676
7415 #: ../fish/guestfish-actions.pod:1678
7417 "This function is a helpful wrapper around L</inotify-read> which just "
7418 "returns a list of pathnames of objects that were touched. The returned "
7419 "pathnames are sorted and deduplicated."
7423 #: ../fish/guestfish-actions.pod:1682
7424 msgid "inotify-init"
7428 #: ../fish/guestfish-actions.pod:1684
7431 " inotify-init maxevents\n"
7436 #: ../fish/guestfish-actions.pod:1686 ../src/guestfs-actions.pod:2537
7438 "This command creates a new inotify handle. The inotify subsystem can be "
7439 "used to notify events which happen to objects in the guest filesystem."
7443 #: ../fish/guestfish-actions.pod:1690
7445 "C<maxevents> is the maximum number of events which will be queued up between "
7446 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7447 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7448 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7449 "but records the fact that it threw them away by setting a flag "
7450 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7454 #: ../fish/guestfish-actions.pod:1700
7456 "Before any events are generated, you have to add some watches to the "
7457 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7458 "L</inotify-watch-all>."
7462 #: ../fish/guestfish-actions.pod:1706
7464 "Queued up events should be read periodically by calling L</inotify-read> (or "
7465 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7466 "If you don't read the events out often enough then you risk the internal "
7467 "queue overflowing."
7471 #: ../fish/guestfish-actions.pod:1713
7473 "The handle should be closed after use by calling L</inotify-close>. This "
7474 "also removes any watches automatically."
7478 #: ../fish/guestfish-actions.pod:1717 ../src/guestfs-actions.pod:2568
7480 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7481 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7482 "that there is one global inotify handle per libguestfs instance."
7486 #: ../fish/guestfish-actions.pod:1722
7487 msgid "inotify-read"
7491 #: ../fish/guestfish-actions.pod:1724
7499 #: ../fish/guestfish-actions.pod:1726 ../src/guestfs-actions.pod:2582
7501 "Return the complete queue of events that have happened since the previous "
7506 #: ../fish/guestfish-actions.pod:1729 ../src/guestfs-actions.pod:2585
7507 msgid "If no events have happened, this returns an empty list."
7511 #: ../fish/guestfish-actions.pod:1731 ../src/guestfs-actions.pod:2587
7513 "I<Note>: In order to make sure that all events have been read, you must call "
7514 "this function repeatedly until it returns an empty list. The reason is that "
7515 "the call will read events up to the maximum appliance-to-host message size "
7516 "and leave remaining events in the queue."
7520 #: ../fish/guestfish-actions.pod:1737
7521 msgid "inotify-rm-watch"
7525 #: ../fish/guestfish-actions.pod:1739
7528 " inotify-rm-watch wd\n"
7533 #: ../fish/guestfish-actions.pod:1741
7534 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7538 #: ../fish/guestfish-actions.pod:1744
7539 msgid "inspect-get-arch"
7543 #: ../fish/guestfish-actions.pod:1746
7546 " inspect-get-arch root\n"
7551 #: ../fish/guestfish-actions.pod:1748
7553 "This returns the architecture of the inspected operating system. The "
7554 "possible return values are listed under L</file-architecture>."
7558 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2622
7560 "If the architecture could not be determined, then the string C<unknown> is "
7565 #: ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1842 ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2078 ../fish/guestfish-actions.pod:2099 ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2185 ../fish/guestfish-actions.pod:2198 ../fish/guestfish-actions.pod:2211 ../fish/guestfish-actions.pod:2221 ../fish/guestfish-actions.pod:2231 ../fish/guestfish-actions.pod:2243 ../fish/guestfish-actions.pod:2339 ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2842 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3218 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3255 ../src/guestfs-actions.pod:3271 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3432
7566 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7570 #: ../fish/guestfish-actions.pod:1757
7571 msgid "inspect-get-distro"
7575 #: ../fish/guestfish-actions.pod:1759
7578 " inspect-get-distro root\n"
7583 #: ../fish/guestfish-actions.pod:1761 ../src/guestfs-actions.pod:2638
7584 msgid "This returns the distro (distribution) of the inspected operating system."
7588 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7589 msgid "Currently defined distros are:"
7593 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7594 msgid "\"archlinux\""
7598 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7603 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7608 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7613 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7618 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7623 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7628 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7633 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7638 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
7643 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
7644 msgid "\"linuxmint\""
7648 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
7653 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
7654 msgid "\"mandriva\""
7658 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
7663 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
7668 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
7673 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
7678 #: ../fish/guestfish-actions.pod:1802 ../src/guestfs-actions.pod:2679
7683 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
7684 msgid "\"redhat-based\""
7688 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2683
7689 msgid "Some Red Hat-derived distro."
7693 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
7698 #: ../fish/guestfish-actions.pod:1810 ../src/guestfs-actions.pod:2687
7699 msgid "Red Hat Enterprise Linux."
7703 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2689
7704 msgid "\"scientificlinux\""
7708 #: ../fish/guestfish-actions.pod:1814 ../src/guestfs-actions.pod:2691
7709 msgid "Scientific Linux."
7713 #: ../fish/guestfish-actions.pod:1816 ../src/guestfs-actions.pod:2693
7714 msgid "\"slackware\""
7718 #: ../fish/guestfish-actions.pod:1818 ../src/guestfs-actions.pod:2695
7723 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2697
7724 msgid "\"ttylinux\""
7728 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2699
7733 #: ../fish/guestfish-actions.pod:1824 ../src/guestfs-actions.pod:2701
7738 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2703
7743 #: ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1912 ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:2705 ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:3189
7748 #: ../fish/guestfish-actions.pod:1830 ../src/guestfs-actions.pod:2707
7749 msgid "The distro could not be determined."
7753 #: ../fish/guestfish-actions.pod:1832 ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:2709 ../src/guestfs-actions.pod:3181
7758 #: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2711
7760 "Windows does not have distributions. This string is returned if the OS type "
7765 #: ../fish/guestfish-actions.pod:1839 ../fish/guestfish-actions.pod:1918 ../fish/guestfish-actions.pod:2182 ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2820 ../src/guestfs-actions.pod:3195
7767 "Future versions of libguestfs may return other strings here. The caller "
7768 "should be prepared to handle any string."
7772 #: ../fish/guestfish-actions.pod:1844
7773 msgid "inspect-get-drive-mappings"
7777 #: ../fish/guestfish-actions.pod:1846
7780 " inspect-get-drive-mappings root\n"
7785 #: ../fish/guestfish-actions.pod:1848 ../src/guestfs-actions.pod:2732
7787 "This call is useful for Windows which uses a primitive system of assigning "
7788 "drive letters (like \"C:\") to partitions. This inspection API examines the "
7789 "Windows Registry to find out how disks/partitions are mapped to drive "
7790 "letters, and returns a hash table as in the example below:"
7794 #: ../fish/guestfish-actions.pod:1854 ../src/guestfs-actions.pod:2738
7804 #: ../fish/guestfish-actions.pod:1858 ../src/guestfs-actions.pod:2742
7806 "Note that keys are drive letters. For Windows, the key is case insensitive "
7807 "and just contains the drive letter, without the customary colon separator "
7812 #: ../fish/guestfish-actions.pod:1862 ../src/guestfs-actions.pod:2746
7814 "In future we may support other operating systems that also used drive "
7815 "letters, but the keys for those might not be case insensitive and might be "
7816 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
7821 #: ../fish/guestfish-actions.pod:1867 ../src/guestfs-actions.pod:2751
7823 "For Windows guests, currently only hard drive mappings are returned. "
7824 "Removable disks (eg. DVD-ROMs) are ignored."
7828 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2754
7830 "For guests that do not use drive mappings, or if the drive mappings could "
7831 "not be determined, this returns an empty hash table."
7835 #: ../fish/guestfish-actions.pod:1873
7837 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7838 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7842 #: ../fish/guestfish-actions.pod:1877
7843 msgid "inspect-get-filesystems"
7847 #: ../fish/guestfish-actions.pod:1879
7850 " inspect-get-filesystems root\n"
7855 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2775
7857 "This returns a list of all the filesystems that we think are associated with "
7858 "this operating system. This includes the root filesystem, other ordinary "
7859 "filesystems, and non-mounted devices like swap partitions."
7863 #: ../fish/guestfish-actions.pod:1886 ../src/guestfs-actions.pod:2780
7865 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7866 "to be shared between operating systems."
7870 #: ../fish/guestfish-actions.pod:1889
7872 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7873 "L</inspect-get-mountpoints>."
7877 #: ../fish/guestfish-actions.pod:1892
7878 msgid "inspect-get-format"
7882 #: ../fish/guestfish-actions.pod:1894
7885 " inspect-get-format root\n"
7890 #: ../fish/guestfish-actions.pod:1896 ../src/guestfs-actions.pod:2798
7892 "This returns the format of the inspected operating system. You can use it "
7893 "to detect install images, live CDs and similar."
7897 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2801
7898 msgid "Currently defined formats are:"
7902 #: ../fish/guestfish-actions.pod:1903 ../src/guestfs-actions.pod:2805
7903 msgid "\"installed\""
7907 #: ../fish/guestfish-actions.pod:1905 ../src/guestfs-actions.pod:2807
7908 msgid "This is an installed operating system."
7912 #: ../fish/guestfish-actions.pod:1907 ../src/guestfs-actions.pod:2809
7913 msgid "\"installer\""
7917 #: ../fish/guestfish-actions.pod:1909 ../src/guestfs-actions.pod:2811
7919 "The disk image being inspected is not an installed operating system, but a "
7920 "I<bootable> install disk, live CD, or similar."
7924 #: ../fish/guestfish-actions.pod:1914 ../src/guestfs-actions.pod:2816
7925 msgid "The format of this disk image is not known."
7929 #: ../fish/guestfish-actions.pod:1923
7930 msgid "inspect-get-hostname"
7934 #: ../fish/guestfish-actions.pod:1925
7937 " inspect-get-hostname root\n"
7942 #: ../fish/guestfish-actions.pod:1927 ../src/guestfs-actions.pod:2836
7944 "This function returns the hostname of the operating system as found by "
7945 "inspection of the guest's configuration files."
7949 #: ../fish/guestfish-actions.pod:1930 ../src/guestfs-actions.pod:2839
7951 "If the hostname could not be determined, then the string C<unknown> is "
7956 #: ../fish/guestfish-actions.pod:1935
7957 msgid "inspect-get-icon"
7961 #: ../fish/guestfish-actions.pod:1937
7964 " inspect-get-icon root [favicon:..] [highquality:..]\n"
7969 #: ../fish/guestfish-actions.pod:1939 ../src/guestfs-actions.pod:2865
7971 "This function returns an icon corresponding to the inspected operating "
7972 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
7973 "to PNG if necessary)."
7977 #: ../fish/guestfish-actions.pod:1943 ../src/guestfs-actions.pod:2869
7979 "If it was not possible to get an icon this function returns a zero-length "
7980 "(non-NULL) buffer. I<Callers must check for this case>."
7984 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
7986 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
7987 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
7988 "this file will be returned. You can disable favicons by passing the "
7989 "optional C<favicon> boolean as false (default is true)."
7993 #: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:2878
7995 "If finding the favicon fails, then we look in other places in the guest for "
8000 #: ../fish/guestfish-actions.pod:1955 ../src/guestfs-actions.pod:2881
8002 "If the optional C<highquality> boolean is true then only high quality icons "
8003 "are returned, which means only icons of high resolution with an alpha "
8004 "channel. The default (false) is to return any icon we can, even if it is of "
8005 "substandard quality."
8009 #: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:2892
8011 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8012 "before you call this, since it needs to read information from the guest "
8013 "filesystem during the call."
8017 #: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:2898
8019 "B<Security:> The icon data comes from the untrusted guest, and should be "
8020 "treated with caution. PNG files have been known to contain exploits. "
8021 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8022 "trying to process or display the icon."
8026 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:2906
8028 "The PNG image returned can be any size. It might not be square. Libguestfs "
8029 "tries to return the largest, highest quality icon available. The "
8030 "application must scale the icon to the required size."
8034 #: ../fish/guestfish-actions.pod:1987 ../src/guestfs-actions.pod:2913
8036 "Extracting icons from Windows guests requires the external C<wrestool> "
8037 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8038 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8039 "installed separately."
8043 #: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:2920
8045 "Operating system icons are usually trademarks. Seek legal advice before "
8046 "using trademarks in applications."
8050 #: ../fish/guestfish-actions.pod:2001
8051 msgid "inspect-get-major-version"
8055 #: ../fish/guestfish-actions.pod:2003
8058 " inspect-get-major-version root\n"
8063 #: ../fish/guestfish-actions.pod:2005 ../src/guestfs-actions.pod:2961
8064 msgid "This returns the major version number of the inspected operating system."
8068 #: ../fish/guestfish-actions.pod:2008 ../src/guestfs-actions.pod:2964
8070 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8071 "popular public names used by the operating system. Notably the operating "
8072 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8073 "1). You can find out the real versions corresponding to releases of Windows "
8074 "by consulting Wikipedia or MSDN."
8078 #: ../fish/guestfish-actions.pod:2015 ../fish/guestfish-actions.pod:2026 ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:2988
8079 msgid "If the version could not be determined, then C<0> is returned."
8083 #: ../fish/guestfish-actions.pod:2019
8084 msgid "inspect-get-minor-version"
8088 #: ../fish/guestfish-actions.pod:2021
8091 " inspect-get-minor-version root\n"
8096 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2985
8097 msgid "This returns the minor version number of the inspected operating system."
8101 #: ../fish/guestfish-actions.pod:2028
8103 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8104 "L</inspect-get-major-version>."
8108 #: ../fish/guestfish-actions.pod:2031
8109 msgid "inspect-get-mountpoints"
8113 #: ../fish/guestfish-actions.pod:2033
8116 " inspect-get-mountpoints root\n"
8121 #: ../fish/guestfish-actions.pod:2035 ../src/guestfs-actions.pod:3003
8123 "This returns a hash of where we think the filesystems associated with this "
8124 "operating system should be mounted. Callers should note that this is at "
8125 "best an educated guess made by reading configuration files such as "
8126 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
8127 "are non-existent or not mountable and callers should be prepared to handle "
8128 "or ignore failures if they try to mount them."
8132 #: ../fish/guestfish-actions.pod:2044 ../src/guestfs-actions.pod:3012
8134 "Each element in the returned hashtable has a key which is the path of the "
8135 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8136 "mounted there (eg. C</dev/sda1>)."
8140 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3017
8141 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8145 #: ../fish/guestfish-actions.pod:2052
8147 "For operating systems like Windows which still use drive letters, this call "
8148 "will only return an entry for the first drive \"mounted on\" C</>. For "
8149 "information about the mapping of drive letters to partitions, see "
8150 "L</inspect-get-drive-mappings>."
8154 #: ../fish/guestfish-actions.pod:2058
8156 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8157 "L</inspect-get-filesystems>."
8161 #: ../fish/guestfish-actions.pod:2061
8162 msgid "inspect-get-package-format"
8166 #: ../fish/guestfish-actions.pod:2063
8169 " inspect-get-package-format root\n"
8174 #: ../fish/guestfish-actions.pod:2065
8176 "This function and L</inspect-get-package-management> return the package "
8177 "format and package management tool used by the inspected operating system. "
8178 "For example for Fedora these functions would return C<rpm> (package format) "
8179 "and C<yum> (package management)."
8183 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3049
8185 "This returns the string C<unknown> if we could not determine the package "
8186 "format I<or> if the operating system does not have a real packaging system "
8191 #: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3053
8193 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8194 "Future versions of libguestfs may return other strings."
8198 #: ../fish/guestfish-actions.pod:2080
8199 msgid "inspect-get-package-management"
8203 #: ../fish/guestfish-actions.pod:2082
8206 " inspect-get-package-management root\n"
8211 #: ../fish/guestfish-actions.pod:2084
8213 "L</inspect-get-package-format> and this function return the package format "
8214 "and package management tool used by the inspected operating system. For "
8215 "example for Fedora these functions would return C<rpm> (package format) and "
8216 "C<yum> (package management)."
8220 #: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3075
8222 "This returns the string C<unknown> if we could not determine the package "
8223 "management tool I<or> if the operating system does not have a real packaging "
8224 "system (eg. Windows)."
8228 #: ../fish/guestfish-actions.pod:2094 ../src/guestfs-actions.pod:3079
8230 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8231 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8232 "libguestfs may return other strings."
8236 #: ../fish/guestfish-actions.pod:2101
8237 msgid "inspect-get-product-name"
8241 #: ../fish/guestfish-actions.pod:2103
8244 " inspect-get-product-name root\n"
8249 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3097
8251 "This returns the product name of the inspected operating system. The "
8252 "product name is generally some freeform string which can be displayed to the "
8253 "user, but should not be parsed by programs."
8257 #: ../fish/guestfish-actions.pod:2110 ../src/guestfs-actions.pod:3102
8259 "If the product name could not be determined, then the string C<unknown> is "
8264 #: ../fish/guestfish-actions.pod:2115
8265 msgid "inspect-get-product-variant"
8269 #: ../fish/guestfish-actions.pod:2117
8272 " inspect-get-product-variant root\n"
8277 #: ../fish/guestfish-actions.pod:2119 ../src/guestfs-actions.pod:3118
8278 msgid "This returns the product variant of the inspected operating system."
8282 #: ../fish/guestfish-actions.pod:2122 ../src/guestfs-actions.pod:3121
8284 "For Windows guests, this returns the contents of the Registry key "
8285 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8286 "which is usually a string such as C<Client> or C<Server> (other values are "
8287 "possible). This can be used to distinguish consumer and enterprise versions "
8288 "of Windows that have the same version number (for example, Windows 7 and "
8289 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8290 "the latter is C<Server>)."
8294 #: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3130
8296 "For enterprise Linux guests, in future we intend this to return the product "
8297 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8298 "implemented at present."
8302 #: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3134
8304 "If the product variant could not be determined, then the string C<unknown> "
8309 #: ../fish/guestfish-actions.pod:2138
8311 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8312 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8316 #: ../fish/guestfish-actions.pod:2142
8317 msgid "inspect-get-roots"
8321 #: ../fish/guestfish-actions.pod:2144
8324 " inspect-get-roots\n"
8329 #: ../fish/guestfish-actions.pod:2146
8331 "This function is a convenient way to get the list of root devices, as "
8332 "returned from a previous call to L</inspect-os>, but without redoing the "
8333 "whole inspection process."
8337 #: ../fish/guestfish-actions.pod:2150
8339 "This returns an empty list if either no root devices were found or the "
8340 "caller has not called L</inspect-os>."
8344 #: ../fish/guestfish-actions.pod:2155
8345 msgid "inspect-get-type"
8349 #: ../fish/guestfish-actions.pod:2157
8352 " inspect-get-type root\n"
8357 #: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3172
8359 "This returns the type of the inspected operating system. Currently defined "
8364 #: ../fish/guestfish-actions.pod:2164 ../src/guestfs-actions.pod:3177
8369 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3179
8370 msgid "Any Linux-based operating system."
8374 #: ../fish/guestfish-actions.pod:2170 ../src/guestfs-actions.pod:3183
8375 msgid "Any Microsoft Windows operating system."
8379 #: ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:3185
8384 #: ../fish/guestfish-actions.pod:2174 ../src/guestfs-actions.pod:3187
8389 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3191
8390 msgid "The operating system type could not be determined."
8394 #: ../fish/guestfish-actions.pod:2187
8395 msgid "inspect-get-windows-current-control-set"
8399 #: ../fish/guestfish-actions.pod:2189
8402 " inspect-get-windows-current-control-set root\n"
8407 #: ../fish/guestfish-actions.pod:2191 ../src/guestfs-actions.pod:3211
8409 "This returns the Windows CurrentControlSet of the inspected guest. The "
8410 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8414 #: ../fish/guestfish-actions.pod:2194 ../src/guestfs-actions.pod:3214
8416 "This call assumes that the guest is Windows and that the Registry could be "
8417 "examined by inspection. If this is not the case then an error is returned."
8421 #: ../fish/guestfish-actions.pod:2200
8422 msgid "inspect-get-windows-systemroot"
8426 #: ../fish/guestfish-actions.pod:2202
8429 " inspect-get-windows-systemroot root\n"
8434 #: ../fish/guestfish-actions.pod:2204 ../src/guestfs-actions.pod:3231
8436 "This returns the Windows systemroot of the inspected guest. The systemroot "
8437 "is a directory path such as C</WINDOWS>."
8441 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3234
8443 "This call assumes that the guest is Windows and that the systemroot could be "
8444 "determined by inspection. If this is not the case then an error is "
8449 #: ../fish/guestfish-actions.pod:2213
8450 msgid "inspect-is-live"
8454 #: ../fish/guestfish-actions.pod:2215
8457 " inspect-is-live root\n"
8462 #: ../fish/guestfish-actions.pod:2217
8464 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8465 "then this returns true if a live image was detected on the disk."
8469 #: ../fish/guestfish-actions.pod:2223
8470 msgid "inspect-is-multipart"
8474 #: ../fish/guestfish-actions.pod:2225
8477 " inspect-is-multipart root\n"
8482 #: ../fish/guestfish-actions.pod:2227
8484 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8485 "then this returns true if the disk is part of a set."
8489 #: ../fish/guestfish-actions.pod:2233
8490 msgid "inspect-is-netinst"
8494 #: ../fish/guestfish-actions.pod:2235
8497 " inspect-is-netinst root\n"
8502 #: ../fish/guestfish-actions.pod:2237
8504 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8505 "then this returns true if the disk is a network installer, ie. not a "
8506 "self-contained install CD but one which is likely to require network access "
8507 "to complete the install."
8511 #: ../fish/guestfish-actions.pod:2245
8512 msgid "inspect-list-applications"
8516 #: ../fish/guestfish-actions.pod:2247
8519 " inspect-list-applications root\n"
8524 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
8525 msgid "Return the list of applications installed in the operating system."
8529 #: ../fish/guestfish-actions.pod:2251
8531 "I<Note:> This call works differently from other parts of the inspection "
8532 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8533 "then mount up the disks, before calling this. Listing applications is a "
8534 "significantly more difficult operation which requires access to the full "
8535 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8536 "are just returning data cached in the libguestfs handle, this call actually "
8537 "reads parts of the mounted filesystems during the call."
8541 #: ../fish/guestfish-actions.pod:2261 ../src/guestfs-actions.pod:3313
8543 "This returns an empty list if the inspection code was not able to determine "
8544 "the list of applications."
8548 #: ../fish/guestfish-actions.pod:2264 ../src/guestfs-actions.pod:3316
8549 msgid "The application structure contains the following fields:"
8553 #: ../fish/guestfish-actions.pod:2268 ../src/guestfs-actions.pod:3320
8558 #: ../fish/guestfish-actions.pod:2270 ../src/guestfs-actions.pod:3322
8560 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8561 "guests, this is the package name."
8565 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8566 msgid "C<app_display_name>"
8570 #: ../fish/guestfish-actions.pod:2275 ../src/guestfs-actions.pod:3327
8572 "The display name of the application, sometimes localized to the install "
8573 "language of the guest operating system."
8577 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
8579 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8580 "to display something can use C<app_name> instead."
8584 #: ../fish/guestfish-actions.pod:2281 ../src/guestfs-actions.pod:3333
8585 msgid "C<app_epoch>"
8589 #: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3335
8591 "For package managers which use epochs, this contains the epoch of the "
8592 "package (an integer). If unavailable, this is returned as C<0>."
8596 #: ../fish/guestfish-actions.pod:2286 ../src/guestfs-actions.pod:3338
8597 msgid "C<app_version>"
8601 #: ../fish/guestfish-actions.pod:2288 ../src/guestfs-actions.pod:3340
8603 "The version string of the application or package. If unavailable this is "
8604 "returned as an empty string C<\"\">."
8608 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8609 msgid "C<app_release>"
8613 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8615 "The release string of the application or package, for package managers that "
8616 "use this. If unavailable this is returned as an empty string C<\"\">."
8620 #: ../fish/guestfish-actions.pod:2297 ../src/guestfs-actions.pod:3349
8621 msgid "C<app_install_path>"
8625 #: ../fish/guestfish-actions.pod:2299 ../src/guestfs-actions.pod:3351
8627 "The installation path of the application (on operating systems such as "
8628 "Windows which use installation paths). This path is in the format used by "
8629 "the guest operating system, it is not a libguestfs path."
8633 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3356
8634 msgid "If unavailable this is returned as an empty string C<\"\">."
8638 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
8639 msgid "C<app_trans_path>"
8643 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
8645 "The install path translated into a libguestfs path. If unavailable this is "
8646 "returned as an empty string C<\"\">."
8650 #: ../fish/guestfish-actions.pod:2311 ../src/guestfs-actions.pod:3363
8651 msgid "C<app_publisher>"
8655 #: ../fish/guestfish-actions.pod:2313 ../src/guestfs-actions.pod:3365
8657 "The name of the publisher of the application, for package managers that use "
8658 "this. If unavailable this is returned as an empty string C<\"\">."
8662 #: ../fish/guestfish-actions.pod:2317 ../src/guestfs-actions.pod:3369
8667 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3371
8669 "The URL (eg. upstream URL) of the application. If unavailable this is "
8670 "returned as an empty string C<\"\">."
8674 #: ../fish/guestfish-actions.pod:2322 ../src/guestfs-actions.pod:3374
8675 msgid "C<app_source_package>"
8679 #: ../fish/guestfish-actions.pod:2324 ../src/guestfs-actions.pod:3376
8681 "For packaging systems which support this, the name of the source package. "
8682 "If unavailable this is returned as an empty string C<\"\">."
8686 #: ../fish/guestfish-actions.pod:2327 ../src/guestfs-actions.pod:3379
8687 msgid "C<app_summary>"
8691 #: ../fish/guestfish-actions.pod:2329 ../src/guestfs-actions.pod:3381
8693 "A short (usually one line) description of the application or package. If "
8694 "unavailable this is returned as an empty string C<\"\">."
8698 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3384
8699 msgid "C<app_description>"
8703 #: ../fish/guestfish-actions.pod:2334 ../src/guestfs-actions.pod:3386
8705 "A longer description of the application or package. If unavailable this is "
8706 "returned as an empty string C<\"\">."
8710 #: ../fish/guestfish-actions.pod:2341
8715 #: ../fish/guestfish-actions.pod:2343
8723 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3404
8725 "This function uses other libguestfs functions and certain heuristics to "
8726 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8727 "for operating systems."
8731 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3408
8732 msgid "The list returned is empty if no operating systems were found."
8736 #: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3410
8738 "If one operating system was found, then this returns a list with a single "
8739 "element, which is the name of the root filesystem of this operating system. "
8740 "It is also possible for this function to return a list containing more than "
8741 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8742 "element being the root filesystem of one of the operating systems."
8746 #: ../fish/guestfish-actions.pod:2358
8748 "You can pass the root string(s) returned to other L</inspect-get-*> "
8749 "functions in order to query further information about each operating system, "
8750 "such as the name and version."
8754 #: ../fish/guestfish-actions.pod:2363
8756 "This function uses other libguestfs features such as L</mount-ro> and "
8757 "L</umount-all> in order to mount and unmount filesystems and look at the "
8758 "contents. This should be called with no disks currently mounted. The "
8759 "function may also use Augeas, so any existing Augeas handle will be closed."
8763 #: ../fish/guestfish-actions.pod:2369 ../src/guestfs-actions.pod:3428
8765 "This function cannot decrypt encrypted disks. The caller must do that first "
8766 "(supplying the necessary keys) if the disk is encrypted."
8770 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2573 ../fish/guestfish-actions.pod:2632
8771 msgid "See also L</list-filesystems>."
8775 #: ../fish/guestfish-actions.pod:2377
8780 #: ../fish/guestfish-actions.pod:2379
8783 " is-blockdev path\n"
8788 #: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3448
8790 "This returns C<true> if and only if there is a block device with the given "
8795 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2402 ../fish/guestfish-actions.pod:2421 ../fish/guestfish-actions.pod:2430 ../fish/guestfish-actions.pod:2440 ../fish/guestfish-actions.pod:2474 ../fish/guestfish-actions.pod:2483
8796 msgid "See also L</stat>."
8800 #: ../fish/guestfish-actions.pod:2386
8805 #: ../fish/guestfish-actions.pod:2388
8813 #: ../fish/guestfish-actions.pod:2390 ../src/guestfs-actions.pod:3462
8815 "This returns true iff this handle is busy processing a command (in the "
8820 #: ../fish/guestfish-actions.pod:2395
8825 #: ../fish/guestfish-actions.pod:2397
8828 " is-chardev path\n"
8833 #: ../fish/guestfish-actions.pod:2399 ../src/guestfs-actions.pod:3477
8835 "This returns C<true> if and only if there is a character device with the "
8836 "given C<path> name."
8840 #: ../fish/guestfish-actions.pod:2404
8845 #: ../fish/guestfish-actions.pod:2406
8853 #: ../fish/guestfish-actions.pod:2408 ../src/guestfs-actions.pod:3491
8855 "This returns true iff this handle is being configured (in the C<CONFIG> "
8860 #: ../fish/guestfish-actions.pod:2413
8865 #: ../fish/guestfish-actions.pod:2415
8873 #: ../fish/guestfish-actions.pod:2417 ../src/guestfs-actions.pod:3506
8875 "This returns C<true> if and only if there is a directory with the given "
8876 "C<path> name. Note that it returns false for other objects like files."
8880 #: ../fish/guestfish-actions.pod:2423
8885 #: ../fish/guestfish-actions.pod:2425
8893 #: ../fish/guestfish-actions.pod:2427 ../src/guestfs-actions.pod:3522
8895 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8896 "given C<path> name."
8900 #: ../fish/guestfish-actions.pod:2432
8905 #: ../fish/guestfish-actions.pod:2434
8913 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3537
8915 "This returns C<true> if and only if there is a regular file with the given "
8916 "C<path> name. Note that it returns false for other objects like "
8921 #: ../fish/guestfish-actions.pod:2442
8922 msgid "is-launching"
8926 #: ../fish/guestfish-actions.pod:2444
8934 #: ../fish/guestfish-actions.pod:2446 ../src/guestfs-actions.pod:3552
8936 "This returns true iff this handle is launching the subprocess (in the "
8937 "C<LAUNCHING> state)."
8941 #: ../fish/guestfish-actions.pod:2451
8946 #: ../fish/guestfish-actions.pod:2453
8954 #: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3567
8956 "This command tests whether C<device> is a logical volume, and returns true "
8957 "iff this is the case."
8961 #: ../fish/guestfish-actions.pod:2458
8966 #: ../fish/guestfish-actions.pod:2460
8974 #: ../fish/guestfish-actions.pod:2462 ../src/guestfs-actions.pod:3579
8976 "This returns true iff this handle is ready to accept commands (in the "
8981 #: ../fish/guestfish-actions.pod:2467
8986 #: ../fish/guestfish-actions.pod:2469
8994 #: ../fish/guestfish-actions.pod:2471 ../src/guestfs-actions.pod:3594
8996 "This returns C<true> if and only if there is a Unix domain socket with the "
8997 "given C<path> name."
9001 #: ../fish/guestfish-actions.pod:2476
9006 #: ../fish/guestfish-actions.pod:2478
9009 " is-symlink path\n"
9014 #: ../fish/guestfish-actions.pod:2480 ../src/guestfs-actions.pod:3609
9016 "This returns C<true> if and only if there is a symbolic link with the given "
9021 #: ../fish/guestfish-actions.pod:2485
9026 #: ../fish/guestfish-actions.pod:2487
9034 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3624
9036 "This returns true iff the file exists and the file is empty or it contains "
9041 #: ../fish/guestfish-actions.pod:2492
9042 msgid "is-zero-device"
9046 #: ../fish/guestfish-actions.pod:2494
9049 " is-zero-device device\n"
9054 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3637
9055 msgid "This returns true iff the device exists and contains all zero bytes."
9059 #: ../fish/guestfish-actions.pod:2498 ../src/guestfs-actions.pod:3639
9060 msgid "Note that for large devices this can take a long time to run."
9064 #: ../fish/guestfish-actions.pod:2500
9065 msgid "kill-subprocess"
9069 #: ../fish/guestfish-actions.pod:2502
9072 " kill-subprocess\n"
9077 #: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3650
9078 msgid "This kills the qemu subprocess. You should never need to call this."
9082 #: ../fish/guestfish-actions.pod:2506
9087 #: ../fish/guestfish-actions.pod:2508
9092 #: ../fish/guestfish-actions.pod:2510
9100 #: ../fish/guestfish-actions.pod:2512 ../src/guestfs-actions.pod:3661
9102 "Internally libguestfs is implemented by running a virtual machine using "
9107 #: ../fish/guestfish-actions.pod:2515 ../src/guestfs-actions.pod:3664
9109 "You should call this after configuring the handle (eg. adding drives) but "
9110 "before performing any actions."
9114 #: ../fish/guestfish-actions.pod:2518
9119 #: ../fish/guestfish-actions.pod:2520
9122 " lchown owner group path\n"
9127 #: ../fish/guestfish-actions.pod:2522
9129 "Change the file owner to C<owner> and group to C<group>. This is like "
9130 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
9135 #: ../fish/guestfish-actions.pod:2530
9140 #: ../fish/guestfish-actions.pod:2532
9143 " lgetxattr path name\n"
9148 #: ../fish/guestfish-actions.pod:2534 ../src/guestfs-actions.pod:3704
9150 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9151 "is a symlink, then this call returns an extended attribute from the symlink."
9155 #: ../fish/guestfish-actions.pod:2548
9156 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9160 #: ../fish/guestfish-actions.pod:2550
9165 #: ../fish/guestfish-actions.pod:2552
9168 " lgetxattrs path\n"
9173 #: ../fish/guestfish-actions.pod:2554
9175 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9176 "it returns the extended attributes of the link itself."
9180 #: ../fish/guestfish-actions.pod:2558
9185 #: ../fish/guestfish-actions.pod:2560
9193 #: ../fish/guestfish-actions.pod:2562 ../src/guestfs-actions.pod:3747
9195 "List all 9p filesystems attached to the guest. A list of mount tags is "
9200 #: ../fish/guestfish-actions.pod:2565
9201 msgid "list-devices"
9205 #: ../fish/guestfish-actions.pod:2567
9213 #: ../fish/guestfish-actions.pod:2569 ../src/guestfs-actions.pod:3761
9214 msgid "List all the block devices."
9218 #: ../fish/guestfish-actions.pod:2571 ../src/guestfs-actions.pod:3763
9219 msgid "The full block device names are returned, eg. C</dev/sda>."
9223 #: ../fish/guestfish-actions.pod:2575
9224 msgid "list-dm-devices"
9228 #: ../fish/guestfish-actions.pod:2577
9231 " list-dm-devices\n"
9236 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3778
9237 msgid "List all device mapper devices."
9241 #: ../fish/guestfish-actions.pod:2581
9243 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9244 "previous call to L</luks-open>."
9248 #: ../fish/guestfish-actions.pod:2584
9250 "Device mapper devices which correspond to logical volumes are I<not> "
9251 "returned in this list. Call L</lvs> if you want to list logical volumes."
9255 #: ../fish/guestfish-actions.pod:2588
9256 msgid "list-filesystems"
9260 #: ../fish/guestfish-actions.pod:2590
9263 " list-filesystems\n"
9268 #: ../fish/guestfish-actions.pod:2592 ../src/guestfs-actions.pod:3798
9270 "This inspection command looks for filesystems on partitions, block devices "
9271 "and logical volumes, returning a list of devices containing filesystems and "
9276 #: ../fish/guestfish-actions.pod:2596 ../src/guestfs-actions.pod:3802
9278 "The return value is a hash, where the keys are the devices containing "
9279 "filesystems, and the values are the filesystem types. For example:"
9283 #: ../fish/guestfish-actions.pod:2600 ../src/guestfs-actions.pod:3806
9286 " \"/dev/sda1\" => \"ntfs\"\n"
9287 " \"/dev/sda2\" => \"ext2\"\n"
9288 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9289 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9294 #: ../fish/guestfish-actions.pod:2605 ../src/guestfs-actions.pod:3811
9296 "The value can have the special value \"unknown\", meaning the content of the "
9297 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9301 #: ../fish/guestfish-actions.pod:2609
9303 "This command runs other libguestfs commands, which might include L</mount> "
9304 "and L</umount>, and therefore you should use this soon after launch and only "
9305 "when nothing is mounted."
9309 #: ../fish/guestfish-actions.pod:2613
9311 "Not all of the filesystems returned will be mountable. In particular, swap "
9312 "partitions are returned in the list. Also this command does not check that "
9313 "each filesystem found is valid and mountable, and some filesystems might be "
9314 "mountable but require special options. Filesystems may not all belong to a "
9315 "single logical operating system (use L</inspect-os> to look for OSes)."
9319 #: ../fish/guestfish-actions.pod:2621
9320 msgid "list-partitions"
9324 #: ../fish/guestfish-actions.pod:2623
9327 " list-partitions\n"
9332 #: ../fish/guestfish-actions.pod:2625 ../src/guestfs-actions.pod:3840
9333 msgid "List all the partitions detected on all block devices."
9337 #: ../fish/guestfish-actions.pod:2627 ../src/guestfs-actions.pod:3842
9338 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9342 #: ../fish/guestfish-actions.pod:2629
9344 "This does not return logical volumes. For that you will need to call "
9349 #: ../fish/guestfish-actions.pod:2634
9354 #: ../fish/guestfish-actions.pod:2636
9362 #: ../fish/guestfish-actions.pod:2638 ../src/guestfs-actions.pod:3861
9364 "List the files in C<directory> (relative to the root directory, there is no "
9365 "cwd) in the format of 'ls -la'."
9369 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3864
9371 "This command is mostly useful for interactive sessions. It is I<not> "
9372 "intended that you try to parse the output string."
9376 #: ../fish/guestfish-actions.pod:2644
9381 #: ../fish/guestfish-actions.pod:2646
9384 " ln target linkname\n"
9389 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:3879
9390 msgid "This command creates a hard link using the C<ln> command."
9394 #: ../fish/guestfish-actions.pod:2650
9399 #: ../fish/guestfish-actions.pod:2652
9402 " ln-f target linkname\n"
9407 #: ../fish/guestfish-actions.pod:2654 ../src/guestfs-actions.pod:3892
9409 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9410 "option removes the link (C<linkname>) if it exists already."
9414 #: ../fish/guestfish-actions.pod:2657
9419 #: ../fish/guestfish-actions.pod:2659
9422 " ln-s target linkname\n"
9427 #: ../fish/guestfish-actions.pod:2661 ../src/guestfs-actions.pod:3906
9428 msgid "This command creates a symbolic link using the C<ln -s> command."
9432 #: ../fish/guestfish-actions.pod:2663
9437 #: ../fish/guestfish-actions.pod:2665
9440 " ln-sf target linkname\n"
9445 #: ../fish/guestfish-actions.pod:2667 ../src/guestfs-actions.pod:3919
9447 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9448 "option removes the link (C<linkname>) if it exists already."
9452 #: ../fish/guestfish-actions.pod:2670
9453 msgid "lremovexattr"
9457 #: ../fish/guestfish-actions.pod:2672
9460 " lremovexattr xattr path\n"
9465 #: ../fish/guestfish-actions.pod:2674
9467 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9468 "it removes an extended attribute of the link itself."
9472 #: ../fish/guestfish-actions.pod:2678
9477 #: ../fish/guestfish-actions.pod:2680
9485 #: ../fish/guestfish-actions.pod:2682 ../src/guestfs-actions.pod:3947
9487 "List the files in C<directory> (relative to the root directory, there is no "
9488 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9493 #: ../fish/guestfish-actions.pod:2686
9495 "This command is mostly useful for interactive sessions. Programs should "
9496 "probably use L</readdir> instead."
9500 #: ../fish/guestfish-actions.pod:2689
9505 #: ../fish/guestfish-actions.pod:2691
9508 " lsetxattr xattr val vallen path\n"
9513 #: ../fish/guestfish-actions.pod:2693
9515 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9516 "sets an extended attribute of the link itself."
9520 #: ../fish/guestfish-actions.pod:2697
9525 #: ../fish/guestfish-actions.pod:2699
9533 #: ../fish/guestfish-actions.pod:2701 ../fish/guestfish-actions.pod:4509 ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:6762
9534 msgid "Returns file information for the given C<path>."
9538 #: ../fish/guestfish-actions.pod:2703
9540 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9541 "the link is stat-ed, not the file it refers to."
9545 #: ../fish/guestfish-actions.pod:2707 ../src/guestfs-actions.pod:3989
9546 msgid "This is the same as the C<lstat(2)> system call."
9550 #: ../fish/guestfish-actions.pod:2709
9555 #: ../fish/guestfish-actions.pod:2711
9558 " lstatlist path 'names ...'\n"
9563 #: ../fish/guestfish-actions.pod:2713
9565 "This call allows you to perform the L</lstat> operation on multiple files, "
9566 "where all files are in the directory C<path>. C<names> is the list of files "
9567 "from this directory."
9571 #: ../fish/guestfish-actions.pod:2717 ../src/guestfs-actions.pod:4008
9573 "On return you get a list of stat structs, with a one-to-one correspondence "
9574 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9575 "then the C<ino> field of that structure is set to C<-1>."
9579 #: ../fish/guestfish-actions.pod:2722
9581 "This call is intended for programs that want to efficiently list a directory "
9582 "contents without making many round-trips. See also L</lxattrlist> for a "
9583 "similarly efficient call for getting extended attributes. Very long "
9584 "directory listings might cause the protocol message size to be exceeded, "
9585 "causing this call to fail. The caller must split up such requests into "
9586 "smaller groups of names."
9590 #: ../fish/guestfish-actions.pod:2730
9591 msgid "luks-add-key"
9595 #: ../fish/guestfish-actions.pod:2732
9598 " luks-add-key device keyslot\n"
9603 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4036
9605 "This command adds a new key on LUKS device C<device>. C<key> is any "
9606 "existing key, and is used to access the device. C<newkey> is the new key to "
9607 "add. C<keyslot> is the key slot that will be replaced."
9611 #: ../fish/guestfish-actions.pod:2739
9613 "Note that if C<keyslot> already contains a key, then this command will "
9614 "fail. You have to use L</luks-kill-slot> first to remove that key."
9618 #: ../fish/guestfish-actions.pod:2743 ../fish/guestfish-actions.pod:2765 ../fish/guestfish-actions.pod:2778 ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2818 ../fish/guestfish-actions.pod:2828
9620 "This command has one or more key or passphrase parameters. Guestfish will "
9621 "prompt for these separately."
9625 #: ../fish/guestfish-actions.pod:2746
9630 #: ../fish/guestfish-actions.pod:2748
9633 " luks-close device\n"
9638 #: ../fish/guestfish-actions.pod:2750
9640 "This closes a LUKS device that was created earlier by L</luks-open> or "
9641 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
9642 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9643 "underlying block device."
9647 #: ../fish/guestfish-actions.pod:2756
9652 #: ../fish/guestfish-actions.pod:2758
9655 " luks-format device keyslot\n"
9660 #: ../fish/guestfish-actions.pod:2760 ../src/guestfs-actions.pod:4077
9662 "This command erases existing data on C<device> and formats the device as a "
9663 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9664 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9668 #: ../fish/guestfish-actions.pod:2768 ../fish/guestfish-actions.pod:2781 ../fish/guestfish-actions.pod:2868 ../fish/guestfish-actions.pod:3529 ../fish/guestfish-actions.pod:4055 ../fish/guestfish-actions.pod:4380 ../fish/guestfish-actions.pod:4403 ../fish/guestfish-actions.pod:4425 ../fish/guestfish-actions.pod:5171 ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4250 ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:6141 ../src/guestfs-actions.pod:6576 ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:7838
9670 "B<This command is dangerous. Without careful use you can easily destroy all "
9675 #: ../fish/guestfish-actions.pod:2771
9676 msgid "luks-format-cipher"
9680 #: ../fish/guestfish-actions.pod:2773
9683 " luks-format-cipher device keyslot cipher\n"
9688 #: ../fish/guestfish-actions.pod:2775
9690 "This command is the same as L</luks-format> but it also allows you to set "
9691 "the C<cipher> used."
9695 #: ../fish/guestfish-actions.pod:2784
9696 msgid "luks-kill-slot"
9700 #: ../fish/guestfish-actions.pod:2786
9703 " luks-kill-slot device keyslot\n"
9708 #: ../fish/guestfish-actions.pod:2788 ../src/guestfs-actions.pod:4124
9710 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9711 "device C<device>. C<key> must be one of the I<other> keys."
9715 #: ../fish/guestfish-actions.pod:2795
9720 #: ../fish/guestfish-actions.pod:2797
9723 " luks-open device mapname\n"
9728 #: ../fish/guestfish-actions.pod:2799 ../src/guestfs-actions.pod:4144
9730 "This command opens a block device which has been encrypted according to the "
9731 "Linux Unified Key Setup (LUKS) standard."
9735 #: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4147
9736 msgid "C<device> is the encrypted block device or partition."
9740 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4149
9742 "The caller must supply one of the keys associated with the LUKS block "
9743 "device, in the C<key> parameter."
9747 #: ../fish/guestfish-actions.pod:2807 ../src/guestfs-actions.pod:4152
9749 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9750 "writes to this block device are decrypted from and encrypted to the "
9751 "underlying C<device> respectively."
9755 #: ../fish/guestfish-actions.pod:2811
9757 "If this block device contains LVM volume groups, then calling L</vgscan> "
9758 "followed by L</vg-activate-all> will make them visible."
9762 #: ../fish/guestfish-actions.pod:2815
9763 msgid "Use L</list-dm-devices> to list all device mapper devices."
9767 #: ../fish/guestfish-actions.pod:2821
9768 msgid "luks-open-ro"
9772 #: ../fish/guestfish-actions.pod:2823
9775 " luks-open-ro device mapname\n"
9780 #: ../fish/guestfish-actions.pod:2825
9782 "This is the same as L</luks-open> except that a read-only mapping is "
9787 #: ../fish/guestfish-actions.pod:2831
9792 #: ../fish/guestfish-actions.pod:2833
9795 " lvcreate logvol volgroup mbytes\n"
9800 #: ../fish/guestfish-actions.pod:2835 ../src/guestfs-actions.pod:4198
9802 "This creates an LVM logical volume called C<logvol> on the volume group "
9803 "C<volgroup>, with C<size> megabytes."
9807 #: ../fish/guestfish-actions.pod:2838
9808 msgid "lvm-canonical-lv-name"
9812 #: ../fish/guestfish-actions.pod:2840
9815 " lvm-canonical-lv-name lvname\n"
9820 #: ../fish/guestfish-actions.pod:2842 ../src/guestfs-actions.pod:4211
9822 "This converts alternative naming schemes for LVs that you might find to the "
9823 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9828 #: ../fish/guestfish-actions.pod:2846 ../src/guestfs-actions.pod:4215
9830 "This command returns an error if the C<lvname> parameter does not refer to a "
9835 #: ../fish/guestfish-actions.pod:2849
9836 msgid "See also L</is-lv>."
9840 #: ../fish/guestfish-actions.pod:2851
9841 msgid "lvm-clear-filter"
9845 #: ../fish/guestfish-actions.pod:2853
9848 " lvm-clear-filter\n"
9853 #: ../fish/guestfish-actions.pod:2855
9855 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
9860 #: ../fish/guestfish-actions.pod:2858 ../fish/guestfish-actions.pod:2889 ../src/guestfs-actions.pod:4233 ../src/guestfs-actions.pod:4275
9861 msgid "This command also clears the LVM cache and performs a volume group scan."
9865 #: ../fish/guestfish-actions.pod:2861
9866 msgid "lvm-remove-all"
9870 #: ../fish/guestfish-actions.pod:2863
9878 #: ../fish/guestfish-actions.pod:2865 ../src/guestfs-actions.pod:4245
9880 "This command removes all LVM logical volumes, volume groups and physical "
9885 #: ../fish/guestfish-actions.pod:2871
9886 msgid "lvm-set-filter"
9890 #: ../fish/guestfish-actions.pod:2873
9893 " lvm-set-filter 'devices ...'\n"
9898 #: ../fish/guestfish-actions.pod:2875 ../src/guestfs-actions.pod:4261
9900 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9901 "block devices in the list C<devices>, and will ignore all other attached "
9906 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4265
9908 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9909 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9910 "there are two types of duplication possible: either cloned PVs/VGs which "
9911 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9912 "same name. In normal operation you cannot create this situation, but you "
9913 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9914 "inside the LVM metadata."
9918 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4278
9919 msgid "You can filter whole block devices or individual partitions."
9923 #: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4280
9925 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9926 "filesystem), even if you are not filtering out that VG."
9930 #: ../fish/guestfish-actions.pod:2898
9935 #: ../fish/guestfish-actions.pod:2900
9938 " lvremove device\n"
9943 #: ../fish/guestfish-actions.pod:2902 ../src/guestfs-actions.pod:4294
9945 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9946 "LV, such as C</dev/VG/LV>."
9950 #: ../fish/guestfish-actions.pod:2905 ../src/guestfs-actions.pod:4297
9952 "You can also remove all LVs in a volume group by specifying the VG name, "
9957 #: ../fish/guestfish-actions.pod:2908
9962 #: ../fish/guestfish-actions.pod:2910
9965 " lvrename logvol newlogvol\n"
9970 #: ../fish/guestfish-actions.pod:2912 ../src/guestfs-actions.pod:4311
9971 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9975 #: ../fish/guestfish-actions.pod:2914
9980 #: ../fish/guestfish-actions.pod:2916
9983 " lvresize device mbytes\n"
9988 #: ../fish/guestfish-actions.pod:2918 ../src/guestfs-actions.pod:4324
9990 "This resizes (expands or shrinks) an existing LVM logical volume to "
9991 "C<mbytes>. When reducing, data in the reduced part is lost."
9995 #: ../fish/guestfish-actions.pod:2922
9996 msgid "lvresize-free"
10000 #: ../fish/guestfish-actions.pod:2924
10003 " lvresize-free lv percent\n"
10008 #: ../fish/guestfish-actions.pod:2926 ../src/guestfs-actions.pod:4339
10010 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10011 "remaining free space in the volume group. Commonly you would call this with "
10012 "pc = 100 which expands the logical volume as much as possible, using all "
10013 "remaining free space in the volume group."
10017 #: ../fish/guestfish-actions.pod:2932
10022 #: ../fish/guestfish-actions.pod:2934
10030 #: ../fish/guestfish-actions.pod:2936 ../src/guestfs-actions.pod:4354
10032 "List all the logical volumes detected. This is the equivalent of the "
10033 "L<lvs(8)> command."
10037 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4357
10039 "This returns a list of the logical volume device names "
10040 "(eg. C</dev/VolGroup00/LogVol00>)."
10044 #: ../fish/guestfish-actions.pod:2942
10045 msgid "See also L</lvs-full>, L</list-filesystems>."
10049 #: ../fish/guestfish-actions.pod:2944
10054 #: ../fish/guestfish-actions.pod:2946
10062 #: ../fish/guestfish-actions.pod:2948 ../src/guestfs-actions.pod:4373
10064 "List all the logical volumes detected. This is the equivalent of the "
10065 "L<lvs(8)> command. The \"full\" version includes all fields."
10069 #: ../fish/guestfish-actions.pod:2951
10074 #: ../fish/guestfish-actions.pod:2953
10082 #: ../fish/guestfish-actions.pod:2955 ../src/guestfs-actions.pod:4388
10083 msgid "This command returns the UUID of the LVM LV C<device>."
10087 #: ../fish/guestfish-actions.pod:2957
10092 #: ../fish/guestfish-actions.pod:2959
10095 " lxattrlist path 'names ...'\n"
10100 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4402
10102 "This call allows you to get the extended attributes of multiple files, where "
10103 "all files are in the directory C<path>. C<names> is the list of files from "
10108 #: ../fish/guestfish-actions.pod:2965 ../src/guestfs-actions.pod:4406
10110 "On return you get a flat list of xattr structs which must be interpreted "
10111 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10112 "C<attrval> in this struct is zero-length to indicate there was an error "
10113 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10114 "number (the number of following attributes for this file, which could be "
10115 "C<\"0\">). Then after the first xattr struct are the zero or more "
10116 "attributes for the first named file. This repeats for the second and "
10117 "subsequent files."
10121 #: ../fish/guestfish-actions.pod:2975
10123 "This call is intended for programs that want to efficiently list a directory "
10124 "contents without making many round-trips. See also L</lstatlist> for a "
10125 "similarly efficient call for getting standard stats. Very long directory "
10126 "listings might cause the protocol message size to be exceeded, causing this "
10127 "call to fail. The caller must split up such requests into smaller groups of "
10132 #: ../fish/guestfish-actions.pod:2983
10137 #: ../fish/guestfish-actions.pod:2985
10145 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4436
10146 msgid "Create a directory named C<path>."
10150 #: ../fish/guestfish-actions.pod:2989
10155 #: ../fish/guestfish-actions.pod:2991
10158 " mkdir-mode path mode\n"
10163 #: ../fish/guestfish-actions.pod:2993 ../src/guestfs-actions.pod:4449
10165 "This command creates a directory, setting the initial permissions of the "
10166 "directory to C<mode>."
10170 #: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4452
10172 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10173 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10178 #: ../fish/guestfish-actions.pod:3000
10179 msgid "See also L</mkdir>, L</umask>"
10183 #: ../fish/guestfish-actions.pod:3002
10188 #: ../fish/guestfish-actions.pod:3004
10196 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4468
10198 "Create a directory named C<path>, creating any parent directories as "
10199 "necessary. This is like the C<mkdir -p> shell command."
10203 #: ../fish/guestfish-actions.pod:3009
10208 #: ../fish/guestfish-actions.pod:3011
10211 " mkdtemp template\n"
10216 #: ../fish/guestfish-actions.pod:3013 ../src/guestfs-actions.pod:4481
10218 "This command creates a temporary directory. The C<template> parameter "
10219 "should be a full pathname for the temporary directory name with the final "
10220 "six characters being \"XXXXXX\"."
10224 #: ../fish/guestfish-actions.pod:3018 ../src/guestfs-actions.pod:4486
10226 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10227 "being suitable for Windows filesystems."
10231 #: ../fish/guestfish-actions.pod:3021 ../src/guestfs-actions.pod:4489
10232 msgid "The name of the temporary directory that was created is returned."
10236 #: ../fish/guestfish-actions.pod:3024 ../src/guestfs-actions.pod:4492
10237 msgid "The temporary directory is created with mode 0700 and is owned by root."
10241 #: ../fish/guestfish-actions.pod:3027 ../src/guestfs-actions.pod:4495
10243 "The caller is responsible for deleting the temporary directory and its "
10244 "contents after use."
10248 #: ../fish/guestfish-actions.pod:3030 ../src/guestfs-actions.pod:4498
10249 msgid "See also: L<mkdtemp(3)>"
10253 #: ../fish/guestfish-actions.pod:3032
10258 #: ../fish/guestfish-actions.pod:3034
10261 " mke2fs-J fstype blocksize device journal\n"
10266 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4514
10268 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10269 "C<journal>. It is equivalent to the command:"
10273 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4518
10276 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10281 #: ../fish/guestfish-actions.pod:3042
10282 msgid "See also L</mke2journal>."
10286 #: ../fish/guestfish-actions.pod:3044
10291 #: ../fish/guestfish-actions.pod:3046
10294 " mke2fs-JL fstype blocksize device label\n"
10299 #: ../fish/guestfish-actions.pod:3048 ../src/guestfs-actions.pod:4535
10301 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10302 "the journal labeled C<label>."
10306 #: ../fish/guestfish-actions.pod:3051
10307 msgid "See also L</mke2journal-L>."
10311 #: ../fish/guestfish-actions.pod:3053
10316 #: ../fish/guestfish-actions.pod:3055
10319 " mke2fs-JU fstype blocksize device uuid\n"
10324 #: ../fish/guestfish-actions.pod:3057 ../src/guestfs-actions.pod:4553
10326 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10327 "the journal with UUID C<uuid>."
10331 #: ../fish/guestfish-actions.pod:3060
10332 msgid "See also L</mke2journal-U>."
10336 #: ../fish/guestfish-actions.pod:3062
10337 msgid "mke2journal"
10341 #: ../fish/guestfish-actions.pod:3064
10344 " mke2journal blocksize device\n"
10349 #: ../fish/guestfish-actions.pod:3066 ../src/guestfs-actions.pod:4569
10351 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10356 #: ../fish/guestfish-actions.pod:3069 ../src/guestfs-actions.pod:4572
10359 " mke2fs -O journal_dev -b blocksize device\n"
10364 #: ../fish/guestfish-actions.pod:3071
10365 msgid "mke2journal-L"
10369 #: ../fish/guestfish-actions.pod:3073
10372 " mke2journal-L blocksize label device\n"
10377 #: ../fish/guestfish-actions.pod:3075 ../src/guestfs-actions.pod:4586
10378 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10382 #: ../fish/guestfish-actions.pod:3077
10383 msgid "mke2journal-U"
10387 #: ../fish/guestfish-actions.pod:3079
10390 " mke2journal-U blocksize uuid device\n"
10395 #: ../fish/guestfish-actions.pod:3081 ../src/guestfs-actions.pod:4600
10396 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10400 #: ../fish/guestfish-actions.pod:3083
10405 #: ../fish/guestfish-actions.pod:3085
10408 " mkfifo mode path\n"
10413 #: ../fish/guestfish-actions.pod:3087
10415 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10416 "is just a convenient wrapper around L</mknod>."
10420 #: ../fish/guestfish-actions.pod:3093
10425 #: ../fish/guestfish-actions.pod:3095
10428 " mkfs fstype device\n"
10433 #: ../fish/guestfish-actions.pod:3097 ../src/guestfs-actions.pod:4630
10435 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10436 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10440 #: ../fish/guestfish-actions.pod:3101
10445 #: ../fish/guestfish-actions.pod:3103
10448 " mkfs-b fstype blocksize device\n"
10453 #: ../fish/guestfish-actions.pod:3105
10455 "This call is similar to L</mkfs>, but it allows you to control the block "
10456 "size of the resulting filesystem. Supported block sizes depend on the "
10457 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10461 #: ../fish/guestfish-actions.pod:3110 ../fish/guestfish-actions.pod:3137 ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4696
10463 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10468 #: ../fish/guestfish-actions.pod:3113
10470 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
10475 #: ../fish/guestfish-actions.pod:3120
10480 #: ../fish/guestfish-actions.pod:3122
10483 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10484 "[sectorsize:..]\n"
10489 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10491 "This function creates a filesystem on C<device>. The filesystem type is "
10492 "C<fstype>, for example C<ext3>."
10496 #: ../fish/guestfish-actions.pod:3131 ../src/guestfs-actions.pod:4690
10497 msgid "C<blocksize>"
10501 #: ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4692
10503 "The filesystem block size. Supported block sizes depend on the filesystem "
10504 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10509 #: ../fish/guestfish-actions.pod:3140 ../src/guestfs-actions.pod:4699
10510 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10514 #: ../fish/guestfish-actions.pod:3142 ../src/guestfs-actions.pod:4701
10515 msgid "C<features>"
10519 #: ../fish/guestfish-actions.pod:3144 ../src/guestfs-actions.pod:4703
10520 msgid "This passes the I<-O> parameter to the external mkfs program."
10524 #: ../fish/guestfish-actions.pod:3146 ../src/guestfs-actions.pod:4705
10526 "For certain filesystem types, this allows extra filesystem features to be "
10527 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10531 #: ../fish/guestfish-actions.pod:3150 ../src/guestfs-actions.pod:4709
10533 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10538 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4712
10543 #: ../fish/guestfish-actions.pod:3155 ../src/guestfs-actions.pod:4714
10545 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10546 "sets the inode size (only for ext2/3/4 filesystems at present)."
10550 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4717
10551 msgid "C<sectorsize>"
10555 #: ../fish/guestfish-actions.pod:3160 ../src/guestfs-actions.pod:4719
10557 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10558 "sets sector size for ufs filesystem."
10562 #: ../fish/guestfish-actions.pod:3167
10563 msgid "mkmountpoint"
10567 #: ../fish/guestfish-actions.pod:3169
10570 " mkmountpoint exemptpath\n"
10575 #: ../fish/guestfish-actions.pod:3171
10577 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10578 "to create extra mountpoints before mounting the first filesystem."
10582 #: ../fish/guestfish-actions.pod:3175 ../src/guestfs-actions.pod:4762
10584 "These calls are I<only> necessary in some very limited circumstances, mainly "
10585 "the case where you want to mount a mix of unrelated and/or read-only "
10586 "filesystems together."
10590 #: ../fish/guestfish-actions.pod:3179 ../src/guestfs-actions.pod:4766
10592 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10593 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10594 "inside that. You can unpack this as follows in guestfish:"
10598 #: ../fish/guestfish-actions.pod:3184 ../src/guestfs-actions.pod:4771
10601 " add-ro Fedora-11-i686-Live.iso\n"
10603 " mkmountpoint /cd\n"
10604 " mkmountpoint /sqsh\n"
10605 " mkmountpoint /ext3fs\n"
10606 " mount /dev/sda /cd\n"
10607 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10608 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10613 #: ../fish/guestfish-actions.pod:3193 ../src/guestfs-actions.pod:4780
10614 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10618 #: ../fish/guestfish-actions.pod:3195
10620 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10621 "unexpected errors if you try to mix these calls. It is safest to manually "
10622 "unmount filesystems and remove mountpoints after use."
10626 #: ../fish/guestfish-actions.pod:3199
10628 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10629 "for this to work for manual mountpoints, you must ensure that the innermost "
10630 "mountpoints have the longest pathnames, as in the example code above."
10634 #: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4791
10635 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10639 #: ../fish/guestfish-actions.pod:3206
10641 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10642 "L</umount-all> to be called when the handle is closed which can also trigger "
10647 #: ../fish/guestfish-actions.pod:3210
10652 #: ../fish/guestfish-actions.pod:3212
10655 " mknod mode devmajor devminor path\n"
10660 #: ../fish/guestfish-actions.pod:3214 ../src/guestfs-actions.pod:4810
10662 "This call creates block or character special devices, or named pipes "
10667 #: ../fish/guestfish-actions.pod:3217 ../src/guestfs-actions.pod:4813
10669 "The C<mode> parameter should be the mode, using the standard constants. "
10670 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10671 "used when creating block and character special devices."
10675 #: ../fish/guestfish-actions.pod:3222
10677 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10678 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10679 "regular file). These constants are available in the standard Linux header "
10680 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10681 "wrappers around this command which bitwise OR in the appropriate constant "
10686 #: ../fish/guestfish-actions.pod:3232
10691 #: ../fish/guestfish-actions.pod:3234
10694 " mknod-b mode devmajor devminor path\n"
10699 #: ../fish/guestfish-actions.pod:3236
10701 "This call creates a block device node called C<path> with mode C<mode> and "
10702 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10703 "wrapper around L</mknod>."
10707 #: ../fish/guestfish-actions.pod:3242
10712 #: ../fish/guestfish-actions.pod:3244
10715 " mknod-c mode devmajor devminor path\n"
10720 #: ../fish/guestfish-actions.pod:3246
10722 "This call creates a char device node called C<path> with mode C<mode> and "
10723 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10724 "wrapper around L</mknod>."
10728 #: ../fish/guestfish-actions.pod:3252
10733 #: ../fish/guestfish-actions.pod:3254
10741 #: ../fish/guestfish-actions.pod:3256 ../src/guestfs-actions.pod:4876
10742 msgid "Create a swap partition on C<device>."
10746 #: ../fish/guestfish-actions.pod:3258
10751 #: ../fish/guestfish-actions.pod:3260
10754 " mkswap-L label device\n"
10759 #: ../fish/guestfish-actions.pod:3262 ../src/guestfs-actions.pod:4889
10760 msgid "Create a swap partition on C<device> with label C<label>."
10764 #: ../fish/guestfish-actions.pod:3264 ../src/guestfs-actions.pod:4891
10766 "Note that you cannot attach a swap label to a block device "
10767 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10768 "the kernel or swap tools."
10772 #: ../fish/guestfish-actions.pod:3268
10777 #: ../fish/guestfish-actions.pod:3270
10780 " mkswap-U uuid device\n"
10785 #: ../fish/guestfish-actions.pod:3272 ../src/guestfs-actions.pod:4906
10786 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10790 #: ../fish/guestfish-actions.pod:3274
10791 msgid "mkswap-file"
10795 #: ../fish/guestfish-actions.pod:3276
10798 " mkswap-file path\n"
10803 #: ../fish/guestfish-actions.pod:3278 ../src/guestfs-actions.pod:4918
10804 msgid "Create a swap file."
10808 #: ../fish/guestfish-actions.pod:3280
10810 "This command just writes a swap file signature to an existing file. To "
10811 "create the file itself, use something like L</fallocate>."
10815 #: ../fish/guestfish-actions.pod:3283
10820 #: ../fish/guestfish-actions.pod:3285
10823 " modprobe modulename\n"
10828 #: ../fish/guestfish-actions.pod:3287 ../src/guestfs-actions.pod:4933
10829 msgid "This loads a kernel module in the appliance."
10833 #: ../fish/guestfish-actions.pod:3289 ../src/guestfs-actions.pod:4935
10835 "The kernel module must have been whitelisted when libguestfs was built (see "
10836 "C<appliance/kmod.whitelist.in> in the source)."
10840 #: ../fish/guestfish-actions.pod:3292
10845 #: ../fish/guestfish-actions.pod:3294
10848 " mount device mountpoint\n"
10853 #: ../fish/guestfish-actions.pod:3296 ../src/guestfs-actions.pod:4956
10855 "Mount a guest disk at a position in the filesystem. Block devices are named "
10856 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10857 "those block devices contain partitions, they will have the usual names "
10858 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10862 #: ../fish/guestfish-actions.pod:3302 ../src/guestfs-actions.pod:4962
10864 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10865 "mounted on C</> before others can be mounted. Other filesystems can only be "
10866 "mounted on directories which already exist."
10870 #: ../fish/guestfish-actions.pod:3307 ../src/guestfs-actions.pod:4967
10872 "The mounted filesystem is writable, if we have sufficient permissions on the "
10873 "underlying device."
10877 #: ../fish/guestfish-actions.pod:3310
10879 "B<Important note:> When you use this call, the filesystem options C<sync> "
10880 "and C<noatime> are set implicitly. This was originally done because we "
10881 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10882 "very large negative performance impact and negligible effect on "
10883 "reliability. Therefore we recommend that you avoid using L</mount> in any "
10884 "code that needs performance, and instead use L</mount-options> (use an empty "
10885 "string for the first parameter if you don't want any options)."
10889 #: ../fish/guestfish-actions.pod:3320
10891 "I<This function is deprecated.> In new code, use the L</mount_options> call "
10896 #: ../fish/guestfish-actions.pod:3327
10901 #: ../fish/guestfish-actions.pod:3329
10904 " mount-9p mounttag mountpoint [options:..]\n"
10909 #: ../fish/guestfish-actions.pod:3331 ../src/guestfs-actions.pod:4999
10911 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10916 #: ../fish/guestfish-actions.pod:3334 ../src/guestfs-actions.pod:5002
10918 "If required, C<trans=virtio> will be automatically added to the options. "
10919 "Any other options required can be passed in the optional C<options> "
10924 #: ../fish/guestfish-actions.pod:3340
10929 #: ../fish/guestfish-actions.pod:3342
10932 " mount-loop file mountpoint\n"
10937 #: ../fish/guestfish-actions.pod:3344 ../src/guestfs-actions.pod:5041
10939 "This command lets you mount C<file> (a filesystem image in a file) on a "
10940 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10945 #: ../fish/guestfish-actions.pod:3348
10946 msgid "mount-options"
10950 #: ../fish/guestfish-actions.pod:3350
10953 " mount-options options device mountpoint\n"
10958 #: ../fish/guestfish-actions.pod:3352
10960 "This is the same as the L</mount> command, but it allows you to set the "
10961 "mount options as for the L<mount(8)> I<-o> flag."
10965 #: ../fish/guestfish-actions.pod:3356 ../src/guestfs-actions.pod:5061
10967 "If the C<options> parameter is an empty string, then no options are passed "
10968 "(all options default to whatever the filesystem uses)."
10972 #: ../fish/guestfish-actions.pod:3360
10977 #: ../fish/guestfish-actions.pod:3362
10980 " mount-ro device mountpoint\n"
10985 #: ../fish/guestfish-actions.pod:3364
10987 "This is the same as the L</mount> command, but it mounts the filesystem with "
10988 "the read-only (I<-o ro>) flag."
10992 #: ../fish/guestfish-actions.pod:3367
10997 #: ../fish/guestfish-actions.pod:3369
11000 " mount-vfs options vfstype device mountpoint\n"
11005 #: ../fish/guestfish-actions.pod:3371
11007 "This is the same as the L</mount> command, but it allows you to set both the "
11008 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11012 #: ../fish/guestfish-actions.pod:3375
11013 msgid "mountpoints"
11017 #: ../fish/guestfish-actions.pod:3377
11025 #: ../fish/guestfish-actions.pod:3379
11027 "This call is similar to L</mounts>. That call returns a list of devices. "
11028 "This one returns a hash table (map) of device name to directory where the "
11029 "device is mounted."
11033 #: ../fish/guestfish-actions.pod:3383
11038 #: ../fish/guestfish-actions.pod:3385
11046 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5122
11048 "This returns the list of currently mounted filesystems. It returns the list "
11049 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11053 #: ../fish/guestfish-actions.pod:3390 ../src/guestfs-actions.pod:5125
11054 msgid "Some internal mounts are not shown."
11058 #: ../fish/guestfish-actions.pod:3392
11059 msgid "See also: L</mountpoints>"
11063 #: ../fish/guestfish-actions.pod:3394
11068 #: ../fish/guestfish-actions.pod:3396
11076 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5142
11078 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11079 "destination filename or destination directory."
11083 #: ../fish/guestfish-actions.pod:3401
11084 msgid "ntfs-3g-probe"
11088 #: ../fish/guestfish-actions.pod:3403
11091 " ntfs-3g-probe true|false device\n"
11096 #: ../fish/guestfish-actions.pod:3405 ../src/guestfs-actions.pod:5156
11098 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11099 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11100 "read-write, and some cannot be mounted at all)."
11104 #: ../fish/guestfish-actions.pod:3409 ../src/guestfs-actions.pod:5160
11106 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11107 "can be mounted read-write. Set it to false if you want to test if the "
11108 "volume can be mounted read-only."
11112 #: ../fish/guestfish-actions.pod:3413 ../src/guestfs-actions.pod:5164
11114 "The return value is an integer which C<0> if the operation would succeed, or "
11115 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11119 #: ../fish/guestfish-actions.pod:3417
11124 #: ../fish/guestfish-actions.pod:3419
11127 " ntfsresize device\n"
11132 #: ../fish/guestfish-actions.pod:3421 ../fish/guestfish-actions.pod:3445 ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:5217
11134 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11135 "size of the underlying device."
11139 #: ../fish/guestfish-actions.pod:3424 ../src/guestfs-actions.pod:5188
11141 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11142 "consistency check (for safety). You have to boot into Windows to perform "
11143 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11144 "resize filesystems which have been marked in this way. So in effect it is "
11145 "not possible to call ntfsresize multiple times on a single filesystem "
11146 "without booting into Windows between each resize."
11150 #: ../fish/guestfish-actions.pod:3432 ../fish/guestfish-actions.pod:3471 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5243
11151 msgid "See also L<ntfsresize(8)>."
11155 #: ../fish/guestfish-actions.pod:3434 ../fish/guestfish-actions.pod:3482
11157 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
11162 #: ../fish/guestfish-actions.pod:3441
11163 msgid "ntfsresize-opts"
11167 #: ../fish/guestfish-actions.pod:3443
11170 " ntfsresize-opts device [size:..] [force:..]\n"
11175 #: ../fish/guestfish-actions.pod:3454 ../src/guestfs-actions.pod:5226
11177 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11178 "resized to fit the container (eg. partition)."
11182 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5229
11187 #: ../fish/guestfish-actions.pod:3459 ../src/guestfs-actions.pod:5231
11189 "If this option is true, then force the resize of the filesystem even if the "
11190 "filesystem is marked as requiring a consistency check."
11194 #: ../fish/guestfish-actions.pod:3462
11196 "After the resize operation, the filesystem is always marked as requiring a "
11197 "consistency check (for safety). You have to boot into Windows to perform "
11198 "this check and clear this condition. If you I<don't> set the C<force> "
11199 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11200 "a single filesystem without booting into Windows between each resize."
11204 #: ../fish/guestfish-actions.pod:3475
11205 msgid "ntfsresize-size"
11209 #: ../fish/guestfish-actions.pod:3477
11212 " ntfsresize-size device size\n"
11217 #: ../fish/guestfish-actions.pod:3479
11219 "This command is the same as L</ntfsresize> except that it allows you to "
11220 "specify the new size (in bytes) explicitly."
11224 #: ../fish/guestfish-actions.pod:3489
11229 #: ../fish/guestfish-actions.pod:3491
11232 " part-add device prlogex startsect endsect\n"
11237 #: ../fish/guestfish-actions.pod:3493
11239 "This command adds a partition to C<device>. If there is no partition table "
11240 "on the device, call L</part-init> first."
11244 #: ../fish/guestfish-actions.pod:3496 ../src/guestfs-actions.pod:5304
11246 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11247 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11248 "C<logical>) and C<e> (or C<extended>) partition types."
11252 #: ../fish/guestfish-actions.pod:3501 ../src/guestfs-actions.pod:5309
11254 "C<startsect> and C<endsect> are the start and end of the partition in "
11255 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11256 "from the end of the disk (C<-1> is the last sector)."
11260 #: ../fish/guestfish-actions.pod:3505
11262 "Creating a partition which covers the whole disk is not so easy. Use "
11263 "L</part-disk> to do that."
11267 #: ../fish/guestfish-actions.pod:3508
11272 #: ../fish/guestfish-actions.pod:3510
11275 " part-del device partnum\n"
11280 #: ../fish/guestfish-actions.pod:3512 ../src/guestfs-actions.pod:5327
11281 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11285 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5329
11287 "Note that in the case of MBR partitioning, deleting an extended partition "
11288 "also deletes any logical partitions it contains."
11292 #: ../fish/guestfish-actions.pod:3518
11297 #: ../fish/guestfish-actions.pod:3520
11300 " part-disk device parttype\n"
11305 #: ../fish/guestfish-actions.pod:3522
11307 "This command is simply a combination of L</part-init> followed by "
11308 "L</part-add> to create a single primary partition covering the whole disk."
11312 #: ../fish/guestfish-actions.pod:3526
11314 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11315 "possible values are described in L</part-init>."
11319 #: ../fish/guestfish-actions.pod:3532
11320 msgid "part-get-bootable"
11324 #: ../fish/guestfish-actions.pod:3534
11327 " part-get-bootable device partnum\n"
11332 #: ../fish/guestfish-actions.pod:3536 ../src/guestfs-actions.pod:5365
11334 "This command returns true if the partition C<partnum> on C<device> has the "
11335 "bootable flag set."
11339 #: ../fish/guestfish-actions.pod:3539
11340 msgid "See also L</part-set-bootable>."
11344 #: ../fish/guestfish-actions.pod:3541
11345 msgid "part-get-mbr-id"
11349 #: ../fish/guestfish-actions.pod:3543
11352 " part-get-mbr-id device partnum\n"
11357 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5381
11359 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11360 "partition C<partnum>."
11364 #: ../fish/guestfish-actions.pod:3548 ../fish/guestfish-actions.pod:3692
11366 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11367 "undefined results for other partition table types (see "
11368 "L</part-get-parttype>)."
11372 #: ../fish/guestfish-actions.pod:3552
11373 msgid "part-get-parttype"
11377 #: ../fish/guestfish-actions.pod:3554
11380 " part-get-parttype device\n"
11385 #: ../fish/guestfish-actions.pod:3556 ../src/guestfs-actions.pod:5398
11387 "This command examines the partition table on C<device> and returns the "
11388 "partition table type (format) being used."
11392 #: ../fish/guestfish-actions.pod:3559
11394 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11395 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11396 "possible, although unusual. See L</part-init> for a full list."
11400 #: ../fish/guestfish-actions.pod:3564
11405 #: ../fish/guestfish-actions.pod:3566
11408 " part-init device parttype\n"
11413 #: ../fish/guestfish-actions.pod:3568 ../src/guestfs-actions.pod:5418
11415 "This creates an empty partition table on C<device> of one of the partition "
11416 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11417 "(for large disks)."
11421 #: ../fish/guestfish-actions.pod:3572
11423 "Initially there are no partitions. Following this, you should call "
11424 "L</part-add> for each partition required."
11428 #: ../fish/guestfish-actions.pod:3575 ../src/guestfs-actions.pod:5425
11429 msgid "Possible values for C<parttype> are:"
11433 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11438 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11443 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
11444 msgid "Intel EFI / GPT partition table."
11448 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11450 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11451 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11452 "the C<mbr> format."
11456 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11461 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
11466 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
11468 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11469 "Windows. This partition type will B<only> work for device sizes up to 2 "
11470 "TB. For large disks we recommend using C<gpt>."
11474 #: ../fish/guestfish-actions.pod:3600 ../src/guestfs-actions.pod:5450
11475 msgid "Other partition table types that may work but are not supported include:"
11479 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11484 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11485 msgid "AIX disk labels."
11489 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11494 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11499 #: ../fish/guestfish-actions.pod:3613 ../src/guestfs-actions.pod:5463
11500 msgid "Amiga \"Rigid Disk Block\" format."
11504 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5465
11509 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5467
11510 msgid "BSD disk labels."
11514 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5469
11519 #: ../fish/guestfish-actions.pod:3621 ../src/guestfs-actions.pod:5471
11520 msgid "DASD, used on IBM mainframes."
11524 #: ../fish/guestfish-actions.pod:3623 ../src/guestfs-actions.pod:5473
11529 #: ../fish/guestfish-actions.pod:3625 ../src/guestfs-actions.pod:5475
11530 msgid "MIPS/SGI volumes."
11534 #: ../fish/guestfish-actions.pod:3627 ../src/guestfs-actions.pod:5477
11539 #: ../fish/guestfish-actions.pod:3629 ../src/guestfs-actions.pod:5479
11540 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11544 #: ../fish/guestfish-actions.pod:3631 ../src/guestfs-actions.pod:5481
11549 #: ../fish/guestfish-actions.pod:3633 ../src/guestfs-actions.pod:5483
11550 msgid "NEC PC-98 format, common in Japan apparently."
11554 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5485
11559 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5487
11560 msgid "Sun disk labels."
11564 #: ../fish/guestfish-actions.pod:3641
11569 #: ../fish/guestfish-actions.pod:3643
11572 " part-list device\n"
11577 #: ../fish/guestfish-actions.pod:3645 ../src/guestfs-actions.pod:5501
11579 "This command parses the partition table on C<device> and returns the list of "
11580 "partitions found."
11584 #: ../fish/guestfish-actions.pod:3648 ../src/guestfs-actions.pod:5504
11585 msgid "The fields in the returned structure are:"
11589 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5508
11590 msgid "B<part_num>"
11594 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5510
11595 msgid "Partition number, counting from 1."
11599 #: ../fish/guestfish-actions.pod:3656 ../src/guestfs-actions.pod:5512
11600 msgid "B<part_start>"
11604 #: ../fish/guestfish-actions.pod:3658
11606 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11607 "the device's sector size, see L</blockdev-getss>."
11611 #: ../fish/guestfish-actions.pod:3661 ../src/guestfs-actions.pod:5517
11612 msgid "B<part_end>"
11616 #: ../fish/guestfish-actions.pod:3663 ../src/guestfs-actions.pod:5519
11617 msgid "End of the partition in bytes."
11621 #: ../fish/guestfish-actions.pod:3665 ../src/guestfs-actions.pod:5521
11622 msgid "B<part_size>"
11626 #: ../fish/guestfish-actions.pod:3667 ../src/guestfs-actions.pod:5523
11627 msgid "Size of the partition in bytes."
11631 #: ../fish/guestfish-actions.pod:3671
11632 msgid "part-set-bootable"
11636 #: ../fish/guestfish-actions.pod:3673
11639 " part-set-bootable device partnum true|false\n"
11644 #: ../fish/guestfish-actions.pod:3675 ../src/guestfs-actions.pod:5541
11646 "This sets the bootable flag on partition numbered C<partnum> on device "
11647 "C<device>. Note that partitions are numbered from 1."
11651 #: ../fish/guestfish-actions.pod:3678 ../src/guestfs-actions.pod:5544
11653 "The bootable flag is used by some operating systems (notably Windows) to "
11654 "determine which partition to boot from. It is by no means universally "
11659 #: ../fish/guestfish-actions.pod:3682
11660 msgid "part-set-mbr-id"
11664 #: ../fish/guestfish-actions.pod:3684
11667 " part-set-mbr-id device partnum idbyte\n"
11672 #: ../fish/guestfish-actions.pod:3686 ../src/guestfs-actions.pod:5560
11674 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11675 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11676 "documentation are in fact hexadecimal numbers, but usually documented "
11677 "without any leading \"0x\" which might be confusing."
11681 #: ../fish/guestfish-actions.pod:3696
11682 msgid "part-set-name"
11686 #: ../fish/guestfish-actions.pod:3698
11689 " part-set-name device partnum name\n"
11694 #: ../fish/guestfish-actions.pod:3700 ../src/guestfs-actions.pod:5582
11696 "This sets the partition name on partition numbered C<partnum> on device "
11697 "C<device>. Note that partitions are numbered from 1."
11701 #: ../fish/guestfish-actions.pod:3703 ../src/guestfs-actions.pod:5585
11703 "The partition name can only be set on certain types of partition table. "
11704 "This works on C<gpt> but not on C<mbr> partitions."
11708 #: ../fish/guestfish-actions.pod:3706
11709 msgid "part-to-dev"
11713 #: ../fish/guestfish-actions.pod:3708
11716 " part-to-dev partition\n"
11721 #: ../fish/guestfish-actions.pod:3710 ../src/guestfs-actions.pod:5598
11723 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11724 "partition number, returning the device name (eg. \"/dev/sdb\")."
11728 #: ../fish/guestfish-actions.pod:3714
11730 "The named partition must exist, for example as a string returned from "
11731 "L</list-partitions>."
11735 #: ../fish/guestfish-actions.pod:3717
11736 msgid "ping-daemon"
11740 #: ../fish/guestfish-actions.pod:3719
11748 #: ../fish/guestfish-actions.pod:3721 ../src/guestfs-actions.pod:5615
11750 "This is a test probe into the guestfs daemon running inside the qemu "
11751 "subprocess. Calling this function checks that the daemon responds to the "
11752 "ping message, without affecting the daemon or attached block device(s) in "
11757 #: ../fish/guestfish-actions.pod:3726
11762 #: ../fish/guestfish-actions.pod:3728
11765 " pread path count offset\n"
11770 #: ../fish/guestfish-actions.pod:3730 ../src/guestfs-actions.pod:5633
11772 "This command lets you read part of a file. It reads C<count> bytes of the "
11773 "file, starting at C<offset>, from file C<path>."
11777 #: ../fish/guestfish-actions.pod:3733 ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5636 ../src/guestfs-actions.pod:5662
11779 "This may read fewer bytes than requested. For further details see the "
11780 "L<pread(2)> system call."
11784 #: ../fish/guestfish-actions.pod:3736
11785 msgid "See also L</pwrite>, L</pread-device>."
11789 #: ../fish/guestfish-actions.pod:3741
11790 msgid "pread-device"
11794 #: ../fish/guestfish-actions.pod:3743
11797 " pread-device device count offset\n"
11802 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5659
11804 "This command lets you read part of a file. It reads C<count> bytes of "
11805 "C<device>, starting at C<offset>."
11809 #: ../fish/guestfish-actions.pod:3751
11810 msgid "See also L</pread>."
11814 #: ../fish/guestfish-actions.pod:3756
11819 #: ../fish/guestfish-actions.pod:3758
11822 " pvcreate device\n"
11827 #: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5682
11829 "This creates an LVM physical volume on the named C<device>, where C<device> "
11830 "should usually be a partition name such as C</dev/sda1>."
11834 #: ../fish/guestfish-actions.pod:3764
11839 #: ../fish/guestfish-actions.pod:3766
11842 " pvremove device\n"
11847 #: ../fish/guestfish-actions.pod:3768 ../src/guestfs-actions.pod:5696
11849 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11854 #: ../fish/guestfish-actions.pod:3771 ../src/guestfs-actions.pod:5699
11856 "The implementation uses the C<pvremove> command which refuses to wipe "
11857 "physical volumes that contain any volume groups, so you have to remove those "
11862 #: ../fish/guestfish-actions.pod:3775
11867 #: ../fish/guestfish-actions.pod:3777
11870 " pvresize device\n"
11875 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5713
11877 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11878 "the new size of the underlying device."
11882 #: ../fish/guestfish-actions.pod:3782
11883 msgid "pvresize-size"
11887 #: ../fish/guestfish-actions.pod:3784
11890 " pvresize-size device size\n"
11895 #: ../fish/guestfish-actions.pod:3786
11897 "This command is the same as L</pvresize> except that it allows you to "
11898 "specify the new size (in bytes) explicitly."
11902 #: ../fish/guestfish-actions.pod:3789
11907 #: ../fish/guestfish-actions.pod:3791
11915 #: ../fish/guestfish-actions.pod:3793 ../src/guestfs-actions.pod:5739
11917 "List all the physical volumes detected. This is the equivalent of the "
11918 "L<pvs(8)> command."
11922 #: ../fish/guestfish-actions.pod:3796 ../src/guestfs-actions.pod:5742
11924 "This returns a list of just the device names that contain PVs "
11925 "(eg. C</dev/sda2>)."
11929 #: ../fish/guestfish-actions.pod:3799
11930 msgid "See also L</pvs-full>."
11934 #: ../fish/guestfish-actions.pod:3801
11939 #: ../fish/guestfish-actions.pod:3803
11947 #: ../fish/guestfish-actions.pod:3805 ../src/guestfs-actions.pod:5758
11949 "List all the physical volumes detected. This is the equivalent of the "
11950 "L<pvs(8)> command. The \"full\" version includes all fields."
11954 #: ../fish/guestfish-actions.pod:3808
11959 #: ../fish/guestfish-actions.pod:3810
11967 #: ../fish/guestfish-actions.pod:3812 ../src/guestfs-actions.pod:5773
11968 msgid "This command returns the UUID of the LVM PV C<device>."
11972 #: ../fish/guestfish-actions.pod:3814
11977 #: ../fish/guestfish-actions.pod:3816
11980 " pwrite path content offset\n"
11985 #: ../fish/guestfish-actions.pod:3818 ../src/guestfs-actions.pod:5789
11987 "This command writes to part of a file. It writes the data buffer C<content> "
11988 "to the file C<path> starting at offset C<offset>."
11992 #: ../fish/guestfish-actions.pod:3821 ../src/guestfs-actions.pod:5792
11994 "This command implements the L<pwrite(2)> system call, and like that system "
11995 "call it may not write the full data requested. The return value is the "
11996 "number of bytes that were actually written to the file. This could even be "
11997 "0, although short writes are unlikely for regular files in ordinary "
12002 #: ../fish/guestfish-actions.pod:3827
12003 msgid "See also L</pread>, L</pwrite-device>."
12007 #: ../fish/guestfish-actions.pod:3832
12008 msgid "pwrite-device"
12012 #: ../fish/guestfish-actions.pod:3834
12015 " pwrite-device device content offset\n"
12020 #: ../fish/guestfish-actions.pod:3836 ../src/guestfs-actions.pod:5816
12022 "This command writes to part of a device. It writes the data buffer "
12023 "C<content> to C<device> starting at offset C<offset>."
12027 #: ../fish/guestfish-actions.pod:3839 ../src/guestfs-actions.pod:5819
12029 "This command implements the L<pwrite(2)> system call, and like that system "
12030 "call it may not write the full data requested (although short writes to disk "
12031 "devices and partitions are probably impossible with standard Linux kernels)."
12035 #: ../fish/guestfish-actions.pod:3844
12036 msgid "See also L</pwrite>."
12040 #: ../fish/guestfish-actions.pod:3849
12045 #: ../fish/guestfish-actions.pod:3851
12048 " read-file path\n"
12053 #: ../fish/guestfish-actions.pod:3853 ../src/guestfs-actions.pod:5840
12054 msgid "This calls returns the contents of the file C<path> as a buffer."
12058 #: ../fish/guestfish-actions.pod:3856
12060 "Unlike L</cat>, this function can correctly handle files that contain "
12061 "embedded ASCII NUL characters. However unlike L</download>, this function "
12062 "is limited in the total size of file that can be handled."
12066 #: ../fish/guestfish-actions.pod:3864
12071 #: ../fish/guestfish-actions.pod:3866
12074 " read-lines path\n"
12079 #: ../fish/guestfish-actions.pod:3870 ../src/guestfs-actions.pod:5865
12081 "The file contents are returned as a list of lines. Trailing C<LF> and "
12082 "C<CRLF> character sequences are I<not> returned."
12086 #: ../fish/guestfish-actions.pod:3873
12088 "Note that this function cannot correctly handle binary files (specifically, "
12089 "files containing C<\\0> character which is treated as end of line). For "
12090 "those you need to use the L</read-file> function which has a more complex "
12095 #: ../fish/guestfish-actions.pod:3878
12100 #: ../fish/guestfish-actions.pod:3880
12108 #: ../fish/guestfish-actions.pod:3882 ../src/guestfs-actions.pod:5885
12109 msgid "This returns the list of directory entries in directory C<dir>."
12113 #: ../fish/guestfish-actions.pod:3884 ../src/guestfs-actions.pod:5887
12115 "All entries in the directory are returned, including C<.> and C<..>. The "
12116 "entries are I<not> sorted, but returned in the same order as the underlying "
12121 #: ../fish/guestfish-actions.pod:3888 ../src/guestfs-actions.pod:5891
12123 "Also this call returns basic file type information about each file. The "
12124 "C<ftyp> field will contain one of the following characters:"
12128 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
12133 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
12134 msgid "Block special"
12138 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
12143 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
12144 msgid "Char special"
12148 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
12153 #: ../fish/guestfish-actions.pod:3903 ../src/guestfs-actions.pod:5906
12158 #: ../fish/guestfish-actions.pod:3905 ../src/guestfs-actions.pod:5908
12163 #: ../fish/guestfish-actions.pod:3907 ../src/guestfs-actions.pod:5910
12164 msgid "FIFO (named pipe)"
12168 #: ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:5912
12173 #: ../fish/guestfish-actions.pod:3911 ../src/guestfs-actions.pod:5914
12174 msgid "Symbolic link"
12178 #: ../fish/guestfish-actions.pod:3913 ../src/guestfs-actions.pod:5916
12183 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:5918
12184 msgid "Regular file"
12188 #: ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:5920
12193 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:5922
12198 #: ../fish/guestfish-actions.pod:3921 ../src/guestfs-actions.pod:5924
12203 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:5926
12204 msgid "Unknown file type"
12208 #: ../fish/guestfish-actions.pod:3925 ../src/guestfs-actions.pod:5928
12213 #: ../fish/guestfish-actions.pod:3927 ../src/guestfs-actions.pod:5930
12214 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12218 #: ../fish/guestfish-actions.pod:3932
12220 "This function is primarily intended for use by programs. To get a simple "
12221 "list of names, use L</ls>. To get a printable directory for human "
12222 "consumption, use L</ll>."
12226 #: ../fish/guestfish-actions.pod:3936
12231 #: ../fish/guestfish-actions.pod:3938
12239 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:5951
12240 msgid "This command reads the target of a symbolic link."
12244 #: ../fish/guestfish-actions.pod:3942
12245 msgid "readlinklist"
12249 #: ../fish/guestfish-actions.pod:3944
12252 " readlinklist path 'names ...'\n"
12257 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5965
12259 "This call allows you to do a C<readlink> operation on multiple files, where "
12260 "all files are in the directory C<path>. C<names> is the list of files from "
12265 #: ../fish/guestfish-actions.pod:3950 ../src/guestfs-actions.pod:5969
12267 "On return you get a list of strings, with a one-to-one correspondence to the "
12268 "C<names> list. Each string is the value of the symbolic link."
12272 #: ../fish/guestfish-actions.pod:3954 ../src/guestfs-actions.pod:5973
12274 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12275 "result string is the empty string C<\"\">. However the whole operation is "
12276 "completed even if there were C<readlink(2)> errors, and so you can call this "
12277 "function with names where you don't know if they are symbolic links already "
12278 "(albeit slightly less efficient)."
12282 #: ../fish/guestfish-actions.pod:3961 ../src/guestfs-actions.pod:5980
12284 "This call is intended for programs that want to efficiently list a directory "
12285 "contents without making many round-trips. Very long directory listings "
12286 "might cause the protocol message size to be exceeded, causing this call to "
12287 "fail. The caller must split up such requests into smaller groups of names."
12291 #: ../fish/guestfish-actions.pod:3968
12296 #: ../fish/guestfish-actions.pod:3970
12304 #: ../fish/guestfish-actions.pod:3972 ../src/guestfs-actions.pod:5999
12306 "Return the canonicalized absolute pathname of C<path>. The returned path "
12307 "has no C<.>, C<..> or symbolic link path elements."
12311 #: ../fish/guestfish-actions.pod:3975
12312 msgid "removexattr"
12316 #: ../fish/guestfish-actions.pod:3977
12319 " removexattr xattr path\n"
12324 #: ../fish/guestfish-actions.pod:3979 ../src/guestfs-actions.pod:6014
12325 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12329 #: ../fish/guestfish-actions.pod:3982
12330 msgid "See also: L</lremovexattr>, L<attr(5)>."
12334 #: ../fish/guestfish-actions.pod:3984
12339 #: ../fish/guestfish-actions.pod:3986
12342 " resize2fs device\n"
12347 #: ../fish/guestfish-actions.pod:3988 ../src/guestfs-actions.pod:6029
12349 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12350 "underlying device."
12354 #: ../fish/guestfish-actions.pod:3991
12356 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12357 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12358 "gives an error about this and sometimes not. In any case, it is always safe "
12359 "to call L</e2fsck-f> before calling this function."
12363 #: ../fish/guestfish-actions.pod:3997
12364 msgid "resize2fs-M"
12368 #: ../fish/guestfish-actions.pod:3999
12371 " resize2fs-M device\n"
12376 #: ../fish/guestfish-actions.pod:4001
12378 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12379 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12384 #: ../fish/guestfish-actions.pod:4005
12386 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12387 "and read the C<Block size> and C<Block count> values. These two numbers, "
12388 "multiplied together, give the resulting size of the minimal filesystem in "
12393 #: ../fish/guestfish-actions.pod:4010
12394 msgid "resize2fs-size"
12398 #: ../fish/guestfish-actions.pod:4012
12401 " resize2fs-size device size\n"
12406 #: ../fish/guestfish-actions.pod:4014
12408 "This command is the same as L</resize2fs> except that it allows you to "
12409 "specify the new size (in bytes) explicitly."
12413 #: ../fish/guestfish-actions.pod:4017
12418 #: ../fish/guestfish-actions.pod:4019
12426 #: ../fish/guestfish-actions.pod:4021 ../src/guestfs-actions.pod:6081
12427 msgid "Remove the single file C<path>."
12431 #: ../fish/guestfish-actions.pod:4023
12436 #: ../fish/guestfish-actions.pod:4025
12444 #: ../fish/guestfish-actions.pod:4027 ../src/guestfs-actions.pod:6093
12446 "Remove the file or directory C<path>, recursively removing the contents if "
12447 "its a directory. This is like the C<rm -rf> shell command."
12451 #: ../fish/guestfish-actions.pod:4031
12456 #: ../fish/guestfish-actions.pod:4033
12464 #: ../fish/guestfish-actions.pod:4035 ../src/guestfs-actions.pod:6107
12465 msgid "Remove the single directory C<path>."
12469 #: ../fish/guestfish-actions.pod:4037
12470 msgid "rmmountpoint"
12474 #: ../fish/guestfish-actions.pod:4039
12477 " rmmountpoint exemptpath\n"
12482 #: ../fish/guestfish-actions.pod:4041
12484 "This calls removes a mountpoint that was previously created with "
12485 "L</mkmountpoint>. See L</mkmountpoint> for full details."
12489 #: ../fish/guestfish-actions.pod:4045
12490 msgid "scrub-device"
12494 #: ../fish/guestfish-actions.pod:4047
12497 " scrub-device device\n"
12502 #: ../fish/guestfish-actions.pod:4049 ../src/guestfs-actions.pod:6133
12504 "This command writes patterns over C<device> to make data retrieval more "
12509 #: ../fish/guestfish-actions.pod:4052 ../fish/guestfish-actions.pod:4067 ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6136 ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6176
12511 "It is an interface to the L<scrub(1)> program. See that manual page for "
12516 #: ../fish/guestfish-actions.pod:4058
12521 #: ../fish/guestfish-actions.pod:4060
12524 " scrub-file file\n"
12529 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6152
12531 "This command writes patterns over a file to make data retrieval more "
12536 #: ../fish/guestfish-actions.pod:4065 ../src/guestfs-actions.pod:6155
12537 msgid "The file is I<removed> after scrubbing."
12541 #: ../fish/guestfish-actions.pod:4070
12542 msgid "scrub-freespace"
12546 #: ../fish/guestfish-actions.pod:4072
12549 " scrub-freespace dir\n"
12554 #: ../fish/guestfish-actions.pod:4074
12556 "This command creates the directory C<dir> and then fills it with files until "
12557 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12558 "deletes them. The intention is to scrub any free space on the partition "
12559 "containing C<dir>."
12563 #: ../fish/guestfish-actions.pod:4083
12568 #: ../fish/guestfish-actions.pod:4085
12573 #: ../fish/guestfish-actions.pod:4087
12576 " set-append append\n"
12581 #: ../fish/guestfish-actions.pod:4089 ../src/guestfs-actions.pod:6189
12583 "This function is used to add additional options to the guest kernel command "
12588 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6192
12590 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12591 "environment variable."
12595 #: ../fish/guestfish-actions.pod:4095 ../src/guestfs-actions.pod:6195
12597 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12598 "(libguestfs always adds a few of its own)."
12602 #: ../fish/guestfish-actions.pod:4098
12603 msgid "set-attach-method"
12607 #: ../fish/guestfish-actions.pod:4100
12608 msgid "attach-method"
12612 #: ../fish/guestfish-actions.pod:4102
12615 " set-attach-method attachmethod\n"
12620 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6208
12622 "Set the method that libguestfs uses to connect to the back end guestfsd "
12623 "daemon. Possible methods are:"
12627 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6213 ../src/guestfs.pod:2800
12628 msgid "C<appliance>"
12632 #: ../fish/guestfish-actions.pod:4111 ../src/guestfs-actions.pod:6215
12634 "Launch an appliance and connect to it. This is the ordinary method and the "
12639 #: ../fish/guestfish-actions.pod:4114 ../src/guestfs-actions.pod:6218
12640 msgid "C<unix:I<path>>"
12644 #: ../fish/guestfish-actions.pod:4116 ../src/guestfs-actions.pod:6220
12645 msgid "Connect to the Unix domain socket I<path>."
12649 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6222
12651 "This method lets you connect to an existing daemon or (using virtio-serial) "
12652 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12653 "RUNNING DAEMONS>."
12657 #: ../fish/guestfish-actions.pod:4124
12658 msgid "set-autosync"
12662 #: ../fish/guestfish-actions.pod:4126
12667 #: ../fish/guestfish-actions.pod:4128
12670 " set-autosync true|false\n"
12675 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6238
12677 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12678 "effort attempt to make filesystems consistent and synchronized when the "
12679 "handle is closed (also if the program exits without closing handles)."
12683 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6243
12685 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12686 "disabled by default)."
12690 #: ../fish/guestfish-actions.pod:4138
12695 #: ../fish/guestfish-actions.pod:4140
12700 #: ../fish/guestfish-actions.pod:4142
12703 " set-direct true|false\n"
12708 #: ../fish/guestfish-actions.pod:4144 ../src/guestfs-actions.pod:6256
12710 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12711 "passed directly through to the appliance once it is launched."
12715 #: ../fish/guestfish-actions.pod:4148
12717 "One consequence of this is that log messages aren't caught by the library "
12718 "and handled by L</set-log-message-callback>, but go straight to stdout."
12722 #: ../fish/guestfish-actions.pod:4152 ../src/guestfs-actions.pod:6264
12723 msgid "You probably don't want to use this unless you know what you are doing."
12727 #: ../fish/guestfish-actions.pod:4155 ../src/guestfs-actions.pod:6267
12728 msgid "The default is disabled."
12732 #: ../fish/guestfish-actions.pod:4157
12733 msgid "set-e2label"
12737 #: ../fish/guestfish-actions.pod:4159
12740 " set-e2label device label\n"
12745 #: ../fish/guestfish-actions.pod:4161 ../src/guestfs-actions.pod:6280
12747 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12748 "C<label>. Filesystem labels are limited to 16 characters."
12752 #: ../fish/guestfish-actions.pod:4165
12754 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12755 "label on a filesystem."
12759 #: ../fish/guestfish-actions.pod:4168
12764 #: ../fish/guestfish-actions.pod:4170
12767 " set-e2uuid device uuid\n"
12772 #: ../fish/guestfish-actions.pod:4172 ../src/guestfs-actions.pod:6298
12774 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12775 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12776 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12780 #: ../fish/guestfish-actions.pod:4177
12782 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12783 "UUID of a filesystem."
12787 #: ../fish/guestfish-actions.pod:4180
12788 msgid "set-memsize"
12792 #: ../fish/guestfish-actions.pod:4182
12797 #: ../fish/guestfish-actions.pod:4184
12800 " set-memsize memsize\n"
12805 #: ../fish/guestfish-actions.pod:4186
12807 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12808 "This only has any effect if called before L</launch>."
12812 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6320
12814 "You can also change this by setting the environment variable "
12815 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12819 #: ../fish/guestfish-actions.pod:4197
12820 msgid "set-network"
12824 #: ../fish/guestfish-actions.pod:4199
12829 #: ../fish/guestfish-actions.pod:4201
12832 " set-network true|false\n"
12837 #: ../fish/guestfish-actions.pod:4203 ../src/guestfs-actions.pod:6337
12839 "If C<network> is true, then the network is enabled in the libguestfs "
12840 "appliance. The default is false."
12844 #: ../fish/guestfish-actions.pod:4206 ../src/guestfs-actions.pod:6340
12846 "This affects whether commands are able to access the network (see "
12847 "L<guestfs(3)/RUNNING COMMANDS>)."
12851 #: ../fish/guestfish-actions.pod:4209
12852 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12856 #: ../fish/guestfish-actions.pod:4212
12861 #: ../fish/guestfish-actions.pod:4216
12864 " set-path searchpath\n"
12869 #: ../fish/guestfish-actions.pod:4218 ../src/guestfs-actions.pod:6356
12870 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12874 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6358
12876 "The default is C<$libdir/guestfs> unless overridden by setting "
12877 "C<LIBGUESTFS_PATH> environment variable."
12881 #: ../fish/guestfish-actions.pod:4223 ../src/guestfs-actions.pod:6361
12882 msgid "Setting C<path> to C<NULL> restores the default path."
12886 #: ../fish/guestfish-actions.pod:4225
12891 #: ../fish/guestfish-actions.pod:4227
12896 #: ../fish/guestfish-actions.pod:4229
12899 " set-pgroup true|false\n"
12904 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6373
12906 "If C<pgroup> is true, child processes are placed into their own process "
12911 #: ../fish/guestfish-actions.pod:4234 ../src/guestfs-actions.pod:6376
12913 "The practical upshot of this is that signals like C<SIGINT> (from users "
12914 "pressing C<^C>) won't be received by the child process."
12918 #: ../fish/guestfish-actions.pod:4237 ../src/guestfs-actions.pod:6379
12920 "The default for this flag is false, because usually you want C<^C> to kill "
12925 #: ../fish/guestfish-actions.pod:4240
12930 #: ../fish/guestfish-actions.pod:4242
12935 #: ../fish/guestfish-actions.pod:4244
12943 #: ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6392
12944 msgid "Set the qemu binary that we will use."
12948 #: ../fish/guestfish-actions.pod:4248 ../src/guestfs-actions.pod:6394
12949 msgid "The default is chosen when the library was compiled by the configure script."
12953 #: ../fish/guestfish-actions.pod:4251 ../src/guestfs-actions.pod:6397
12955 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12960 #: ../fish/guestfish-actions.pod:4254 ../src/guestfs-actions.pod:6400
12961 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12965 #: ../fish/guestfish-actions.pod:4256 ../src/guestfs-actions.pod:6402
12967 "Note that you should call this function as early as possible after creating "
12968 "the handle. This is because some pre-launch operations depend on testing "
12969 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12970 "don't retest features, and so you might see inconsistent results. Using the "
12971 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12972 "the qemu binary at the same time as the handle is created."
12976 #: ../fish/guestfish-actions.pod:4264
12977 msgid "set-recovery-proc"
12981 #: ../fish/guestfish-actions.pod:4266
12982 msgid "recovery-proc"
12986 #: ../fish/guestfish-actions.pod:4268
12989 " set-recovery-proc true|false\n"
12994 #: ../fish/guestfish-actions.pod:4270
12996 "If this is called with the parameter C<false> then L</launch> does not "
12997 "create a recovery process. The purpose of the recovery process is to stop "
12998 "runaway qemu processes in the case where the main program aborts abruptly."
13002 #: ../fish/guestfish-actions.pod:4275
13004 "This only has any effect if called before L</launch>, and the default is "
13009 #: ../fish/guestfish-actions.pod:4278 ../src/guestfs-actions.pod:6428
13011 "About the only time when you would want to disable this is if the main "
13012 "process will fork itself into the background (\"daemonize\" itself). In "
13013 "this case the recovery process thinks that the main program has disappeared "
13014 "and so kills qemu, which is not very helpful."
13018 #: ../fish/guestfish-actions.pod:4284
13019 msgid "set-selinux"
13023 #: ../fish/guestfish-actions.pod:4286
13028 #: ../fish/guestfish-actions.pod:4288
13031 " set-selinux true|false\n"
13036 #: ../fish/guestfish-actions.pod:4290 ../src/guestfs-actions.pod:6444
13038 "This sets the selinux flag that is passed to the appliance at boot time. "
13039 "The default is C<selinux=0> (disabled)."
13043 #: ../fish/guestfish-actions.pod:4293 ../src/guestfs-actions.pod:6447
13045 "Note that if SELinux is enabled, it is always in Permissive mode "
13046 "(C<enforcing=0>)."
13050 #: ../fish/guestfish-actions.pod:4299
13055 #: ../fish/guestfish-actions.pod:4301
13060 #: ../fish/guestfish-actions.pod:4303
13063 " set-trace true|false\n"
13068 #: ../fish/guestfish-actions.pod:4305 ../src/guestfs-actions.pod:6463
13070 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13071 "return values are traced."
13075 #: ../fish/guestfish-actions.pod:4308 ../src/guestfs-actions.pod:6466
13077 "If you want to trace C API calls into libguestfs (and other libraries) then "
13078 "possibly a better way is to use the external ltrace(1) command."
13082 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6470
13084 "Command traces are disabled unless the environment variable "
13085 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13089 #: ../fish/guestfish-actions.pod:4315
13091 "Trace messages are normally sent to C<stderr>, unless you register a "
13092 "callback to send them somewhere else (see L</set-event-callback>)."
13096 #: ../fish/guestfish-actions.pod:4319
13097 msgid "set-verbose"
13101 #: ../fish/guestfish-actions.pod:4321
13106 #: ../fish/guestfish-actions.pod:4323
13109 " set-verbose true|false\n"
13114 #: ../fish/guestfish-actions.pod:4325 ../src/guestfs-actions.pod:6487
13115 msgid "If C<verbose> is true, this turns on verbose messages."
13119 #: ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:6489
13121 "Verbose messages are disabled unless the environment variable "
13122 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13126 #: ../fish/guestfish-actions.pod:4330
13128 "Verbose messages are normally sent to C<stderr>, unless you register a "
13129 "callback to send them somewhere else (see L</set-event-callback>)."
13133 #: ../fish/guestfish-actions.pod:4334
13138 #: ../fish/guestfish-actions.pod:4336
13141 " setcon context\n"
13146 #: ../fish/guestfish-actions.pod:4338 ../src/guestfs-actions.pod:6506
13148 "This sets the SELinux security context of the daemon to the string "
13153 #: ../fish/guestfish-actions.pod:4341 ../src/guestfs-actions.pod:6509
13154 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13158 #: ../fish/guestfish-actions.pod:4343
13163 #: ../fish/guestfish-actions.pod:4345
13166 " setxattr xattr val vallen path\n"
13171 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6524
13173 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13174 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13178 #: ../fish/guestfish-actions.pod:4351
13179 msgid "See also: L</lsetxattr>, L<attr(5)>."
13183 #: ../fish/guestfish-actions.pod:4353
13188 #: ../fish/guestfish-actions.pod:4355
13191 " sfdisk device cyls heads sectors 'lines ...'\n"
13196 #: ../fish/guestfish-actions.pod:4357 ../src/guestfs-actions.pod:6551
13198 "This is a direct interface to the L<sfdisk(8)> program for creating "
13199 "partitions on block devices."
13203 #: ../fish/guestfish-actions.pod:4360 ../src/guestfs-actions.pod:6554
13204 msgid "C<device> should be a block device, for example C</dev/sda>."
13208 #: ../fish/guestfish-actions.pod:4362 ../src/guestfs-actions.pod:6556
13210 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13211 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13212 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13213 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13214 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13215 "the kernel) cannot work out the right geometry and you will need to tell it."
13219 #: ../fish/guestfish-actions.pod:4370 ../src/guestfs-actions.pod:6564
13221 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13222 "refer to the L<sfdisk(8)> manpage."
13226 #: ../fish/guestfish-actions.pod:4373 ../src/guestfs-actions.pod:6567
13228 "To create a single partition occupying the whole disk, you would pass "
13229 "C<lines> as a single element list, when the single element being the string "
13234 #: ../fish/guestfish-actions.pod:4377
13235 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13239 #: ../fish/guestfish-actions.pod:4383 ../fish/guestfish-actions.pod:4406 ../fish/guestfish-actions.pod:4428
13241 "I<This function is deprecated.> In new code, use the L</part_add> call "
13246 #: ../fish/guestfish-actions.pod:4390
13251 #: ../fish/guestfish-actions.pod:4392
13254 " sfdiskM device 'lines ...'\n"
13259 #: ../fish/guestfish-actions.pod:4394
13261 "This is a simplified interface to the L</sfdisk> command, where partition "
13262 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13263 "you don't need to specify the cyls, heads and sectors parameters which were "
13264 "rarely if ever used anyway."
13268 #: ../fish/guestfish-actions.pod:4400
13269 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13273 #: ../fish/guestfish-actions.pod:4413
13278 #: ../fish/guestfish-actions.pod:4415
13281 " sfdisk-N device partnum cyls heads sectors line\n"
13286 #: ../fish/guestfish-actions.pod:4417 ../src/guestfs-actions.pod:6629
13288 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13289 "(note: C<n> counts from 1)."
13293 #: ../fish/guestfish-actions.pod:4420
13295 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13296 "cyls/heads/sectors parameters."
13300 #: ../fish/guestfish-actions.pod:4423
13301 msgid "See also: L</part-add>"
13305 #: ../fish/guestfish-actions.pod:4435
13306 msgid "sfdisk-disk-geometry"
13310 #: ../fish/guestfish-actions.pod:4437
13313 " sfdisk-disk-geometry device\n"
13318 #: ../fish/guestfish-actions.pod:4439
13320 "This displays the disk geometry of C<device> read from the partition table. "
13321 "Especially in the case where the underlying block device has been resized, "
13322 "this can be different from the kernel's idea of the geometry (see "
13323 "L</sfdisk-kernel-geometry>)."
13327 #: ../fish/guestfish-actions.pod:4444 ../fish/guestfish-actions.pod:4453 ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6671
13328 msgid "The result is in human-readable format, and not designed to be parsed."
13332 #: ../fish/guestfish-actions.pod:4447
13333 msgid "sfdisk-kernel-geometry"
13337 #: ../fish/guestfish-actions.pod:4449
13340 " sfdisk-kernel-geometry device\n"
13345 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6669
13346 msgid "This displays the kernel's idea of the geometry of C<device>."
13350 #: ../fish/guestfish-actions.pod:4456
13355 #: ../fish/guestfish-actions.pod:4458
13358 " sfdisk-l device\n"
13363 #: ../fish/guestfish-actions.pod:4460 ../src/guestfs-actions.pod:6692
13365 "This displays the partition table on C<device>, in the human-readable output "
13366 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13370 #: ../fish/guestfish-actions.pod:4464
13371 msgid "See also: L</part-list>"
13375 #: ../fish/guestfish-actions.pod:4466
13377 "I<This function is deprecated.> In new code, use the L</part_list> call "
13382 #: ../fish/guestfish-actions.pod:4473
13387 #: ../fish/guestfish-actions.pod:4475
13395 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6709
13397 "This call runs a command from the guest filesystem via the guest's "
13402 #: ../fish/guestfish-actions.pod:4480
13403 msgid "This is like L</command>, but passes the command to:"
13407 #: ../fish/guestfish-actions.pod:4482 ../src/guestfs-actions.pod:6714
13410 " /bin/sh -c \"command\"\n"
13415 #: ../fish/guestfish-actions.pod:4484 ../src/guestfs-actions.pod:6716
13417 "Depending on the guest's shell, this usually results in wildcards being "
13418 "expanded, shell expressions being interpolated and so on."
13422 #: ../fish/guestfish-actions.pod:4488
13423 msgid "All the provisos about L</command> apply to this call."
13427 #: ../fish/guestfish-actions.pod:4490
13432 #: ../fish/guestfish-actions.pod:4492
13435 " sh-lines command\n"
13440 #: ../fish/guestfish-actions.pod:4494
13441 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13445 #: ../fish/guestfish-actions.pod:4497
13446 msgid "See also: L</command-lines>"
13450 #: ../fish/guestfish-actions.pod:4499
13455 #: ../fish/guestfish-actions.pod:4501
13463 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6750
13464 msgid "Sleep for C<secs> seconds."
13468 #: ../fish/guestfish-actions.pod:4505
13473 #: ../fish/guestfish-actions.pod:4507
13481 #: ../fish/guestfish-actions.pod:4511 ../src/guestfs-actions.pod:6764
13482 msgid "This is the same as the C<stat(2)> system call."
13486 #: ../fish/guestfish-actions.pod:4513
13491 #: ../fish/guestfish-actions.pod:4515
13499 #: ../fish/guestfish-actions.pod:4517 ../src/guestfs-actions.pod:6778
13501 "Returns file system statistics for any mounted file system. C<path> should "
13502 "be a file or directory in the mounted file system (typically it is the mount "
13503 "point itself, but it doesn't need to be)."
13507 #: ../fish/guestfish-actions.pod:4521 ../src/guestfs-actions.pod:6782
13508 msgid "This is the same as the C<statvfs(2)> system call."
13512 #: ../fish/guestfish-actions.pod:4523
13517 #: ../fish/guestfish-actions.pod:4525
13525 #: ../fish/guestfish-actions.pod:4527 ../src/guestfs-actions.pod:6796
13527 "This runs the L<strings(1)> command on a file and returns the list of "
13528 "printable strings found."
13532 #: ../fish/guestfish-actions.pod:4533
13537 #: ../fish/guestfish-actions.pod:4535
13540 " strings-e encoding path\n"
13545 #: ../fish/guestfish-actions.pod:4537
13547 "This is like the L</strings> command, but allows you to specify the encoding "
13548 "of strings that are looked for in the source file C<path>."
13552 #: ../fish/guestfish-actions.pod:4541 ../src/guestfs-actions.pod:6819
13553 msgid "Allowed encodings are:"
13557 #: ../fish/guestfish-actions.pod:4545 ../src/guestfs-actions.pod:6823
13562 #: ../fish/guestfish-actions.pod:4547
13564 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13565 "ISO-8859-X (this is what L</strings> uses)."
13569 #: ../fish/guestfish-actions.pod:4550 ../src/guestfs-actions.pod:6828
13574 #: ../fish/guestfish-actions.pod:4552 ../src/guestfs-actions.pod:6830
13575 msgid "Single 8-bit-byte characters."
13579 #: ../fish/guestfish-actions.pod:4554 ../src/guestfs-actions.pod:6832
13584 #: ../fish/guestfish-actions.pod:4556 ../src/guestfs-actions.pod:6834
13585 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13589 #: ../fish/guestfish-actions.pod:4559 ../src/guestfs-actions.pod:6837
13590 msgid "l (lower case letter L)"
13594 #: ../fish/guestfish-actions.pod:4561 ../src/guestfs-actions.pod:6839
13596 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13597 "examining binaries in Windows guests."
13601 #: ../fish/guestfish-actions.pod:4564 ../src/guestfs-actions.pod:6842
13606 #: ../fish/guestfish-actions.pod:4566 ../src/guestfs-actions.pod:6844
13607 msgid "32-bit big endian such as UCS-4BE."
13611 #: ../fish/guestfish-actions.pod:4568 ../src/guestfs-actions.pod:6846
13616 #: ../fish/guestfish-actions.pod:4570 ../src/guestfs-actions.pod:6848
13617 msgid "32-bit little endian such as UCS-4LE."
13621 #: ../fish/guestfish-actions.pod:4574 ../src/guestfs-actions.pod:6852
13622 msgid "The returned strings are transcoded to UTF-8."
13626 #: ../fish/guestfish-actions.pod:4579
13627 msgid "swapoff-device"
13631 #: ../fish/guestfish-actions.pod:4581
13634 " swapoff-device device\n"
13639 #: ../fish/guestfish-actions.pod:4583
13641 "This command disables the libguestfs appliance swap device or partition "
13642 "named C<device>. See L</swapon-device>."
13646 #: ../fish/guestfish-actions.pod:4587
13647 msgid "swapoff-file"
13651 #: ../fish/guestfish-actions.pod:4589
13654 " swapoff-file file\n"
13659 #: ../fish/guestfish-actions.pod:4591 ../src/guestfs-actions.pod:6883
13660 msgid "This command disables the libguestfs appliance swap on file."
13664 #: ../fish/guestfish-actions.pod:4593
13665 msgid "swapoff-label"
13669 #: ../fish/guestfish-actions.pod:4595
13672 " swapoff-label label\n"
13677 #: ../fish/guestfish-actions.pod:4597 ../src/guestfs-actions.pod:6895
13679 "This command disables the libguestfs appliance swap on labeled swap "
13684 #: ../fish/guestfish-actions.pod:4600
13685 msgid "swapoff-uuid"
13689 #: ../fish/guestfish-actions.pod:4602
13692 " swapoff-uuid uuid\n"
13697 #: ../fish/guestfish-actions.pod:4604 ../src/guestfs-actions.pod:6908
13699 "This command disables the libguestfs appliance swap partition with the given "
13704 #: ../fish/guestfish-actions.pod:4607
13705 msgid "swapon-device"
13709 #: ../fish/guestfish-actions.pod:4609
13712 " swapon-device device\n"
13717 #: ../fish/guestfish-actions.pod:4611
13719 "This command enables the libguestfs appliance to use the swap device or "
13720 "partition named C<device>. The increased memory is made available for all "
13721 "commands, for example those run using L</command> or L</sh>."
13725 #: ../fish/guestfish-actions.pod:4616 ../src/guestfs-actions.pod:6926
13727 "Note that you should not swap to existing guest swap partitions unless you "
13728 "know what you are doing. They may contain hibernation information, or other "
13729 "information that the guest doesn't want you to trash. You also risk leaking "
13730 "information about the host to the guest this way. Instead, attach a new "
13731 "host device to the guest and swap on that."
13735 #: ../fish/guestfish-actions.pod:4623
13736 msgid "swapon-file"
13740 #: ../fish/guestfish-actions.pod:4625
13743 " swapon-file file\n"
13748 #: ../fish/guestfish-actions.pod:4627
13749 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
13753 #: ../fish/guestfish-actions.pod:4630
13754 msgid "swapon-label"
13758 #: ../fish/guestfish-actions.pod:4632
13761 " swapon-label label\n"
13766 #: ../fish/guestfish-actions.pod:4634
13768 "This command enables swap to a labeled swap partition. See "
13769 "L</swapon-device> for other notes."
13773 #: ../fish/guestfish-actions.pod:4637
13774 msgid "swapon-uuid"
13778 #: ../fish/guestfish-actions.pod:4639
13781 " swapon-uuid uuid\n"
13786 #: ../fish/guestfish-actions.pod:4641
13788 "This command enables swap to a swap partition with the given UUID. See "
13789 "L</swapon-device> for other notes."
13793 #: ../fish/guestfish-actions.pod:4644
13798 #: ../fish/guestfish-actions.pod:4646
13806 #: ../fish/guestfish-actions.pod:4648 ../src/guestfs-actions.pod:6981
13808 "This syncs the disk, so that any writes are flushed through to the "
13809 "underlying disk image."
13813 #: ../fish/guestfish-actions.pod:4651 ../src/guestfs-actions.pod:6984
13815 "You should always call this if you have modified a disk image, before "
13816 "closing the handle."
13820 #: ../fish/guestfish-actions.pod:4654
13825 #: ../fish/guestfish-actions.pod:4656
13833 #: ../fish/guestfish-actions.pod:4658 ../src/guestfs-actions.pod:6997
13834 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13838 #: ../fish/guestfish-actions.pod:4664
13843 #: ../fish/guestfish-actions.pod:4666
13846 " tail-n nrlines path\n"
13851 #: ../fish/guestfish-actions.pod:4668 ../src/guestfs-actions.pod:7016
13853 "If the parameter C<nrlines> is a positive number, this returns the last "
13854 "C<nrlines> lines of the file C<path>."
13858 #: ../fish/guestfish-actions.pod:4671 ../src/guestfs-actions.pod:7019
13860 "If the parameter C<nrlines> is a negative number, this returns lines from "
13861 "the file C<path>, starting with the C<-nrlines>th line."
13865 #: ../fish/guestfish-actions.pod:4679
13870 #: ../fish/guestfish-actions.pod:4681
13873 " tar-in (tarfile|-) directory\n"
13878 #: ../fish/guestfish-actions.pod:4683 ../src/guestfs-actions.pod:7040
13880 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13881 "tar file) into C<directory>."
13885 #: ../fish/guestfish-actions.pod:4686
13886 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
13890 #: ../fish/guestfish-actions.pod:4691
13895 #: ../fish/guestfish-actions.pod:4693
13898 " tar-out directory (tarfile|-)\n"
13903 #: ../fish/guestfish-actions.pod:4695 ../src/guestfs-actions.pod:7057
13905 "This command packs the contents of C<directory> and downloads it to local "
13910 #: ../fish/guestfish-actions.pod:4698
13911 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
13915 #: ../fish/guestfish-actions.pod:4703
13920 #: ../fish/guestfish-actions.pod:4705
13923 " tgz-in (tarball|-) directory\n"
13928 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7074
13930 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13931 "tar file) into C<directory>."
13935 #: ../fish/guestfish-actions.pod:4710
13936 msgid "To upload an uncompressed tarball, use L</tar-in>."
13940 #: ../fish/guestfish-actions.pod:4714
13945 #: ../fish/guestfish-actions.pod:4716
13948 " tgz-out directory (tarball|-)\n"
13953 #: ../fish/guestfish-actions.pod:4718 ../src/guestfs-actions.pod:7090
13955 "This command packs the contents of C<directory> and downloads it to local "
13960 #: ../fish/guestfish-actions.pod:4721
13961 msgid "To download an uncompressed tarball, use L</tar-out>."
13965 #: ../fish/guestfish-actions.pod:4725
13970 #: ../fish/guestfish-actions.pod:4727
13978 #: ../fish/guestfish-actions.pod:4729 ../src/guestfs-actions.pod:7105
13980 "Touch acts like the L<touch(1)> command. It can be used to update the "
13981 "timestamps on a file, or, if the file does not exist, to create a new "
13982 "zero-length file."
13986 #: ../fish/guestfish-actions.pod:4733 ../src/guestfs-actions.pod:7109
13988 "This command only works on regular files, and will fail on other file types "
13989 "such as directories, symbolic links, block special etc."
13993 #: ../fish/guestfish-actions.pod:4736
13998 #: ../fish/guestfish-actions.pod:4738
14006 #: ../fish/guestfish-actions.pod:4740 ../src/guestfs-actions.pod:7122
14008 "This command truncates C<path> to a zero-length file. The file must exist "
14013 #: ../fish/guestfish-actions.pod:4743
14014 msgid "truncate-size"
14018 #: ../fish/guestfish-actions.pod:4745
14021 " truncate-size path size\n"
14026 #: ../fish/guestfish-actions.pod:4747 ../src/guestfs-actions.pod:7136
14028 "This command truncates C<path> to size C<size> bytes. The file must exist "
14033 #: ../fish/guestfish-actions.pod:4750
14035 "If the current file size is less than C<size> then the file is extended to "
14036 "the required size with zero bytes. This creates a sparse file (ie. disk "
14037 "blocks are not allocated for the file until you write to it). To create a "
14038 "non-sparse file of zeroes, use L</fallocate64> instead."
14042 #: ../fish/guestfish-actions.pod:4756
14047 #: ../fish/guestfish-actions.pod:4758
14050 " tune2fs-l device\n"
14055 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7155
14057 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14062 #: ../fish/guestfish-actions.pod:4763 ../src/guestfs-actions.pod:7158
14064 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14065 "for more details. The list of fields returned isn't clearly defined, and "
14066 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14067 "and the filesystem itself."
14071 #: ../fish/guestfish-actions.pod:4768
14076 #: ../fish/guestfish-actions.pod:4770
14079 " txz-in (tarball|-) directory\n"
14084 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7178
14086 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14087 "tar file) into C<directory>."
14091 #: ../fish/guestfish-actions.pod:4777
14096 #: ../fish/guestfish-actions.pod:4779
14099 " txz-out directory (tarball|-)\n"
14104 #: ../fish/guestfish-actions.pod:4781 ../src/guestfs-actions.pod:7192
14106 "This command packs the contents of C<directory> and downloads it to local "
14107 "file C<tarball> (as an xz compressed tar archive)."
14111 #: ../fish/guestfish-actions.pod:4786
14116 #: ../fish/guestfish-actions.pod:4788
14124 #: ../fish/guestfish-actions.pod:4790 ../src/guestfs-actions.pod:7205
14126 "This function sets the mask used for creating new files and device nodes to "
14131 #: ../fish/guestfish-actions.pod:4793 ../src/guestfs-actions.pod:7208
14133 "Typical umask values would be C<022> which creates new files with "
14134 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14135 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14139 #: ../fish/guestfish-actions.pod:4798 ../src/guestfs-actions.pod:7213
14141 "The default umask is C<022>. This is important because it means that "
14142 "directories and device nodes will be created with C<0644> or C<0755> mode "
14143 "even if you specify C<0777>."
14147 #: ../fish/guestfish-actions.pod:4802
14148 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14152 #: ../fish/guestfish-actions.pod:4805 ../src/guestfs-actions.pod:7220
14153 msgid "This call returns the previous umask."
14157 #: ../fish/guestfish-actions.pod:4807
14162 #: ../fish/guestfish-actions.pod:4809
14167 #: ../fish/guestfish-actions.pod:4811
14170 " umount pathordevice\n"
14175 #: ../fish/guestfish-actions.pod:4813 ../src/guestfs-actions.pod:7232
14177 "This unmounts the given filesystem. The filesystem may be specified either "
14178 "by its mountpoint (path) or the device which contains the filesystem."
14182 #: ../fish/guestfish-actions.pod:4817
14187 #: ../fish/guestfish-actions.pod:4819
14188 msgid "unmount-all"
14192 #: ../fish/guestfish-actions.pod:4821
14200 #: ../fish/guestfish-actions.pod:4823 ../src/guestfs-actions.pod:7245
14201 msgid "This unmounts all mounted filesystems."
14205 #: ../fish/guestfish-actions.pod:4825 ../src/guestfs-actions.pod:7247
14206 msgid "Some internal mounts are not unmounted by this call."
14210 #: ../fish/guestfish-actions.pod:4827
14215 #: ../fish/guestfish-actions.pod:4829
14218 " upload (filename|-) remotefilename\n"
14223 #: ../fish/guestfish-actions.pod:4831 ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7284
14224 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14228 #: ../fish/guestfish-actions.pod:4836
14229 msgid "See also L</download>."
14233 #: ../fish/guestfish-actions.pod:4840
14234 msgid "upload-offset"
14238 #: ../fish/guestfish-actions.pod:4842
14241 " upload-offset (filename|-) remotefilename offset\n"
14246 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7287
14248 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14249 "The intention is to overwrite parts of existing files or devices, although "
14250 "if a non-existant file is specified then it is created with a \"hole\" "
14251 "before C<offset>. The size of the data written is implicit in the size of "
14252 "the source C<filename>."
14256 #: ../fish/guestfish-actions.pod:4854
14258 "Note that there is no limit on the amount of data that can be uploaded with "
14259 "this call, unlike with L</pwrite>, and this call always writes the full "
14260 "amount unless an error occurs."
14264 #: ../fish/guestfish-actions.pod:4859
14265 msgid "See also L</upload>, L</pwrite>."
14269 #: ../fish/guestfish-actions.pod:4863
14274 #: ../fish/guestfish-actions.pod:4865
14277 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14282 #: ../fish/guestfish-actions.pod:4867 ../src/guestfs-actions.pod:7320
14283 msgid "This command sets the timestamps of a file with nanosecond precision."
14287 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7323
14289 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14294 #: ../fish/guestfish-actions.pod:4873 ../src/guestfs-actions.pod:7326
14296 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14297 "nanoseconds from the epoch."
14301 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7329
14303 "If the C<*nsecs> field contains the special value C<-1> then the "
14304 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14305 "ignored in this case)."
14309 #: ../fish/guestfish-actions.pod:4880 ../src/guestfs-actions.pod:7333
14311 "If the C<*nsecs> field contains the special value C<-2> then the "
14312 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14317 #: ../fish/guestfish-actions.pod:4884
14322 #: ../fish/guestfish-actions.pod:4886
14330 #: ../fish/guestfish-actions.pod:4888 ../src/guestfs-actions.pod:7346
14331 msgid "Return the libguestfs version number that the program is linked against."
14335 #: ../fish/guestfish-actions.pod:4891 ../src/guestfs-actions.pod:7349
14337 "Note that because of dynamic linking this is not necessarily the version of "
14338 "libguestfs that you compiled against. You can compile the program, and then "
14339 "at runtime dynamically link against a completely different C<libguestfs.so> "
14344 #: ../fish/guestfish-actions.pod:4896 ../src/guestfs-actions.pod:7354
14346 "This call was added in version C<1.0.58>. In previous versions of "
14347 "libguestfs there was no way to get the version number. From C code you can "
14348 "use dynamic linker functions to find out if this symbol exists (if it "
14349 "doesn't, then it's an earlier version)."
14353 #: ../fish/guestfish-actions.pod:4902 ../src/guestfs-actions.pod:7360
14355 "The call returns a structure with four elements. The first three (C<major>, "
14356 "C<minor> and C<release>) are numbers and correspond to the usual version "
14357 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14358 "but may be used for distro-specific information."
14362 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7366
14363 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14367 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7369
14368 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14372 #: ../fish/guestfish-actions.pod:4913
14374 "I<Note:> Don't use this call to test for availability of features. In "
14375 "enterprise distributions we backport features from later versions into "
14376 "earlier versions, making this an unreliable way to test for features. Use "
14377 "L</available> instead."
14381 #: ../fish/guestfish-actions.pod:4919
14386 #: ../fish/guestfish-actions.pod:4921
14389 " vfs-label device\n"
14394 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7389
14395 msgid "This returns the filesystem label of the filesystem on C<device>."
14399 #: ../fish/guestfish-actions.pod:4926 ../src/guestfs-actions.pod:7392
14400 msgid "If the filesystem is unlabeled, this returns the empty string."
14404 #: ../fish/guestfish-actions.pod:4928
14405 msgid "To find a filesystem from the label, use L</findfs-label>."
14409 #: ../fish/guestfish-actions.pod:4930
14414 #: ../fish/guestfish-actions.pod:4932
14417 " vfs-type device\n"
14422 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7407
14424 "This command gets the filesystem type corresponding to the filesystem on "
14429 #: ../fish/guestfish-actions.pod:4937 ../src/guestfs-actions.pod:7410
14431 "For most filesystems, the result is the name of the Linux VFS module which "
14432 "would be used to mount this filesystem if you mounted it without specifying "
14433 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14437 #: ../fish/guestfish-actions.pod:4942
14442 #: ../fish/guestfish-actions.pod:4944
14445 " vfs-uuid device\n"
14450 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7426
14451 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14455 #: ../fish/guestfish-actions.pod:4949 ../src/guestfs-actions.pod:7429
14456 msgid "If the filesystem does not have a UUID, this returns the empty string."
14460 #: ../fish/guestfish-actions.pod:4951
14461 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14465 #: ../fish/guestfish-actions.pod:4953
14466 msgid "vg-activate"
14470 #: ../fish/guestfish-actions.pod:4955
14473 " vg-activate true|false 'volgroups ...'\n"
14478 #: ../fish/guestfish-actions.pod:4957 ../src/guestfs-actions.pod:7445
14480 "This command activates or (if C<activate> is false) deactivates all logical "
14481 "volumes in the listed volume groups C<volgroups>."
14485 #: ../fish/guestfish-actions.pod:4960 ../src/guestfs-actions.pod:7448
14486 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14490 #: ../fish/guestfish-actions.pod:4962 ../src/guestfs-actions.pod:7450
14492 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14493 "activated or deactivated."
14497 #: ../fish/guestfish-actions.pod:4965
14498 msgid "vg-activate-all"
14502 #: ../fish/guestfish-actions.pod:4967
14505 " vg-activate-all true|false\n"
14510 #: ../fish/guestfish-actions.pod:4969 ../src/guestfs-actions.pod:7463
14512 "This command activates or (if C<activate> is false) deactivates all logical "
14513 "volumes in all volume groups."
14517 #: ../fish/guestfish-actions.pod:4972 ../src/guestfs-actions.pod:7466
14518 msgid "This command is the same as running C<vgchange -a y|n>"
14522 #: ../fish/guestfish-actions.pod:4974
14527 #: ../fish/guestfish-actions.pod:4976
14530 " vgcreate volgroup 'physvols ...'\n"
14535 #: ../fish/guestfish-actions.pod:4978 ../src/guestfs-actions.pod:7479
14537 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14538 "of physical volumes C<physvols>."
14542 #: ../fish/guestfish-actions.pod:4981
14547 #: ../fish/guestfish-actions.pod:4983
14550 " vglvuuids vgname\n"
14555 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7492
14557 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14558 "volumes created in this volume group."
14562 #: ../fish/guestfish-actions.pod:4988
14564 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14565 "logical volumes and volume groups."
14569 #: ../fish/guestfish-actions.pod:4991
14570 msgid "See also L</vgpvuuids>."
14574 #: ../fish/guestfish-actions.pod:4993
14579 #: ../fish/guestfish-actions.pod:4995
14582 " vgpvuuids vgname\n"
14587 #: ../fish/guestfish-actions.pod:4997 ../src/guestfs-actions.pod:7512
14589 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14590 "volumes that this volume group resides on."
14594 #: ../fish/guestfish-actions.pod:5000
14596 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14597 "physical volumes and volume groups."
14601 #: ../fish/guestfish-actions.pod:5003
14602 msgid "See also L</vglvuuids>."
14606 #: ../fish/guestfish-actions.pod:5005
14611 #: ../fish/guestfish-actions.pod:5007
14614 " vgremove vgname\n"
14619 #: ../fish/guestfish-actions.pod:5009 ../src/guestfs-actions.pod:7532
14620 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14624 #: ../fish/guestfish-actions.pod:5011 ../src/guestfs-actions.pod:7534
14625 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14629 #: ../fish/guestfish-actions.pod:5014
14634 #: ../fish/guestfish-actions.pod:5016
14637 " vgrename volgroup newvolgroup\n"
14642 #: ../fish/guestfish-actions.pod:5018 ../src/guestfs-actions.pod:7548
14643 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14647 #: ../fish/guestfish-actions.pod:5020
14652 #: ../fish/guestfish-actions.pod:5022
14660 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7559
14662 "List all the volumes groups detected. This is the equivalent of the "
14663 "L<vgs(8)> command."
14667 #: ../fish/guestfish-actions.pod:5027 ../src/guestfs-actions.pod:7562
14669 "This returns a list of just the volume group names that were detected "
14670 "(eg. C<VolGroup00>)."
14674 #: ../fish/guestfish-actions.pod:5030
14675 msgid "See also L</vgs-full>."
14679 #: ../fish/guestfish-actions.pod:5032
14684 #: ../fish/guestfish-actions.pod:5034
14692 #: ../fish/guestfish-actions.pod:5036 ../src/guestfs-actions.pod:7578
14694 "List all the volumes groups detected. This is the equivalent of the "
14695 "L<vgs(8)> command. The \"full\" version includes all fields."
14699 #: ../fish/guestfish-actions.pod:5039
14704 #: ../fish/guestfish-actions.pod:5041
14712 #: ../fish/guestfish-actions.pod:5043 ../src/guestfs-actions.pod:7592
14714 "This rescans all block devices and rebuilds the list of LVM physical "
14715 "volumes, volume groups and logical volumes."
14719 #: ../fish/guestfish-actions.pod:5046
14724 #: ../fish/guestfish-actions.pod:5048
14732 #: ../fish/guestfish-actions.pod:5050 ../src/guestfs-actions.pod:7605
14733 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14737 #: ../fish/guestfish-actions.pod:5052
14742 #: ../fish/guestfish-actions.pod:5054
14750 #: ../fish/guestfish-actions.pod:5056 ../src/guestfs-actions.pod:7645
14752 "This command counts the characters in a file, using the C<wc -c> external "
14757 #: ../fish/guestfish-actions.pod:5059
14762 #: ../fish/guestfish-actions.pod:5061
14770 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7658
14772 "This command counts the lines in a file, using the C<wc -l> external "
14777 #: ../fish/guestfish-actions.pod:5066
14782 #: ../fish/guestfish-actions.pod:5068
14790 #: ../fish/guestfish-actions.pod:5070 ../src/guestfs-actions.pod:7671
14792 "This command counts the words in a file, using the C<wc -w> external "
14797 #: ../fish/guestfish-actions.pod:5073
14802 #: ../fish/guestfish-actions.pod:5075
14805 " write path content\n"
14810 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7686
14812 "This call creates a file called C<path>. The content of the file is the "
14813 "string C<content> (which can contain any 8 bit data)."
14817 #: ../fish/guestfish-actions.pod:5080
14818 msgid "See also L</write-append>."
14822 #: ../fish/guestfish-actions.pod:5085
14823 msgid "write-append"
14827 #: ../fish/guestfish-actions.pod:5087
14830 " write-append path content\n"
14835 #: ../fish/guestfish-actions.pod:5089 ../src/guestfs-actions.pod:7706
14837 "This call appends C<content> to the end of file C<path>. If C<path> does "
14838 "not exist, then a new file is created."
14842 #: ../fish/guestfish-actions.pod:5092
14843 msgid "See also L</write>."
14847 #: ../fish/guestfish-actions.pod:5097
14852 #: ../fish/guestfish-actions.pod:5099
14855 " write-file path content size\n"
14860 #: ../fish/guestfish-actions.pod:5101 ../src/guestfs-actions.pod:7733
14862 "This call creates a file called C<path>. The contents of the file is the "
14863 "string C<content> (which can contain any 8 bit data), with length C<size>."
14867 #: ../fish/guestfish-actions.pod:5105 ../src/guestfs-actions.pod:7737
14869 "As a special case, if C<size> is C<0> then the length is calculated using "
14870 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14874 #: ../fish/guestfish-actions.pod:5109 ../src/guestfs-actions.pod:7741
14876 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14877 "I<not> work, even if the length is specified."
14881 #: ../fish/guestfish-actions.pod:5115
14882 msgid "I<This function is deprecated.> In new code, use the L</write> call instead."
14886 #: ../fish/guestfish-actions.pod:5122
14891 #: ../fish/guestfish-actions.pod:5124
14894 " zegrep regex path\n"
14899 #: ../fish/guestfish-actions.pod:5126 ../src/guestfs-actions.pod:7758
14900 msgid "This calls the external C<zegrep> program and returns the matching lines."
14904 #: ../fish/guestfish-actions.pod:5132
14909 #: ../fish/guestfish-actions.pod:5134
14912 " zegrepi regex path\n"
14917 #: ../fish/guestfish-actions.pod:5136 ../src/guestfs-actions.pod:7777
14918 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14922 #: ../fish/guestfish-actions.pod:5142
14927 #: ../fish/guestfish-actions.pod:5144
14935 #: ../fish/guestfish-actions.pod:5146 ../src/guestfs-actions.pod:7795
14936 msgid "This command writes zeroes over the first few blocks of C<device>."
14940 #: ../fish/guestfish-actions.pod:5148 ../src/guestfs-actions.pod:7797
14942 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14943 "securely wipe the device). It should be sufficient to remove any partition "
14944 "tables, filesystem superblocks and so on."
14948 #: ../fish/guestfish-actions.pod:5152 ../fish/guestfish-actions.pod:5167 ../src/guestfs-actions.pod:7801 ../src/guestfs-actions.pod:7827
14950 "If blocks are already zero, then this command avoids writing zeroes. This "
14951 "prevents the underlying device from becoming non-sparse or growing "
14956 #: ../fish/guestfish-actions.pod:5156
14957 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
14961 #: ../fish/guestfish-actions.pod:5159
14962 msgid "zero-device"
14966 #: ../fish/guestfish-actions.pod:5161
14969 " zero-device device\n"
14974 #: ../fish/guestfish-actions.pod:5163
14976 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
14977 "which just zeroes the first few blocks of a device."
14981 #: ../fish/guestfish-actions.pod:5174
14986 #: ../fish/guestfish-actions.pod:5176
14989 " zerofree device\n"
14994 #: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7849
14996 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14997 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14998 "possible to compress the filesystem more effectively."
15002 #: ../fish/guestfish-actions.pod:5183 ../src/guestfs-actions.pod:7854
15003 msgid "You should B<not> run this program if the filesystem is mounted."
15007 #: ../fish/guestfish-actions.pod:5186 ../src/guestfs-actions.pod:7857
15009 "It is possible that using this program can damage the filesystem or data on "
15014 #: ../fish/guestfish-actions.pod:5189
15019 #: ../fish/guestfish-actions.pod:5191
15022 " zfgrep pattern path\n"
15027 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7871
15028 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15032 #: ../fish/guestfish-actions.pod:5199
15037 #: ../fish/guestfish-actions.pod:5201
15040 " zfgrepi pattern path\n"
15045 #: ../fish/guestfish-actions.pod:5203 ../src/guestfs-actions.pod:7890
15046 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15050 #: ../fish/guestfish-actions.pod:5209
15055 #: ../fish/guestfish-actions.pod:5211
15058 " zfile meth path\n"
15063 #: ../fish/guestfish-actions.pod:5213 ../src/guestfs-actions.pod:7916
15064 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15068 #: ../fish/guestfish-actions.pod:5216 ../src/guestfs-actions.pod:7919
15069 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15073 #: ../fish/guestfish-actions.pod:5218
15074 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
15078 #: ../fish/guestfish-actions.pod:5221
15079 msgid "I<This function is deprecated.> In new code, use the L</file> call instead."
15083 #: ../fish/guestfish-actions.pod:5228
15088 #: ../fish/guestfish-actions.pod:5230
15091 " zgrep regex path\n"
15096 #: ../fish/guestfish-actions.pod:5232 ../src/guestfs-actions.pod:7936
15097 msgid "This calls the external C<zgrep> program and returns the matching lines."
15101 #: ../fish/guestfish-actions.pod:5238
15106 #: ../fish/guestfish-actions.pod:5240
15109 " zgrepi regex path\n"
15114 #: ../fish/guestfish-actions.pod:5242 ../src/guestfs-actions.pod:7955
15115 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15119 #: ../fish/guestfish-commands.pod:1
15124 #: ../fish/guestfish-commands.pod:3
15129 #: ../fish/guestfish-commands.pod:5
15132 " alloc filename size\n"
15137 #: ../fish/guestfish-commands.pod:7
15139 "This creates an empty (zeroed) file of the given size, and then adds so it "
15140 "can be further examined."
15144 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
15145 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15149 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
15150 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15154 #: ../fish/guestfish-commands.pod:14
15156 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15157 "image, see L</PREPARED DISK IMAGES>."
15161 #: ../fish/guestfish-commands.pod:17
15166 #: ../fish/guestfish-commands.pod:19
15169 " copy-in local [local ...] /remotedir\n"
15174 #: ../fish/guestfish-commands.pod:21
15176 "C<copy-in> copies local files or directories recursively into the disk "
15177 "image, placing them in the directory called C</remotedir> (which must "
15178 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15179 "other commands as necessary."
15183 #: ../fish/guestfish-commands.pod:26
15185 "Multiple local files and directories can be specified, but the last "
15186 "parameter must always be a remote directory. Wildcards cannot be used."
15190 #: ../fish/guestfish-commands.pod:30
15195 #: ../fish/guestfish-commands.pod:32
15198 " copy-out remote [remote ...] localdir\n"
15203 #: ../fish/guestfish-commands.pod:34
15205 "C<copy-out> copies remote files or directories recursively out of the disk "
15206 "image, placing them on the host disk in a local directory called C<localdir> "
15207 "(which must exist). This guestfish meta-command turns into a sequence of "
15208 "L</download>, L</tar-out> and other commands as necessary."
15212 #: ../fish/guestfish-commands.pod:40
15214 "Multiple remote files and directories can be specified, but the last "
15215 "parameter must always be a local directory. To download to the current "
15216 "directory, use C<.> as in:"
15220 #: ../fish/guestfish-commands.pod:44
15223 " copy-out /home .\n"
15228 #: ../fish/guestfish-commands.pod:46
15230 "Wildcards cannot be used in the ordinary command, but you can use them with "
15231 "the help of L</glob> like this:"
15235 #: ../fish/guestfish-commands.pod:49
15238 " glob copy-out /home/* .\n"
15243 #: ../fish/guestfish-commands.pod:51
15248 #: ../fish/guestfish-commands.pod:53
15251 " display filename\n"
15256 #: ../fish/guestfish-commands.pod:55
15258 "Use C<display> (a graphical display program) to display an image file. It "
15259 "downloads the file, and runs C<display> on it."
15263 #: ../fish/guestfish-commands.pod:58
15265 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15266 "environment variable. For example to use the GNOME display program:"
15270 #: ../fish/guestfish-commands.pod:61
15273 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15278 #: ../fish/guestfish-commands.pod:63
15279 msgid "See also L<display(1)>."
15283 #: ../fish/guestfish-commands.pod:65
15288 #: ../fish/guestfish-commands.pod:67
15291 " echo [params ...]\n"
15296 #: ../fish/guestfish-commands.pod:69
15297 msgid "This echos the parameters to the terminal."
15301 #: ../fish/guestfish-commands.pod:71
15306 #: ../fish/guestfish-commands.pod:73
15311 #: ../fish/guestfish-commands.pod:75
15316 #: ../fish/guestfish-commands.pod:77
15324 #: ../fish/guestfish-commands.pod:79
15326 "This is used to edit a file. It downloads the file, edits it locally using "
15327 "your editor, then uploads the result."
15331 #: ../fish/guestfish-commands.pod:82
15333 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15334 "or C<emacs> you will get those corresponding editors."
15338 #: ../fish/guestfish-commands.pod:86
15343 #: ../fish/guestfish-commands.pod:88
15346 " glob command args...\n"
15351 #: ../fish/guestfish-commands.pod:90
15353 "Expand wildcards in any paths in the args list, and run C<command> "
15354 "repeatedly on each matching path."
15358 #: ../fish/guestfish-commands.pod:93
15359 msgid "See L</WILDCARDS AND GLOBBING>."
15363 #: ../fish/guestfish-commands.pod:95
15368 #: ../fish/guestfish-commands.pod:97
15371 " hexedit <filename|device>\n"
15372 " hexedit <filename|device> <max>\n"
15373 " hexedit <filename|device> <start> <max>\n"
15378 #: ../fish/guestfish-commands.pod:101
15380 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15385 #: ../fish/guestfish-commands.pod:104
15387 "This command works by downloading potentially the whole file or device, "
15388 "editing it locally, then uploading it. If the file or device is large, you "
15389 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15390 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15391 "usual modifiers allowed such as C<1M> (1 megabyte)."
15395 #: ../fish/guestfish-commands.pod:111
15396 msgid "For example to edit the first few sectors of a disk you might do:"
15400 #: ../fish/guestfish-commands.pod:114
15403 " hexedit /dev/sda 1M\n"
15408 #: ../fish/guestfish-commands.pod:116
15410 "which would allow you to edit anywhere within the first megabyte of the "
15415 #: ../fish/guestfish-commands.pod:119
15416 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15420 #: ../fish/guestfish-commands.pod:121
15423 " hexedit /dev/sda1 0x400 0x400\n"
15428 #: ../fish/guestfish-commands.pod:123
15429 msgid "(assuming the superblock is in the standard location)."
15433 #: ../fish/guestfish-commands.pod:125
15435 "This command requires the external L<hexedit(1)> program. You can specify "
15436 "another program to use by setting the C<HEXEDITOR> environment variable."
15440 #: ../fish/guestfish-commands.pod:129
15441 msgid "See also L</hexdump>."
15445 #: ../fish/guestfish-commands.pod:131
15450 #: ../fish/guestfish-commands.pod:133
15458 #: ../fish/guestfish-commands.pod:135
15459 msgid "Change the local directory, ie. the current directory of guestfish itself."
15463 #: ../fish/guestfish-commands.pod:138
15464 msgid "Note that C<!cd> won't do what you might expect."
15468 #: ../fish/guestfish-commands.pod:140
15473 #: ../fish/guestfish-commands.pod:142
15478 #: ../fish/guestfish-commands.pod:144
15486 #: ../fish/guestfish-commands.pod:146
15487 msgid "Opens the manual page for guestfish."
15491 #: ../fish/guestfish-commands.pod:148
15496 #: ../fish/guestfish-commands.pod:150
15501 #: ../fish/guestfish-commands.pod:152
15509 #: ../fish/guestfish-commands.pod:154
15517 #: ../fish/guestfish-commands.pod:156
15518 msgid "This is used to view a file."
15522 #: ../fish/guestfish-commands.pod:158
15524 "The default viewer is C<$PAGER>. However if you use the alternate command "
15525 "C<less> you will get the C<less> command specifically."
15529 #: ../fish/guestfish-commands.pod:161
15534 #: ../fish/guestfish-commands.pod:163
15542 #: ../fish/guestfish-commands.pod:165
15544 "Close and reopen the libguestfs handle. It is not necessary to use this "
15545 "normally, because the handle is closed properly when guestfish exits. "
15546 "However this is occasionally useful for testing."
15550 #: ../fish/guestfish-commands.pod:169
15555 #: ../fish/guestfish-commands.pod:171
15558 " setenv VAR value\n"
15563 #: ../fish/guestfish-commands.pod:173
15564 msgid "Set the environment variable C<VAR> to the string C<value>."
15568 #: ../fish/guestfish-commands.pod:175
15569 msgid "To print the value of an environment variable use a shell command such as:"
15573 #: ../fish/guestfish-commands.pod:178
15581 #: ../fish/guestfish-commands.pod:180
15586 #: ../fish/guestfish-commands.pod:182
15589 " sparse filename size\n"
15594 #: ../fish/guestfish-commands.pod:184
15596 "This creates an empty sparse file of the given size, and then adds so it can "
15597 "be further examined."
15601 #: ../fish/guestfish-commands.pod:187
15603 "In all respects it works the same as the L</alloc> command, except that the "
15604 "image file is allocated sparsely, which means that disk blocks are not "
15605 "assigned to the file until they are needed. Sparse disk files only use "
15606 "space when written to, but they are slower and there is a danger you could "
15607 "run out of real disk space during a write operation."
15611 #: ../fish/guestfish-commands.pod:197
15616 #: ../fish/guestfish-commands.pod:199
15624 #: ../fish/guestfish-commands.pod:201
15626 "This command returns a list of the optional groups known to the daemon, and "
15627 "indicates which ones are supported by this build of the libguestfs "
15632 #: ../fish/guestfish-commands.pod:205
15633 msgid "See also L<guestfs(3)/AVAILABILITY>."
15637 #: ../fish/guestfish-commands.pod:207
15642 #: ../fish/guestfish-commands.pod:209
15645 " time command args...\n"
15650 #: ../fish/guestfish-commands.pod:211
15652 "Run the command as usual, but print the elapsed time afterwards. This can "
15653 "be useful for benchmarking operations."
15657 #: ../fish/guestfish-commands.pod:214
15662 #: ../fish/guestfish-commands.pod:216
15670 #: ../fish/guestfish-commands.pod:218
15671 msgid "Remove C<VAR> from the environment."
15675 #: ../fish/guestfish.pod:5
15676 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15680 #: ../fish/guestfish.pod:9
15683 " guestfish [--options] [commands]\n"
15688 #: ../fish/guestfish.pod:11
15696 #: ../fish/guestfish.pod:13
15699 " guestfish [--ro|--rw] -a disk.img\n"
15704 #: ../fish/guestfish.pod:15
15707 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15712 #: ../fish/guestfish.pod:17
15715 " guestfish -d libvirt-domain\n"
15720 #: ../fish/guestfish.pod:19
15723 " guestfish [--ro|--rw] -a disk.img -i\n"
15728 #: ../fish/guestfish.pod:21
15731 " guestfish -d libvirt-domain -i\n"
15736 #: ../fish/guestfish.pod:25
15738 "Using guestfish in read/write mode on live virtual machines can be "
15739 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15740 "option to use guestfish safely if the disk image or virtual machine might be "
15745 #: ../fish/guestfish.pod:32
15747 "Guestfish is a shell and command-line tool for examining and modifying "
15748 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15749 "functionality of the guestfs API, see L<guestfs(3)>."
15753 #: ../fish/guestfish.pod:36
15755 "Guestfish gives you structured access to the libguestfs API, from shell "
15756 "scripts or the command line or interactively. If you want to rescue a "
15757 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15762 #: ../fish/guestfish.pod:43
15763 msgid "As an interactive shell"
15767 #: ../fish/guestfish.pod:45
15775 #: ../fish/guestfish.pod:47
15778 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15779 " editing virtual machine filesystems.\n"
15784 #: ../fish/guestfish.pod:50
15787 " Type: 'help' for a list of commands\n"
15788 " 'man' to read the manual\n"
15789 " 'quit' to quit the shell\n"
15794 #: ../fish/guestfish.pod:54
15797 " ><fs> add-ro disk.img\n"
15799 " ><fs> list-filesystems\n"
15800 " /dev/sda1: ext4\n"
15801 " /dev/vg_guest/lv_root: ext4\n"
15802 " /dev/vg_guest/lv_swap: swap\n"
15803 " ><fs> mount /dev/vg_guest/lv_root /\n"
15804 " ><fs> cat /etc/fstab\n"
15806 " # Created by anaconda\n"
15813 #: ../fish/guestfish.pod:67
15814 msgid "From shell scripts"
15818 #: ../fish/guestfish.pod:69
15819 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15823 #: ../fish/guestfish.pod:71
15826 " guestfish <<_EOF_\n"
15829 " mount /dev/vg_guest/lv_root /\n"
15830 " write /etc/motd \"Welcome, new users\"\n"
15836 #: ../fish/guestfish.pod:78
15837 msgid "List the LVM logical volumes in a disk image:"
15841 #: ../fish/guestfish.pod:80
15844 " guestfish -a disk.img --ro <<_EOF_\n"
15852 #: ../fish/guestfish.pod:85
15853 msgid "List all the filesystems in a disk image:"
15857 #: ../fish/guestfish.pod:87
15860 " guestfish -a disk.img --ro <<_EOF_\n"
15862 " list-filesystems\n"
15868 #: ../fish/guestfish.pod:92
15869 msgid "On one command line"
15873 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15874 msgid "Update C</etc/resolv.conf> in a guest:"
15878 #: ../fish/guestfish.pod:96
15882 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15883 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15888 #: ../fish/guestfish.pod:100
15889 msgid "Edit C</boot/grub/grub.conf> interactively:"
15893 #: ../fish/guestfish.pod:102
15896 " guestfish --rw --add disk.img \\\n"
15897 " --mount /dev/vg_guest/lv_root \\\n"
15898 " --mount /dev/sda1:/boot \\\n"
15899 " edit /boot/grub/grub.conf\n"
15904 #: ../fish/guestfish.pod:107
15905 msgid "Mount disks automatically"
15909 #: ../fish/guestfish.pod:109
15911 "Use the I<-i> option to automatically mount the disks from a virtual "
15916 #: ../fish/guestfish.pod:112
15919 " guestfish --ro -a disk.img -i cat /etc/group\n"
15924 #: ../fish/guestfish.pod:114
15927 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15932 #: ../fish/guestfish.pod:116
15933 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15937 #: ../fish/guestfish.pod:118
15940 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
15945 #: ../fish/guestfish.pod:120
15946 msgid "As a script interpreter"
15950 #: ../fish/guestfish.pod:122
15951 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15955 #: ../fish/guestfish.pod:124
15958 " #!/usr/bin/guestfish -f\n"
15959 " sparse test1.img 100M\n"
15961 " part-disk /dev/sda mbr\n"
15962 " mkfs ext2 /dev/sda1\n"
15967 #: ../fish/guestfish.pod:130
15968 msgid "Start with a prepared disk"
15972 #: ../fish/guestfish.pod:132
15974 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15975 "single ext2-formatted partition:"
15979 #: ../fish/guestfish.pod:135
15982 " guestfish -N fs\n"
15987 #: ../fish/guestfish.pod:137
15988 msgid "To list what is available do:"
15992 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
15995 " guestfish -N help | less\n"
16000 #: ../fish/guestfish.pod:141
16001 msgid "Remote control"
16005 #: ../fish/guestfish.pod:143
16008 " eval \"`guestfish --listen`\"\n"
16009 " guestfish --remote add-ro disk.img\n"
16010 " guestfish --remote run\n"
16011 " guestfish --remote lvs\n"
16016 #: ../fish/guestfish.pod:154
16017 msgid "Displays general help on options."
16021 #: ../fish/guestfish.pod:158
16022 msgid "B<--cmd-help>"
16026 #: ../fish/guestfish.pod:160
16027 msgid "Lists all available guestfish commands."
16031 #: ../fish/guestfish.pod:162
16036 #: ../fish/guestfish.pod:164
16037 msgid "B<--cmd-help cmd>"
16041 #: ../fish/guestfish.pod:166
16042 msgid "Displays detailed help on a single command C<cmd>."
16046 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16047 msgid "B<-a image>"
16051 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16052 msgid "B<--add image>"
16056 #: ../fish/guestfish.pod:172
16057 msgid "Add a block device or virtual machine image to the shell."
16061 #: ../fish/guestfish.pod:177
16063 "Using this flag is mostly equivalent to using the C<add> command, with "
16064 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16065 "the I<--format=...> flag was given."
16069 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16071 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16072 "URI to use. The default is to use the default libvirt connection."
16076 #: ../fish/guestfish.pod:189
16081 #: ../fish/guestfish.pod:191
16083 "If using the I<--listen> option and a csh-like shell, use this option. See "
16084 "section L</REMOTE CONTROL AND CSH> below."
16088 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16089 msgid "B<-d libvirt-domain>"
16093 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16094 msgid "B<--domain libvirt-domain>"
16098 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16100 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16101 "used, then any libvirt domain can be used. However in write mode, only "
16102 "libvirt domains which are shut down can be named here."
16106 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16107 msgid "Domain UUIDs can be used instead of names."
16111 #: ../fish/guestfish.pod:204
16113 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16114 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16115 "if the I<--format:...> flag was given."
16119 #: ../fish/guestfish.pod:208
16124 #: ../fish/guestfish.pod:210
16125 msgid "B<--no-dest-paths>"
16129 #: ../fish/guestfish.pod:212
16131 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16132 "to hit the tab key to complete paths on the guest filesystem, but this "
16133 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16134 "allow this feature to be disabled."
16138 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16140 "When prompting for keys and passphrases, guestfish normally turns echoing "
16141 "off so you cannot see what you are typing. If you are not worried about "
16142 "Tempest attacks and there is no one else in the room you can specify this "
16143 "flag to see what you are typing."
16147 #: ../fish/guestfish.pod:224
16152 #: ../fish/guestfish.pod:226
16153 msgid "B<--file file>"
16157 #: ../fish/guestfish.pod:228
16158 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16162 #: ../fish/guestfish.pod:231
16165 " #!/usr/bin/guestfish -f\n"
16170 #: ../fish/guestfish.pod:244
16173 " guestfish --format=raw -a disk.img\n"
16178 #: ../fish/guestfish.pod:248
16181 " guestfish --format=raw -a disk.img --format -a another.img\n"
16186 #: ../fish/guestfish.pod:253
16188 "If you have untrusted raw-format guest disk images, you should use this "
16189 "option to specify the disk format. This avoids a possible security problem "
16190 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16194 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16195 msgid "B<--inspector>"
16199 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16201 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16202 "system and mount filesystems as they would be mounted on the real virtual "
16207 #: ../fish/guestfish.pod:266
16208 msgid "Typical usage is either:"
16212 #: ../fish/guestfish.pod:268
16215 " guestfish -d myguest -i\n"
16220 #: ../fish/guestfish.pod:270
16221 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16225 #: ../fish/guestfish.pod:272
16228 " guestfish --ro -d myguest -i\n"
16233 #: ../fish/guestfish.pod:274
16234 msgid "(for active domains, readonly), or specify the block device directly:"
16238 #: ../fish/guestfish.pod:276
16241 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16246 #: ../fish/guestfish.pod:278
16248 "Note that the command line syntax changed slightly over older versions of "
16249 "guestfish. You can still use the old syntax:"
16253 #: ../fish/guestfish.pod:281
16256 " guestfish [--ro] -i disk.img\n"
16261 #: ../fish/guestfish.pod:283
16264 " guestfish [--ro] -i libvirt-domain\n"
16269 #: ../fish/guestfish.pod:285
16271 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16272 "then using other commands to mount the filesystems that were found."
16276 #: ../fish/guestfish.pod:294
16277 msgid "B<--listen>"
16281 #: ../fish/guestfish.pod:296
16283 "Fork into the background and listen for remote commands. See section "
16284 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16288 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16293 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16295 "Connect to a live virtual machine. (Experimental, see "
16296 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16300 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16301 msgid "B<-m dev[:mountpoint[:options]]>"
16305 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16306 msgid "B<--mount dev[:mountpoint[:options]]>"
16310 #: ../fish/guestfish.pod:308
16311 msgid "Mount the named partition or logical volume on the given mountpoint."
16315 #: ../fish/guestfish.pod:310
16316 msgid "If the mountpoint is omitted, it defaults to C</>."
16320 #: ../fish/guestfish.pod:312
16321 msgid "You have to mount something on C</> before most commands will work."
16325 #: ../fish/guestfish.pod:314
16327 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16332 #: ../fish/guestfish.pod:317
16334 "If you don't know what filesystems a disk image contains, you can either run "
16335 "guestfish without this option, then list the partitions, filesystems and LVs "
16336 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16337 "commands), or you can use the L<virt-filesystems(1)> program."
16341 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16343 "The third (and rarely used) part of the mount parameter is the list of mount "
16344 "options used to mount the underlying filesystem. If this is not given, then "
16345 "the mount options are either the empty string or C<ro> (the latter if the "
16346 "I<--ro> flag is used). By specifying the mount options, you override this "
16347 "default choice. Probably the only time you would use this is to enable ACLs "
16348 "and/or extended attributes if the filesystem can support them:"
16352 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16355 " -m /dev/sda1:/:acl,user_xattr\n"
16360 #: ../fish/guestfish.pod:333
16361 msgid "Using this flag is equivalent to using the C<mount-options> command."
16365 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193 ../resize/virt-resize.pod:358
16370 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16371 msgid "B<--no-sync>"
16375 #: ../fish/guestfish.pod:339
16377 "Disable autosync. This is enabled by default. See the discussion of "
16378 "autosync in the L<guestfs(3)> manpage."
16382 #: ../fish/guestfish.pod:342
16387 #: ../fish/guestfish.pod:344
16388 msgid "B<--new type>"
16392 #: ../fish/guestfish.pod:346
16397 #: ../fish/guestfish.pod:348
16399 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16400 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16401 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16406 #: ../fish/guestfish.pod:353
16407 msgid "B<--progress-bars>"
16411 #: ../fish/guestfish.pod:355
16412 msgid "Enable progress bars, even when guestfish is used non-interactively."
16416 #: ../fish/guestfish.pod:357
16418 "Progress bars are enabled by default when guestfish is used as an "
16419 "interactive shell."
16423 #: ../fish/guestfish.pod:360
16424 msgid "B<--no-progress-bars>"
16428 #: ../fish/guestfish.pod:362
16429 msgid "Disable progress bars."
16433 #: ../fish/guestfish.pod:364
16434 msgid "B<--remote[=pid]>"
16438 #: ../fish/guestfish.pod:366
16440 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16441 "CONTROL GUESTFISH OVER A SOCKET> below."
16445 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239 ../rescue/virt-rescue.pod:161
16450 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241 ../rescue/virt-rescue.pod:163
16455 #: ../fish/guestfish.pod:373
16457 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16458 "mounts are done read-only."
16462 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16464 "The option must always be used if the disk image or virtual machine might be "
16465 "running, and is generally recommended in cases where you don't need write "
16466 "access to the disk."
16470 #: ../fish/guestfish.pod:380
16472 "Note that prepared disk images created with I<-N> are not affected by this "
16473 "option. Also commands like C<add> are not affected - you have to specify "
16474 "the C<readonly:true> option explicitly if you need it."
16478 #: ../fish/guestfish.pod:384
16479 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16483 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253 ../rescue/virt-rescue.pod:173
16484 msgid "B<--selinux>"
16488 #: ../fish/guestfish.pod:388
16489 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16493 #: ../fish/guestfish.pod:394
16495 "Enable very verbose messages. This is particularly useful if you find a "
16500 #: ../fish/guestfish.pod:401
16501 msgid "Display the guestfish / libguestfs version number and exit."
16505 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269 ../rescue/virt-rescue.pod:190
16510 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271 ../rescue/virt-rescue.pod:192
16515 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16517 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16518 "mounts are done read-write."
16522 #: ../fish/guestfish.pod:410
16523 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16527 #: ../fish/guestfish.pod:414
16528 msgid "Echo each command before executing it."
16532 #: ../fish/guestfish.pod:418
16533 msgid "COMMANDS ON COMMAND LINE"
16537 #: ../fish/guestfish.pod:420
16538 msgid "Any additional (non-option) arguments are treated as commands to execute."
16542 #: ../fish/guestfish.pod:423
16544 "Commands to execute should be separated by a colon (C<:>), where the colon "
16545 "is a separate parameter. Thus:"
16549 #: ../fish/guestfish.pod:426
16552 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16557 #: ../fish/guestfish.pod:428
16559 "If there are no additional arguments, then we enter a shell, either an "
16560 "interactive shell with a prompt (if the input is a terminal) or a "
16561 "non-interactive shell."
16565 #: ../fish/guestfish.pod:432
16567 "In either command line mode or non-interactive shell, the first command that "
16568 "gives an error causes the whole shell to exit. In interactive mode (with a "
16569 "prompt) if a command fails, you can continue to enter commands."
16573 #: ../fish/guestfish.pod:437
16574 msgid "USING launch (OR run)"
16578 #: ../fish/guestfish.pod:439
16580 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16581 "then launch it, then mount any disks you need, and finally issue "
16582 "actions/commands. So the general order of the day is:"
16586 #: ../fish/guestfish.pod:447
16587 msgid "add or -a/--add"
16591 #: ../fish/guestfish.pod:451
16592 msgid "launch (aka run)"
16596 #: ../fish/guestfish.pod:455
16597 msgid "mount or -m/--mount"
16601 #: ../fish/guestfish.pod:459
16602 msgid "any other commands"
16606 #: ../fish/guestfish.pod:463
16608 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16609 "guest before mounting or performing any other commands."
16613 #: ../fish/guestfish.pod:466
16615 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16616 "I<--new> options were given then C<run> is done automatically, simply "
16617 "because guestfish can't perform the action you asked for without doing this."
16621 #: ../fish/guestfish.pod:471
16622 msgid "OPENING DISKS FOR READ AND WRITE"
16626 #: ../fish/guestfish.pod:473
16628 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16629 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16630 "I<-i> and I<-m> open disk images read-only or for writing."
16634 #: ../fish/guestfish.pod:478
16636 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16637 "opening disk images supplied on the command line for write. To open a disk "
16638 "image read-only you have to do I<-a image --ro>."
16642 #: ../fish/guestfish.pod:482
16644 "This matters: If you accidentally open a live VM disk image writable then "
16645 "you will cause irreversible disk corruption."
16649 #: ../fish/guestfish.pod:485
16651 "In a future libguestfs we intend to change the default the other way. Disk "
16652 "images will be opened read-only. You will have to either specify "
16653 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16654 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16655 "access for disk images specified by those other command line options."
16659 #: ../fish/guestfish.pod:492
16661 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16662 "which does nothing (it is already the default). However it is highly "
16663 "recommended that you use this option to indicate that you need write access, "
16664 "and prepare your scripts for the day when this option will be required for "
16669 #: ../fish/guestfish.pod:498
16671 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16672 "other libguestfs program apart from guestfish and guestmount."
16676 #: ../fish/guestfish.pod:501
16681 #: ../fish/guestfish.pod:503
16683 "You can quote ordinary parameters using either single or double quotes. For "
16688 #: ../fish/guestfish.pod:506
16691 " add \"file with a space.img\"\n"
16696 #: ../fish/guestfish.pod:508
16699 " rm '/file name'\n"
16704 #: ../fish/guestfish.pod:510
16712 #: ../fish/guestfish.pod:512
16714 "A few commands require a list of strings to be passed. For these, use a "
16715 "whitespace-separated list, enclosed in quotes. Strings containing "
16716 "whitespace to be passed through must be enclosed in single quotes. A "
16717 "literal single quote must be escaped with a backslash."
16721 #: ../fish/guestfish.pod:517
16724 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16725 " command \"/bin/echo 'foo bar'\"\n"
16726 " command \"/bin/echo \\'foo\\'\"\n"
16731 #: ../fish/guestfish.pod:521
16732 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16736 #: ../fish/guestfish.pod:523
16738 "In double-quoted arguments (only) use backslash to insert special "
16743 #: ../fish/guestfish.pod:528
16748 #: ../fish/guestfish.pod:530
16749 msgid "Alert (bell) character."
16753 #: ../fish/guestfish.pod:532
16758 #: ../fish/guestfish.pod:534
16759 msgid "Backspace character."
16763 #: ../fish/guestfish.pod:536
16768 #: ../fish/guestfish.pod:538
16769 msgid "Form feed character."
16773 #: ../fish/guestfish.pod:540
16778 #: ../fish/guestfish.pod:542
16779 msgid "Newline character."
16783 #: ../fish/guestfish.pod:544
16788 #: ../fish/guestfish.pod:546
16789 msgid "Carriage return character."
16793 #: ../fish/guestfish.pod:548
16798 #: ../fish/guestfish.pod:550
16799 msgid "Horizontal tab character."
16803 #: ../fish/guestfish.pod:552
16808 #: ../fish/guestfish.pod:554
16809 msgid "Vertical tab character."
16813 #: ../fish/guestfish.pod:556
16818 #: ../fish/guestfish.pod:558
16819 msgid "A literal double quote character."
16823 #: ../fish/guestfish.pod:560
16828 #: ../fish/guestfish.pod:562
16830 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
16835 #: ../fish/guestfish.pod:565
16840 #: ../fish/guestfish.pod:567
16841 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
16845 #: ../fish/guestfish.pod:570
16847 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16852 #: ../fish/guestfish.pod:573
16857 #: ../fish/guestfish.pod:575
16858 msgid "A literal backslash character."
16862 #: ../fish/guestfish.pod:579
16863 msgid "OPTIONAL ARGUMENTS"
16867 #: ../fish/guestfish.pod:581
16869 "Some commands take optional arguments. These arguments appear in this "
16870 "documentation as C<[argname:..]>. You can use them as in these examples:"
16874 #: ../fish/guestfish.pod:585
16877 " add-drive-opts filename\n"
16882 #: ../fish/guestfish.pod:587
16885 " add-drive-opts filename readonly:true\n"
16890 #: ../fish/guestfish.pod:589
16893 " add-drive-opts filename format:qcow2 readonly:false\n"
16898 #: ../fish/guestfish.pod:591
16900 "Each optional argument can appear at most once. All optional arguments must "
16901 "appear after the required ones."
16905 #: ../fish/guestfish.pod:594
16910 #: ../fish/guestfish.pod:596
16911 msgid "This section applies to all commands which can take integers as parameters."
16915 #: ../fish/guestfish.pod:599
16916 msgid "SIZE SUFFIX"
16920 #: ../fish/guestfish.pod:601
16922 "When the command takes a parameter measured in bytes, you can use one of the "
16923 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16927 #: ../fish/guestfish.pod:607
16928 msgid "B<k> or B<K> or B<KiB>"
16932 #: ../fish/guestfish.pod:609
16933 msgid "The size in kilobytes (multiplied by 1024)."
16937 #: ../fish/guestfish.pod:611
16942 #: ../fish/guestfish.pod:613
16943 msgid "The size in SI 1000 byte units."
16947 #: ../fish/guestfish.pod:615
16948 msgid "B<M> or B<MiB>"
16952 #: ../fish/guestfish.pod:617
16953 msgid "The size in megabytes (multiplied by 1048576)."
16957 #: ../fish/guestfish.pod:619
16962 #: ../fish/guestfish.pod:621
16963 msgid "The size in SI 1000000 byte units."
16967 #: ../fish/guestfish.pod:623
16968 msgid "B<G> or B<GiB>"
16972 #: ../fish/guestfish.pod:625
16973 msgid "The size in gigabytes (multiplied by 2**30)."
16977 #: ../fish/guestfish.pod:627
16982 #: ../fish/guestfish.pod:629
16983 msgid "The size in SI 10**9 byte units."
16987 #: ../fish/guestfish.pod:631
16988 msgid "B<T> or B<TiB>"
16992 #: ../fish/guestfish.pod:633
16993 msgid "The size in terabytes (multiplied by 2**40)."
16997 #: ../fish/guestfish.pod:635
17002 #: ../fish/guestfish.pod:637
17003 msgid "The size in SI 10**12 byte units."
17007 #: ../fish/guestfish.pod:639
17008 msgid "B<P> or B<PiB>"
17012 #: ../fish/guestfish.pod:641
17013 msgid "The size in petabytes (multiplied by 2**50)."
17017 #: ../fish/guestfish.pod:643
17022 #: ../fish/guestfish.pod:645
17023 msgid "The size in SI 10**15 byte units."
17027 #: ../fish/guestfish.pod:647
17028 msgid "B<E> or B<EiB>"
17032 #: ../fish/guestfish.pod:649
17033 msgid "The size in exabytes (multiplied by 2**60)."
17037 #: ../fish/guestfish.pod:651
17042 #: ../fish/guestfish.pod:653
17043 msgid "The size in SI 10**18 byte units."
17047 #: ../fish/guestfish.pod:655
17048 msgid "B<Z> or B<ZiB>"
17052 #: ../fish/guestfish.pod:657
17053 msgid "The size in zettabytes (multiplied by 2**70)."
17057 #: ../fish/guestfish.pod:659
17062 #: ../fish/guestfish.pod:661
17063 msgid "The size in SI 10**21 byte units."
17067 #: ../fish/guestfish.pod:663
17068 msgid "B<Y> or B<YiB>"
17072 #: ../fish/guestfish.pod:665
17073 msgid "The size in yottabytes (multiplied by 2**80)."
17077 #: ../fish/guestfish.pod:667
17082 #: ../fish/guestfish.pod:669
17083 msgid "The size in SI 10**24 byte units."
17087 #: ../fish/guestfish.pod:675
17090 " truncate-size /file 1G\n"
17095 #: ../fish/guestfish.pod:677
17096 msgid "would truncate the file to 1 gigabyte."
17100 #: ../fish/guestfish.pod:679
17102 "Be careful because a few commands take sizes in kilobytes or megabytes "
17103 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17104 "Adding a suffix will probably not do what you expect."
17108 #: ../fish/guestfish.pod:683
17109 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17113 #: ../fish/guestfish.pod:685
17115 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17116 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17120 #: ../fish/guestfish.pod:688
17123 " 1234 decimal number 1234\n"
17124 " 02322 octal number, equivalent to decimal 1234\n"
17125 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17130 #: ../fish/guestfish.pod:692
17132 "When using the C<chmod> command, you almost always want to specify an octal "
17133 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17134 "L<chmod(1)> program):"
17138 #: ../fish/guestfish.pod:696
17141 " chmod 0777 /public # OK\n"
17142 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17147 #: ../fish/guestfish.pod:699
17149 "Commands that return numbers usually print them in decimal, but some "
17150 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17151 "octal, preceeded by C<0>)."
17155 #: ../fish/guestfish.pod:703
17156 msgid "WILDCARDS AND GLOBBING"
17160 #: ../fish/guestfish.pod:705
17162 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17163 "(globbing) by default. So for example the following will not do what you "
17168 #: ../fish/guestfish.pod:709
17176 #: ../fish/guestfish.pod:711
17178 "Assuming you don't have a directory called literally C</home/*> then the "
17179 "above command will return an error."
17183 #: ../fish/guestfish.pod:714
17184 msgid "To perform wildcard expansion, use the C<glob> command."
17188 #: ../fish/guestfish.pod:716
17191 " glob rm-rf /home/*\n"
17196 #: ../fish/guestfish.pod:718
17198 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17199 "many times), equivalent to:"
17203 #: ../fish/guestfish.pod:721
17206 " rm-rf /home/jim\n"
17207 " rm-rf /home/joe\n"
17208 " rm-rf /home/mary\n"
17213 #: ../fish/guestfish.pod:725
17214 msgid "C<glob> only works on simple guest paths and not on device names."
17218 #: ../fish/guestfish.pod:727
17220 "If you have several parameters, each containing a wildcard, then glob will "
17221 "perform a Cartesian product."
17225 #: ../fish/guestfish.pod:730
17230 #: ../fish/guestfish.pod:732
17232 "Any line which starts with a I<#> character is treated as a comment and "
17233 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17234 "a command. For example:"
17238 #: ../fish/guestfish.pod:736
17241 " # this is a comment\n"
17242 " # this is a comment\n"
17243 " foo # NOT a comment\n"
17248 #: ../fish/guestfish.pod:740
17249 msgid "Blank lines are also ignored."
17253 #: ../fish/guestfish.pod:742
17254 msgid "RUNNING COMMANDS LOCALLY"
17258 #: ../fish/guestfish.pod:744
17260 "Any line which starts with a I<!> character is treated as a command sent to "
17261 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17265 #: ../fish/guestfish.pod:748
17269 " tgz-out /remote local/remote-data.tar.gz\n"
17274 #: ../fish/guestfish.pod:751
17276 "will create a directory C<local> on the host, and then export the contents "
17277 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17278 "(See C<tgz-out>)."
17282 #: ../fish/guestfish.pod:755
17284 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17285 "effect, due to the way that subprocesses work in Unix."
17289 #: ../fish/guestfish.pod:758
17290 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17294 #: ../fish/guestfish.pod:760
17296 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17297 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17298 "and executed as guestfish commands."
17302 #: ../fish/guestfish.pod:764
17304 "Thus you can use shell script to construct arbitrary guestfish commands "
17305 "which are then parsed by guestfish."
17309 #: ../fish/guestfish.pod:767
17311 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17312 "through C</foo.100>) using guestfish commands alone. However this is simple "
17313 "if we use a shell script to create the guestfish commands for us:"
17317 #: ../fish/guestfish.pod:772
17320 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17325 #: ../fish/guestfish.pod:774
17326 msgid "or with names like C</foo.001>:"
17330 #: ../fish/guestfish.pod:776
17333 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17338 #: ../fish/guestfish.pod:778
17340 "When using guestfish interactively it can be helpful to just run the shell "
17341 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17342 "ordinary I<!> local command), see what guestfish commands it would run, and "
17343 "when you are happy with those prepend the C<E<lt>> character to run the "
17344 "guestfish commands for real."
17348 #: ../fish/guestfish.pod:784
17353 #: ../fish/guestfish.pod:786
17355 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17356 "command (a guestfish command) to the second command (any host command). For "
17361 #: ../fish/guestfish.pod:790
17364 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17369 #: ../fish/guestfish.pod:792
17371 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17372 "program). The above command would list all accounts in the guest filesystem "
17373 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17377 #: ../fish/guestfish.pod:797
17380 " hexdump /bin/ls | head\n"
17381 " list-devices | tail -1\n"
17382 " tgz-out / - | tar ztf -\n"
17387 #: ../fish/guestfish.pod:801
17389 "The space before the pipe symbol is required, any space after the pipe "
17390 "symbol is optional. Everything after the pipe symbol is just passed "
17391 "straight to the host shell, so it can contain redirections, globs and "
17392 "anything else that makes sense on the host side."
17396 #: ../fish/guestfish.pod:806
17398 "To use a literal argument which begins with a pipe symbol, you have to quote "
17403 #: ../fish/guestfish.pod:809
17411 #: ../fish/guestfish.pod:811
17412 msgid "HOME DIRECTORIES"
17416 #: ../fish/guestfish.pod:813
17418 "If a parameter starts with the character C<~> then the tilde may be expanded "
17419 "as a home directory path (either C<~> for the current user's home directory, "
17420 "or C<~user> for another user)."
17424 #: ../fish/guestfish.pod:817
17426 "Note that home directory expansion happens for users known I<on the host>, "
17427 "not in the guest filesystem."
17431 #: ../fish/guestfish.pod:820
17433 "To use a literal argument which begins with a tilde, you have to quote it, "
17438 #: ../fish/guestfish.pod:823
17446 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17447 msgid "ENCRYPTED DISKS"
17451 #: ../fish/guestfish.pod:827
17453 "Libguestfs has some support for Linux guests encrypted according to the "
17454 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17455 "disk encryption systems used by modern Linux guests. Currently only "
17456 "LVM-on-LUKS is supported."
17460 #: ../fish/guestfish.pod:832
17461 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17465 #: ../fish/guestfish.pod:834
17468 " ><fs> vfs-type /dev/sda2\n"
17474 #: ../fish/guestfish.pod:837
17476 "Then open those devices using L</luks-open>. This creates a device-mapper "
17477 "device called C</dev/mapper/luksdev>."
17481 #: ../fish/guestfish.pod:840
17484 " ><fs> luks-open /dev/sda2 luksdev\n"
17485 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17490 #: ../fish/guestfish.pod:843
17492 "Finally you have to tell LVM to scan for volume groups on the newly created "
17497 #: ../fish/guestfish.pod:846
17501 " vg-activate-all true\n"
17506 #: ../fish/guestfish.pod:849
17507 msgid "The logical volume(s) can now be mounted in the usual way."
17511 #: ../fish/guestfish.pod:851
17513 "Before closing a LUKS device you must unmount any logical volumes on it and "
17514 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17515 "one. Then you can close the mapper device:"
17519 #: ../fish/guestfish.pod:855
17522 " vg-activate false /dev/VG\n"
17523 " luks-close /dev/mapper/luksdev\n"
17528 #: ../fish/guestfish.pod:860
17530 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17531 "letters and paths (with some limitations). The following commands are "
17536 #: ../fish/guestfish.pod:864
17539 " file /WINDOWS/system32/config/system.LOG\n"
17544 #: ../fish/guestfish.pod:866
17547 " file win:\\windows\\system32\\config\\system.log\n"
17552 #: ../fish/guestfish.pod:868
17555 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17560 #: ../fish/guestfish.pod:870
17562 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17563 "where the drive is mounted, prepending that to the path, changing all "
17564 "backslash characters to forward slash, then resolving the result using "
17565 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
17566 "then the parameter might be rewritten like this:"
17570 #: ../fish/guestfish.pod:876
17573 " win:e:\\foo\\bar => /e/FOO/bar\n"
17578 #: ../fish/guestfish.pod:878
17579 msgid "This only works in argument positions that expect a path."
17583 #: ../fish/guestfish.pod:880
17584 msgid "UPLOADING AND DOWNLOADING FILES"
17588 #: ../fish/guestfish.pod:882
17590 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17591 "others which upload from or download to a local file, you can use the "
17592 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17596 #: ../fish/guestfish.pod:886
17604 #: ../fish/guestfish.pod:888
17605 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17609 #: ../fish/guestfish.pod:891
17612 " tar-out /etc - | tar tf -\n"
17617 #: ../fish/guestfish.pod:893
17619 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17620 "command (see L</PIPES>)."
17624 #: ../fish/guestfish.pod:896
17626 "When using C<-> to read from stdin, the input is read up to the end of "
17627 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17628 "some arbitrary end marker:"
17632 #: ../fish/guestfish.pod:900
17635 " upload -<<END /foo\n"
17644 #: ../fish/guestfish.pod:906
17646 "Any string of characters can be used instead of C<END>. The end marker must "
17647 "appear on a line of its own, without any preceeding or following characters "
17648 "(not even spaces)."
17652 #: ../fish/guestfish.pod:910
17654 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17655 "upload local files (so-called \"FileIn\" parameters in the generator)."
17659 #: ../fish/guestfish.pod:913
17660 msgid "EXIT ON ERROR BEHAVIOUR"
17664 #: ../fish/guestfish.pod:915
17666 "By default, guestfish will ignore any errors when in interactive mode "
17667 "(ie. taking commands from a human over a tty), and will exit on the first "
17668 "error in non-interactive mode (scripts, commands given on the command line)."
17672 #: ../fish/guestfish.pod:920
17674 "If you prefix a command with a I<-> character, then that command will not "
17675 "cause guestfish to exit, even if that (one) command returns an error."
17679 #: ../fish/guestfish.pod:924
17680 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17684 #: ../fish/guestfish.pod:926
17686 "Guestfish can be remote-controlled over a socket. This is useful "
17687 "particularly in shell scripts where you want to make several different "
17688 "changes to a filesystem, but you don't want the overhead of starting up a "
17689 "guestfish process each time."
17693 #: ../fish/guestfish.pod:931
17694 msgid "Start a guestfish server process using:"
17698 #: ../fish/guestfish.pod:933
17701 " eval \"`guestfish --listen`\"\n"
17706 #: ../fish/guestfish.pod:935
17707 msgid "and then send it commands by doing:"
17711 #: ../fish/guestfish.pod:937
17714 " guestfish --remote cmd [...]\n"
17719 #: ../fish/guestfish.pod:939
17720 msgid "To cause the server to exit, send it the exit command:"
17724 #: ../fish/guestfish.pod:943
17726 "Note that the server will normally exit if there is an error in a command. "
17727 "You can change this in the usual way. See section L</EXIT ON ERROR "
17732 #: ../fish/guestfish.pod:947
17733 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17737 #: ../fish/guestfish.pod:949
17739 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17740 "is how the I<--remote> option knows where to send the commands. You can "
17741 "have several guestfish listener processes running using:"
17745 #: ../fish/guestfish.pod:953
17748 " eval \"`guestfish --listen`\"\n"
17749 " pid1=$GUESTFISH_PID\n"
17750 " eval \"`guestfish --listen`\"\n"
17751 " pid2=$GUESTFISH_PID\n"
17753 " guestfish --remote=$pid1 cmd\n"
17754 " guestfish --remote=$pid2 cmd\n"
17759 #: ../fish/guestfish.pod:961
17760 msgid "REMOTE CONTROL AND CSH"
17764 #: ../fish/guestfish.pod:963
17766 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17771 #: ../fish/guestfish.pod:966
17774 " eval \"`guestfish --listen --csh`\"\n"
17779 #: ../fish/guestfish.pod:968
17780 msgid "REMOTE CONTROL DETAILS"
17784 #: ../fish/guestfish.pod:970
17786 "Remote control happens over a Unix domain socket called "
17787 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17788 "of the process, and C<$PID> is the process ID of the server."
17792 #: ../fish/guestfish.pod:974
17793 msgid "Guestfish client and server versions must match exactly."
17797 #: ../fish/guestfish.pod:976
17798 msgid "REMOTE CONTROL RUN COMMAND HANGING"
17802 #: ../fish/guestfish.pod:978
17804 "Using the C<run> (or C<launch>) command remotely in a command substitution "
17805 "context hangs, ie. don't do (note the backquotes):"
17809 #: ../fish/guestfish.pod:981
17812 " a=`guestfish --remote run`\n"
17817 #: ../fish/guestfish.pod:983
17819 "Since the C<run> command produces no output on stdout, this is not useful "
17820 "anyway. For further information see "
17821 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
17825 #: ../fish/guestfish.pod:987
17826 msgid "PREPARED DISK IMAGES"
17830 #: ../fish/guestfish.pod:989
17832 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17833 "preformatted disk images that guestfish can make for you to save typing. "
17834 "This is particularly useful for testing purposes. This option is used "
17835 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17836 "can be mixed with I<-a>)."
17840 #: ../fish/guestfish.pod:995
17842 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17843 "the second and so on. Existing files in the current directory are "
17848 #: ../fish/guestfish.pod:999
17850 "The type briefly describes how the disk should be sized, partitioned, how "
17851 "filesystem(s) should be created, and how content should be added. "
17852 "Optionally the type can be followed by extra parameters, separated by C<:> "
17853 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17854 "sparsely-allocated disk, containing a single partition, with the partition "
17855 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17856 "on a 1GB disk instead."
17860 #: ../fish/guestfish.pod:1007
17861 msgid "To list the available types and any extra parameters they take, run:"
17865 #: ../fish/guestfish.pod:1011
17867 "Note that the prepared filesystem is not mounted. You would usually have to "
17868 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17872 #: ../fish/guestfish.pod:1015
17874 "If any I<-N> or I<--new> options are given, the guest is automatically "
17879 #: ../fish/guestfish.pod:1020
17880 msgid "Create a 100MB disk with an ext4-formatted partition:"
17884 #: ../fish/guestfish.pod:1022
17887 " guestfish -N fs:ext4\n"
17892 #: ../fish/guestfish.pod:1024
17893 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17897 #: ../fish/guestfish.pod:1026
17900 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17905 #: ../fish/guestfish.pod:1028
17906 msgid "Create a blank 200MB disk:"
17910 #: ../fish/guestfish.pod:1030
17913 " guestfish -N disk:200M\n"
17918 #: ../fish/guestfish.pod:1032
17919 msgid "PROGRESS BARS"
17923 #: ../fish/guestfish.pod:1034
17925 "Some (not all) long-running commands send progress notification messages as "
17926 "they are running. Guestfish turns these messages into progress bars."
17930 #: ../fish/guestfish.pod:1038
17932 "When a command that supports progress bars takes longer than two seconds to "
17933 "run, and if progress bars are enabled, then you will see one appearing below "
17938 #: ../fish/guestfish.pod:1042
17941 " ><fs> copy-size /large-file /another-file 2048M\n"
17942 " / 10% [#####-----------------------------------------] 00:30\n"
17947 #: ../fish/guestfish.pod:1045
17949 "The spinner on the left hand side moves round once for every progress "
17950 "notification received from the backend. This is a (reasonably) golden "
17951 "assurance that the command is \"doing something\" even if the progress bar "
17952 "is not moving, because the command is able to send the progress "
17953 "notifications. When the bar reaches 100% and the command finishes, the "
17954 "spinner disappears."
17958 #: ../fish/guestfish.pod:1052
17960 "Progress bars are enabled by default when guestfish is used interactively. "
17961 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17962 "and you can disable them completely using I<--no-progress-bars>."
17966 #: ../fish/guestfish.pod:1057
17967 msgid "GUESTFISH COMMANDS"
17971 #: ../fish/guestfish.pod:1059
17973 "The commands in this section are guestfish convenience commands, in other "
17974 "words, they are not part of the L<guestfs(3)> API."
17978 #: ../fish/guestfish.pod:1062
17983 #: ../fish/guestfish.pod:1064
17992 #: ../fish/guestfish.pod:1067
17993 msgid "Without any parameter, this provides general help."
17997 #: ../fish/guestfish.pod:1069
17998 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18002 #: ../fish/guestfish.pod:1071
18003 msgid "quit | exit"
18007 #: ../fish/guestfish.pod:1073
18008 msgid "This exits guestfish. You can also use C<^D> key."
18012 #: ../fish/guestfish.pod:1075
18013 msgid "@FISH_COMMANDS@"
18017 #: ../fish/guestfish.pod:1077
18022 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1479
18027 #: ../fish/guestfish.pod:1083
18029 "guestfish returns 0 if the commands completed without error, or 1 if there "
18034 #: ../fish/guestfish.pod:1090
18039 #: ../fish/guestfish.pod:1092
18041 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18046 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:3084
18047 msgid "FEBOOTSTRAP_KERNEL"
18051 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:3086
18052 msgid "FEBOOTSTRAP_MODULES"
18056 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:3088
18058 "These two environment variables allow the kernel that libguestfs uses in the "
18059 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18060 "most recent host kernel is chosen. For more information about kernel "
18061 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
18062 "available in febootstrap E<ge> 3.8."
18066 #: ../fish/guestfish.pod:1105
18067 msgid "GUESTFISH_DISPLAY_IMAGE"
18071 #: ../fish/guestfish.pod:1107
18073 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18074 "If not set, it uses L<display(1)>."
18078 #: ../fish/guestfish.pod:1110
18079 msgid "GUESTFISH_PID"
18083 #: ../fish/guestfish.pod:1112
18085 "Used with the I<--remote> option to specify the remote guestfish process to "
18086 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18090 #: ../fish/guestfish.pod:1116
18095 #: ../fish/guestfish.pod:1118
18097 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18098 "not specified, the external L<hexedit(1)> program is used."
18102 #: ../fish/guestfish.pod:1122
18107 #: ../fish/guestfish.pod:1124
18109 "If compiled with GNU readline support, various files in the home directory "
18110 "can be used. See L</FILES>."
18114 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:3094
18115 msgid "LIBGUESTFS_APPEND"
18119 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:3096
18120 msgid "Pass additional options to the guest kernel."
18124 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:3098
18125 msgid "LIBGUESTFS_DEBUG"
18129 #: ../fish/guestfish.pod:1133
18131 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18132 "effect as using the B<-v> option."
18136 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:3103
18137 msgid "LIBGUESTFS_MEMSIZE"
18141 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:3105
18142 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
18146 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:3108
18149 " LIBGUESTFS_MEMSIZE=700\n"
18154 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:3110
18155 msgid "LIBGUESTFS_PATH"
18159 #: ../fish/guestfish.pod:1145
18161 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18162 "the discussion of paths in L<guestfs(3)>."
18166 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3115
18167 msgid "LIBGUESTFS_QEMU"
18171 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3117
18173 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18174 "which was found at compile time by the configure script is used."
18178 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3123
18179 msgid "LIBGUESTFS_TRACE"
18183 #: ../fish/guestfish.pod:1156
18184 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18188 #: ../fish/guestfish.pod:1158
18193 #: ../fish/guestfish.pod:1160
18195 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18200 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3128
18205 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3130
18207 "Location of temporary directory, defaults to C</tmp> except for the cached "
18208 "supermin appliance which defaults to C</var/tmp>."
18212 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3133
18214 "If libguestfs was compiled to use the supermin appliance then the real "
18215 "appliance is cached in this directory, shared between all handles belonging "
18216 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18217 "use in case C</var/tmp> is not large enough."
18221 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288 ../rescue/virt-rescue.pod:269
18226 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292 ../rescue/virt-rescue.pod:273
18227 msgid "$HOME/.libguestfs-tools.rc"
18231 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294 ../rescue/virt-rescue.pod:275
18232 msgid "/etc/libguestfs-tools.conf"
18236 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296 ../rescue/virt-rescue.pod:277
18238 "This configuration file controls the default read-only or read-write mode "
18239 "(I<--ro> or I<--rw>)."
18243 #: ../fish/guestfish.pod:1187
18244 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18248 #: ../fish/guestfish.pod:1189
18249 msgid "$HOME/.guestfish"
18253 #: ../fish/guestfish.pod:1191
18255 "If compiled with GNU readline support, then the command history is saved in "
18260 #: ../fish/guestfish.pod:1194
18261 msgid "$HOME/.inputrc"
18265 #: ../fish/guestfish.pod:1196
18266 msgid "/etc/inputrc"
18270 #: ../fish/guestfish.pod:1198
18272 "If compiled with GNU readline support, then these files can be used to "
18273 "configure readline. For further information, please see "
18274 "L<readline(3)/INITIALIZATION FILE>."
18278 #: ../fish/guestfish.pod:1202
18279 msgid "To write rules which only apply to guestfish, use:"
18283 #: ../fish/guestfish.pod:1204
18293 #: ../fish/guestfish.pod:1208
18295 "Variables that you can set in inputrc that change the behaviour of guestfish "
18296 "in useful ways include:"
18300 #: ../fish/guestfish.pod:1213
18301 msgid "completion-ignore-case (default: on)"
18305 #: ../fish/guestfish.pod:1215
18307 "By default, guestfish will ignore case when tab-completing paths on the "
18312 #: ../fish/guestfish.pod:1218
18315 " set completion-ignore-case off\n"
18320 #: ../fish/guestfish.pod:1220
18321 msgid "to make guestfish case sensitive."
18325 #: ../fish/guestfish.pod:1224
18330 #: ../fish/guestfish.pod:1226
18331 msgid "test2.img (etc)"
18335 #: ../fish/guestfish.pod:1228
18337 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18338 "will be created in the file C<test1.img> in the current directory. The "
18339 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18340 "the same name will be overwritten."
18344 #: ../fish/guestfish.pod:1237
18346 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18347 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18348 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18349 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18350 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18351 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18352 "L<febootstrap-supermin-helper(8)>."
18356 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3220 ../test-tool/libguestfs-test-tool.pod:112
18357 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18361 #: ../fish/virt-copy-in.pod:5
18362 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18366 #: ../fish/virt-copy-in.pod:9
18369 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18374 #: ../fish/virt-copy-in.pod:11
18377 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18382 #: ../fish/virt-copy-in.pod:15
18384 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18385 "causing disk corruption. The virtual machine must be shut down before you "
18386 "use this command."
18390 #: ../fish/virt-copy-in.pod:21
18392 "C<virt-copy-in> copies files and directories from the local disk into a "
18393 "virtual machine disk image or named libvirt domain."
18397 #: ../fish/virt-copy-in.pod:24
18399 "You can give one of more filenames and directories on the command line. "
18400 "Directories are copied in recursively. The final parameter must be the "
18401 "destination directory in the disk image which must be an absolute path "
18402 "starting with a C</> character."
18406 #: ../fish/virt-copy-in.pod:33
18409 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18414 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18415 msgid "Upload a home directory to a guest:"
18419 #: ../fish/virt-copy-in.pod:37
18422 " virt-copy-in -d MyGuest skel /home\n"
18427 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18428 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18432 #: ../fish/virt-copy-in.pod:41
18434 "This command is just a simple shell script wrapper around the "
18435 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
18436 "trivial copy, you are probably better off using guestfish directly."
18440 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18442 "Since the shell script just passes options straight to guestfish, read "
18443 "L<guestfish(1)> to see the full list of options."
18447 #: ../fish/virt-copy-in.pod:52
18449 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18450 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18454 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18455 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18459 #: ../fish/virt-copy-out.pod:5
18461 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18466 #: ../fish/virt-copy-out.pod:9
18469 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18474 #: ../fish/virt-copy-out.pod:11
18477 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18482 #: ../fish/virt-copy-out.pod:15
18484 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18485 "image or named libvirt domain."
18489 #: ../fish/virt-copy-out.pod:18
18491 "You can give one of more filenames and directories on the command line. "
18492 "Directories are copied out recursively."
18496 #: ../fish/virt-copy-out.pod:23
18497 msgid "Download the home directories from a virtual machine:"
18501 #: ../fish/virt-copy-out.pod:25
18505 " virt-copy-out -d MyGuest /home homes\n"
18510 #: ../fish/virt-copy-out.pod:30
18512 "This command is just a simple shell script wrapper around the "
18513 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
18514 "trivial copy, you are probably better off using guestfish directly."
18518 #: ../fish/virt-copy-out.pod:41
18520 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18521 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18525 #: ../fish/virt-tar-in.pod:5
18526 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18530 #: ../fish/virt-tar-in.pod:9
18533 " virt-tar-in -a disk.img data.tar /destination\n"
18538 #: ../fish/virt-tar-in.pod:11
18541 " virt-tar-in -d domain data.tar /destination\n"
18546 #: ../fish/virt-tar-in.pod:13
18549 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18554 #: ../fish/virt-tar-in.pod:17
18556 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18557 "causing disk corruption. The virtual machine must be shut down before you "
18558 "use this command."
18562 #: ../fish/virt-tar-in.pod:23
18564 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18565 "image or named libvirt domain."
18569 #: ../fish/virt-tar-in.pod:26
18571 "The first parameter is the tar file. Use C<-> to read the tar file from "
18572 "standard input. The second parameter is the absolute target directory to "
18577 #: ../fish/virt-tar-in.pod:34
18580 " virt-tar-in -d MyGuest homes.tar /home\n"
18585 #: ../fish/virt-tar-in.pod:38
18587 "This command is just a simple shell script wrapper around the "
18588 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
18589 "copy, you are probably better off using guestfish directly."
18593 #: ../fish/virt-tar-in.pod:49
18595 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18596 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18597 "L<http://libguestfs.org/>."
18601 #: ../fish/virt-tar-out.pod:5
18602 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18606 #: ../fish/virt-tar-out.pod:9
18609 " virt-tar-out -a disk.img /dir files.tar\n"
18614 #: ../fish/virt-tar-out.pod:11
18617 " virt-tar-out -d domain /dir files.tar\n"
18622 #: ../fish/virt-tar-out.pod:13
18625 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18630 #: ../fish/virt-tar-out.pod:17
18631 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18635 #: ../fish/virt-tar-out.pod:20
18637 "The first parameter is the absolute path of the virtual machine directory. "
18638 "The second parameter is the tar file to write. Use C<-> to write to "
18643 #: ../fish/virt-tar-out.pod:26
18644 msgid "Download the home directories from a guest:"
18648 #: ../fish/virt-tar-out.pod:28
18651 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18656 #: ../fish/virt-tar-out.pod:32
18658 "This command is just a simple shell script wrapper around the "
18659 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
18660 "trivial copy, you are probably better off using guestfish directly."
18664 #: ../fish/virt-tar-out.pod:43
18666 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18667 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18671 #: ../fuse/guestmount.pod:5
18672 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18676 #: ../fuse/guestmount.pod:9
18679 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18684 #: ../fuse/guestmount.pod:11
18687 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18692 #: ../fuse/guestmount.pod:13
18695 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18700 #: ../fuse/guestmount.pod:17
18702 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18703 "machines. If you do this, you risk disk corruption in the VM."
18707 #: ../fuse/guestmount.pod:22
18709 "The guestmount program can be used to mount virtual machine filesystems and "
18710 "other disk images on the host. It uses libguestfs for access to the guest "
18711 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18712 "a mountable device."
18716 #: ../fuse/guestmount.pod:27
18718 "Along with other options, you have to give at least one device (I<-a> "
18719 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18720 "option) or use the I<-i> inspection option. How this works is better "
18721 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18726 #: ../fuse/guestmount.pod:33
18728 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18729 "by you, and the filesystem will not be visible to any other users unless you "
18730 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18731 "the filesystem, use the C<fusermount -u> command."
18735 #: ../fuse/guestmount.pod:41
18737 "For a typical Windows guest which has its main filesystem on the first "
18742 #: ../fuse/guestmount.pod:44
18745 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18750 #: ../fuse/guestmount.pod:46
18752 "For a typical Linux guest which has a /boot filesystem on the first "
18753 "partition, and the root filesystem on a logical volume:"
18757 #: ../fuse/guestmount.pod:49
18760 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18765 #: ../fuse/guestmount.pod:51
18766 msgid "To get libguestfs to detect guest mountpoints for you:"
18770 #: ../fuse/guestmount.pod:53
18773 " guestmount -a guest.img -i --ro /mnt\n"
18778 #: ../fuse/guestmount.pod:55
18779 msgid "For a libvirt guest called \"Guest\" you could do:"
18783 #: ../fuse/guestmount.pod:57
18786 " guestmount -d Guest -i --ro /mnt\n"
18791 #: ../fuse/guestmount.pod:59
18793 "If you don't know what filesystems are contained in a guest or disk image, "
18794 "use L<virt-filesystems(1)> first:"
18798 #: ../fuse/guestmount.pod:62
18801 " virt-filesystems MyGuest\n"
18806 #: ../fuse/guestmount.pod:64
18808 "If you want to trace the libguestfs calls but without excessive debugging "
18809 "information, we recommend:"
18813 #: ../fuse/guestmount.pod:67
18816 " guestmount [...] --trace /mnt\n"
18821 #: ../fuse/guestmount.pod:69
18822 msgid "If you want to debug the program, we recommend:"
18826 #: ../fuse/guestmount.pod:71
18829 " guestmount [...] --trace --verbose /mnt\n"
18834 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:544
18839 #: ../fuse/guestmount.pod:75
18840 msgid "Other users cannot see the filesystem by default"
18844 #: ../fuse/guestmount.pod:77
18846 "If you mount a filesystem as one user (eg. root), then other users will not "
18847 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
18848 "option when mounting:"
18852 #: ../fuse/guestmount.pod:81
18855 " sudo guestmount [...] -o allow_other /mnt\n"
18860 #: ../fuse/guestmount.pod:91
18861 msgid "Add a block device or virtual machine image."
18865 #: ../fuse/guestmount.pod:114
18866 msgid "B<--dir-cache-timeout N>"
18870 #: ../fuse/guestmount.pod:116
18872 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18873 "seconds. The readdir cache [actually, there are several semi-independent "
18874 "caches] is populated after a readdir(2) call with the stat and extended "
18875 "attributes of the files in the directory, in anticipation that they will be "
18876 "requested soon after."
18880 #: ../fuse/guestmount.pod:122
18882 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18883 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18884 "requests, only cache existing ones."
18888 #: ../fuse/guestmount.pod:142
18890 "If you have untrusted raw-format guest disk images, you should use this "
18891 "option to specify the disk format. This avoids a possible security problem "
18892 "with malicious guests (CVE-2010-3851). See also "
18893 "L<guestfs(3)/guestfs_add_drive_opts>."
18897 #: ../fuse/guestmount.pod:147
18898 msgid "B<--fuse-help>"
18902 #: ../fuse/guestmount.pod:149
18903 msgid "Display help on special FUSE options (see I<-o> below)."
18907 #: ../fuse/guestmount.pod:153
18908 msgid "Display brief help and exit."
18912 #: ../fuse/guestmount.pod:177
18914 "Mount the named partition or logical volume on the given mountpoint B<in the "
18915 "guest> (this has nothing to do with mountpoints in the host)."
18919 #: ../fuse/guestmount.pod:180
18921 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
18922 "something on C</>."
18926 #: ../fuse/guestmount.pod:197
18928 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
18929 "unmounted. If you specify this option, then we don't attempt to sync the "
18930 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
18934 #: ../fuse/guestmount.pod:202
18935 msgid "B<-o option>"
18939 #: ../fuse/guestmount.pod:204
18940 msgid "B<--option option>"
18944 #: ../fuse/guestmount.pod:206
18945 msgid "Pass extra options to FUSE."
18949 #: ../fuse/guestmount.pod:208
18951 "To get a list of all the extra options supported by FUSE, use the command "
18952 "below. Note that only the FUSE I<-o> options can be passed, and only some "
18953 "of them are a good idea."
18957 #: ../fuse/guestmount.pod:212
18960 " guestmount --fuse-help\n"
18965 #: ../fuse/guestmount.pod:214
18966 msgid "Some potentially useful FUSE options:"
18970 #: ../fuse/guestmount.pod:218
18971 msgid "B<-o allow_other>"
18975 #: ../fuse/guestmount.pod:220
18976 msgid "Allow other users to see the filesystem."
18980 #: ../fuse/guestmount.pod:222
18981 msgid "B<-o attr_timeout=N>"
18985 #: ../fuse/guestmount.pod:224
18986 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
18990 #: ../fuse/guestmount.pod:226
18991 msgid "B<-o kernel_cache>"
18995 #: ../fuse/guestmount.pod:228
18997 "Allow the kernel to cache files (reduces the number of reads that have to go "
18998 "through the L<guestfs(3)> API). This is generally a good idea if you can "
18999 "afford the extra memory usage."
19003 #: ../fuse/guestmount.pod:232
19004 msgid "B<-o uid=N> B<-o gid=N>"
19008 #: ../fuse/guestmount.pod:234
19010 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19011 "the chosen values."
19015 #: ../fuse/guestmount.pod:243
19017 "Add devices and mount everything read-only. Also disallow writes and make "
19018 "the disk appear read-only to FUSE."
19022 #: ../fuse/guestmount.pod:246
19024 "This is highly recommended if you are not going to edit the guest disk. If "
19025 "the guest is running and this option is I<not> supplied, then there is a "
19026 "strong risk of disk corruption in the guest. We try to prevent this from "
19027 "happening, but it is not always possible."
19031 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19032 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19036 #: ../fuse/guestmount.pod:255
19037 msgid "Enable SELinux support for the guest."
19041 #: ../fuse/guestmount.pod:261
19042 msgid "Enable verbose messages from underlying libguestfs."
19046 #: ../fuse/guestmount.pod:267
19047 msgid "Display the program version and exit."
19051 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299 ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
19052 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19056 #: ../fuse/guestmount.pod:280
19061 #: ../fuse/guestmount.pod:282
19062 msgid "Trace libguestfs calls and entry into each FUSE function."
19066 #: ../fuse/guestmount.pod:284
19067 msgid "This also stops the daemon from forking into the background."
19071 #: ../fuse/guestmount.pod:310
19073 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19074 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
19075 "L<http://fuse.sf.net/>."
19079 #: ../fuse/guestmount.pod:325
19080 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19084 #: ../inspector/virt-inspector.pod:5
19086 "virt-inspector - Display operating system version and other information "
19087 "about a virtual machine"
19091 #: ../inspector/virt-inspector.pod:9
19094 " virt-inspector [--options] -d domname\n"
19099 #: ../inspector/virt-inspector.pod:11
19102 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19107 #: ../inspector/virt-inspector.pod:15
19110 " virt-inspector domname\n"
19115 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19118 " virt-inspector disk.img [disk.img ...]\n"
19123 #: ../inspector/virt-inspector.pod:21
19125 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19126 "determine the version of the operating system and other information about "
19127 "the virtual machine."
19131 #: ../inspector/virt-inspector.pod:25
19132 msgid "Virt-inspector produces XML output for feeding into other programs."
19136 #: ../inspector/virt-inspector.pod:27
19138 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19139 "the libvirt domain (see: C<virsh list --all>)."
19143 #: ../inspector/virt-inspector.pod:30
19145 "You can also run virt-inspector directly on disk images from a single "
19146 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19147 "has several block devices, in which case you should list several I<-a> "
19148 "options one after another, with the first corresponding to the guest's "
19149 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
19153 #: ../inspector/virt-inspector.pod:37
19155 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19156 "keys and similar."
19160 #: ../inspector/virt-inspector.pod:40
19162 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19163 "inspect several virtual machines, you have to run virt-inspector several "
19164 "times (for example, from a shell script for-loop)."
19168 #: ../inspector/virt-inspector.pod:45
19170 "Because virt-inspector needs direct access to guest images, it won't "
19171 "normally work over remote libvirt connections."
19175 #: ../inspector/virt-inspector.pod:48
19177 "All of the information available from virt-inspector is also available "
19178 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19179 "The same information can also be fetched using guestfish or via libguestfs "
19180 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19181 "WITH OTHER PROGRAMMING LANGUAGES>)."
19185 #: ../inspector/virt-inspector.pod:81
19187 "Libvirt is only used if you specify a C<domname> on the command line. If "
19188 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19193 #: ../inspector/virt-inspector.pod:94
19195 "When prompting for keys and passphrases, virt-inspector normally turns "
19196 "echoing off so you cannot see what you are typing. If you are not worried "
19197 "about Tempest attacks and there is no one else in the room you can specify "
19198 "this flag to see what you are typing."
19202 #: ../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
19204 "Specify the format of disk images given on the command line. If this is "
19205 "omitted then the format is autodetected from the content of the disk image."
19209 #: ../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
19211 "If disk images are requested from libvirt, then this program asks libvirt "
19212 "for this information. In this case, the value of the format parameter is "
19217 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
19219 "If working with untrusted raw-format guest disk images, you should ensure "
19220 "the format is always specified."
19224 #: ../inspector/virt-inspector.pod:139
19225 msgid "Previous versions of virt-inspector allowed you to write either:"
19229 #: ../inspector/virt-inspector.pod:145
19232 " virt-inspector guestname\n"
19237 #: ../inspector/virt-inspector.pod:153
19242 #: ../inspector/virt-inspector.pod:155
19244 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19245 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19246 "just an overview."
19250 #: ../inspector/virt-inspector.pod:159
19252 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19253 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19254 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19255 "which is vanishingly rare in real world VMs."
19259 #: ../inspector/virt-inspector.pod:164
19260 msgid "E<lt>operatingsystemE<gt>"
19264 #: ../inspector/virt-inspector.pod:166
19266 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19267 "describe the operating system, its architecture, the descriptive \"product "
19268 "name\" string, the type of OS and so on, as in this example:"
19272 #: ../inspector/virt-inspector.pod:170
19275 " <operatingsystems>\n"
19276 " <operatingsystem>\n"
19277 " <root>/dev/sda2</root>\n"
19278 " <name>windows</name>\n"
19279 " <arch>i386</arch>\n"
19280 " <distro>windows</distro>\n"
19281 " <product_name>Windows 7 Enterprise</product_name>\n"
19282 " <product_variant>Client</product_variant>\n"
19283 " <major_version>6</major_version>\n"
19284 " <minor_version>1</minor_version>\n"
19285 " <windows_systemroot>/Windows</windows_systemroot>\n"
19286 " <format>installed</format>\n"
19291 #: ../inspector/virt-inspector.pod:183
19293 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19294 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19295 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19296 "architecture. The other fields are fairly self-explanatory, but because "
19297 "these fields are taken directly from the libguestfs inspection API you can "
19298 "find precise information from L<guestfs(3)/INSPECTION>."
19302 #: ../inspector/virt-inspector.pod:191
19304 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19305 "of view of libguestfs (block devices may have completely different names "
19306 "inside the VM itself)."
19310 #: ../inspector/virt-inspector.pod:195
19311 msgid "E<lt>mountpointsE<gt>"
19315 #: ../inspector/virt-inspector.pod:197
19317 "Un*x-like guests typically have multiple filesystems which are mounted at "
19318 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19319 "element which looks like this:"
19323 #: ../inspector/virt-inspector.pod:201
19326 " <operatingsystems>\n"
19327 " <operatingsystem>\n"
19330 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19331 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19332 " </mountpoints>\n"
19337 #: ../inspector/virt-inspector.pod:209
19339 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19340 "and may have completely different names inside the guest. Only mountable "
19341 "filesystems appear in this list, not things like swap devices."
19345 #: ../inspector/virt-inspector.pod:214
19346 msgid "E<lt>filesystemsE<gt>"
19350 #: ../inspector/virt-inspector.pod:216
19352 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19353 "filesystems belonging to the guest, including swap and empty partitions. "
19354 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19355 "this OS or shared with this OS and other OSes)."
19359 #: ../inspector/virt-inspector.pod:222
19360 msgid "You might see something like this:"
19364 #: ../inspector/virt-inspector.pod:224
19367 " <operatingsystems>\n"
19368 " <operatingsystem>\n"
19371 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19372 " <type>ext4</type>\n"
19373 " <label>Fedora-13-x86_64</label>\n"
19374 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19380 #: ../inspector/virt-inspector.pod:234
19382 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19383 "the label, and the UUID."
19387 #: ../inspector/virt-inspector.pod:237
19388 msgid "E<lt>applicationsE<gt>"
19392 #: ../inspector/virt-inspector.pod:239
19394 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19395 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19400 #: ../inspector/virt-inspector.pod:243
19402 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19403 "Typical values would be C<rpm> and C<deb>."
19407 #: ../inspector/virt-inspector.pod:246
19409 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19410 "Typical values include C<yum>, C<up2date> and C<apt>"
19414 #: ../inspector/virt-inspector.pod:249
19415 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19419 #: ../inspector/virt-inspector.pod:252
19422 " <operatingsystems>\n"
19423 " <operatingsystem>\n"
19425 " <applications>\n"
19427 " <name>coreutils</name>\n"
19428 " <version>8.5</version>\n"
19429 " <release>1</release>\n"
19430 " </application>\n"
19435 #: ../inspector/virt-inspector.pod:262
19437 "The version and release fields may not be available for some types guests. "
19438 "Other fields are possible, see "
19439 "L<guestfs(3)/guestfs_inspect_list_applications>."
19443 #: ../inspector/virt-inspector.pod:266
19444 msgid "E<lt>drive_mappingsE<gt>"
19448 #: ../inspector/virt-inspector.pod:268
19450 "For operating systems like Windows which use drive letters, virt-inspector "
19451 "is able to find out how drive letters map to filesystems."
19455 #: ../inspector/virt-inspector.pod:272
19458 " <operatingsystems>\n"
19459 " <operatingsystem>\n"
19461 " <drive_mappings>\n"
19462 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19463 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19464 " </drive_mappings>\n"
19469 #: ../inspector/virt-inspector.pod:280
19471 "In the example above, drive C maps to the filesystem on the second partition "
19472 "on the first disk, and drive E maps to the filesystem on the first partition "
19473 "on the second disk."
19477 #: ../inspector/virt-inspector.pod:284
19479 "Note that this only covers permanent local filesystem mappings, not things "
19480 "like network shares. Furthermore NTFS volume mount points may not be listed "
19485 #: ../inspector/virt-inspector.pod:288
19486 msgid "E<lt>iconE<gt>"
19490 #: ../inspector/virt-inspector.pod:290
19492 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19493 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19494 "very large and high quality."
19498 #: ../inspector/virt-inspector.pod:294
19501 " <operatingsystems>\n"
19502 " <operatingsystem>\n"
19505 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19506 " [... many lines of base64 data ...]\n"
19512 #: ../inspector/virt-inspector.pod:302
19514 "To display the icon, you have to extract it and convert the base64 data back "
19515 "to a binary file. Use an XPath query or simply an editor to extract the "
19516 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19521 #: ../inspector/virt-inspector.pod:307
19524 " base64 -i -d < icon.data > icon.png\n"
19529 #: ../inspector/virt-inspector.pod:309
19530 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19534 #: ../inspector/virt-inspector.pod:311
19536 "Virt-inspector can detect some operating system installers on install disks, "
19537 "live CDs, bootable USB keys and more."
19541 #: ../inspector/virt-inspector.pod:314
19543 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19544 "fields may be present to indicate a live CD, network installer, or one part "
19545 "of a multipart CD. For example:"
19549 #: ../inspector/virt-inspector.pod:318
19552 " <operatingsystems>\n"
19553 " <operatingsystem>\n"
19554 " <root>/dev/sda</root>\n"
19555 " <name>linux</name>\n"
19556 " <arch>i386</arch>\n"
19557 " <distro>ubuntu</distro>\n"
19558 " <product_name>Ubuntu 10.10 "Maverick "
19559 "Meerkat"</product_name>\n"
19560 " <major_version>10</major_version>\n"
19561 " <minor_version>10</minor_version>\n"
19562 " <format>installer</format>\n"
19568 #: ../inspector/virt-inspector.pod:330
19569 msgid "USING XPATH"
19573 #: ../inspector/virt-inspector.pod:332
19575 "You can use the XPath query language to select parts of the XML. We "
19576 "recommend using C<xmlstarlet> to perform XPath queries from the command "
19581 #: ../inspector/virt-inspector.pod:338
19584 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19586 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19587 " <type>ext4</type>\n"
19593 #: ../inspector/virt-inspector.pod:344
19596 " $ virt-inspector -d Guest | \\\n"
19597 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19603 #: ../inspector/virt-inspector.pod:348
19606 " $ virt-inspector -d Guest | \\\n"
19607 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19608 " [displays the guest icon, if there is one]\n"
19613 #: ../inspector/virt-inspector.pod:359
19614 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19618 #: ../inspector/virt-inspector.pod:361
19620 "Early versions of libguestfs shipped with a different virt-inspector program "
19621 "written in Perl (the current version is written in C). The XML output of "
19622 "the Perl virt-inspector was different and it could also output in other "
19623 "formats like text."
19627 #: ../inspector/virt-inspector.pod:366
19628 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19632 #: ../inspector/virt-inspector.pod:369
19634 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19635 "versions of virt-inspector with different names:"
19639 #: ../inspector/virt-inspector.pod:372
19642 " virt-inspector Old Perl version.\n"
19643 " virt-inspector2 New C version.\n"
19648 #: ../inspector/virt-inspector.pod:382
19650 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19651 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
19655 #: ../inspector/virt-inspector.pod:399
19656 msgid "Matthew Booth L<mbooth@redhat.com>"
19660 #: ../java/examples/guestfs-java.pod:5
19661 msgid "guestfs-java - How to use libguestfs from Java"
19665 #: ../java/examples/guestfs-java.pod:9
19668 " import com.redhat.et.libguestfs.*;\n"
19673 #: ../java/examples/guestfs-java.pod:11
19676 " GuestFS g = new GuestFS ();\n"
19677 " g.add_drive_opts (\"disk.img\", null);\n"
19683 #: ../java/examples/guestfs-java.pod:17
19685 "This manual page documents how to call libguestfs from the Java programming "
19686 "language. This page just documents the differences from the C API and gives "
19687 "some examples. If you are not familiar with using libguestfs, you also need "
19688 "to read L<guestfs(3)>."
19692 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19693 msgid "CLOSING THE HANDLE"
19697 #: ../java/examples/guestfs-java.pod:24
19699 "The handle is closed when it is reaped by the garbage collector. Because "
19700 "libguestfs handles include a lot of state, it is also possible to close (and "
19701 "hence free) them explicitly by calling the C<close> method."
19705 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19710 #: ../java/examples/guestfs-java.pod:31
19712 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19713 "exception. This has a single parameter which is the error message (a "
19718 #: ../java/examples/guestfs-java.pod:35
19719 msgid "Calling any method on a closed handle raises the same exception."
19723 #: ../java/examples/guestfs-java.pod:47
19725 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19726 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
19727 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
19728 "L<http://caml.inria.fr/>."
19732 #: ../ocaml/examples/guestfs-ocaml.pod:5
19733 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19737 #: ../ocaml/examples/guestfs-ocaml.pod:9
19738 msgid "Module style:"
19742 #: ../ocaml/examples/guestfs-ocaml.pod:11
19745 " let g = Guestfs.create () in\n"
19746 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19747 " Guestfs.launch g;\n"
19752 #: ../ocaml/examples/guestfs-ocaml.pod:15
19753 msgid "Object-oriented style:"
19757 #: ../ocaml/examples/guestfs-ocaml.pod:17
19760 " let g = new Guestfs.guestfs () in\n"
19761 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19767 #: ../ocaml/examples/guestfs-ocaml.pod:21
19770 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19772 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19777 #: ../ocaml/examples/guestfs-ocaml.pod:27
19779 "This manual page documents how to call libguestfs from the OCaml programming "
19780 "language. This page just documents the differences from the C API and gives "
19781 "some examples. If you are not familiar with using libguestfs, you also need "
19782 "to read L<guestfs(3)>."
19786 #: ../ocaml/examples/guestfs-ocaml.pod:32
19787 msgid "PROGRAMMING STYLES"
19791 #: ../ocaml/examples/guestfs-ocaml.pod:34
19793 "There are two different programming styles supported by the OCaml bindings. "
19794 "You can use a module style, with each C function mapped to an OCaml "
19799 #: ../ocaml/examples/guestfs-ocaml.pod:38
19802 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19807 #: ../ocaml/examples/guestfs-ocaml.pod:40
19812 #: ../ocaml/examples/guestfs-ocaml.pod:42
19815 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19820 #: ../ocaml/examples/guestfs-ocaml.pod:44
19822 "Alternately you can use an object-oriented style, calling methods on the "
19823 "class C<Guestfs.guestfs>:"
19827 #: ../ocaml/examples/guestfs-ocaml.pod:47
19830 " method set_verbose : bool -> unit\n"
19835 #: ../ocaml/examples/guestfs-ocaml.pod:49
19837 "The object-oriented style is usually briefer, and the minor performance "
19838 "penalty isn't noticable in the general overhead of performing libguestfs "
19843 #: ../ocaml/examples/guestfs-ocaml.pod:55
19845 "The handle is closed when it is reaped by the garbage collector. Because "
19846 "libguestfs handles include a lot of state, it is also possible to close (and "
19847 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19852 #: ../ocaml/examples/guestfs-ocaml.pod:62
19854 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19855 "exception. This has a single parameter which is the error message (a "
19860 #: ../ocaml/examples/guestfs-ocaml.pod:66
19862 "Calling any function/method on a closed handle raises "
19863 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
19868 #: ../ocaml/examples/guestfs-ocaml.pod:80
19870 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19871 "L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
19872 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
19873 "L<http://caml.inria.fr/>."
19877 #: ../perl/examples/guestfs-perl.pod:5
19878 msgid "guestfs-perl - How to use libguestfs from Perl"
19882 #: ../perl/examples/guestfs-perl.pod:9
19885 " use Sys::Guestfs;\n"
19890 #: ../perl/examples/guestfs-perl.pod:11
19893 " my $h = Sys::Guestfs->new ();\n"
19894 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
19895 " $h->launch ();\n"
19896 " $h->mount_options ('', '/dev/sda1', '/');\n"
19897 " $h->touch ('/hello');\n"
19903 #: ../perl/examples/guestfs-perl.pod:20
19905 "This manual page documents how to call libguestfs from the Perl programming "
19906 "language. This page just documents the differences from the C API and gives "
19907 "some examples. If you are not familiar with using libguestfs, you also need "
19908 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
19912 #: ../perl/examples/guestfs-perl.pod:26
19917 #: ../perl/examples/guestfs-perl.pod:28
19919 "Errors from libguestfs functions turn into calls to C<croak> (see "
19924 #: ../perl/examples/guestfs-perl.pod:41
19926 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
19927 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
19928 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
19929 "L<http://libguestfs.org/>."
19933 #: ../python/examples/guestfs-python.pod:5
19934 msgid "guestfs-python - How to use libguestfs from Python"
19938 #: ../python/examples/guestfs-python.pod:9
19941 " import guestfs\n"
19942 " g = guestfs.GuestFS ()\n"
19943 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
19949 #: ../python/examples/guestfs-python.pod:16
19951 "This manual page documents how to call libguestfs from the Python "
19952 "programming language. This page just documents the differences from the C "
19953 "API and gives some examples. If you are not familiar with using libguestfs, "
19954 "you also need to read L<guestfs(3)>."
19958 #: ../python/examples/guestfs-python.pod:23
19960 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
19961 "single string argument which is the error message."
19965 #: ../python/examples/guestfs-python.pod:26
19966 msgid "MORE DOCUMENTATION"
19970 #: ../python/examples/guestfs-python.pod:28
19975 #: ../python/examples/guestfs-python.pod:30
19979 " >>> import guestfs\n"
19980 " >>> help (guestfs)\n"
19985 #: ../python/examples/guestfs-python.pod:44
19987 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19988 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
19989 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19993 #: ../rescue/virt-rescue.pod:5
19994 msgid "virt-rescue - Run a rescue shell on a virtual machine"
19998 #: ../rescue/virt-rescue.pod:9
20001 " virt-rescue [--options] -d domname\n"
20006 #: ../rescue/virt-rescue.pod:11
20009 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20014 #: ../rescue/virt-rescue.pod:15
20017 " virt-rescue [--options] domname\n"
20022 #: ../rescue/virt-rescue.pod:17
20025 " virt-rescue [--options] disk.img [disk.img ...]\n"
20030 #: ../rescue/virt-rescue.pod:21
20032 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20033 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20034 "you from doing this, but doesn't catch all cases."
20038 #: ../rescue/virt-rescue.pod:25
20040 "However if you use the I<--ro> (read only) option, then you can attach a "
20041 "shell to a live virtual machine. The results might be strange or "
20042 "inconsistent at times but you won't get disk corruption."
20046 #: ../rescue/virt-rescue.pod:31
20048 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20049 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20050 "recovery tools which you can use to examine or rescue a virtual machine or "
20055 #: ../rescue/virt-rescue.pod:36
20057 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20058 "on disk image(s):"
20062 #: ../rescue/virt-rescue.pod:39
20065 " virt-rescue -d GuestName\n"
20070 #: ../rescue/virt-rescue.pod:41
20073 " virt-rescue --ro -a /path/to/disk.img\n"
20078 #: ../rescue/virt-rescue.pod:43
20081 " virt-rescue -a /dev/sdc\n"
20086 #: ../rescue/virt-rescue.pod:45
20087 msgid "For live VMs you I<must> use the --ro option."
20091 #: ../rescue/virt-rescue.pod:47
20093 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20094 "in an interactive bash shell where you can use many ordinary Linux "
20095 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20096 "appliance. You must mount the virtual machine's filesystems by hand. There "
20097 "is an empty directory called C</sysroot> where you can mount filesystems."
20101 #: ../rescue/virt-rescue.pod:54
20103 "In the example below, we list logical volumes, then choose one to mount "
20104 "under C</sysroot>:"
20108 #: ../rescue/virt-rescue.pod:57
20112 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20113 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20114 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20115 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20116 " ><rescue> ls /sysroot\n"
20121 #: ../rescue/virt-rescue.pod:64
20123 "If you don't know what filesystems are available on the virtual machine then "
20124 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20128 #: ../rescue/virt-rescue.pod:70
20130 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20131 "virtual machine. For example you can use it on a blank file if you want to "
20132 "partition that file (although we would recommend using L<guestfish(1)> "
20133 "instead as it is more suitable for this purpose). You can even use "
20134 "virt-rescue on things like SD cards."
20138 #: ../rescue/virt-rescue.pod:76
20140 "Virt-rescue does not require root. You only need to run it as root if you "
20141 "need root to open the disk image."
20145 #: ../rescue/virt-rescue.pod:79
20147 "This tool is just designed for quick interactive hacking on a virtual "
20148 "machine. For more structured access to a virtual machine disk image, you "
20149 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20150 "make scripted changes to guests, use L<guestfish(1)>."
20154 #: ../rescue/virt-rescue.pod:103
20155 msgid "B<--append kernelopts>"
20159 #: ../rescue/virt-rescue.pod:105
20160 msgid "Pass additional options to the rescue kernel."
20164 #: ../rescue/virt-rescue.pod:135
20167 " virt-rescue --format=raw -a disk.img\n"
20172 #: ../rescue/virt-rescue.pod:139
20175 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20180 #: ../rescue/virt-rescue.pod:148
20185 #: ../rescue/virt-rescue.pod:150
20186 msgid "B<--memsize MB>"
20190 #: ../rescue/virt-rescue.pod:152
20192 "Change the amount of memory allocated to the rescue system. The default is "
20193 "set by libguestfs and is small but adequate for running system tools. The "
20194 "occasional program might need more memory. The parameter is specified in "
20199 #: ../rescue/virt-rescue.pod:157
20200 msgid "B<--network>"
20204 #: ../rescue/virt-rescue.pod:159
20205 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20209 #: ../rescue/virt-rescue.pod:165
20210 msgid "Open the image read-only."
20214 #: ../rescue/virt-rescue.pod:175
20216 "Enable SELinux in the rescue appliance. You should read "
20217 "L<guestfs(3)/SELINUX> before using this option."
20221 #: ../rescue/virt-rescue.pod:194
20223 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20224 "are done read-write."
20228 #: ../rescue/virt-rescue.pod:207
20229 msgid "Previous versions of virt-rescue allowed you to write either:"
20233 #: ../rescue/virt-rescue.pod:209
20236 " virt-rescue disk.img [disk.img ...]\n"
20241 #: ../rescue/virt-rescue.pod:213
20244 " virt-rescue guestname\n"
20249 #: ../rescue/virt-rescue.pod:221
20254 #: ../rescue/virt-rescue.pod:223
20256 "Adding the I<--network> option enables QEMU user networking in the rescue "
20257 "appliance. There are some differences between user networking and ordinary "
20262 #: ../rescue/virt-rescue.pod:229
20263 msgid "ping does not work"
20267 #: ../rescue/virt-rescue.pod:231
20269 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20270 "send the ping packets, and because virt-rescue must be able to run as "
20271 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
20272 "command. The ping command will appear to resolve addresses but will not be "
20273 "able to send or receive any packets. This does not mean that the network is "
20278 #: ../rescue/virt-rescue.pod:238
20279 msgid "cannot receive connections"
20283 #: ../rescue/virt-rescue.pod:240
20284 msgid "QEMU user networking cannot receive incoming connections."
20288 #: ../rescue/virt-rescue.pod:242
20289 msgid "making TCP connections"
20293 #: ../rescue/virt-rescue.pod:244
20295 "The virt-rescue appliance needs to be small and so does not include many "
20296 "network tools. In particular there is no L<telnet(1)> command. You can "
20297 "make TCP connections from the shell using the magical "
20298 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20302 #: ../rescue/virt-rescue.pod:249
20305 " exec 3<>/dev/tcp/redhat.com/80\n"
20306 " echo \"GET /\" >&3\n"
20312 #: ../rescue/virt-rescue.pod:253
20313 msgid "See L<bash(1)> for more details."
20317 #: ../rescue/virt-rescue.pod:259
20319 "Several environment variables affect virt-rescue. See "
20320 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
20324 #: ../rescue/virt-rescue.pod:286
20326 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20327 "L<http://libguestfs.org/>."
20331 #: ../resize/virt-resize.pod:5
20332 msgid "virt-resize - Resize a virtual machine disk"
20336 #: ../resize/virt-resize.pod:9
20339 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20340 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20341 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20346 #: ../resize/virt-resize.pod:15
20348 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20349 "larger or smaller overall, and resizing or deleting any partitions contained "
20354 #: ../resize/virt-resize.pod:19
20356 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20357 "not> be used on live virtual machines - for consistent results, shut the "
20358 "virtual machine down before resizing it."
20362 #: ../resize/virt-resize.pod:23
20364 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20365 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20369 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:520 ../src/guestfs.pod:469 ../src/guestfs.pod:1261 ../src/guestfs.pod:1400 ../src/guestfs.pod:2578
20374 #: ../resize/virt-resize.pod:33
20376 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20377 "fill the extra 5GB of space."
20381 #: ../resize/virt-resize.pod:36
20384 " virt-filesystems --long -h --all -a olddisk\n"
20389 #: ../resize/virt-resize.pod:38
20392 " truncate -r olddisk newdisk\n"
20393 " truncate -s +5G newdisk\n"
20398 #: ../resize/virt-resize.pod:41
20401 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20402 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20407 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:527 ../src/guestfs.pod:475 ../src/guestfs.pod:1265 ../src/guestfs.pod:1404 ../src/guestfs.pod:2603
20412 #: ../resize/virt-resize.pod:46
20414 "As above, but make the /boot partition 200MB bigger, while giving the "
20415 "remaining space to /dev/sda2:"
20419 #: ../resize/virt-resize.pod:49
20422 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20423 " olddisk newdisk\n"
20428 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:533 ../src/guestfs.pod:486 ../src/guestfs.pod:1410
20433 #: ../resize/virt-resize.pod:54
20435 "As in the first example, but expand a logical volume as the final step. "
20436 "This is what you would typically use for Linux guests that use LVM:"
20440 #: ../resize/virt-resize.pod:58
20443 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20444 " olddisk newdisk\n"
20449 #: ../resize/virt-resize.pod:61
20454 #: ../resize/virt-resize.pod:63
20456 "As in the first example, but the output format will be qcow2 instead of a "
20461 #: ../resize/virt-resize.pod:66
20464 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20465 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20470 #: ../resize/virt-resize.pod:71
20471 msgid "DETAILED USAGE"
20475 #: ../resize/virt-resize.pod:73
20476 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20480 #: ../resize/virt-resize.pod:77
20481 msgid "1. Shut down the virtual machine"
20485 #: ../resize/virt-resize.pod:79
20486 msgid "2. Locate input disk image"
20490 #: ../resize/virt-resize.pod:81
20492 "Locate the input disk image (ie. the file or device on the host containing "
20493 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20494 "dumpxml> like this to find the disk image name:"
20498 #: ../resize/virt-resize.pod:85
20501 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20502 " Found 1 nodes:\n"
20504 " <source dev=\"/dev/vg/lv_guest\" />\n"
20509 #: ../resize/virt-resize.pod:90
20510 msgid "3. Look at current sizing"
20514 #: ../resize/virt-resize.pod:92
20515 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20519 #: ../resize/virt-resize.pod:95
20522 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20523 " Name Type Size Parent\n"
20524 " /dev/sda1 partition 101M /dev/sda\n"
20525 " /dev/sda2 partition 7.9G /dev/sda\n"
20526 " /dev/sda device 8.0G -\n"
20531 #: ../resize/virt-resize.pod:101
20533 "(This example is a virtual machine with an 8 GB disk which we would like to "
20534 "expand up to 10 GB)."
20538 #: ../resize/virt-resize.pod:104
20539 msgid "4. Create output disk"
20543 #: ../resize/virt-resize.pod:106
20545 "Virt-resize cannot do in-place disk modifications. You have to have space "
20546 "to store the resized output disk."
20550 #: ../resize/virt-resize.pod:109
20551 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20555 #: ../resize/virt-resize.pod:112
20558 " # rm -f outdisk\n"
20559 " # truncate -s 10G outdisk\n"
20564 #: ../resize/virt-resize.pod:115
20565 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20569 #: ../resize/virt-resize.pod:117
20572 " # lvcreate -L 10G -n lv_name vg_name\n"
20577 #: ../resize/virt-resize.pod:119
20578 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20582 #: ../resize/virt-resize.pod:121
20585 " # virsh pool-list\n"
20586 " # virsh vol-create-as poolname newvol 10G\n"
20591 #: ../resize/virt-resize.pod:124
20596 #: ../resize/virt-resize.pod:126
20598 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20599 "file) and the output disk. The output disk is the one created in the "
20604 #: ../resize/virt-resize.pod:130
20607 " # virt-resize indisk outdisk\n"
20612 #: ../resize/virt-resize.pod:132
20614 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20615 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20616 "larger, then an extra, empty partition is created at the end of the disk "
20617 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20622 #: ../resize/virt-resize.pod:138
20624 "More realistically you'd want to expand existing partitions in the disk "
20625 "image by passing extra options (for the full list see the L</OPTIONS> "
20630 #: ../resize/virt-resize.pod:142
20632 "L</--expand> is the most useful option. It expands the named partition "
20633 "within the disk to fill any extra space:"
20637 #: ../resize/virt-resize.pod:145
20640 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20645 #: ../resize/virt-resize.pod:147
20647 "(In this case, an extra partition is I<not> created at the end of the disk, "
20648 "because there will be no unused space)."
20652 #: ../resize/virt-resize.pod:150
20654 "L</--resize> is the other commonly used option. The following would "
20655 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20656 "rest of the available space:"
20660 #: ../resize/virt-resize.pod:154
20663 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20664 " indisk outdisk\n"
20669 #: ../resize/virt-resize.pod:157
20671 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20672 "if virt-resize knows how, it will resize the contents, the equivalent of "
20673 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20674 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20675 "filesystems, so you would have to online resize them after booting the "
20680 #: ../resize/virt-resize.pod:164
20681 msgid "Other options are covered below."
20685 #: ../resize/virt-resize.pod:166
20690 #: ../resize/virt-resize.pod:168
20691 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20695 #: ../resize/virt-resize.pod:170
20696 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20700 #: ../resize/virt-resize.pod:172
20703 " # virsh edit guestname\n"
20708 #: ../resize/virt-resize.pod:174
20710 "Change E<lt>source ...E<gt>, see "
20711 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20715 #: ../resize/virt-resize.pod:177
20716 msgid "Then start up the domain with the new, resized disk:"
20720 #: ../resize/virt-resize.pod:179
20723 " # virsh start guestname\n"
20728 #: ../resize/virt-resize.pod:181
20730 "and check that it still works. See also the L</NOTES> section below for "
20731 "additional information."
20735 #: ../resize/virt-resize.pod:184
20736 msgid "7. Resize LVs etc inside the guest"
20740 #: ../resize/virt-resize.pod:186
20741 msgid "(This can also be done offline using L<guestfish(1)>)"
20745 #: ../resize/virt-resize.pod:188
20747 "Once the guest has booted you should see the new space available, at least "
20748 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20749 "may need to resize LVs inside PVs, and also resize filesystem types that "
20750 "virt-resize does not know how to expand."
20754 #: ../resize/virt-resize.pod:195
20755 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20759 #: ../resize/virt-resize.pod:197
20761 "Shrinking is somewhat more complex than expanding, and only an overview is "
20766 #: ../resize/virt-resize.pod:200
20768 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20769 "filesystems). The user has to shrink content before passing the disk image "
20770 "to virt-resize, and virt-resize will check that the content has been shrunk "
20775 #: ../resize/virt-resize.pod:205
20776 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20780 #: ../resize/virt-resize.pod:207
20782 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20783 "steps 3 and 4 above to allocate a new disk image."
20787 #: ../resize/virt-resize.pod:210
20788 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20792 #: ../resize/virt-resize.pod:213
20793 msgid "IGNORING OR DELETING PARTITIONS"
20797 #: ../resize/virt-resize.pod:215
20799 "virt-resize also gives a convenient way to ignore or delete partitions when "
20800 "copying from the input disk to the output disk. Ignoring a partition speeds "
20801 "up the copy where you don't care about the existing contents of a "
20802 "partition. Deleting a partition removes it completely, but note that it "
20803 "also renumbers any partitions after the one which is deleted, which can "
20804 "leave some guests unbootable."
20808 #: ../resize/virt-resize.pod:222
20809 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20813 #: ../resize/virt-resize.pod:224
20815 "If the input disk is in qcow2 format, then you may prefer that the output is "
20816 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
20817 "the fly. The output format is simply determined by the format of the empty "
20818 "output container that you provide. Thus to create qcow2 output, use:"
20822 #: ../resize/virt-resize.pod:230
20825 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20830 #: ../resize/virt-resize.pod:232
20831 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20835 #: ../resize/virt-resize.pod:234
20836 msgid "Similarly, to get non-sparse raw output use:"
20840 #: ../resize/virt-resize.pod:236
20843 " fallocate -l size outdisk\n"
20848 #: ../resize/virt-resize.pod:238
20850 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20851 "if=/dev/zero of=outdisk bs=1M count=..>)"
20855 #: ../resize/virt-resize.pod:247
20856 msgid "Display help."
20860 #: ../resize/virt-resize.pod:249
20865 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20870 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20871 msgid "Enable debugging messages."
20875 #: ../resize/virt-resize.pod:255
20876 msgid "B<--delete part>"
20880 #: ../resize/virt-resize.pod:257
20882 "Delete the named partition. It would be more accurate to describe this as "
20883 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
20884 "the original disk image is left intact."
20888 #: ../resize/virt-resize.pod:261
20890 "Note that when you delete a partition, then anything contained in the "
20891 "partition is also deleted. Furthermore, this causes any partitions that "
20892 "come after to be I<renumbered>, which can easily make your guest unbootable."
20896 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:454
20897 msgid "You can give this option multiple times."
20901 #: ../resize/virt-resize.pod:268
20902 msgid "B<--expand part>"
20906 #: ../resize/virt-resize.pod:270
20908 "Expand the named partition so it uses up all extra space (space left over "
20909 "after any other resize changes that you request have been done)."
20913 #: ../resize/virt-resize.pod:273
20915 "If virt-resize knows how, it will expand the direct content of the "
20916 "partition. For example, if the partition is an LVM PV, it will expand the "
20917 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
20918 "content it doesn't know about alone."
20922 #: ../resize/virt-resize.pod:278
20923 msgid "Currently virt-resize can resize:"
20927 #: ../resize/virt-resize.pod:284
20928 msgid "ext2, ext3 and ext4 filesystems."
20932 #: ../resize/virt-resize.pod:288
20933 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
20937 #: ../resize/virt-resize.pod:290
20939 "The filesystem must have been shut down consistently last time it was used. "
20940 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
20941 "consistency check, so at the first boot after resizing Windows will check "
20946 #: ../resize/virt-resize.pod:297
20948 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
20949 "inside the PV, but see the I<--LV-expand> option. The user could also "
20950 "resize LVs as desired after boot."
20954 #: ../resize/virt-resize.pod:303
20955 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
20959 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
20960 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
20964 #: ../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
20965 msgid "B<--format> raw"
20969 #: ../resize/virt-resize.pod:311
20971 "Specify the format of the input disk image. If this flag is not given then "
20972 "it is auto-detected from the image itself."
20976 #: ../resize/virt-resize.pod:317
20978 "Note that this option I<does not> affect the output format. See L</QCOW2 "
20979 "AND NON-SPARSE RAW FORMATS>."
20983 #: ../resize/virt-resize.pod:320
20984 msgid "B<--ignore part>"
20988 #: ../resize/virt-resize.pod:322
20990 "Ignore the named partition. Effectively this means the partition is "
20991 "allocated on the destination disk, but the content is not copied across from "
20992 "the source disk. The content of the partition will be blank (all zero "
20997 #: ../resize/virt-resize.pod:329
20998 msgid "B<--LV-expand logvol>"
21002 #: ../resize/virt-resize.pod:331
21004 "This takes the logical volume and, as a final step, expands it to fill all "
21005 "the space available in its volume group. A typical usage, assuming a Linux "
21006 "guest with a single PV C</dev/sda2> and a root device called "
21007 "C</dev/vg_guest/lv_root> would be:"
21011 #: ../resize/virt-resize.pod:336
21014 " virt-resize indisk outdisk \\\n"
21015 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21020 #: ../resize/virt-resize.pod:339
21022 "This would first expand the partition (and PV), and then expand the root "
21023 "device to fill the extra space in the PV."
21027 #: ../resize/virt-resize.pod:342
21029 "The contents of the LV are also resized if virt-resize knows how to do "
21030 "that. You can stop virt-resize from trying to expand the content by using "
21031 "the option I<--no-expand-content>."
21035 #: ../resize/virt-resize.pod:346
21036 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21040 #: ../resize/virt-resize.pod:348
21042 "You can give this option multiple times, I<but> it doesn't make sense to do "
21043 "this unless the logical volumes you specify are all in different volume "
21048 #: ../resize/virt-resize.pod:352
21049 msgid "B<--machine-readable>"
21053 #: ../resize/virt-resize.pod:354
21055 "This option is used to make the output more machine friendly when being "
21056 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
21060 #: ../resize/virt-resize.pod:360
21061 msgid "B<--dryrun>"
21065 #: ../resize/virt-resize.pod:362
21066 msgid "Print a summary of what would be done, but don't do anything."
21070 #: ../resize/virt-resize.pod:364
21071 msgid "B<--no-copy-boot-loader>"
21075 #: ../resize/virt-resize.pod:366
21077 "By default, virt-resize copies over some sectors at the start of the disk "
21078 "(up to the beginning of the first partition). Commonly these sectors "
21079 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21080 "in order for the guest to boot correctly."
21084 #: ../resize/virt-resize.pod:371
21086 "If you specify this flag, then this initial copy is not done. You may need "
21087 "to reinstall the boot loader in this case."
21091 #: ../resize/virt-resize.pod:374
21092 msgid "B<--no-extra-partition>"
21096 #: ../resize/virt-resize.pod:376
21098 "By default, virt-resize creates an extra partition if there is any extra, "
21099 "unused space after all resizing has happened. Use this option to prevent "
21100 "the extra partition from being created. If you do this then the extra space "
21101 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21102 "tool in the guest."
21106 #: ../resize/virt-resize.pod:382
21108 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21113 #: ../resize/virt-resize.pod:385
21114 msgid "B<--no-expand-content>"
21118 #: ../resize/virt-resize.pod:387
21120 "By default, virt-resize will try to expand the direct contents of "
21121 "partitions, if it knows how (see I<--expand> option above)."
21125 #: ../resize/virt-resize.pod:390
21127 "If you give the I<--no-expand-content> option then virt-resize will not "
21132 #: ../resize/virt-resize.pod:393
21133 msgid "B<--ntfsresize-force>"
21137 #: ../resize/virt-resize.pod:395
21139 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21140 "the NTFS disk is marked as needing a consistency check. You have to use "
21141 "this option if you want to resize a Windows guest multiple times without "
21142 "booting into Windows between each resize."
21146 #: ../resize/virt-resize.pod:401
21147 msgid "B<--output-format> raw"
21151 #: ../resize/virt-resize.pod:403
21153 "Specify the format of the output disk image. If this flag is not given then "
21154 "it is auto-detected from the image itself."
21158 #: ../resize/virt-resize.pod:409
21160 "Note that this option I<does not create> the output format. This option "
21161 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21162 "need to create the output disk with the right format. See L</QCOW2 AND "
21163 "NON-SPARSE RAW FORMATS>."
21167 #: ../resize/virt-resize.pod:414
21172 #: ../resize/virt-resize.pod:416
21177 #: ../resize/virt-resize.pod:418
21178 msgid "Don't print the summary."
21182 #: ../resize/virt-resize.pod:420
21183 msgid "B<--resize part=size>"
21187 #: ../resize/virt-resize.pod:422
21189 "Resize the named partition (expanding or shrinking it) so that it has the "
21194 #: ../resize/virt-resize.pod:425
21196 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21197 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21198 "size; or as a relative number or percentage. For example:"
21202 #: ../resize/virt-resize.pod:431
21205 " --resize /dev/sda2=10G\n"
21210 #: ../resize/virt-resize.pod:433
21213 " --resize /dev/sda4=90%\n"
21218 #: ../resize/virt-resize.pod:435
21221 " --resize /dev/sda2=+1G\n"
21226 #: ../resize/virt-resize.pod:437
21229 " --resize /dev/sda2=-200M\n"
21234 #: ../resize/virt-resize.pod:439
21237 " --resize /dev/sda1=+128K\n"
21242 #: ../resize/virt-resize.pod:441
21245 " --resize /dev/sda1=+10%\n"
21250 #: ../resize/virt-resize.pod:443
21253 " --resize /dev/sda1=-10%\n"
21258 #: ../resize/virt-resize.pod:445
21260 "You can increase the size of any partition. Virt-resize will expand the "
21261 "direct content of the partition if it knows how (see I<--expand> below)."
21265 #: ../resize/virt-resize.pod:449
21267 "You can only I<decrease> the size of partitions that contain filesystems or "
21268 "PVs which have already been shrunk. Virt-resize will check this has been "
21269 "done before proceeding, or else will print an error (see also "
21270 "I<--resize-force>)."
21274 #: ../resize/virt-resize.pod:456
21275 msgid "B<--resize-force part=size>"
21279 #: ../resize/virt-resize.pod:458
21281 "This is the same as I<--resize> except that it will let you decrease the "
21282 "size of any partition. Generally this means you will lose any data which "
21283 "was at the end of the partition you shrink, but you may not care about that "
21284 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21285 "as a swap partition)."
21289 #: ../resize/virt-resize.pod:464
21290 msgid "See also the I<--ignore> option."
21294 #: ../resize/virt-resize.pod:466
21295 msgid "B<--shrink part>"
21299 #: ../resize/virt-resize.pod:468
21301 "Shrink the named partition until the overall disk image fits in the "
21302 "destination. The named partition B<must> contain a filesystem or PV which "
21303 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21304 "online tools). Virt-resize will check this and give an error if it has not "
21309 #: ../resize/virt-resize.pod:474
21311 "The amount by which the overall disk must be shrunk (after carrying out all "
21312 "other operations requested by the user) is called the \"deficit\". For "
21313 "example, a straight copy (assume no other operations) from a 5GB disk image "
21314 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21315 "would give an error unless the user specified a partition to shrink and that "
21316 "partition had more than a gigabyte of free space."
21320 #: ../resize/virt-resize.pod:492
21321 msgid "MACHINE READABLE OUTPUT"
21325 #: ../resize/virt-resize.pod:494
21327 "The I<--machine-readable> option can be used to make the output more machine "
21328 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21333 #: ../resize/virt-resize.pod:498
21334 msgid "There are two ways to use this option."
21338 #: ../resize/virt-resize.pod:500
21340 "Firstly use the option on its own to query the capabilities of the "
21341 "virt-resize binary. Typical output looks like this:"
21345 #: ../resize/virt-resize.pod:503
21348 " $ virt-resize --machine-readable\n"
21350 " ntfsresize-force\n"
21358 #: ../resize/virt-resize.pod:510
21360 "A list of features is printed, one per line, and the program exits with "
21365 #: ../resize/virt-resize.pod:513
21367 "Secondly use the option in conjunction with other options to make the "
21368 "regular program output more machine friendly."
21372 #: ../resize/virt-resize.pod:516
21373 msgid "At the moment this means:"
21377 #: ../resize/virt-resize.pod:522
21379 "Progress bar messages can be parsed from stdout by looking for this regular "
21384 #: ../resize/virt-resize.pod:525
21387 " ^[0-9]+/[0-9]+$\n"
21392 #: ../resize/virt-resize.pod:529
21394 "The calling program should treat messages sent to stdout (except for "
21395 "progress bar messages) as status messages. They can be logged and/or "
21396 "displayed to the user."
21400 #: ../resize/virt-resize.pod:535
21402 "The calling program should treat messages sent to stderr as error messages. "
21403 "In addition, virt-resize exits with a non-zero status code if there was a "
21408 #: ../resize/virt-resize.pod:541
21410 "Versions of the program prior to 1.13.9 did not support the "
21411 "I<--machine-readable> option and will return an error."
21415 #: ../resize/virt-resize.pod:546
21416 msgid "\"Partition 1 does not end on cylinder boundary.\""
21420 #: ../resize/virt-resize.pod:548
21422 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21423 "means the partitions will not be aligned to the ancient CHS geometry. "
21424 "However CHS geometry is meaningless for disks manufactured since the early "
21425 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21426 "cylinders is not required by any modern operating system."
21430 #: ../resize/virt-resize.pod:555
21431 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21435 #: ../resize/virt-resize.pod:557
21437 "In Windows Vista and later versions, Microsoft switched to using a separate "
21438 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21439 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21440 "the boot partition. Doing so seems to break the guest completely. However "
21441 "expanding the second partition (ie. C: drive) should work."
21445 #: ../resize/virt-resize.pod:564
21447 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21448 "NTFS partitions have been expanded. This is just a safety check and (unless "
21449 "it find errors) is nothing to worry about."
21453 #: ../resize/virt-resize.pod:568
21454 msgid "GUEST BOOT STUCK AT \"GRUB\""
21458 #: ../resize/virt-resize.pod:570
21460 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21461 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21462 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21463 "although we think is to do with partition alignment."
21467 #: ../resize/virt-resize.pod:575
21470 " guestfish -i -a newdisk\n"
21471 " ><fs> cat /boot/grub/device.map\n"
21472 " # check the contents of this file are sensible or\n"
21473 " # edit the file if necessary\n"
21474 " ><fs> grub-install / /dev/vda\n"
21480 #: ../resize/virt-resize.pod:582
21482 "For more flexible guest reconfiguration, including if you need to specify "
21483 "other parameters to grub-install, use L<virt-rescue(1)>."
21487 #: ../resize/virt-resize.pod:585
21488 msgid "ALTERNATIVE TOOLS"
21492 #: ../resize/virt-resize.pod:587
21494 "There are several proprietary tools for resizing partitions. We won't "
21495 "mention any here."
21499 #: ../resize/virt-resize.pod:590
21501 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21502 "operations on disk images. They can resize and move partitions, but I don't "
21503 "think they can do anything with the contents, and they certainly don't "
21508 #: ../resize/virt-resize.pod:595
21510 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21511 "but at a much lower level. You will probably end up hand-calculating sector "
21512 "offsets, which is something that virt-resize was designed to avoid. If you "
21513 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21518 #: ../resize/virt-resize.pod:615
21520 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21521 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21522 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21523 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21524 "L<http://libguestfs.org/>."
21528 #: ../ruby/examples/guestfs-ruby.pod:5
21529 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21533 #: ../ruby/examples/guestfs-ruby.pod:9
21536 " require 'guestfs'\n"
21537 " g = Guestfs::Guestfs.new()\n"
21538 " g.add_drive_opts(\"disk.img\",\n"
21539 " :readonly => 1, :format => \"raw\")\n"
21545 #: ../ruby/examples/guestfs-ruby.pod:17
21547 "This manual page documents how to call libguestfs from the Ruby programming "
21548 "language. This page just documents the differences from the C API and gives "
21549 "some examples. If you are not familiar with using libguestfs, you also need "
21550 "to read L<guestfs(3)>."
21554 #: ../ruby/examples/guestfs-ruby.pod:24
21556 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21557 "This has a single parameter which is the error message (a string)."
21561 #: ../ruby/examples/guestfs-ruby.pod:38
21563 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21564 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
21565 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21569 #: ../src/guestfs-actions.pod:1
21570 msgid "guestfs_add_cdrom"
21574 #: ../src/guestfs-actions.pod:3
21578 " guestfs_add_cdrom (guestfs_h *g,\n"
21579 " const char *filename);\n"
21584 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270
21586 "I<This function is deprecated.> In new code, use the "
21587 "L</guestfs_add_drive_opts> call instead."
21591 #: ../src/guestfs-actions.pod:24
21593 "This call checks for the existence of C<filename>. This stops you from "
21594 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21595 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21600 #: ../src/guestfs-actions.pod:31
21602 "If you just want to add an ISO file (often you use this as an efficient way "
21603 "to transfer large files into the guest), then you should probably use "
21604 "C<guestfs_add_drive_ro> instead."
21608 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:280 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552 ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652 ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084 ../src/guestfs-actions.pod:1168 ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1219 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1407 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:2368 ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4045 ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4236 ../src/guestfs-actions.pod:4248 ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4313 ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4458 ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4522 ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4574 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:4634 ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4828 ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4908 ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4938 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5065 ../src/guestfs-actions.pod:5079 ../src/guestfs-actions.pod:5096 ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5570 ../src/guestfs-actions.pod:5588 ../src/guestfs-actions.pod:5620 ../src/guestfs-actions.pod:5686 ../src/guestfs-actions.pod:5703 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:6019 ../src/guestfs-actions.pod:6038 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6071 ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6123 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6179 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6246 ../src/guestfs-actions.pod:6269 ../src/guestfs-actions.pod:6287 ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6327 ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6363 ../src/guestfs-actions.pod:6382 ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6496 ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6530 ../src/guestfs-actions.pod:6574 ../src/guestfs-actions.pod:6604 ../src/guestfs-actions.pod:6637 ../src/guestfs-actions.pod:6752 ../src/guestfs-actions.pod:6873 ../src/guestfs-actions.pod:6885 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6911 ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6972 ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7046 ../src/guestfs-actions.pod:7063 ../src/guestfs-actions.pod:7079 ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7145 ../src/guestfs-actions.pod:7181 ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7236 ../src/guestfs-actions.pod:7249 ../src/guestfs-actions.pod:7267 ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7337 ../src/guestfs-actions.pod:7453 ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7482 ../src/guestfs-actions.pod:7537 ../src/guestfs-actions.pod:7550 ../src/guestfs-actions.pod:7595 ../src/guestfs-actions.pod:7635 ../src/guestfs-actions.pod:7691 ../src/guestfs-actions.pod:7711 ../src/guestfs-actions.pod:7744 ../src/guestfs-actions.pod:7808 ../src/guestfs-actions.pod:7831 ../src/guestfs-actions.pod:7860
21609 msgid "This function returns 0 on success or -1 on error."
21613 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1170 ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2197 ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7114 ../src/guestfs-actions.pod:7637
21614 msgid "(Added in 0.3)"
21618 #: ../src/guestfs-actions.pod:41
21619 msgid "guestfs_add_domain"
21623 #: ../src/guestfs-actions.pod:43
21627 " guestfs_add_domain (guestfs_h *g,\n"
21628 " const char *dom,\n"
21634 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2857 ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4992 ../src/guestfs-actions.pod:5209
21636 "You may supply a list of optional arguments to this call. Use zero or more "
21637 "of the following pairs of parameters, and terminate the list with C<-1> on "
21638 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21642 #: ../src/guestfs-actions.pod:53
21645 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21646 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21647 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21648 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21649 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21654 #: ../src/guestfs-actions.pod:59
21656 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21657 "It works by connecting to libvirt, requesting the domain and domain XML from "
21658 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21663 #: ../src/guestfs-actions.pod:94
21665 "The other optional parameters are passed directly through to "
21666 "C<guestfs_add_drive_opts>."
21670 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1385 ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:2499 ../src/guestfs-actions.pod:2975 ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:5168 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:5826 ../src/guestfs-actions.pod:7222 ../src/guestfs-actions.pod:7648 ../src/guestfs-actions.pod:7661 ../src/guestfs-actions.pod:7674
21671 msgid "On error this function returns -1."
21675 #: ../src/guestfs-actions.pod:99
21676 msgid "(Added in 1.7.4)"
21680 #: ../src/guestfs-actions.pod:101
21681 msgid "guestfs_add_domain_va"
21685 #: ../src/guestfs-actions.pod:103
21689 " guestfs_add_domain_va (guestfs_h *g,\n"
21690 " const char *dom,\n"
21691 " va_list args);\n"
21696 #: ../src/guestfs-actions.pod:108
21697 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21701 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:2941 ../src/guestfs-actions.pod:2953 ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5032 ../src/guestfs-actions.pod:5258 ../src/guestfs-actions.pod:5269
21702 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21706 #: ../src/guestfs-actions.pod:112
21707 msgid "guestfs_add_domain_argv"
21711 #: ../src/guestfs-actions.pod:114
21715 " guestfs_add_domain_argv (guestfs_h *g,\n"
21716 " const char *dom,\n"
21717 " const struct guestfs_add_domain_argv *optargs);\n"
21722 #: ../src/guestfs-actions.pod:119
21723 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21727 #: ../src/guestfs-actions.pod:123
21728 msgid "guestfs_add_drive"
21732 #: ../src/guestfs-actions.pod:125
21736 " guestfs_add_drive (guestfs_h *g,\n"
21737 " const char *filename);\n"
21742 #: ../src/guestfs-actions.pod:129
21744 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21745 "optional parameters, so the disk is added writable, with the format being "
21746 "detected automatically."
21750 #: ../src/guestfs-actions.pod:133
21752 "Automatic detection of the format opens you up to a potential security hole "
21753 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21754 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21755 "you should think about replacing calls to this function with calls to "
21756 "C<guestfs_add_drive_opts>, and specifying the format."
21760 #: ../src/guestfs-actions.pod:144
21761 msgid "guestfs_add_drive_opts"
21765 #: ../src/guestfs-actions.pod:146
21769 " guestfs_add_drive_opts (guestfs_h *g,\n"
21770 " const char *filename,\n"
21776 #: ../src/guestfs-actions.pod:156
21779 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21780 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21781 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21786 #: ../src/guestfs-actions.pod:185
21788 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
21789 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
21790 "Possible formats include C<raw> and C<qcow2>."
21794 #: ../src/guestfs-actions.pod:196
21796 "This rarely-used option lets you emulate the behaviour of the deprecated "
21797 "C<guestfs_add_drive_with_if> call (q.v.)"
21801 #: ../src/guestfs-actions.pod:203
21802 msgid "(Added in 1.5.23)"
21806 #: ../src/guestfs-actions.pod:205
21807 msgid "guestfs_add_drive_opts_va"
21811 #: ../src/guestfs-actions.pod:207
21815 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21816 " const char *filename,\n"
21817 " va_list args);\n"
21822 #: ../src/guestfs-actions.pod:212
21823 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21827 #: ../src/guestfs-actions.pod:216
21828 msgid "guestfs_add_drive_opts_argv"
21832 #: ../src/guestfs-actions.pod:218
21836 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21837 " const char *filename,\n"
21838 " const struct guestfs_add_drive_opts_argv "
21844 #: ../src/guestfs-actions.pod:223
21845 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21849 #: ../src/guestfs-actions.pod:227
21850 msgid "guestfs_add_drive_ro"
21854 #: ../src/guestfs-actions.pod:229
21858 " guestfs_add_drive_ro (guestfs_h *g,\n"
21859 " const char *filename);\n"
21864 #: ../src/guestfs-actions.pod:233
21866 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21867 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21868 "disk is added read-only, with the format being detected automatically."
21872 #: ../src/guestfs-actions.pod:240
21873 msgid "(Added in 1.0.38)"
21877 #: ../src/guestfs-actions.pod:242
21878 msgid "guestfs_add_drive_ro_with_if"
21882 #: ../src/guestfs-actions.pod:244
21886 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
21887 " const char *filename,\n"
21888 " const char *iface);\n"
21893 #: ../src/guestfs-actions.pod:256
21895 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
21896 "QEMU interface emulation to use at run time."
21900 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2458
21901 msgid "(Added in 1.0.84)"
21905 #: ../src/guestfs-actions.pod:263
21906 msgid "guestfs_add_drive_with_if"
21910 #: ../src/guestfs-actions.pod:265
21914 " guestfs_add_drive_with_if (guestfs_h *g,\n"
21915 " const char *filename,\n"
21916 " const char *iface);\n"
21921 #: ../src/guestfs-actions.pod:277
21923 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
21924 "QEMU interface emulation to use at run time."
21928 #: ../src/guestfs-actions.pod:284
21929 msgid "guestfs_aug_clear"
21933 #: ../src/guestfs-actions.pod:286
21937 " guestfs_aug_clear (guestfs_h *g,\n"
21938 " const char *augpath);\n"
21943 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
21944 msgid "(Added in 1.3.4)"
21948 #: ../src/guestfs-actions.pod:297
21949 msgid "guestfs_aug_close"
21953 #: ../src/guestfs-actions.pod:299
21957 " guestfs_aug_close (guestfs_h *g);\n"
21962 #: ../src/guestfs-actions.pod:302
21964 "Close the current Augeas handle and free up any resources used by it. After "
21965 "calling this, you have to call C<guestfs_aug_init> again before you can use "
21966 "any other Augeas functions."
21970 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494 ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522 ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554 ../src/guestfs-actions.pod:5877
21971 msgid "(Added in 0.7)"
21975 #: ../src/guestfs-actions.pod:311
21976 msgid "guestfs_aug_defnode"
21980 #: ../src/guestfs-actions.pod:313
21983 " struct guestfs_int_bool *\n"
21984 " guestfs_aug_defnode (guestfs_h *g,\n"
21985 " const char *name,\n"
21986 " const char *expr,\n"
21987 " const char *val);\n"
21992 #: ../src/guestfs-actions.pod:322
21994 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21995 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
21996 "containing that single node."
22000 #: ../src/guestfs-actions.pod:330
22002 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22003 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22007 #: ../src/guestfs-actions.pod:336
22008 msgid "guestfs_aug_defvar"
22012 #: ../src/guestfs-actions.pod:338
22016 " guestfs_aug_defvar (guestfs_h *g,\n"
22017 " const char *name,\n"
22018 " const char *expr);\n"
22023 #: ../src/guestfs-actions.pod:354
22024 msgid "guestfs_aug_get"
22028 #: ../src/guestfs-actions.pod:356
22032 " guestfs_aug_get (guestfs_h *g,\n"
22033 " const char *augpath);\n"
22038 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005 ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1254 ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:1290 ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1724 ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2035 ../src/guestfs-actions.pod:2209 ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3220 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3867 ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4500 ../src/guestfs-actions.pod:5406 ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:5953 ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6698 ../src/guestfs-actions.pod:6722 ../src/guestfs-actions.pod:7396 ../src/guestfs-actions.pod:7415 ../src/guestfs-actions.pod:7433 ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7924
22040 "This function returns a string, or NULL on error. I<The caller must free "
22041 "the returned string after use>."
22045 #: ../src/guestfs-actions.pod:368
22046 msgid "guestfs_aug_init"
22050 #: ../src/guestfs-actions.pod:370
22054 " guestfs_aug_init (guestfs_h *g,\n"
22055 " const char *root,\n"
22061 #: ../src/guestfs-actions.pod:379
22062 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22066 #: ../src/guestfs-actions.pod:404
22068 "This option is only useful when debugging Augeas lenses. Use of this option "
22069 "may require additional memory for the libguestfs appliance. You may need to "
22070 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22071 "C<guestfs_set_memsize>."
22075 #: ../src/guestfs-actions.pod:419
22076 msgid "Do not load the tree in C<guestfs_aug_init>."
22080 #: ../src/guestfs-actions.pod:423
22081 msgid "To close the handle, you can call C<guestfs_aug_close>."
22085 #: ../src/guestfs-actions.pod:431
22086 msgid "guestfs_aug_insert"
22090 #: ../src/guestfs-actions.pod:433
22094 " guestfs_aug_insert (guestfs_h *g,\n"
22095 " const char *augpath,\n"
22096 " const char *label,\n"
22102 #: ../src/guestfs-actions.pod:451
22103 msgid "guestfs_aug_load"
22107 #: ../src/guestfs-actions.pod:453
22111 " guestfs_aug_load (guestfs_h *g);\n"
22116 #: ../src/guestfs-actions.pod:465
22117 msgid "guestfs_aug_ls"
22121 #: ../src/guestfs-actions.pod:467
22125 " guestfs_aug_ls (guestfs_h *g,\n"
22126 " const char *augpath);\n"
22131 #: ../src/guestfs-actions.pod:471
22133 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22134 "sorting the resulting nodes into alphabetical order."
22138 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490 ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2525 ../src/guestfs-actions.pod:2786 ../src/guestfs-actions.pod:3160 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3954 ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5987 ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6799 ../src/guestfs-actions.pod:6854 ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7024 ../src/guestfs-actions.pod:7500 ../src/guestfs-actions.pod:7520 ../src/guestfs-actions.pod:7567 ../src/guestfs-actions.pod:7761 ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7874 ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7939 ../src/guestfs-actions.pod:7958
22140 "This function returns a NULL-terminated array of strings (like "
22141 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
22142 "strings and the array after use>."
22146 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4253 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:5133 ../src/guestfs-actions.pod:5688 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6579 ../src/guestfs-actions.pod:7238 ../src/guestfs-actions.pod:7251 ../src/guestfs-actions.pod:7484 ../src/guestfs-actions.pod:7749
22147 msgid "(Added in 0.8)"
22151 #: ../src/guestfs-actions.pod:480
22152 msgid "guestfs_aug_match"
22156 #: ../src/guestfs-actions.pod:482
22160 " guestfs_aug_match (guestfs_h *g,\n"
22161 " const char *augpath);\n"
22166 #: ../src/guestfs-actions.pod:496
22167 msgid "guestfs_aug_mv"
22171 #: ../src/guestfs-actions.pod:498
22175 " guestfs_aug_mv (guestfs_h *g,\n"
22176 " const char *src,\n"
22177 " const char *dest);\n"
22182 #: ../src/guestfs-actions.pod:510
22183 msgid "guestfs_aug_rm"
22187 #: ../src/guestfs-actions.pod:512
22191 " guestfs_aug_rm (guestfs_h *g,\n"
22192 " const char *augpath);\n"
22197 #: ../src/guestfs-actions.pod:524
22198 msgid "guestfs_aug_save"
22202 #: ../src/guestfs-actions.pod:526
22206 " guestfs_aug_save (guestfs_h *g);\n"
22211 #: ../src/guestfs-actions.pod:531
22213 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22218 #: ../src/guestfs-actions.pod:538
22219 msgid "guestfs_aug_set"
22223 #: ../src/guestfs-actions.pod:540
22227 " guestfs_aug_set (guestfs_h *g,\n"
22228 " const char *augpath,\n"
22229 " const char *val);\n"
22234 #: ../src/guestfs-actions.pod:547
22236 "In the Augeas API, it is possible to clear a node by setting the value to "
22237 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22238 "this call. Instead you must use the C<guestfs_aug_clear> call."
22242 #: ../src/guestfs-actions.pod:556
22243 msgid "guestfs_available"
22247 #: ../src/guestfs-actions.pod:558
22251 " guestfs_available (guestfs_h *g,\n"
22252 " char *const *groups);\n"
22257 #: ../src/guestfs-actions.pod:566
22259 "The libguestfs groups, and the functions that those groups correspond to, "
22260 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22261 "runtime by calling C<guestfs_available_all_groups>."
22265 #: ../src/guestfs-actions.pod:590
22266 msgid "You must call C<guestfs_launch> before calling this function."
22270 #: ../src/guestfs-actions.pod:612
22272 "This call was added in version C<1.0.80>. In previous versions of "
22273 "libguestfs all you could do would be to speculatively execute a command to "
22274 "find out if the daemon implemented it. See also C<guestfs_version>."
22278 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
22279 msgid "(Added in 1.0.80)"
22283 #: ../src/guestfs-actions.pod:623
22284 msgid "guestfs_available_all_groups"
22288 #: ../src/guestfs-actions.pod:625
22292 " guestfs_available_all_groups (guestfs_h *g);\n"
22297 #: ../src/guestfs-actions.pod:628
22299 "This command returns a list of all optional groups that this daemon knows "
22300 "about. Note this returns both supported and unsupported groups. To find "
22301 "out which ones the daemon can actually support you have to call "
22302 "C<guestfs_available> on each member of the returned list."
22306 #: ../src/guestfs-actions.pod:634
22307 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22311 #: ../src/guestfs-actions.pod:640
22312 msgid "(Added in 1.3.15)"
22316 #: ../src/guestfs-actions.pod:642
22317 msgid "guestfs_base64_in"
22321 #: ../src/guestfs-actions.pod:644
22325 " guestfs_base64_in (guestfs_h *g,\n"
22326 " const char *base64file,\n"
22327 " const char *filename);\n"
22332 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22333 msgid "(Added in 1.3.5)"
22337 #: ../src/guestfs-actions.pod:656
22338 msgid "guestfs_base64_out"
22342 #: ../src/guestfs-actions.pod:658
22346 " guestfs_base64_out (guestfs_h *g,\n"
22347 " const char *filename,\n"
22348 " const char *base64file);\n"
22353 #: ../src/guestfs-actions.pod:670
22354 msgid "guestfs_blockdev_flushbufs"
22358 #: ../src/guestfs-actions.pod:672
22362 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22363 " const char *device);\n"
22368 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
22369 msgid "(Added in 0.9.3)"
22373 #: ../src/guestfs-actions.pod:685
22374 msgid "guestfs_blockdev_getbsz"
22378 #: ../src/guestfs-actions.pod:687
22382 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22383 " const char *device);\n"
22388 #: ../src/guestfs-actions.pod:702
22389 msgid "guestfs_blockdev_getro"
22393 #: ../src/guestfs-actions.pod:704
22397 " guestfs_blockdev_getro (guestfs_h *g,\n"
22398 " const char *device);\n"
22403 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1479 ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2172 ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:3257 ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3599 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:5370
22404 msgid "This function returns a C truth value on success or -1 on error."
22408 #: ../src/guestfs-actions.pod:717
22409 msgid "guestfs_blockdev_getsize64"
22413 #: ../src/guestfs-actions.pod:719
22417 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22418 " const char *device);\n"
22423 #: ../src/guestfs-actions.pod:725
22424 msgid "See also C<guestfs_blockdev_getsz>."
22428 #: ../src/guestfs-actions.pod:733
22429 msgid "guestfs_blockdev_getss"
22433 #: ../src/guestfs-actions.pod:735
22437 " guestfs_blockdev_getss (guestfs_h *g,\n"
22438 " const char *device);\n"
22443 #: ../src/guestfs-actions.pod:742
22445 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22450 #: ../src/guestfs-actions.pod:751
22451 msgid "guestfs_blockdev_getsz"
22455 #: ../src/guestfs-actions.pod:753
22459 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22460 " const char *device);\n"
22465 #: ../src/guestfs-actions.pod:760
22467 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22468 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22472 #: ../src/guestfs-actions.pod:770
22473 msgid "guestfs_blockdev_rereadpt"
22477 #: ../src/guestfs-actions.pod:772
22481 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22482 " const char *device);\n"
22487 #: ../src/guestfs-actions.pod:784
22488 msgid "guestfs_blockdev_setbsz"
22492 #: ../src/guestfs-actions.pod:786
22496 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22497 " const char *device,\n"
22498 " int blocksize);\n"
22503 #: ../src/guestfs-actions.pod:802
22504 msgid "guestfs_blockdev_setro"
22508 #: ../src/guestfs-actions.pod:804
22512 " guestfs_blockdev_setro (guestfs_h *g,\n"
22513 " const char *device);\n"
22518 #: ../src/guestfs-actions.pod:816
22519 msgid "guestfs_blockdev_setrw"
22523 #: ../src/guestfs-actions.pod:818
22527 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22528 " const char *device);\n"
22533 #: ../src/guestfs-actions.pod:830
22534 msgid "guestfs_btrfs_filesystem_resize"
22538 #: ../src/guestfs-actions.pod:832
22542 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22543 " const char *mountpoint,\n"
22549 #: ../src/guestfs-actions.pod:842
22552 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22557 #: ../src/guestfs-actions.pod:865
22558 msgid "(Added in 1.11.17)"
22562 #: ../src/guestfs-actions.pod:867
22563 msgid "guestfs_btrfs_filesystem_resize_va"
22567 #: ../src/guestfs-actions.pod:869
22571 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22572 " const char *mountpoint,\n"
22573 " va_list args);\n"
22578 #: ../src/guestfs-actions.pod:874
22579 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22583 #: ../src/guestfs-actions.pod:878
22584 msgid "guestfs_btrfs_filesystem_resize_argv"
22588 #: ../src/guestfs-actions.pod:880
22592 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22593 " const char *mountpoint,\n"
22595 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22600 #: ../src/guestfs-actions.pod:885
22601 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22605 #: ../src/guestfs-actions.pod:889
22606 msgid "guestfs_case_sensitive_path"
22610 #: ../src/guestfs-actions.pod:891
22614 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22615 " const char *path);\n"
22620 #: ../src/guestfs-actions.pod:917
22622 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
22623 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22624 "how the directories were originally created under Windows)."
22628 #: ../src/guestfs-actions.pod:925
22629 msgid "See also C<guestfs_realpath>."
22633 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7418
22634 msgid "(Added in 1.0.75)"
22638 #: ../src/guestfs-actions.pod:932
22639 msgid "guestfs_cat"
22643 #: ../src/guestfs-actions.pod:934
22647 " guestfs_cat (guestfs_h *g,\n"
22648 " const char *path);\n"
22653 #: ../src/guestfs-actions.pod:940
22655 "Note that this function cannot correctly handle binary files (specifically, "
22656 "files containing C<\\0> character which is treated as end of string). For "
22657 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22658 "functions which have a more complex interface."
22662 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:4380 ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5765 ../src/guestfs-actions.pod:7571 ../src/guestfs-actions.pod:7585
22663 msgid "(Added in 0.4)"
22667 #: ../src/guestfs-actions.pod:953
22668 msgid "guestfs_checksum"
22672 #: ../src/guestfs-actions.pod:955
22676 " guestfs_checksum (guestfs_h *g,\n"
22677 " const char *csumtype,\n"
22678 " const char *path);\n"
22683 #: ../src/guestfs-actions.pod:1001
22684 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22688 #: ../src/guestfs-actions.pod:1003
22689 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22693 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316 ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3469 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3559 ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:7274
22694 msgid "(Added in 1.0.2)"
22698 #: ../src/guestfs-actions.pod:1010
22699 msgid "guestfs_checksum_device"
22703 #: ../src/guestfs-actions.pod:1012
22707 " guestfs_checksum_device (guestfs_h *g,\n"
22708 " const char *csumtype,\n"
22709 " const char *device);\n"
22714 #: ../src/guestfs-actions.pod:1017
22716 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22717 "device named C<device>. For the types of checksums supported see the "
22718 "C<guestfs_checksum> command."
22722 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5335 ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5572 ../src/guestfs-actions.pod:7183 ../src/guestfs-actions.pod:7197 ../src/guestfs-actions.pod:7597
22723 msgid "(Added in 1.3.2)"
22727 #: ../src/guestfs-actions.pod:1026
22728 msgid "guestfs_checksums_out"
22732 #: ../src/guestfs-actions.pod:1028
22736 " guestfs_checksums_out (guestfs_h *g,\n"
22737 " const char *csumtype,\n"
22738 " const char *directory,\n"
22739 " const char *sumsfile);\n"
22744 #: ../src/guestfs-actions.pod:1048
22745 msgid "(Added in 1.3.7)"
22749 #: ../src/guestfs-actions.pod:1050
22750 msgid "guestfs_chmod"
22754 #: ../src/guestfs-actions.pod:1052
22758 " guestfs_chmod (guestfs_h *g,\n"
22760 " const char *path);\n"
22765 #: ../src/guestfs-actions.pod:1070
22766 msgid "guestfs_chown"
22770 #: ../src/guestfs-actions.pod:1072
22774 " guestfs_chown (guestfs_h *g,\n"
22777 " const char *path);\n"
22782 #: ../src/guestfs-actions.pod:1088
22783 msgid "guestfs_command"
22787 #: ../src/guestfs-actions.pod:1090
22791 " guestfs_command (guestfs_h *g,\n"
22792 " char *const *arguments);\n"
22797 #: ../src/guestfs-actions.pod:1099
22799 "The single parameter is an argv-style list of arguments. The first element "
22800 "is the name of the program to run. Subsequent elements are parameters. The "
22801 "list must be non-empty (ie. must contain a program name). Note that the "
22802 "command runs directly, and is I<not> invoked via the shell (see "
22807 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1615
22808 msgid "(Added in 0.9.1)"
22812 #: ../src/guestfs-actions.pod:1132
22813 msgid "guestfs_command_lines"
22817 #: ../src/guestfs-actions.pod:1134
22821 " guestfs_command_lines (guestfs_h *g,\n"
22822 " char *const *arguments);\n"
22827 #: ../src/guestfs-actions.pod:1138
22829 "This is the same as C<guestfs_command>, but splits the result into a list of "
22834 #: ../src/guestfs-actions.pod:1141
22835 msgid "See also: C<guestfs_sh_lines>"
22839 #: ../src/guestfs-actions.pod:1152
22840 msgid "guestfs_config"
22844 #: ../src/guestfs-actions.pod:1154
22848 " guestfs_config (guestfs_h *g,\n"
22849 " const char *qemuparam,\n"
22850 " const char *qemuvalue);\n"
22855 #: ../src/guestfs-actions.pod:1172
22856 msgid "guestfs_copy_size"
22860 #: ../src/guestfs-actions.pod:1174
22864 " guestfs_copy_size (guestfs_h *g,\n"
22865 " const char *src,\n"
22866 " const char *dest,\n"
22867 " int64_t size);\n"
22872 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1764 ../src/guestfs-actions.pod:1786 ../src/guestfs-actions.pod:3669 ../src/guestfs-actions.pod:7269 ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7810 ../src/guestfs-actions.pod:7833
22874 "This long-running command can generate progress notification messages so "
22875 "that the caller can display a progress bar or indicator. To receive these "
22876 "messages, the caller must register a progress event callback. See "
22877 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
22881 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4393 ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:7504 ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7610
22882 msgid "(Added in 1.0.87)"
22886 #: ../src/guestfs-actions.pod:1195
22891 #: ../src/guestfs-actions.pod:1197
22895 " guestfs_cp (guestfs_h *g,\n"
22896 " const char *src,\n"
22897 " const char *dest);\n"
22902 #: ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1221 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1367 ../src/guestfs-actions.pod:1481 ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5622
22903 msgid "(Added in 1.0.18)"
22907 #: ../src/guestfs-actions.pod:1209
22908 msgid "guestfs_cp_a"
22912 #: ../src/guestfs-actions.pod:1211
22916 " guestfs_cp_a (guestfs_h *g,\n"
22917 " const char *src,\n"
22918 " const char *dest);\n"
22923 #: ../src/guestfs-actions.pod:1223
22928 #: ../src/guestfs-actions.pod:1225
22932 " guestfs_dd (guestfs_h *g,\n"
22933 " const char *src,\n"
22934 " const char *dest);\n"
22939 #: ../src/guestfs-actions.pod:1235
22941 "If the destination is a device, it must be as large or larger than the "
22942 "source file or device, otherwise the copy will fail. This command cannot do "
22943 "partial copies (see C<guestfs_copy_size>)."
22947 #: ../src/guestfs-actions.pod:1243
22952 #: ../src/guestfs-actions.pod:1245
22956 " guestfs_df (guestfs_h *g);\n"
22961 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
22963 "This command is mostly useful for interactive sessions. It is I<not> "
22964 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
22969 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274 ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2388 ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7663 ../src/guestfs-actions.pod:7676
22970 msgid "(Added in 1.0.54)"
22974 #: ../src/guestfs-actions.pod:1259
22975 msgid "guestfs_df_h"
22979 #: ../src/guestfs-actions.pod:1261
22983 " guestfs_df_h (guestfs_h *g);\n"
22988 #: ../src/guestfs-actions.pod:1276
22989 msgid "guestfs_dmesg"
22993 #: ../src/guestfs-actions.pod:1278
22997 " guestfs_dmesg (guestfs_h *g);\n"
23002 #: ../src/guestfs-actions.pod:1285
23004 "Another way to get the same information is to enable verbose messages with "
23005 "C<guestfs_set_verbose> or by setting the environment variable "
23006 "C<LIBGUESTFS_DEBUG=1> before running the program."
23010 #: ../src/guestfs-actions.pod:1295
23011 msgid "guestfs_download"
23015 #: ../src/guestfs-actions.pod:1297
23019 " guestfs_download (guestfs_h *g,\n"
23020 " const char *remotefilename,\n"
23021 " const char *filename);\n"
23026 #: ../src/guestfs-actions.pod:1307
23027 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23031 #: ../src/guestfs-actions.pod:1318
23032 msgid "guestfs_download_offset"
23036 #: ../src/guestfs-actions.pod:1320
23040 " guestfs_download_offset (guestfs_h *g,\n"
23041 " const char *remotefilename,\n"
23042 " const char *filename,\n"
23043 " int64_t offset,\n"
23044 " int64_t size);\n"
23049 #: ../src/guestfs-actions.pod:1333
23051 "Note that there is no limit on the amount of data that can be downloaded "
23052 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23053 "full amount unless an error occurs."
23057 #: ../src/guestfs-actions.pod:1338
23058 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23062 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7308
23063 msgid "(Added in 1.5.17)"
23067 #: ../src/guestfs-actions.pod:1349
23068 msgid "guestfs_drop_caches"
23072 #: ../src/guestfs-actions.pod:1351
23076 " guestfs_drop_caches (guestfs_h *g,\n"
23077 " int whattodrop);\n"
23082 #: ../src/guestfs-actions.pod:1369
23087 #: ../src/guestfs-actions.pod:1371
23091 " guestfs_du (guestfs_h *g,\n"
23092 " const char *path);\n"
23097 #: ../src/guestfs-actions.pod:1394
23098 msgid "guestfs_e2fsck_f"
23102 #: ../src/guestfs-actions.pod:1396
23106 " guestfs_e2fsck_f (guestfs_h *g,\n"
23107 " const char *device);\n"
23112 #: ../src/guestfs-actions.pod:1404
23114 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23115 "Normally you should use C<guestfs_fsck>."
23119 #: ../src/guestfs-actions.pod:1409
23120 msgid "(Added in 1.0.29)"
23124 #: ../src/guestfs-actions.pod:1411
23125 msgid "guestfs_echo_daemon"
23129 #: ../src/guestfs-actions.pod:1413
23133 " guestfs_echo_daemon (guestfs_h *g,\n"
23134 " char *const *words);\n"
23139 #: ../src/guestfs-actions.pod:1422
23140 msgid "See also C<guestfs_ping_daemon>."
23144 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:6479
23145 msgid "(Added in 1.0.69)"
23149 #: ../src/guestfs-actions.pod:1429
23150 msgid "guestfs_egrep"
23154 #: ../src/guestfs-actions.pod:1431
23158 " guestfs_egrep (guestfs_h *g,\n"
23159 " const char *regex,\n"
23160 " const char *path);\n"
23165 #: ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1465 ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:1568 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:2529 ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3897 ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6875 ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6913 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:7768 ../src/guestfs-actions.pod:7787 ../src/guestfs-actions.pod:7881 ../src/guestfs-actions.pod:7900 ../src/guestfs-actions.pod:7946 ../src/guestfs-actions.pod:7965
23166 msgid "(Added in 1.0.66)"
23170 #: ../src/guestfs-actions.pod:1448
23171 msgid "guestfs_egrepi"
23175 #: ../src/guestfs-actions.pod:1450
23179 " guestfs_egrepi (guestfs_h *g,\n"
23180 " const char *regex,\n"
23181 " const char *path);\n"
23186 #: ../src/guestfs-actions.pod:1467
23187 msgid "guestfs_equal"
23191 #: ../src/guestfs-actions.pod:1469
23195 " guestfs_equal (guestfs_h *g,\n"
23196 " const char *file1,\n"
23197 " const char *file2);\n"
23202 #: ../src/guestfs-actions.pod:1483
23203 msgid "guestfs_exists"
23207 #: ../src/guestfs-actions.pod:1485
23211 " guestfs_exists (guestfs_h *g,\n"
23212 " const char *path);\n"
23217 #: ../src/guestfs-actions.pod:1492
23218 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23222 #: ../src/guestfs-actions.pod:1498
23223 msgid "guestfs_fallocate"
23227 #: ../src/guestfs-actions.pod:1500
23231 " guestfs_fallocate (guestfs_h *g,\n"
23232 " const char *path,\n"
23238 #: ../src/guestfs-actions.pod:1505
23240 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
23245 #: ../src/guestfs-actions.pod:1524
23246 msgid "guestfs_fallocate64"
23250 #: ../src/guestfs-actions.pod:1526
23254 " guestfs_fallocate64 (guestfs_h *g,\n"
23255 " const char *path,\n"
23261 #: ../src/guestfs-actions.pod:1535
23263 "Note that this call allocates disk blocks for the file. To create a sparse "
23264 "file use C<guestfs_truncate_size> instead."
23268 #: ../src/guestfs-actions.pod:1538
23270 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23271 "oversight it only allowed 30 bit lengths to be specified, effectively "
23272 "limiting the maximum size of files created through that call to 1GB."
23276 #: ../src/guestfs-actions.pod:1549
23277 msgid "(Added in 1.3.17)"
23281 #: ../src/guestfs-actions.pod:1551
23282 msgid "guestfs_fgrep"
23286 #: ../src/guestfs-actions.pod:1553
23290 " guestfs_fgrep (guestfs_h *g,\n"
23291 " const char *pattern,\n"
23292 " const char *path);\n"
23297 #: ../src/guestfs-actions.pod:1570
23298 msgid "guestfs_fgrepi"
23302 #: ../src/guestfs-actions.pod:1572
23306 " guestfs_fgrepi (guestfs_h *g,\n"
23307 " const char *pattern,\n"
23308 " const char *path);\n"
23313 #: ../src/guestfs-actions.pod:1589
23314 msgid "guestfs_file"
23318 #: ../src/guestfs-actions.pod:1591
23322 " guestfs_file (guestfs_h *g,\n"
23323 " const char *path);\n"
23328 #: ../src/guestfs-actions.pod:1609
23330 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23331 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23335 #: ../src/guestfs-actions.pod:1617
23336 msgid "guestfs_file_architecture"
23340 #: ../src/guestfs-actions.pod:1619
23344 " guestfs_file_architecture (guestfs_h *g,\n"
23345 " const char *filename);\n"
23350 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2995 ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3203 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3572
23351 msgid "(Added in 1.5.3)"
23355 #: ../src/guestfs-actions.pod:1729
23356 msgid "guestfs_filesize"
23360 #: ../src/guestfs-actions.pod:1731
23364 " guestfs_filesize (guestfs_h *g,\n"
23365 " const char *file);\n"
23370 #: ../src/guestfs-actions.pod:1737
23372 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23373 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23374 "devices, use C<guestfs_blockdev_getsize64>."
23378 #: ../src/guestfs-actions.pod:1743
23379 msgid "(Added in 1.0.82)"
23383 #: ../src/guestfs-actions.pod:1745
23384 msgid "guestfs_fill"
23388 #: ../src/guestfs-actions.pod:1747
23392 " guestfs_fill (guestfs_h *g,\n"
23395 " const char *path);\n"
23400 #: ../src/guestfs-actions.pod:1757
23402 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23403 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23404 "bytes use C<guestfs_fill_pattern>."
23408 #: ../src/guestfs-actions.pod:1769
23409 msgid "(Added in 1.0.79)"
23413 #: ../src/guestfs-actions.pod:1771
23414 msgid "guestfs_fill_pattern"
23418 #: ../src/guestfs-actions.pod:1773
23422 " guestfs_fill_pattern (guestfs_h *g,\n"
23423 " const char *pattern,\n"
23425 " const char *path);\n"
23430 #: ../src/guestfs-actions.pod:1779
23432 "This function is like C<guestfs_fill> except that it creates a new file of "
23433 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23434 "pattern is truncated if necessary to ensure the length of the file is "
23435 "exactly C<len> bytes."
23439 #: ../src/guestfs-actions.pod:1791
23440 msgid "(Added in 1.3.12)"
23444 #: ../src/guestfs-actions.pod:1793
23445 msgid "guestfs_find"
23449 #: ../src/guestfs-actions.pod:1795
23453 " guestfs_find (guestfs_h *g,\n"
23454 " const char *directory);\n"
23459 #: ../src/guestfs-actions.pod:1811
23460 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23464 #: ../src/guestfs-actions.pod:1824
23465 msgid "See also C<guestfs_find0>."
23469 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:6040
23470 msgid "(Added in 1.0.27)"
23474 #: ../src/guestfs-actions.pod:1835
23475 msgid "guestfs_find0"
23479 #: ../src/guestfs-actions.pod:1837
23483 " guestfs_find0 (guestfs_h *g,\n"
23484 " const char *directory,\n"
23485 " const char *files);\n"
23490 #: ../src/guestfs-actions.pod:1846
23492 "This command works the same way as C<guestfs_find> with the following "
23497 #: ../src/guestfs-actions.pod:1873
23498 msgid "(Added in 1.0.74)"
23502 #: ../src/guestfs-actions.pod:1875
23503 msgid "guestfs_findfs_label"
23507 #: ../src/guestfs-actions.pod:1877
23511 " guestfs_findfs_label (guestfs_h *g,\n"
23512 " const char *label);\n"
23517 #: ../src/guestfs-actions.pod:1885
23518 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23522 #: ../src/guestfs-actions.pod:1892
23523 msgid "guestfs_findfs_uuid"
23527 #: ../src/guestfs-actions.pod:1894
23531 " guestfs_findfs_uuid (guestfs_h *g,\n"
23532 " const char *uuid);\n"
23537 #: ../src/guestfs-actions.pod:1902
23538 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23542 #: ../src/guestfs-actions.pod:1909
23543 msgid "guestfs_fsck"
23547 #: ../src/guestfs-actions.pod:1911
23551 " guestfs_fsck (guestfs_h *g,\n"
23552 " const char *fstype,\n"
23553 " const char *device);\n"
23558 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7815
23559 msgid "(Added in 1.0.16)"
23563 #: ../src/guestfs-actions.pod:1948
23564 msgid "guestfs_get_append"
23568 #: ../src/guestfs-actions.pod:1950
23572 " guestfs_get_append (guestfs_h *g);\n"
23577 #: ../src/guestfs-actions.pod:1958
23579 "This function returns a string which may be NULL. There is no way to return "
23580 "an error from this function. The string is owned by the guest handle and "
23581 "must I<not> be freed."
23585 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5718 ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6701 ../src/guestfs-actions.pod:7455 ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7862
23586 msgid "(Added in 1.0.26)"
23590 #: ../src/guestfs-actions.pod:1964
23591 msgid "guestfs_get_attach_method"
23595 #: ../src/guestfs-actions.pod:1966
23599 " guestfs_get_attach_method (guestfs_h *g);\n"
23604 #: ../src/guestfs-actions.pod:1969
23605 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23609 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6230
23610 msgid "(Added in 1.9.8)"
23614 #: ../src/guestfs-actions.pod:1976
23615 msgid "guestfs_get_autosync"
23619 #: ../src/guestfs-actions.pod:1978
23623 " guestfs_get_autosync (guestfs_h *g);\n"
23628 #: ../src/guestfs-actions.pod:1987
23629 msgid "guestfs_get_direct"
23633 #: ../src/guestfs-actions.pod:1989
23637 " guestfs_get_direct (guestfs_h *g);\n"
23642 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6271
23643 msgid "(Added in 1.0.72)"
23647 #: ../src/guestfs-actions.pod:1998
23648 msgid "guestfs_get_e2label"
23652 #: ../src/guestfs-actions.pod:2000
23656 " guestfs_get_e2label (guestfs_h *g,\n"
23657 " const char *device);\n"
23662 #: ../src/guestfs-actions.pod:2004
23664 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
23669 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6308
23670 msgid "(Added in 1.0.15)"
23674 #: ../src/guestfs-actions.pod:2019
23675 msgid "guestfs_get_e2uuid"
23679 #: ../src/guestfs-actions.pod:2021
23683 " guestfs_get_e2uuid (guestfs_h *g,\n"
23684 " const char *device);\n"
23689 #: ../src/guestfs-actions.pod:2025
23691 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
23696 #: ../src/guestfs-actions.pod:2040
23697 msgid "guestfs_get_memsize"
23701 #: ../src/guestfs-actions.pod:2042
23705 " guestfs_get_memsize (guestfs_h *g);\n"
23710 #: ../src/guestfs-actions.pod:2048
23712 "If C<guestfs_set_memsize> was not called on this handle, and if "
23713 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23714 "value for memsize."
23718 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4830 ../src/guestfs-actions.pod:4849 ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4880 ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4910 ../src/guestfs-actions.pod:5943 ../src/guestfs-actions.pod:6329 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:7224
23719 msgid "(Added in 1.0.55)"
23723 #: ../src/guestfs-actions.pod:2059
23724 msgid "guestfs_get_network"
23728 #: ../src/guestfs-actions.pod:2061
23732 " guestfs_get_network (guestfs_h *g);\n"
23737 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6348
23738 msgid "(Added in 1.5.4)"
23742 #: ../src/guestfs-actions.pod:2070
23743 msgid "guestfs_get_path"
23747 #: ../src/guestfs-actions.pod:2072
23751 " guestfs_get_path (guestfs_h *g);\n"
23756 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
23758 "This function returns a string, or NULL on error. The string is owned by "
23759 "the guest handle and must I<not> be freed."
23763 #: ../src/guestfs-actions.pod:2085
23764 msgid "guestfs_get_pgroup"
23768 #: ../src/guestfs-actions.pod:2087
23772 " guestfs_get_pgroup (guestfs_h *g);\n"
23777 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:7716
23778 msgid "(Added in 1.11.18)"
23782 #: ../src/guestfs-actions.pod:2096
23783 msgid "guestfs_get_pid"
23787 #: ../src/guestfs-actions.pod:2098
23791 " guestfs_get_pid (guestfs_h *g);\n"
23796 #: ../src/guestfs-actions.pod:2108
23797 msgid "(Added in 1.0.56)"
23801 #: ../src/guestfs-actions.pod:2110
23802 msgid "guestfs_get_qemu"
23806 #: ../src/guestfs-actions.pod:2112
23810 " guestfs_get_qemu (guestfs_h *g);\n"
23815 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6412
23816 msgid "(Added in 1.0.6)"
23820 #: ../src/guestfs-actions.pod:2125
23821 msgid "guestfs_get_recovery_proc"
23825 #: ../src/guestfs-actions.pod:2127
23829 " guestfs_get_recovery_proc (guestfs_h *g);\n"
23834 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:4460 ../src/guestfs-actions.pod:5648 ../src/guestfs-actions.pod:5991 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:7127 ../src/guestfs-actions.pod:7147 ../src/guestfs-actions.pod:7339
23835 msgid "(Added in 1.0.77)"
23839 #: ../src/guestfs-actions.pod:2136
23840 msgid "guestfs_get_selinux"
23844 #: ../src/guestfs-actions.pod:2138
23848 " guestfs_get_selinux (guestfs_h *g);\n"
23853 #: ../src/guestfs-actions.pod:2141
23855 "This returns the current setting of the selinux flag which is passed to the "
23856 "appliance at boot time. See C<guestfs_set_selinux>."
23860 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6513
23861 msgid "(Added in 1.0.67)"
23865 #: ../src/guestfs-actions.pod:2151
23866 msgid "guestfs_get_state"
23870 #: ../src/guestfs-actions.pod:2153
23874 " guestfs_get_state (guestfs_h *g);\n"
23879 #: ../src/guestfs-actions.pod:2165
23880 msgid "guestfs_get_trace"
23884 #: ../src/guestfs-actions.pod:2167
23888 " guestfs_get_trace (guestfs_h *g);\n"
23893 #: ../src/guestfs-actions.pod:2176
23894 msgid "guestfs_get_umask"
23898 #: ../src/guestfs-actions.pod:2178
23902 " guestfs_get_umask (guestfs_h *g);\n"
23907 #: ../src/guestfs-actions.pod:2181
23909 "Return the current umask. By default the umask is C<022> unless it has been "
23910 "set by calling C<guestfs_umask>."
23914 #: ../src/guestfs-actions.pod:2188
23915 msgid "guestfs_get_verbose"
23919 #: ../src/guestfs-actions.pod:2190
23923 " guestfs_get_verbose (guestfs_h *g);\n"
23928 #: ../src/guestfs-actions.pod:2199
23929 msgid "guestfs_getcon"
23933 #: ../src/guestfs-actions.pod:2201
23937 " guestfs_getcon (guestfs_h *g);\n"
23942 #: ../src/guestfs-actions.pod:2206
23943 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
23947 #: ../src/guestfs-actions.pod:2214
23948 msgid "guestfs_getxattr"
23952 #: ../src/guestfs-actions.pod:2216
23956 " guestfs_getxattr (guestfs_h *g,\n"
23957 " const char *path,\n"
23958 " const char *name,\n"
23959 " size_t *size_r);\n"
23964 #: ../src/guestfs-actions.pod:2222
23966 "Get a single extended attribute from file C<path> named C<name>. This call "
23967 "follows symlinks. If you want to lookup an extended attribute for the "
23968 "symlink itself, use C<guestfs_lgetxattr>."
23972 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3708
23974 "Normally it is better to get all extended attributes from a file in one go "
23975 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
23976 "implementations are buggy and do not provide a way to list out attributes. "
23977 "For these filesystems (notably ntfs-3g) you have to know the names of the "
23978 "extended attributes you want in advance and call this function."
23982 #: ../src/guestfs-actions.pod:2236
23983 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
23987 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5848
23989 "This function returns a buffer, or NULL on error. The size of the returned "
23990 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
23995 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3724
23996 msgid "(Added in 1.7.24)"
24000 #: ../src/guestfs-actions.pod:2244
24001 msgid "guestfs_getxattrs"
24005 #: ../src/guestfs-actions.pod:2246
24008 " struct guestfs_xattr_list *\n"
24009 " guestfs_getxattrs (guestfs_h *g,\n"
24010 " const char *path);\n"
24015 #: ../src/guestfs-actions.pod:2256
24016 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24020 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:4424
24022 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24023 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24027 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3740 ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3975 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6532 ../src/guestfs-actions.pod:7927
24028 msgid "(Added in 1.0.59)"
24032 #: ../src/guestfs-actions.pod:2264
24033 msgid "guestfs_glob_expand"
24037 #: ../src/guestfs-actions.pod:2266
24041 " guestfs_glob_expand (guestfs_h *g,\n"
24042 " const char *pattern);\n"
24047 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6742
24048 msgid "(Added in 1.0.50)"
24052 #: ../src/guestfs-actions.pod:2287
24053 msgid "guestfs_grep"
24057 #: ../src/guestfs-actions.pod:2289
24061 " guestfs_grep (guestfs_h *g,\n"
24062 " const char *regex,\n"
24063 " const char *path);\n"
24068 #: ../src/guestfs-actions.pod:2306
24069 msgid "guestfs_grepi"
24073 #: ../src/guestfs-actions.pod:2308
24077 " guestfs_grepi (guestfs_h *g,\n"
24078 " const char *regex,\n"
24079 " const char *path);\n"
24084 #: ../src/guestfs-actions.pod:2325
24085 msgid "guestfs_grub_install"
24089 #: ../src/guestfs-actions.pod:2327
24093 " guestfs_grub_install (guestfs_h *g,\n"
24094 " const char *root,\n"
24095 " const char *device);\n"
24100 #: ../src/guestfs-actions.pod:2370
24101 msgid "(Added in 1.0.17)"
24105 #: ../src/guestfs-actions.pod:2372
24106 msgid "guestfs_head"
24110 #: ../src/guestfs-actions.pod:2374
24114 " guestfs_head (guestfs_h *g,\n"
24115 " const char *path);\n"
24120 #: ../src/guestfs-actions.pod:2390
24121 msgid "guestfs_head_n"
24125 #: ../src/guestfs-actions.pod:2392
24129 " guestfs_head_n (guestfs_h *g,\n"
24131 " const char *path);\n"
24136 #: ../src/guestfs-actions.pod:2414
24137 msgid "guestfs_hexdump"
24141 #: ../src/guestfs-actions.pod:2416
24145 " guestfs_hexdump (guestfs_h *g,\n"
24146 " const char *path);\n"
24151 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:6806 ../src/guestfs-actions.pod:6861
24152 msgid "(Added in 1.0.22)"
24156 #: ../src/guestfs-actions.pod:2431
24157 msgid "guestfs_initrd_cat"
24161 #: ../src/guestfs-actions.pod:2433
24165 " guestfs_initrd_cat (guestfs_h *g,\n"
24166 " const char *initrdpath,\n"
24167 " const char *filename,\n"
24168 " size_t *size_r);\n"
24173 #: ../src/guestfs-actions.pod:2449
24174 msgid "See also C<guestfs_initrd_list>."
24178 #: ../src/guestfs-actions.pod:2460
24179 msgid "guestfs_initrd_list"
24183 #: ../src/guestfs-actions.pod:2462
24187 " guestfs_initrd_list (guestfs_h *g,\n"
24188 " const char *path);\n"
24193 #: ../src/guestfs-actions.pod:2482
24194 msgid "guestfs_inotify_add_watch"
24198 #: ../src/guestfs-actions.pod:2484
24202 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24203 " const char *path,\n"
24209 #: ../src/guestfs-actions.pod:2503
24210 msgid "guestfs_inotify_close"
24214 #: ../src/guestfs-actions.pod:2505
24218 " guestfs_inotify_close (guestfs_h *g);\n"
24223 #: ../src/guestfs-actions.pod:2516
24224 msgid "guestfs_inotify_files"
24228 #: ../src/guestfs-actions.pod:2518
24232 " guestfs_inotify_files (guestfs_h *g);\n"
24237 #: ../src/guestfs-actions.pod:2521
24239 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24240 "returns a list of pathnames of objects that were touched. The returned "
24241 "pathnames are sorted and deduplicated."
24245 #: ../src/guestfs-actions.pod:2531
24246 msgid "guestfs_inotify_init"
24250 #: ../src/guestfs-actions.pod:2533
24254 " guestfs_inotify_init (guestfs_h *g,\n"
24255 " int maxevents);\n"
24260 #: ../src/guestfs-actions.pod:2541
24262 "C<maxevents> is the maximum number of events which will be queued up between "
24263 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24264 "passed as C<0>, then the kernel (or previously set) default is used. For "
24265 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24266 "throws away events, but records the fact that it threw them away by setting "
24267 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24268 "C<guestfs_inotify_read>)."
24272 #: ../src/guestfs-actions.pod:2551
24274 "Before any events are generated, you have to add some watches to the "
24275 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24276 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24280 #: ../src/guestfs-actions.pod:2557
24282 "Queued up events should be read periodically by calling "
24283 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24284 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24285 "often enough then you risk the internal queue overflowing."
24289 #: ../src/guestfs-actions.pod:2564
24291 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24292 "This also removes any watches automatically."
24296 #: ../src/guestfs-actions.pod:2577
24297 msgid "guestfs_inotify_read"
24301 #: ../src/guestfs-actions.pod:2579
24304 " struct guestfs_inotify_event_list *\n"
24305 " guestfs_inotify_read (guestfs_h *g);\n"
24310 #: ../src/guestfs-actions.pod:2593
24312 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24313 "there was an error. I<The caller must call "
24314 "C<guestfs_free_inotify_event_list> after use>."
24318 #: ../src/guestfs-actions.pod:2599
24319 msgid "guestfs_inotify_rm_watch"
24323 #: ../src/guestfs-actions.pod:2601
24327 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24333 #: ../src/guestfs-actions.pod:2605
24335 "Remove a previously defined inotify watch. See "
24336 "C<guestfs_inotify_add_watch>."
24340 #: ../src/guestfs-actions.pod:2612
24341 msgid "guestfs_inspect_get_arch"
24345 #: ../src/guestfs-actions.pod:2614
24349 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24350 " const char *root);\n"
24355 #: ../src/guestfs-actions.pod:2618
24357 "This returns the architecture of the inspected operating system. The "
24358 "possible return values are listed under C<guestfs_file_architecture>."
24362 #: ../src/guestfs-actions.pod:2632
24363 msgid "guestfs_inspect_get_distro"
24367 #: ../src/guestfs-actions.pod:2634
24371 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24372 " const char *root);\n"
24377 #: ../src/guestfs-actions.pod:2726
24378 msgid "guestfs_inspect_get_drive_mappings"
24382 #: ../src/guestfs-actions.pod:2728
24386 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24387 " const char *root);\n"
24392 #: ../src/guestfs-actions.pod:2757
24394 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24395 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24399 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:3029 ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:5109 ../src/guestfs-actions.pod:7163
24401 "This function returns a NULL-terminated array of strings, or NULL if there "
24402 "was an error. The array of strings will always have length C<2n+1>, where "
24403 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24404 "caller must free the strings and the array after use>."
24408 #: ../src/guestfs-actions.pod:2767 ../src/guestfs-actions.pod:3223
24409 msgid "(Added in 1.9.17)"
24413 #: ../src/guestfs-actions.pod:2769
24414 msgid "guestfs_inspect_get_filesystems"
24418 #: ../src/guestfs-actions.pod:2771
24422 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24423 " const char *root);\n"
24428 #: ../src/guestfs-actions.pod:2783
24430 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24431 "C<guestfs_inspect_get_mountpoints>."
24435 #: ../src/guestfs-actions.pod:2792
24436 msgid "guestfs_inspect_get_format"
24440 #: ../src/guestfs-actions.pod:2794
24444 " guestfs_inspect_get_format (guestfs_h *g,\n"
24445 " const char *root);\n"
24450 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3293 ../src/guestfs-actions.pod:6059
24451 msgid "(Added in 1.9.4)"
24455 #: ../src/guestfs-actions.pod:2830
24456 msgid "guestfs_inspect_get_hostname"
24460 #: ../src/guestfs-actions.pod:2832
24464 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24465 " const char *root);\n"
24470 #: ../src/guestfs-actions.pod:2847
24471 msgid "(Added in 1.7.9)"
24475 #: ../src/guestfs-actions.pod:2849
24476 msgid "guestfs_inspect_get_icon"
24480 #: ../src/guestfs-actions.pod:2851
24484 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24485 " const char *root,\n"
24486 " size_t *size_r,\n"
24492 #: ../src/guestfs-actions.pod:2862
24495 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24496 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24501 #: ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:5008
24502 msgid "(Added in 1.11.12)"
24506 #: ../src/guestfs-actions.pod:2931
24507 msgid "guestfs_inspect_get_icon_va"
24511 #: ../src/guestfs-actions.pod:2933
24515 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24516 " const char *root,\n"
24517 " size_t *size_r,\n"
24518 " va_list args);\n"
24523 #: ../src/guestfs-actions.pod:2939
24524 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24528 #: ../src/guestfs-actions.pod:2943
24529 msgid "guestfs_inspect_get_icon_argv"
24533 #: ../src/guestfs-actions.pod:2945
24537 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24538 " const char *root,\n"
24539 " size_t *size_r,\n"
24540 " const struct guestfs_inspect_get_icon_argv "
24546 #: ../src/guestfs-actions.pod:2951
24547 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24551 #: ../src/guestfs-actions.pod:2955
24552 msgid "guestfs_inspect_get_major_version"
24556 #: ../src/guestfs-actions.pod:2957
24560 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24561 " const char *root);\n"
24566 #: ../src/guestfs-actions.pod:2979
24567 msgid "guestfs_inspect_get_minor_version"
24571 #: ../src/guestfs-actions.pod:2981
24575 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24576 " const char *root);\n"
24581 #: ../src/guestfs-actions.pod:2990
24583 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24584 "C<guestfs_inspect_get_major_version>."
24588 #: ../src/guestfs-actions.pod:2997
24589 msgid "guestfs_inspect_get_mountpoints"
24593 #: ../src/guestfs-actions.pod:2999
24597 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24598 " const char *root);\n"
24603 #: ../src/guestfs-actions.pod:3020
24605 "For operating systems like Windows which still use drive letters, this call "
24606 "will only return an entry for the first drive \"mounted on\" C</>. For "
24607 "information about the mapping of drive letters to partitions, see "
24608 "C<guestfs_inspect_get_drive_mappings>."
24612 #: ../src/guestfs-actions.pod:3026
24614 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24615 "C<guestfs_inspect_get_filesystems>."
24619 #: ../src/guestfs-actions.pod:3037
24620 msgid "guestfs_inspect_get_package_format"
24624 #: ../src/guestfs-actions.pod:3039
24628 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24629 " const char *root);\n"
24634 #: ../src/guestfs-actions.pod:3043
24636 "This function and C<guestfs_inspect_get_package_management> return the "
24637 "package format and package management tool used by the inspected operating "
24638 "system. For example for Fedora these functions would return C<rpm> (package "
24639 "format) and C<yum> (package management)."
24643 #: ../src/guestfs-actions.pod:3061 ../src/guestfs-actions.pod:3089
24644 msgid "(Added in 1.7.5)"
24648 #: ../src/guestfs-actions.pod:3063
24649 msgid "guestfs_inspect_get_package_management"
24653 #: ../src/guestfs-actions.pod:3065
24657 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24658 " const char *root);\n"
24663 #: ../src/guestfs-actions.pod:3069
24665 "C<guestfs_inspect_get_package_format> and this function return the package "
24666 "format and package management tool used by the inspected operating system. "
24667 "For example for Fedora these functions would return C<rpm> (package format) "
24668 "and C<yum> (package management)."
24672 #: ../src/guestfs-actions.pod:3091
24673 msgid "guestfs_inspect_get_product_name"
24677 #: ../src/guestfs-actions.pod:3093
24681 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24682 " const char *root);\n"
24687 #: ../src/guestfs-actions.pod:3112
24688 msgid "guestfs_inspect_get_product_variant"
24692 #: ../src/guestfs-actions.pod:3114
24696 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24697 " const char *root);\n"
24702 #: ../src/guestfs-actions.pod:3137
24704 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24705 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24709 #: ../src/guestfs-actions.pod:3144
24710 msgid "(Added in 1.9.13)"
24714 #: ../src/guestfs-actions.pod:3146
24715 msgid "guestfs_inspect_get_roots"
24719 #: ../src/guestfs-actions.pod:3148
24723 " guestfs_inspect_get_roots (guestfs_h *g);\n"
24728 #: ../src/guestfs-actions.pod:3151
24730 "This function is a convenient way to get the list of root devices, as "
24731 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
24732 "the whole inspection process."
24736 #: ../src/guestfs-actions.pod:3155
24738 "This returns an empty list if either no root devices were found or the "
24739 "caller has not called C<guestfs_inspect_os>."
24743 #: ../src/guestfs-actions.pod:3164
24744 msgid "(Added in 1.7.3)"
24748 #: ../src/guestfs-actions.pod:3166
24749 msgid "guestfs_inspect_get_type"
24753 #: ../src/guestfs-actions.pod:3168
24757 " guestfs_inspect_get_type (guestfs_h *g,\n"
24758 " const char *root);\n"
24763 #: ../src/guestfs-actions.pod:3205
24764 msgid "guestfs_inspect_get_windows_current_control_set"
24768 #: ../src/guestfs-actions.pod:3207
24772 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
24773 " const char *root);\n"
24778 #: ../src/guestfs-actions.pod:3225
24779 msgid "guestfs_inspect_get_windows_systemroot"
24783 #: ../src/guestfs-actions.pod:3227
24787 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
24788 " const char *root);\n"
24793 #: ../src/guestfs-actions.pod:3243
24794 msgid "(Added in 1.5.25)"
24798 #: ../src/guestfs-actions.pod:3245
24799 msgid "guestfs_inspect_is_live"
24803 #: ../src/guestfs-actions.pod:3247
24807 " guestfs_inspect_is_live (guestfs_h *g,\n"
24808 " const char *root);\n"
24813 #: ../src/guestfs-actions.pod:3251
24815 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24816 "disk), then this returns true if a live image was detected on the disk."
24820 #: ../src/guestfs-actions.pod:3261
24821 msgid "guestfs_inspect_is_multipart"
24825 #: ../src/guestfs-actions.pod:3263
24829 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
24830 " const char *root);\n"
24835 #: ../src/guestfs-actions.pod:3267
24837 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24838 "disk), then this returns true if the disk is part of a set."
24842 #: ../src/guestfs-actions.pod:3277
24843 msgid "guestfs_inspect_is_netinst"
24847 #: ../src/guestfs-actions.pod:3279
24851 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
24852 " const char *root);\n"
24857 #: ../src/guestfs-actions.pod:3283
24859 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24860 "disk), then this returns true if the disk is a network installer, ie. not a "
24861 "self-contained install CD but one which is likely to require network access "
24862 "to complete the install."
24866 #: ../src/guestfs-actions.pod:3295
24867 msgid "guestfs_inspect_list_applications"
24871 #: ../src/guestfs-actions.pod:3297
24874 " struct guestfs_application_list *\n"
24875 " guestfs_inspect_list_applications (guestfs_h *g,\n"
24876 " const char *root);\n"
24881 #: ../src/guestfs-actions.pod:3303
24883 "I<Note:> This call works differently from other parts of the inspection "
24884 "API. You have to call C<guestfs_inspect_os>, then "
24885 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
24886 "this. Listing applications is a significantly more difficult operation "
24887 "which requires access to the full filesystem. Also note that unlike the "
24888 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
24889 "the libguestfs handle, this call actually reads parts of the mounted "
24890 "filesystems during the call."
24894 #: ../src/guestfs-actions.pod:3393
24896 "This function returns a C<struct guestfs_application_list *>, or NULL if "
24897 "there was an error. I<The caller must call C<guestfs_free_application_list> "
24902 #: ../src/guestfs-actions.pod:3397
24903 msgid "(Added in 1.7.8)"
24907 #: ../src/guestfs-actions.pod:3399
24908 msgid "guestfs_inspect_os"
24912 #: ../src/guestfs-actions.pod:3401
24916 " guestfs_inspect_os (guestfs_h *g);\n"
24921 #: ../src/guestfs-actions.pod:3417
24923 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
24924 "functions in order to query further information about each operating system, "
24925 "such as the name and version."
24929 #: ../src/guestfs-actions.pod:3422
24931 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
24932 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
24933 "the contents. This should be called with no disks currently mounted. The "
24934 "function may also use Augeas, so any existing Augeas handle will be closed."
24938 #: ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3847
24939 msgid "See also C<guestfs_list_filesystems>."
24943 #: ../src/guestfs-actions.pod:3442
24944 msgid "guestfs_is_blockdev"
24948 #: ../src/guestfs-actions.pod:3444
24952 " guestfs_is_blockdev (guestfs_h *g,\n"
24953 " const char *path);\n"
24958 #: ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3525 ../src/guestfs-actions.pod:3541 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:3612
24959 msgid "See also C<guestfs_stat>."
24963 #: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3484 ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3616
24964 msgid "(Added in 1.5.10)"
24968 #: ../src/guestfs-actions.pod:3457
24969 msgid "guestfs_is_busy"
24973 #: ../src/guestfs-actions.pod:3459
24977 " guestfs_is_busy (guestfs_h *g);\n"
24982 #: ../src/guestfs-actions.pod:3471
24983 msgid "guestfs_is_chardev"
24987 #: ../src/guestfs-actions.pod:3473
24991 " guestfs_is_chardev (guestfs_h *g,\n"
24992 " const char *path);\n"
24997 #: ../src/guestfs-actions.pod:3486
24998 msgid "guestfs_is_config"
25002 #: ../src/guestfs-actions.pod:3488
25006 " guestfs_is_config (guestfs_h *g);\n"
25011 #: ../src/guestfs-actions.pod:3500
25012 msgid "guestfs_is_dir"
25016 #: ../src/guestfs-actions.pod:3502
25020 " guestfs_is_dir (guestfs_h *g,\n"
25021 " const char *path);\n"
25026 #: ../src/guestfs-actions.pod:3516
25027 msgid "guestfs_is_fifo"
25031 #: ../src/guestfs-actions.pod:3518
25035 " guestfs_is_fifo (guestfs_h *g,\n"
25036 " const char *path);\n"
25041 #: ../src/guestfs-actions.pod:3531
25042 msgid "guestfs_is_file"
25046 #: ../src/guestfs-actions.pod:3533
25050 " guestfs_is_file (guestfs_h *g,\n"
25051 " const char *path);\n"
25056 #: ../src/guestfs-actions.pod:3547
25057 msgid "guestfs_is_launching"
25061 #: ../src/guestfs-actions.pod:3549
25065 " guestfs_is_launching (guestfs_h *g);\n"
25070 #: ../src/guestfs-actions.pod:3561
25071 msgid "guestfs_is_lv"
25075 #: ../src/guestfs-actions.pod:3563
25079 " guestfs_is_lv (guestfs_h *g,\n"
25080 " const char *device);\n"
25085 #: ../src/guestfs-actions.pod:3574
25086 msgid "guestfs_is_ready"
25090 #: ../src/guestfs-actions.pod:3576
25094 " guestfs_is_ready (guestfs_h *g);\n"
25099 #: ../src/guestfs-actions.pod:3588
25100 msgid "guestfs_is_socket"
25104 #: ../src/guestfs-actions.pod:3590
25108 " guestfs_is_socket (guestfs_h *g,\n"
25109 " const char *path);\n"
25114 #: ../src/guestfs-actions.pod:3603
25115 msgid "guestfs_is_symlink"
25119 #: ../src/guestfs-actions.pod:3605
25123 " guestfs_is_symlink (guestfs_h *g,\n"
25124 " const char *path);\n"
25129 #: ../src/guestfs-actions.pod:3618
25130 msgid "guestfs_is_zero"
25134 #: ../src/guestfs-actions.pod:3620
25138 " guestfs_is_zero (guestfs_h *g,\n"
25139 " const char *path);\n"
25144 #: ../src/guestfs-actions.pod:3629 ../src/guestfs-actions.pod:3643
25145 msgid "(Added in 1.11.8)"
25149 #: ../src/guestfs-actions.pod:3631
25150 msgid "guestfs_is_zero_device"
25154 #: ../src/guestfs-actions.pod:3633
25158 " guestfs_is_zero_device (guestfs_h *g,\n"
25159 " const char *device);\n"
25164 #: ../src/guestfs-actions.pod:3645
25165 msgid "guestfs_kill_subprocess"
25169 #: ../src/guestfs-actions.pod:3647
25173 " guestfs_kill_subprocess (guestfs_h *g);\n"
25178 #: ../src/guestfs-actions.pod:3656
25179 msgid "guestfs_launch"
25183 #: ../src/guestfs-actions.pod:3658
25187 " guestfs_launch (guestfs_h *g);\n"
25192 #: ../src/guestfs-actions.pod:3676
25193 msgid "guestfs_lchown"
25197 #: ../src/guestfs-actions.pod:3678
25201 " guestfs_lchown (guestfs_h *g,\n"
25204 " const char *path);\n"
25209 #: ../src/guestfs-actions.pod:3684
25211 "Change the file owner to C<owner> and group to C<group>. This is like "
25212 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25213 "changed, not the target."
25217 #: ../src/guestfs-actions.pod:3696
25218 msgid "guestfs_lgetxattr"
25222 #: ../src/guestfs-actions.pod:3698
25226 " guestfs_lgetxattr (guestfs_h *g,\n"
25227 " const char *path,\n"
25228 " const char *name,\n"
25229 " size_t *size_r);\n"
25234 #: ../src/guestfs-actions.pod:3718
25235 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25239 #: ../src/guestfs-actions.pod:3726
25240 msgid "guestfs_lgetxattrs"
25244 #: ../src/guestfs-actions.pod:3728
25247 " struct guestfs_xattr_list *\n"
25248 " guestfs_lgetxattrs (guestfs_h *g,\n"
25249 " const char *path);\n"
25254 #: ../src/guestfs-actions.pod:3732
25256 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25257 "then it returns the extended attributes of the link itself."
25261 #: ../src/guestfs-actions.pod:3742
25262 msgid "guestfs_list_9p"
25266 #: ../src/guestfs-actions.pod:3744
25270 " guestfs_list_9p (guestfs_h *g);\n"
25275 #: ../src/guestfs-actions.pod:3756
25276 msgid "guestfs_list_devices"
25280 #: ../src/guestfs-actions.pod:3758
25284 " guestfs_list_devices (guestfs_h *g);\n"
25289 #: ../src/guestfs-actions.pod:3773
25290 msgid "guestfs_list_dm_devices"
25294 #: ../src/guestfs-actions.pod:3775
25298 " guestfs_list_dm_devices (guestfs_h *g);\n"
25303 #: ../src/guestfs-actions.pod:3780
25305 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25306 "previous call to C<guestfs_luks_open>."
25310 #: ../src/guestfs-actions.pod:3783
25312 "Device mapper devices which correspond to logical volumes are I<not> "
25313 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25318 #: ../src/guestfs-actions.pod:3791 ../src/guestfs-actions.pod:5247
25319 msgid "(Added in 1.11.15)"
25323 #: ../src/guestfs-actions.pod:3793
25324 msgid "guestfs_list_filesystems"
25328 #: ../src/guestfs-actions.pod:3795
25332 " guestfs_list_filesystems (guestfs_h *g);\n"
25337 #: ../src/guestfs-actions.pod:3815
25339 "This command runs other libguestfs commands, which might include "
25340 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25341 "soon after launch and only when nothing is mounted."
25345 #: ../src/guestfs-actions.pod:3819
25347 "Not all of the filesystems returned will be mountable. In particular, swap "
25348 "partitions are returned in the list. Also this command does not check that "
25349 "each filesystem found is valid and mountable, and some filesystems might be "
25350 "mountable but require special options. Filesystems may not all belong to a "
25351 "single logical operating system (use C<guestfs_inspect_os> to look for "
25356 #: ../src/guestfs-actions.pod:3833 ../src/guestfs-actions.pod:5608
25357 msgid "(Added in 1.5.15)"
25361 #: ../src/guestfs-actions.pod:3835
25362 msgid "guestfs_list_partitions"
25366 #: ../src/guestfs-actions.pod:3837
25370 " guestfs_list_partitions (guestfs_h *g);\n"
25375 #: ../src/guestfs-actions.pod:3844
25377 "This does not return logical volumes. For that you will need to call "
25382 #: ../src/guestfs-actions.pod:3855
25387 #: ../src/guestfs-actions.pod:3857
25391 " guestfs_ll (guestfs_h *g,\n"
25392 " const char *directory);\n"
25397 #: ../src/guestfs-actions.pod:3872
25402 #: ../src/guestfs-actions.pod:3874
25406 " guestfs_ln (guestfs_h *g,\n"
25407 " const char *target,\n"
25408 " const char *linkname);\n"
25413 #: ../src/guestfs-actions.pod:3885
25414 msgid "guestfs_ln_f"
25418 #: ../src/guestfs-actions.pod:3887
25422 " guestfs_ln_f (guestfs_h *g,\n"
25423 " const char *target,\n"
25424 " const char *linkname);\n"
25429 #: ../src/guestfs-actions.pod:3899
25430 msgid "guestfs_ln_s"
25434 #: ../src/guestfs-actions.pod:3901
25438 " guestfs_ln_s (guestfs_h *g,\n"
25439 " const char *target,\n"
25440 " const char *linkname);\n"
25445 #: ../src/guestfs-actions.pod:3912
25446 msgid "guestfs_ln_sf"
25450 #: ../src/guestfs-actions.pod:3914
25454 " guestfs_ln_sf (guestfs_h *g,\n"
25455 " const char *target,\n"
25456 " const char *linkname);\n"
25461 #: ../src/guestfs-actions.pod:3926
25462 msgid "guestfs_lremovexattr"
25466 #: ../src/guestfs-actions.pod:3928
25470 " guestfs_lremovexattr (guestfs_h *g,\n"
25471 " const char *xattr,\n"
25472 " const char *path);\n"
25477 #: ../src/guestfs-actions.pod:3933
25479 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25480 "link, then it removes an extended attribute of the link itself."
25484 #: ../src/guestfs-actions.pod:3941
25489 #: ../src/guestfs-actions.pod:3943
25493 " guestfs_ls (guestfs_h *g,\n"
25494 " const char *directory);\n"
25499 #: ../src/guestfs-actions.pod:3951
25501 "This command is mostly useful for interactive sessions. Programs should "
25502 "probably use C<guestfs_readdir> instead."
25506 #: ../src/guestfs-actions.pod:3960
25507 msgid "guestfs_lsetxattr"
25511 #: ../src/guestfs-actions.pod:3962
25515 " guestfs_lsetxattr (guestfs_h *g,\n"
25516 " const char *xattr,\n"
25517 " const char *val,\n"
25519 " const char *path);\n"
25524 #: ../src/guestfs-actions.pod:3969
25526 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25527 "then it sets an extended attribute of the link itself."
25531 #: ../src/guestfs-actions.pod:3977
25532 msgid "guestfs_lstat"
25536 #: ../src/guestfs-actions.pod:3979
25539 " struct guestfs_stat *\n"
25540 " guestfs_lstat (guestfs_h *g,\n"
25541 " const char *path);\n"
25546 #: ../src/guestfs-actions.pod:3985
25548 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25549 "link, then the link is stat-ed, not the file it refers to."
25553 #: ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:6766
25555 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25556 "error. I<The caller must call C<guestfs_free_stat> after use>."
25560 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:6770 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:7169
25561 msgid "(Added in 0.9.2)"
25565 #: ../src/guestfs-actions.pod:3997
25566 msgid "guestfs_lstatlist"
25570 #: ../src/guestfs-actions.pod:3999
25573 " struct guestfs_stat_list *\n"
25574 " guestfs_lstatlist (guestfs_h *g,\n"
25575 " const char *path,\n"
25576 " char *const *names);\n"
25581 #: ../src/guestfs-actions.pod:4004
25583 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25584 "files, where all files are in the directory C<path>. C<names> is the list "
25585 "of files from this directory."
25589 #: ../src/guestfs-actions.pod:4013
25591 "This call is intended for programs that want to efficiently list a directory "
25592 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25593 "for a similarly efficient call for getting extended attributes. Very long "
25594 "directory listings might cause the protocol message size to be exceeded, "
25595 "causing this call to fail. The caller must split up such requests into "
25596 "smaller groups of names."
25600 #: ../src/guestfs-actions.pod:4021
25602 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25603 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25607 #: ../src/guestfs-actions.pod:4027
25608 msgid "guestfs_luks_add_key"
25612 #: ../src/guestfs-actions.pod:4029
25616 " guestfs_luks_add_key (guestfs_h *g,\n"
25617 " const char *device,\n"
25618 " const char *key,\n"
25619 " const char *newkey,\n"
25625 #: ../src/guestfs-actions.pod:4041
25627 "Note that if C<keyslot> already contains a key, then this command will "
25628 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
25632 #: ../src/guestfs-actions.pod:4047 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4184
25634 "This function takes a key or passphrase parameter which could contain "
25635 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
25640 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4134
25641 msgid "(Added in 1.5.2)"
25645 #: ../src/guestfs-actions.pod:4053
25646 msgid "guestfs_luks_close"
25650 #: ../src/guestfs-actions.pod:4055
25654 " guestfs_luks_close (guestfs_h *g,\n"
25655 " const char *device);\n"
25660 #: ../src/guestfs-actions.pod:4059
25662 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25663 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
25664 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25665 "underlying block device."
25669 #: ../src/guestfs-actions.pod:4067 ../src/guestfs-actions.pod:4169 ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:4238 ../src/guestfs-actions.pod:4286
25670 msgid "(Added in 1.5.1)"
25674 #: ../src/guestfs-actions.pod:4069
25675 msgid "guestfs_luks_format"
25679 #: ../src/guestfs-actions.pod:4071
25683 " guestfs_luks_format (guestfs_h *g,\n"
25684 " const char *device,\n"
25685 " const char *key,\n"
25691 #: ../src/guestfs-actions.pod:4093
25692 msgid "guestfs_luks_format_cipher"
25696 #: ../src/guestfs-actions.pod:4095
25700 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25701 " const char *device,\n"
25702 " const char *key,\n"
25704 " const char *cipher);\n"
25709 #: ../src/guestfs-actions.pod:4102
25711 "This command is the same as C<guestfs_luks_format> but it also allows you to "
25712 "set the C<cipher> used."
25716 #: ../src/guestfs-actions.pod:4116
25717 msgid "guestfs_luks_kill_slot"
25721 #: ../src/guestfs-actions.pod:4118
25725 " guestfs_luks_kill_slot (guestfs_h *g,\n"
25726 " const char *device,\n"
25727 " const char *key,\n"
25733 #: ../src/guestfs-actions.pod:4136
25734 msgid "guestfs_luks_open"
25738 #: ../src/guestfs-actions.pod:4138
25742 " guestfs_luks_open (guestfs_h *g,\n"
25743 " const char *device,\n"
25744 " const char *key,\n"
25745 " const char *mapname);\n"
25750 #: ../src/guestfs-actions.pod:4156
25752 "If this block device contains LVM volume groups, then calling "
25753 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
25758 #: ../src/guestfs-actions.pod:4160
25759 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
25763 #: ../src/guestfs-actions.pod:4171
25764 msgid "guestfs_luks_open_ro"
25768 #: ../src/guestfs-actions.pod:4173
25772 " guestfs_luks_open_ro (guestfs_h *g,\n"
25773 " const char *device,\n"
25774 " const char *key,\n"
25775 " const char *mapname);\n"
25780 #: ../src/guestfs-actions.pod:4179
25782 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
25787 #: ../src/guestfs-actions.pod:4190
25788 msgid "guestfs_lvcreate"
25792 #: ../src/guestfs-actions.pod:4192
25796 " guestfs_lvcreate (guestfs_h *g,\n"
25797 " const char *logvol,\n"
25798 " const char *volgroup,\n"
25804 #: ../src/guestfs-actions.pod:4205
25805 msgid "guestfs_lvm_canonical_lv_name"
25809 #: ../src/guestfs-actions.pod:4207
25813 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
25814 " const char *lvname);\n"
25819 #: ../src/guestfs-actions.pod:4218
25820 msgid "See also C<guestfs_is_lv>."
25824 #: ../src/guestfs-actions.pod:4223
25825 msgid "(Added in 1.5.24)"
25829 #: ../src/guestfs-actions.pod:4225
25830 msgid "guestfs_lvm_clear_filter"
25834 #: ../src/guestfs-actions.pod:4227
25838 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
25843 #: ../src/guestfs-actions.pod:4230
25845 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
25846 "see every block device."
25850 #: ../src/guestfs-actions.pod:4240
25851 msgid "guestfs_lvm_remove_all"
25855 #: ../src/guestfs-actions.pod:4242
25859 " guestfs_lvm_remove_all (guestfs_h *g);\n"
25864 #: ../src/guestfs-actions.pod:4255
25865 msgid "guestfs_lvm_set_filter"
25869 #: ../src/guestfs-actions.pod:4257
25873 " guestfs_lvm_set_filter (guestfs_h *g,\n"
25874 " char *const *devices);\n"
25879 #: ../src/guestfs-actions.pod:4288
25880 msgid "guestfs_lvremove"
25884 #: ../src/guestfs-actions.pod:4290
25888 " guestfs_lvremove (guestfs_h *g,\n"
25889 " const char *device);\n"
25894 #: ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:5705 ../src/guestfs-actions.pod:7539
25895 msgid "(Added in 1.0.13)"
25899 #: ../src/guestfs-actions.pod:4304
25900 msgid "guestfs_lvrename"
25904 #: ../src/guestfs-actions.pod:4306
25908 " guestfs_lvrename (guestfs_h *g,\n"
25909 " const char *logvol,\n"
25910 " const char *newlogvol);\n"
25915 #: ../src/guestfs-actions.pod:4315 ../src/guestfs-actions.pod:7552
25916 msgid "(Added in 1.0.83)"
25920 #: ../src/guestfs-actions.pod:4317
25921 msgid "guestfs_lvresize"
25925 #: ../src/guestfs-actions.pod:4319
25929 " guestfs_lvresize (guestfs_h *g,\n"
25930 " const char *device,\n"
25936 #: ../src/guestfs-actions.pod:4332
25937 msgid "guestfs_lvresize_free"
25941 #: ../src/guestfs-actions.pod:4334
25945 " guestfs_lvresize_free (guestfs_h *g,\n"
25946 " const char *lv,\n"
25952 #: ../src/guestfs-actions.pod:4347
25953 msgid "(Added in 1.3.3)"
25957 #: ../src/guestfs-actions.pod:4349
25958 msgid "guestfs_lvs"
25962 #: ../src/guestfs-actions.pod:4351
25966 " guestfs_lvs (guestfs_h *g);\n"
25971 #: ../src/guestfs-actions.pod:4360
25972 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
25976 #: ../src/guestfs-actions.pod:4368
25977 msgid "guestfs_lvs_full"
25981 #: ../src/guestfs-actions.pod:4370
25984 " struct guestfs_lvm_lv_list *\n"
25985 " guestfs_lvs_full (guestfs_h *g);\n"
25990 #: ../src/guestfs-actions.pod:4376
25992 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
25993 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
25998 #: ../src/guestfs-actions.pod:4382
25999 msgid "guestfs_lvuuid"
26003 #: ../src/guestfs-actions.pod:4384
26007 " guestfs_lvuuid (guestfs_h *g,\n"
26008 " const char *device);\n"
26013 #: ../src/guestfs-actions.pod:4395
26014 msgid "guestfs_lxattrlist"
26018 #: ../src/guestfs-actions.pod:4397
26021 " struct guestfs_xattr_list *\n"
26022 " guestfs_lxattrlist (guestfs_h *g,\n"
26023 " const char *path,\n"
26024 " char *const *names);\n"
26029 #: ../src/guestfs-actions.pod:4416
26031 "This call is intended for programs that want to efficiently list a directory "
26032 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26033 "a similarly efficient call for getting standard stats. Very long directory "
26034 "listings might cause the protocol message size to be exceeded, causing this "
26035 "call to fail. The caller must split up such requests into smaller groups of "
26040 #: ../src/guestfs-actions.pod:4430
26041 msgid "guestfs_mkdir"
26045 #: ../src/guestfs-actions.pod:4432
26049 " guestfs_mkdir (guestfs_h *g,\n"
26050 " const char *path);\n"
26055 #: ../src/guestfs-actions.pod:4442
26056 msgid "guestfs_mkdir_mode"
26060 #: ../src/guestfs-actions.pod:4444
26064 " guestfs_mkdir_mode (guestfs_h *g,\n"
26065 " const char *path,\n"
26071 #: ../src/guestfs-actions.pod:4456
26072 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26076 #: ../src/guestfs-actions.pod:4462
26077 msgid "guestfs_mkdir_p"
26081 #: ../src/guestfs-actions.pod:4464
26085 " guestfs_mkdir_p (guestfs_h *g,\n"
26086 " const char *path);\n"
26091 #: ../src/guestfs-actions.pod:4475
26092 msgid "guestfs_mkdtemp"
26096 #: ../src/guestfs-actions.pod:4477
26100 " guestfs_mkdtemp (guestfs_h *g,\n"
26101 " const char *template);\n"
26106 #: ../src/guestfs-actions.pod:4505
26107 msgid "guestfs_mke2fs_J"
26111 #: ../src/guestfs-actions.pod:4507
26115 " guestfs_mke2fs_J (guestfs_h *g,\n"
26116 " const char *fstype,\n"
26117 " int blocksize,\n"
26118 " const char *device,\n"
26119 " const char *journal);\n"
26124 #: ../src/guestfs-actions.pod:4520
26125 msgid "See also C<guestfs_mke2journal>."
26129 #: ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4542 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4604 ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4940
26130 msgid "(Added in 1.0.68)"
26134 #: ../src/guestfs-actions.pod:4526
26135 msgid "guestfs_mke2fs_JL"
26139 #: ../src/guestfs-actions.pod:4528
26143 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26144 " const char *fstype,\n"
26145 " int blocksize,\n"
26146 " const char *device,\n"
26147 " const char *label);\n"
26152 #: ../src/guestfs-actions.pod:4538
26153 msgid "See also C<guestfs_mke2journal_L>."
26157 #: ../src/guestfs-actions.pod:4544
26158 msgid "guestfs_mke2fs_JU"
26162 #: ../src/guestfs-actions.pod:4546
26166 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26167 " const char *fstype,\n"
26168 " int blocksize,\n"
26169 " const char *device,\n"
26170 " const char *uuid);\n"
26175 #: ../src/guestfs-actions.pod:4556
26176 msgid "See also C<guestfs_mke2journal_U>."
26180 #: ../src/guestfs-actions.pod:4562
26181 msgid "guestfs_mke2journal"
26185 #: ../src/guestfs-actions.pod:4564
26189 " guestfs_mke2journal (guestfs_h *g,\n"
26190 " int blocksize,\n"
26191 " const char *device);\n"
26196 #: ../src/guestfs-actions.pod:4578
26197 msgid "guestfs_mke2journal_L"
26201 #: ../src/guestfs-actions.pod:4580
26205 " guestfs_mke2journal_L (guestfs_h *g,\n"
26206 " int blocksize,\n"
26207 " const char *label,\n"
26208 " const char *device);\n"
26213 #: ../src/guestfs-actions.pod:4592
26214 msgid "guestfs_mke2journal_U"
26218 #: ../src/guestfs-actions.pod:4594
26222 " guestfs_mke2journal_U (guestfs_h *g,\n"
26223 " int blocksize,\n"
26224 " const char *uuid,\n"
26225 " const char *device);\n"
26230 #: ../src/guestfs-actions.pod:4606
26231 msgid "guestfs_mkfifo"
26235 #: ../src/guestfs-actions.pod:4608
26239 " guestfs_mkfifo (guestfs_h *g,\n"
26241 " const char *path);\n"
26246 #: ../src/guestfs-actions.pod:4613
26248 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26249 "is just a convenient wrapper around C<guestfs_mknod>."
26253 #: ../src/guestfs-actions.pod:4623
26254 msgid "guestfs_mkfs"
26258 #: ../src/guestfs-actions.pod:4625
26262 " guestfs_mkfs (guestfs_h *g,\n"
26263 " const char *fstype,\n"
26264 " const char *device);\n"
26269 #: ../src/guestfs-actions.pod:4638
26270 msgid "guestfs_mkfs_b"
26274 #: ../src/guestfs-actions.pod:4640
26278 " guestfs_mkfs_b (guestfs_h *g,\n"
26279 " const char *fstype,\n"
26280 " int blocksize,\n"
26281 " const char *device);\n"
26286 #: ../src/guestfs-actions.pod:4646
26288 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
26293 #: ../src/guestfs-actions.pod:4653
26295 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26296 "block size of the resulting filesystem. Supported block sizes depend on the "
26297 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26301 #: ../src/guestfs-actions.pod:4665
26302 msgid "guestfs_mkfs_opts"
26306 #: ../src/guestfs-actions.pod:4667
26310 " guestfs_mkfs_opts (guestfs_h *g,\n"
26311 " const char *fstype,\n"
26312 " const char *device,\n"
26318 #: ../src/guestfs-actions.pod:4678
26321 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26322 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26323 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26324 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26329 #: ../src/guestfs-actions.pod:4726
26330 msgid "(Added in 1.7.19)"
26334 #: ../src/guestfs-actions.pod:4728
26335 msgid "guestfs_mkfs_opts_va"
26339 #: ../src/guestfs-actions.pod:4730
26343 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26344 " const char *fstype,\n"
26345 " const char *device,\n"
26346 " va_list args);\n"
26351 #: ../src/guestfs-actions.pod:4736
26352 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26356 #: ../src/guestfs-actions.pod:4740
26357 msgid "guestfs_mkfs_opts_argv"
26361 #: ../src/guestfs-actions.pod:4742
26365 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26366 " const char *fstype,\n"
26367 " const char *device,\n"
26368 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26373 #: ../src/guestfs-actions.pod:4748
26374 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26378 #: ../src/guestfs-actions.pod:4752
26379 msgid "guestfs_mkmountpoint"
26383 #: ../src/guestfs-actions.pod:4754
26387 " guestfs_mkmountpoint (guestfs_h *g,\n"
26388 " const char *exemptpath);\n"
26393 #: ../src/guestfs-actions.pod:4758
26395 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26396 "that can be used to create extra mountpoints before mounting the first "
26401 #: ../src/guestfs-actions.pod:4782
26403 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26404 "may get unexpected errors if you try to mix these calls. It is safest to "
26405 "manually unmount filesystems and remove mountpoints after use."
26409 #: ../src/guestfs-actions.pod:4786
26411 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26412 "first, so for this to work for manual mountpoints, you must ensure that the "
26413 "innermost mountpoints have the longest pathnames, as in the example code "
26418 #: ../src/guestfs-actions.pod:4793
26420 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26421 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26422 "can also trigger these issues."
26426 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:6125
26427 msgid "(Added in 1.0.62)"
26431 #: ../src/guestfs-actions.pod:4801
26432 msgid "guestfs_mknod"
26436 #: ../src/guestfs-actions.pod:4803
26440 " guestfs_mknod (guestfs_h *g,\n"
26444 " const char *path);\n"
26449 #: ../src/guestfs-actions.pod:4818
26451 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26452 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26453 "regular file). These constants are available in the standard Linux header "
26454 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26455 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26456 "the appropriate constant for you."
26460 #: ../src/guestfs-actions.pod:4832
26461 msgid "guestfs_mknod_b"
26465 #: ../src/guestfs-actions.pod:4834
26469 " guestfs_mknod_b (guestfs_h *g,\n"
26473 " const char *path);\n"
26478 #: ../src/guestfs-actions.pod:4841
26480 "This call creates a block device node called C<path> with mode C<mode> and "
26481 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26482 "wrapper around C<guestfs_mknod>."
26486 #: ../src/guestfs-actions.pod:4851
26487 msgid "guestfs_mknod_c"
26491 #: ../src/guestfs-actions.pod:4853
26495 " guestfs_mknod_c (guestfs_h *g,\n"
26499 " const char *path);\n"
26504 #: ../src/guestfs-actions.pod:4860
26506 "This call creates a char device node called C<path> with mode C<mode> and "
26507 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26508 "wrapper around C<guestfs_mknod>."
26512 #: ../src/guestfs-actions.pod:4870
26513 msgid "guestfs_mkswap"
26517 #: ../src/guestfs-actions.pod:4872
26521 " guestfs_mkswap (guestfs_h *g,\n"
26522 " const char *device);\n"
26527 #: ../src/guestfs-actions.pod:4882
26528 msgid "guestfs_mkswap_L"
26532 #: ../src/guestfs-actions.pod:4884
26536 " guestfs_mkswap_L (guestfs_h *g,\n"
26537 " const char *label,\n"
26538 " const char *device);\n"
26543 #: ../src/guestfs-actions.pod:4899
26544 msgid "guestfs_mkswap_U"
26548 #: ../src/guestfs-actions.pod:4901
26552 " guestfs_mkswap_U (guestfs_h *g,\n"
26553 " const char *uuid,\n"
26554 " const char *device);\n"
26559 #: ../src/guestfs-actions.pod:4912
26560 msgid "guestfs_mkswap_file"
26564 #: ../src/guestfs-actions.pod:4914
26568 " guestfs_mkswap_file (guestfs_h *g,\n"
26569 " const char *path);\n"
26574 #: ../src/guestfs-actions.pod:4920
26576 "This command just writes a swap file signature to an existing file. To "
26577 "create the file itself, use something like C<guestfs_fallocate>."
26581 #: ../src/guestfs-actions.pod:4927
26582 msgid "guestfs_modprobe"
26586 #: ../src/guestfs-actions.pod:4929
26590 " guestfs_modprobe (guestfs_h *g,\n"
26591 " const char *modulename);\n"
26596 #: ../src/guestfs-actions.pod:4942
26597 msgid "guestfs_mount"
26601 #: ../src/guestfs-actions.pod:4944
26605 " guestfs_mount (guestfs_h *g,\n"
26606 " const char *device,\n"
26607 " const char *mountpoint);\n"
26612 #: ../src/guestfs-actions.pod:4949
26614 "I<This function is deprecated.> In new code, use the "
26615 "L</guestfs_mount_options> call instead."
26619 #: ../src/guestfs-actions.pod:4970
26621 "B<Important note:> When you use this call, the filesystem options C<sync> "
26622 "and C<noatime> are set implicitly. This was originally done because we "
26623 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26624 "very large negative performance impact and negligible effect on "
26625 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
26626 "in any code that needs performance, and instead use C<guestfs_mount_options> "
26627 "(use an empty string for the first parameter if you don't want any options)."
26631 #: ../src/guestfs-actions.pod:4984
26632 msgid "guestfs_mount_9p"
26636 #: ../src/guestfs-actions.pod:4986
26640 " guestfs_mount_9p (guestfs_h *g,\n"
26641 " const char *mounttag,\n"
26642 " const char *mountpoint,\n"
26648 #: ../src/guestfs-actions.pod:4997
26651 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26656 #: ../src/guestfs-actions.pod:5010
26657 msgid "guestfs_mount_9p_va"
26661 #: ../src/guestfs-actions.pod:5012
26665 " guestfs_mount_9p_va (guestfs_h *g,\n"
26666 " const char *mounttag,\n"
26667 " const char *mountpoint,\n"
26668 " va_list args);\n"
26673 #: ../src/guestfs-actions.pod:5018
26674 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26678 #: ../src/guestfs-actions.pod:5022
26679 msgid "guestfs_mount_9p_argv"
26683 #: ../src/guestfs-actions.pod:5024
26687 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26688 " const char *mounttag,\n"
26689 " const char *mountpoint,\n"
26690 " const struct guestfs_mount_9p_argv *optargs);\n"
26695 #: ../src/guestfs-actions.pod:5030
26696 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26700 #: ../src/guestfs-actions.pod:5034
26701 msgid "guestfs_mount_loop"
26705 #: ../src/guestfs-actions.pod:5036
26709 " guestfs_mount_loop (guestfs_h *g,\n"
26710 " const char *file,\n"
26711 " const char *mountpoint);\n"
26716 #: ../src/guestfs-actions.pod:5049
26717 msgid "guestfs_mount_options"
26721 #: ../src/guestfs-actions.pod:5051
26725 " guestfs_mount_options (guestfs_h *g,\n"
26726 " const char *options,\n"
26727 " const char *device,\n"
26728 " const char *mountpoint);\n"
26733 #: ../src/guestfs-actions.pod:5057
26735 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26736 "the mount options as for the L<mount(8)> I<-o> flag."
26740 #: ../src/guestfs-actions.pod:5067 ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5098
26741 msgid "(Added in 1.0.10)"
26745 #: ../src/guestfs-actions.pod:5069
26746 msgid "guestfs_mount_ro"
26750 #: ../src/guestfs-actions.pod:5071
26754 " guestfs_mount_ro (guestfs_h *g,\n"
26755 " const char *device,\n"
26756 " const char *mountpoint);\n"
26761 #: ../src/guestfs-actions.pod:5076
26763 "This is the same as the C<guestfs_mount> command, but it mounts the "
26764 "filesystem with the read-only (I<-o ro>) flag."
26768 #: ../src/guestfs-actions.pod:5083
26769 msgid "guestfs_mount_vfs"
26773 #: ../src/guestfs-actions.pod:5085
26777 " guestfs_mount_vfs (guestfs_h *g,\n"
26778 " const char *options,\n"
26779 " const char *vfstype,\n"
26780 " const char *device,\n"
26781 " const char *mountpoint);\n"
26786 #: ../src/guestfs-actions.pod:5092
26788 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26789 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
26794 #: ../src/guestfs-actions.pod:5100
26795 msgid "guestfs_mountpoints"
26799 #: ../src/guestfs-actions.pod:5102
26803 " guestfs_mountpoints (guestfs_h *g);\n"
26808 #: ../src/guestfs-actions.pod:5105
26810 "This call is similar to C<guestfs_mounts>. That call returns a list of "
26811 "devices. This one returns a hash table (map) of device name to directory "
26812 "where the device is mounted."
26816 #: ../src/guestfs-actions.pod:5117
26817 msgid "guestfs_mounts"
26821 #: ../src/guestfs-actions.pod:5119
26825 " guestfs_mounts (guestfs_h *g);\n"
26830 #: ../src/guestfs-actions.pod:5127
26831 msgid "See also: C<guestfs_mountpoints>"
26835 #: ../src/guestfs-actions.pod:5135
26840 #: ../src/guestfs-actions.pod:5137
26844 " guestfs_mv (guestfs_h *g,\n"
26845 " const char *src,\n"
26846 " const char *dest);\n"
26851 #: ../src/guestfs-actions.pod:5149
26852 msgid "guestfs_ntfs_3g_probe"
26856 #: ../src/guestfs-actions.pod:5151
26860 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
26862 " const char *device);\n"
26867 #: ../src/guestfs-actions.pod:5170
26868 msgid "(Added in 1.0.43)"
26872 #: ../src/guestfs-actions.pod:5172
26873 msgid "guestfs_ntfsresize"
26877 #: ../src/guestfs-actions.pod:5174
26881 " guestfs_ntfsresize (guestfs_h *g,\n"
26882 " const char *device);\n"
26887 #: ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5278
26889 "I<This function is deprecated.> In new code, use the "
26890 "L</guestfs_ntfsresize_opts> call instead."
26894 #: ../src/guestfs-actions.pod:5202
26895 msgid "guestfs_ntfsresize_opts"
26899 #: ../src/guestfs-actions.pod:5204
26903 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
26904 " const char *device,\n"
26910 #: ../src/guestfs-actions.pod:5214
26913 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
26914 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
26919 #: ../src/guestfs-actions.pod:5234
26921 "After the resize operation, the filesystem is always marked as requiring a "
26922 "consistency check (for safety). You have to boot into Windows to perform "
26923 "this check and clear this condition. If you I<don't> set the C<force> "
26924 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
26925 "times on a single filesystem without booting into Windows between each "
26930 #: ../src/guestfs-actions.pod:5249
26931 msgid "guestfs_ntfsresize_opts_va"
26935 #: ../src/guestfs-actions.pod:5251
26939 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
26940 " const char *device,\n"
26941 " va_list args);\n"
26946 #: ../src/guestfs-actions.pod:5256
26947 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
26951 #: ../src/guestfs-actions.pod:5260
26952 msgid "guestfs_ntfsresize_opts_argv"
26956 #: ../src/guestfs-actions.pod:5262
26960 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
26961 " const char *device,\n"
26962 " const struct guestfs_ntfsresize_opts_argv "
26968 #: ../src/guestfs-actions.pod:5267
26969 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
26973 #: ../src/guestfs-actions.pod:5271
26974 msgid "guestfs_ntfsresize_size"
26978 #: ../src/guestfs-actions.pod:5273
26982 " guestfs_ntfsresize_size (guestfs_h *g,\n"
26983 " const char *device,\n"
26984 " int64_t size);\n"
26989 #: ../src/guestfs-actions.pod:5285
26991 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
26992 "to specify the new size (in bytes) explicitly."
26996 #: ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:7696
26997 msgid "(Added in 1.3.14)"
27001 #: ../src/guestfs-actions.pod:5292
27002 msgid "guestfs_part_add"
27006 #: ../src/guestfs-actions.pod:5294
27010 " guestfs_part_add (guestfs_h *g,\n"
27011 " const char *device,\n"
27012 " const char *prlogex,\n"
27013 " int64_t startsect,\n"
27014 " int64_t endsect);\n"
27019 #: ../src/guestfs-actions.pod:5301
27021 "This command adds a partition to C<device>. If there is no partition table "
27022 "on the device, call C<guestfs_part_init> first."
27026 #: ../src/guestfs-actions.pod:5313
27028 "Creating a partition which covers the whole disk is not so easy. Use "
27029 "C<guestfs_part_disk> to do that."
27033 #: ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5493 ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:5590
27034 msgid "(Added in 1.0.78)"
27038 #: ../src/guestfs-actions.pod:5320
27039 msgid "guestfs_part_del"
27043 #: ../src/guestfs-actions.pod:5322
27047 " guestfs_part_del (guestfs_h *g,\n"
27048 " const char *device,\n"
27054 #: ../src/guestfs-actions.pod:5337
27055 msgid "guestfs_part_disk"
27059 #: ../src/guestfs-actions.pod:5339
27063 " guestfs_part_disk (guestfs_h *g,\n"
27064 " const char *device,\n"
27065 " const char *parttype);\n"
27070 #: ../src/guestfs-actions.pod:5344
27072 "This command is simply a combination of C<guestfs_part_init> followed by "
27073 "C<guestfs_part_add> to create a single primary partition covering the whole "
27078 #: ../src/guestfs-actions.pod:5348
27080 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27081 "possible values are described in C<guestfs_part_init>."
27085 #: ../src/guestfs-actions.pod:5358
27086 msgid "guestfs_part_get_bootable"
27090 #: ../src/guestfs-actions.pod:5360
27094 " guestfs_part_get_bootable (guestfs_h *g,\n"
27095 " const char *device,\n"
27101 #: ../src/guestfs-actions.pod:5368
27102 msgid "See also C<guestfs_part_set_bootable>."
27106 #: ../src/guestfs-actions.pod:5374
27107 msgid "guestfs_part_get_mbr_id"
27111 #: ../src/guestfs-actions.pod:5376
27115 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27116 " const char *device,\n"
27122 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5566
27124 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27125 "undefined results for other partition table types (see "
27126 "C<guestfs_part_get_parttype>)."
27130 #: ../src/guestfs-actions.pod:5392
27131 msgid "guestfs_part_get_parttype"
27135 #: ../src/guestfs-actions.pod:5394
27139 " guestfs_part_get_parttype (guestfs_h *g,\n"
27140 " const char *device);\n"
27145 #: ../src/guestfs-actions.pod:5401
27147 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27148 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27149 "possible, although unusual. See C<guestfs_part_init> for a full list."
27153 #: ../src/guestfs-actions.pod:5411
27154 msgid "guestfs_part_init"
27158 #: ../src/guestfs-actions.pod:5413
27162 " guestfs_part_init (guestfs_h *g,\n"
27163 " const char *device,\n"
27164 " const char *parttype);\n"
27169 #: ../src/guestfs-actions.pod:5422
27171 "Initially there are no partitions. Following this, you should call "
27172 "C<guestfs_part_add> for each partition required."
27176 #: ../src/guestfs-actions.pod:5495
27177 msgid "guestfs_part_list"
27181 #: ../src/guestfs-actions.pod:5497
27184 " struct guestfs_partition_list *\n"
27185 " guestfs_part_list (guestfs_h *g,\n"
27186 " const char *device);\n"
27191 #: ../src/guestfs-actions.pod:5514
27193 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27194 "the device's sector size, see C<guestfs_blockdev_getss>."
27198 #: ../src/guestfs-actions.pod:5527
27200 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27201 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
27206 #: ../src/guestfs-actions.pod:5533
27207 msgid "guestfs_part_set_bootable"
27211 #: ../src/guestfs-actions.pod:5535
27215 " guestfs_part_set_bootable (guestfs_h *g,\n"
27216 " const char *device,\n"
27218 " int bootable);\n"
27223 #: ../src/guestfs-actions.pod:5552
27224 msgid "guestfs_part_set_mbr_id"
27228 #: ../src/guestfs-actions.pod:5554
27232 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27233 " const char *device,\n"
27240 #: ../src/guestfs-actions.pod:5574
27241 msgid "guestfs_part_set_name"
27245 #: ../src/guestfs-actions.pod:5576
27249 " guestfs_part_set_name (guestfs_h *g,\n"
27250 " const char *device,\n"
27252 " const char *name);\n"
27257 #: ../src/guestfs-actions.pod:5592
27258 msgid "guestfs_part_to_dev"
27262 #: ../src/guestfs-actions.pod:5594
27266 " guestfs_part_to_dev (guestfs_h *g,\n"
27267 " const char *partition);\n"
27272 #: ../src/guestfs-actions.pod:5602
27274 "The named partition must exist, for example as a string returned from "
27275 "C<guestfs_list_partitions>."
27279 #: ../src/guestfs-actions.pod:5610
27280 msgid "guestfs_ping_daemon"
27284 #: ../src/guestfs-actions.pod:5612
27288 " guestfs_ping_daemon (guestfs_h *g);\n"
27293 #: ../src/guestfs-actions.pod:5624
27294 msgid "guestfs_pread"
27298 #: ../src/guestfs-actions.pod:5626
27302 " guestfs_pread (guestfs_h *g,\n"
27303 " const char *path,\n"
27305 " int64_t offset,\n"
27306 " size_t *size_r);\n"
27311 #: ../src/guestfs-actions.pod:5639
27312 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27316 #: ../src/guestfs-actions.pod:5650
27317 msgid "guestfs_pread_device"
27321 #: ../src/guestfs-actions.pod:5652
27325 " guestfs_pread_device (guestfs_h *g,\n"
27326 " const char *device,\n"
27328 " int64_t offset,\n"
27329 " size_t *size_r);\n"
27334 #: ../src/guestfs-actions.pod:5665
27335 msgid "See also C<guestfs_pread>."
27339 #: ../src/guestfs-actions.pod:5674
27340 msgid "(Added in 1.5.21)"
27344 #: ../src/guestfs-actions.pod:5676
27345 msgid "guestfs_pvcreate"
27349 #: ../src/guestfs-actions.pod:5678
27353 " guestfs_pvcreate (guestfs_h *g,\n"
27354 " const char *device);\n"
27359 #: ../src/guestfs-actions.pod:5690
27360 msgid "guestfs_pvremove"
27364 #: ../src/guestfs-actions.pod:5692
27368 " guestfs_pvremove (guestfs_h *g,\n"
27369 " const char *device);\n"
27374 #: ../src/guestfs-actions.pod:5707
27375 msgid "guestfs_pvresize"
27379 #: ../src/guestfs-actions.pod:5709
27383 " guestfs_pvresize (guestfs_h *g,\n"
27384 " const char *device);\n"
27389 #: ../src/guestfs-actions.pod:5720
27390 msgid "guestfs_pvresize_size"
27394 #: ../src/guestfs-actions.pod:5722
27398 " guestfs_pvresize_size (guestfs_h *g,\n"
27399 " const char *device,\n"
27400 " int64_t size);\n"
27405 #: ../src/guestfs-actions.pod:5727
27407 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27408 "specify the new size (in bytes) explicitly."
27412 #: ../src/guestfs-actions.pod:5734
27413 msgid "guestfs_pvs"
27417 #: ../src/guestfs-actions.pod:5736
27421 " guestfs_pvs (guestfs_h *g);\n"
27426 #: ../src/guestfs-actions.pod:5745
27427 msgid "See also C<guestfs_pvs_full>."
27431 #: ../src/guestfs-actions.pod:5753
27432 msgid "guestfs_pvs_full"
27436 #: ../src/guestfs-actions.pod:5755
27439 " struct guestfs_lvm_pv_list *\n"
27440 " guestfs_pvs_full (guestfs_h *g);\n"
27445 #: ../src/guestfs-actions.pod:5761
27447 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27448 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
27453 #: ../src/guestfs-actions.pod:5767
27454 msgid "guestfs_pvuuid"
27458 #: ../src/guestfs-actions.pod:5769
27462 " guestfs_pvuuid (guestfs_h *g,\n"
27463 " const char *device);\n"
27468 #: ../src/guestfs-actions.pod:5780
27469 msgid "guestfs_pwrite"
27473 #: ../src/guestfs-actions.pod:5782
27477 " guestfs_pwrite (guestfs_h *g,\n"
27478 " const char *path,\n"
27479 " const char *content,\n"
27480 " size_t content_size,\n"
27481 " int64_t offset);\n"
27486 #: ../src/guestfs-actions.pod:5798
27487 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27491 #: ../src/guestfs-actions.pod:5807
27492 msgid "guestfs_pwrite_device"
27496 #: ../src/guestfs-actions.pod:5809
27500 " guestfs_pwrite_device (guestfs_h *g,\n"
27501 " const char *device,\n"
27502 " const char *content,\n"
27503 " size_t content_size,\n"
27504 " int64_t offset);\n"
27509 #: ../src/guestfs-actions.pod:5824
27510 msgid "See also C<guestfs_pwrite>."
27514 #: ../src/guestfs-actions.pod:5831
27515 msgid "(Added in 1.5.20)"
27519 #: ../src/guestfs-actions.pod:5833
27520 msgid "guestfs_read_file"
27524 #: ../src/guestfs-actions.pod:5835
27528 " guestfs_read_file (guestfs_h *g,\n"
27529 " const char *path,\n"
27530 " size_t *size_r);\n"
27535 #: ../src/guestfs-actions.pod:5843
27537 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27538 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27539 "function is limited in the total size of file that can be handled."
27543 #: ../src/guestfs-actions.pod:5855
27544 msgid "(Added in 1.0.63)"
27548 #: ../src/guestfs-actions.pod:5857
27549 msgid "guestfs_read_lines"
27553 #: ../src/guestfs-actions.pod:5859
27557 " guestfs_read_lines (guestfs_h *g,\n"
27558 " const char *path);\n"
27563 #: ../src/guestfs-actions.pod:5868
27565 "Note that this function cannot correctly handle binary files (specifically, "
27566 "files containing C<\\0> character which is treated as end of line). For "
27567 "those you need to use the C<guestfs_read_file> function which has a more "
27568 "complex interface."
27572 #: ../src/guestfs-actions.pod:5879
27573 msgid "guestfs_readdir"
27577 #: ../src/guestfs-actions.pod:5881
27580 " struct guestfs_dirent_list *\n"
27581 " guestfs_readdir (guestfs_h *g,\n"
27582 " const char *dir);\n"
27587 #: ../src/guestfs-actions.pod:5935
27589 "This function is primarily intended for use by programs. To get a simple "
27590 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27591 "consumption, use C<guestfs_ll>."
27595 #: ../src/guestfs-actions.pod:5939
27597 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27598 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
27603 #: ../src/guestfs-actions.pod:5945
27604 msgid "guestfs_readlink"
27608 #: ../src/guestfs-actions.pod:5947
27612 " guestfs_readlink (guestfs_h *g,\n"
27613 " const char *path);\n"
27618 #: ../src/guestfs-actions.pod:5958
27619 msgid "guestfs_readlinklist"
27623 #: ../src/guestfs-actions.pod:5960
27627 " guestfs_readlinklist (guestfs_h *g,\n"
27628 " const char *path,\n"
27629 " char *const *names);\n"
27634 #: ../src/guestfs-actions.pod:5993
27635 msgid "guestfs_realpath"
27639 #: ../src/guestfs-actions.pod:5995
27643 " guestfs_realpath (guestfs_h *g,\n"
27644 " const char *path);\n"
27649 #: ../src/guestfs-actions.pod:6007
27650 msgid "guestfs_removexattr"
27654 #: ../src/guestfs-actions.pod:6009
27658 " guestfs_removexattr (guestfs_h *g,\n"
27659 " const char *xattr,\n"
27660 " const char *path);\n"
27665 #: ../src/guestfs-actions.pod:6017
27666 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27670 #: ../src/guestfs-actions.pod:6023
27671 msgid "guestfs_resize2fs"
27675 #: ../src/guestfs-actions.pod:6025
27679 " guestfs_resize2fs (guestfs_h *g,\n"
27680 " const char *device);\n"
27685 #: ../src/guestfs-actions.pod:6032
27687 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27688 "C<device> before calling this command. For unknown reasons C<resize2fs> "
27689 "sometimes gives an error about this and sometimes not. In any case, it is "
27690 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27694 #: ../src/guestfs-actions.pod:6042
27695 msgid "guestfs_resize2fs_M"
27699 #: ../src/guestfs-actions.pod:6044
27703 " guestfs_resize2fs_M (guestfs_h *g,\n"
27704 " const char *device);\n"
27709 #: ../src/guestfs-actions.pod:6048
27711 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
27712 "resized to its minimum size. This works like the I<-M> option to the "
27713 "C<resize2fs> command."
27717 #: ../src/guestfs-actions.pod:6052
27719 "To get the resulting size of the filesystem you should call "
27720 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
27721 "These two numbers, multiplied together, give the resulting size of the "
27722 "minimal filesystem in bytes."
27726 #: ../src/guestfs-actions.pod:6061
27727 msgid "guestfs_resize2fs_size"
27731 #: ../src/guestfs-actions.pod:6063
27735 " guestfs_resize2fs_size (guestfs_h *g,\n"
27736 " const char *device,\n"
27737 " int64_t size);\n"
27742 #: ../src/guestfs-actions.pod:6068
27744 "This command is the same as C<guestfs_resize2fs> except that it allows you "
27745 "to specify the new size (in bytes) explicitly."
27749 #: ../src/guestfs-actions.pod:6075
27754 #: ../src/guestfs-actions.pod:6077
27758 " guestfs_rm (guestfs_h *g,\n"
27759 " const char *path);\n"
27764 #: ../src/guestfs-actions.pod:6087
27765 msgid "guestfs_rm_rf"
27769 #: ../src/guestfs-actions.pod:6089
27773 " guestfs_rm_rf (guestfs_h *g,\n"
27774 " const char *path);\n"
27779 #: ../src/guestfs-actions.pod:6101
27780 msgid "guestfs_rmdir"
27784 #: ../src/guestfs-actions.pod:6103
27788 " guestfs_rmdir (guestfs_h *g,\n"
27789 " const char *path);\n"
27794 #: ../src/guestfs-actions.pod:6113
27795 msgid "guestfs_rmmountpoint"
27799 #: ../src/guestfs-actions.pod:6115
27803 " guestfs_rmmountpoint (guestfs_h *g,\n"
27804 " const char *exemptpath);\n"
27809 #: ../src/guestfs-actions.pod:6119
27811 "This calls removes a mountpoint that was previously created with "
27812 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
27816 #: ../src/guestfs-actions.pod:6127
27817 msgid "guestfs_scrub_device"
27821 #: ../src/guestfs-actions.pod:6129
27825 " guestfs_scrub_device (guestfs_h *g,\n"
27826 " const char *device);\n"
27831 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6181
27832 msgid "(Added in 1.0.52)"
27836 #: ../src/guestfs-actions.pod:6146
27837 msgid "guestfs_scrub_file"
27841 #: ../src/guestfs-actions.pod:6148
27845 " guestfs_scrub_file (guestfs_h *g,\n"
27846 " const char *file);\n"
27851 #: ../src/guestfs-actions.pod:6164
27852 msgid "guestfs_scrub_freespace"
27856 #: ../src/guestfs-actions.pod:6166
27860 " guestfs_scrub_freespace (guestfs_h *g,\n"
27861 " const char *dir);\n"
27866 #: ../src/guestfs-actions.pod:6170
27868 "This command creates the directory C<dir> and then fills it with files until "
27869 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
27870 "and deletes them. The intention is to scrub any free space on the partition "
27871 "containing C<dir>."
27875 #: ../src/guestfs-actions.pod:6183
27876 msgid "guestfs_set_append"
27880 #: ../src/guestfs-actions.pod:6185
27884 " guestfs_set_append (guestfs_h *g,\n"
27885 " const char *append);\n"
27890 #: ../src/guestfs-actions.pod:6202
27891 msgid "guestfs_set_attach_method"
27895 #: ../src/guestfs-actions.pod:6204
27899 " guestfs_set_attach_method (guestfs_h *g,\n"
27900 " const char *attachmethod);\n"
27905 #: ../src/guestfs-actions.pod:6232
27906 msgid "guestfs_set_autosync"
27910 #: ../src/guestfs-actions.pod:6234
27914 " guestfs_set_autosync (guestfs_h *g,\n"
27915 " int autosync);\n"
27920 #: ../src/guestfs-actions.pod:6250
27921 msgid "guestfs_set_direct"
27925 #: ../src/guestfs-actions.pod:6252
27929 " guestfs_set_direct (guestfs_h *g,\n"
27935 #: ../src/guestfs-actions.pod:6260
27937 "One consequence of this is that log messages aren't caught by the library "
27938 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
27943 #: ../src/guestfs-actions.pod:6273
27944 msgid "guestfs_set_e2label"
27948 #: ../src/guestfs-actions.pod:6275
27952 " guestfs_set_e2label (guestfs_h *g,\n"
27953 " const char *device,\n"
27954 " const char *label);\n"
27959 #: ../src/guestfs-actions.pod:6284
27961 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
27962 "the existing label on a filesystem."
27966 #: ../src/guestfs-actions.pod:6291
27967 msgid "guestfs_set_e2uuid"
27971 #: ../src/guestfs-actions.pod:6293
27975 " guestfs_set_e2uuid (guestfs_h *g,\n"
27976 " const char *device,\n"
27977 " const char *uuid);\n"
27982 #: ../src/guestfs-actions.pod:6303
27984 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
27985 "the existing UUID of a filesystem."
27989 #: ../src/guestfs-actions.pod:6310
27990 msgid "guestfs_set_memsize"
27994 #: ../src/guestfs-actions.pod:6312
27998 " guestfs_set_memsize (guestfs_h *g,\n"
28004 #: ../src/guestfs-actions.pod:6316
28006 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28007 "This only has any effect if called before C<guestfs_launch>."
28011 #: ../src/guestfs-actions.pod:6331
28012 msgid "guestfs_set_network"
28016 #: ../src/guestfs-actions.pod:6333
28020 " guestfs_set_network (guestfs_h *g,\n"
28026 #: ../src/guestfs-actions.pod:6343
28028 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28033 #: ../src/guestfs-actions.pod:6350
28034 msgid "guestfs_set_path"
28038 #: ../src/guestfs-actions.pod:6352
28042 " guestfs_set_path (guestfs_h *g,\n"
28043 " const char *searchpath);\n"
28048 #: ../src/guestfs-actions.pod:6367
28049 msgid "guestfs_set_pgroup"
28053 #: ../src/guestfs-actions.pod:6369
28057 " guestfs_set_pgroup (guestfs_h *g,\n"
28063 #: ../src/guestfs-actions.pod:6386
28064 msgid "guestfs_set_qemu"
28068 #: ../src/guestfs-actions.pod:6388
28072 " guestfs_set_qemu (guestfs_h *g,\n"
28073 " const char *qemu);\n"
28078 #: ../src/guestfs-actions.pod:6414
28079 msgid "guestfs_set_recovery_proc"
28083 #: ../src/guestfs-actions.pod:6416
28087 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28088 " int recoveryproc);\n"
28093 #: ../src/guestfs-actions.pod:6420
28095 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28096 "not create a recovery process. The purpose of the recovery process is to "
28097 "stop runaway qemu processes in the case where the main program aborts "
28102 #: ../src/guestfs-actions.pod:6425
28104 "This only has any effect if called before C<guestfs_launch>, and the default "
28109 #: ../src/guestfs-actions.pod:6438
28110 msgid "guestfs_set_selinux"
28114 #: ../src/guestfs-actions.pod:6440
28118 " guestfs_set_selinux (guestfs_h *g,\n"
28124 #: ../src/guestfs-actions.pod:6457
28125 msgid "guestfs_set_trace"
28129 #: ../src/guestfs-actions.pod:6459
28133 " guestfs_set_trace (guestfs_h *g,\n"
28139 #: ../src/guestfs-actions.pod:6473
28141 "Trace messages are normally sent to C<stderr>, unless you register a "
28142 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28146 #: ../src/guestfs-actions.pod:6481
28147 msgid "guestfs_set_verbose"
28151 #: ../src/guestfs-actions.pod:6483
28155 " guestfs_set_verbose (guestfs_h *g,\n"
28161 #: ../src/guestfs-actions.pod:6492
28163 "Verbose messages are normally sent to C<stderr>, unless you register a "
28164 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28168 #: ../src/guestfs-actions.pod:6500
28169 msgid "guestfs_setcon"
28173 #: ../src/guestfs-actions.pod:6502
28177 " guestfs_setcon (guestfs_h *g,\n"
28178 " const char *context);\n"
28183 #: ../src/guestfs-actions.pod:6515
28184 msgid "guestfs_setxattr"
28188 #: ../src/guestfs-actions.pod:6517
28192 " guestfs_setxattr (guestfs_h *g,\n"
28193 " const char *xattr,\n"
28194 " const char *val,\n"
28196 " const char *path);\n"
28201 #: ../src/guestfs-actions.pod:6528
28202 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28206 #: ../src/guestfs-actions.pod:6534
28207 msgid "guestfs_sfdisk"
28211 #: ../src/guestfs-actions.pod:6536
28215 " guestfs_sfdisk (guestfs_h *g,\n"
28216 " const char *device,\n"
28220 " char *const *lines);\n"
28225 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6622
28227 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
28232 #: ../src/guestfs-actions.pod:6571
28233 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28237 #: ../src/guestfs-actions.pod:6581
28238 msgid "guestfs_sfdiskM"
28242 #: ../src/guestfs-actions.pod:6583
28246 " guestfs_sfdiskM (guestfs_h *g,\n"
28247 " const char *device,\n"
28248 " char *const *lines);\n"
28253 #: ../src/guestfs-actions.pod:6595
28255 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28256 "partition sizes are specified in megabytes only (rounded to the nearest "
28257 "cylinder) and you don't need to specify the cyls, heads and sectors "
28258 "parameters which were rarely if ever used anyway."
28262 #: ../src/guestfs-actions.pod:6601
28264 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28265 "C<guestfs_part_disk>"
28269 #: ../src/guestfs-actions.pod:6611
28270 msgid "guestfs_sfdisk_N"
28274 #: ../src/guestfs-actions.pod:6613
28278 " guestfs_sfdisk_N (guestfs_h *g,\n"
28279 " const char *device,\n"
28284 " const char *line);\n"
28289 #: ../src/guestfs-actions.pod:6632
28291 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28292 "for the cyls/heads/sectors parameters."
28296 #: ../src/guestfs-actions.pod:6635
28297 msgid "See also: C<guestfs_part_add>"
28301 #: ../src/guestfs-actions.pod:6644
28302 msgid "guestfs_sfdisk_disk_geometry"
28306 #: ../src/guestfs-actions.pod:6646
28310 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28311 " const char *device);\n"
28316 #: ../src/guestfs-actions.pod:6650
28318 "This displays the disk geometry of C<device> read from the partition table. "
28319 "Especially in the case where the underlying block device has been resized, "
28320 "this can be different from the kernel's idea of the geometry (see "
28321 "C<guestfs_sfdisk_kernel_geometry>)."
28325 #: ../src/guestfs-actions.pod:6663
28326 msgid "guestfs_sfdisk_kernel_geometry"
28330 #: ../src/guestfs-actions.pod:6665
28334 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28335 " const char *device);\n"
28340 #: ../src/guestfs-actions.pod:6679
28341 msgid "guestfs_sfdisk_l"
28345 #: ../src/guestfs-actions.pod:6681
28349 " guestfs_sfdisk_l (guestfs_h *g,\n"
28350 " const char *device);\n"
28355 #: ../src/guestfs-actions.pod:6685
28357 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
28362 #: ../src/guestfs-actions.pod:6696
28363 msgid "See also: C<guestfs_part_list>"
28367 #: ../src/guestfs-actions.pod:6703
28372 #: ../src/guestfs-actions.pod:6705
28376 " guestfs_sh (guestfs_h *g,\n"
28377 " const char *command);\n"
28382 #: ../src/guestfs-actions.pod:6712
28383 msgid "This is like C<guestfs_command>, but passes the command to:"
28387 #: ../src/guestfs-actions.pod:6720
28388 msgid "All the provisos about C<guestfs_command> apply to this call."
28392 #: ../src/guestfs-actions.pod:6727
28393 msgid "guestfs_sh_lines"
28397 #: ../src/guestfs-actions.pod:6729
28401 " guestfs_sh_lines (guestfs_h *g,\n"
28402 " const char *command);\n"
28407 #: ../src/guestfs-actions.pod:6733
28409 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28414 #: ../src/guestfs-actions.pod:6736
28415 msgid "See also: C<guestfs_command_lines>"
28419 #: ../src/guestfs-actions.pod:6744
28420 msgid "guestfs_sleep"
28424 #: ../src/guestfs-actions.pod:6746
28428 " guestfs_sleep (guestfs_h *g,\n"
28434 #: ../src/guestfs-actions.pod:6754
28435 msgid "(Added in 1.0.41)"
28439 #: ../src/guestfs-actions.pod:6756 ../src/guestfs-structs.pod:109
28440 msgid "guestfs_stat"
28444 #: ../src/guestfs-actions.pod:6758
28447 " struct guestfs_stat *\n"
28448 " guestfs_stat (guestfs_h *g,\n"
28449 " const char *path);\n"
28454 #: ../src/guestfs-actions.pod:6772 ../src/guestfs-structs.pod:135
28455 msgid "guestfs_statvfs"
28459 #: ../src/guestfs-actions.pod:6774
28462 " struct guestfs_statvfs *\n"
28463 " guestfs_statvfs (guestfs_h *g,\n"
28464 " const char *path);\n"
28469 #: ../src/guestfs-actions.pod:6784
28471 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28472 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28476 #: ../src/guestfs-actions.pod:6790
28477 msgid "guestfs_strings"
28481 #: ../src/guestfs-actions.pod:6792
28485 " guestfs_strings (guestfs_h *g,\n"
28486 " const char *path);\n"
28491 #: ../src/guestfs-actions.pod:6808
28492 msgid "guestfs_strings_e"
28496 #: ../src/guestfs-actions.pod:6810
28500 " guestfs_strings_e (guestfs_h *g,\n"
28501 " const char *encoding,\n"
28502 " const char *path);\n"
28507 #: ../src/guestfs-actions.pod:6815
28509 "This is like the C<guestfs_strings> command, but allows you to specify the "
28510 "encoding of strings that are looked for in the source file C<path>."
28514 #: ../src/guestfs-actions.pod:6825
28516 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28517 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28521 #: ../src/guestfs-actions.pod:6863
28522 msgid "guestfs_swapoff_device"
28526 #: ../src/guestfs-actions.pod:6865
28530 " guestfs_swapoff_device (guestfs_h *g,\n"
28531 " const char *device);\n"
28536 #: ../src/guestfs-actions.pod:6869
28538 "This command disables the libguestfs appliance swap device or partition "
28539 "named C<device>. See C<guestfs_swapon_device>."
28543 #: ../src/guestfs-actions.pod:6877
28544 msgid "guestfs_swapoff_file"
28548 #: ../src/guestfs-actions.pod:6879
28552 " guestfs_swapoff_file (guestfs_h *g,\n"
28553 " const char *file);\n"
28558 #: ../src/guestfs-actions.pod:6889
28559 msgid "guestfs_swapoff_label"
28563 #: ../src/guestfs-actions.pod:6891
28567 " guestfs_swapoff_label (guestfs_h *g,\n"
28568 " const char *label);\n"
28573 #: ../src/guestfs-actions.pod:6902
28574 msgid "guestfs_swapoff_uuid"
28578 #: ../src/guestfs-actions.pod:6904
28582 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28583 " const char *uuid);\n"
28588 #: ../src/guestfs-actions.pod:6915
28589 msgid "guestfs_swapon_device"
28593 #: ../src/guestfs-actions.pod:6917
28597 " guestfs_swapon_device (guestfs_h *g,\n"
28598 " const char *device);\n"
28603 #: ../src/guestfs-actions.pod:6921
28605 "This command enables the libguestfs appliance to use the swap device or "
28606 "partition named C<device>. The increased memory is made available for all "
28607 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28611 #: ../src/guestfs-actions.pod:6937
28612 msgid "guestfs_swapon_file"
28616 #: ../src/guestfs-actions.pod:6939
28620 " guestfs_swapon_file (guestfs_h *g,\n"
28621 " const char *file);\n"
28626 #: ../src/guestfs-actions.pod:6943
28628 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28633 #: ../src/guestfs-actions.pod:6950
28634 msgid "guestfs_swapon_label"
28638 #: ../src/guestfs-actions.pod:6952
28642 " guestfs_swapon_label (guestfs_h *g,\n"
28643 " const char *label);\n"
28648 #: ../src/guestfs-actions.pod:6956
28650 "This command enables swap to a labeled swap partition. See "
28651 "C<guestfs_swapon_device> for other notes."
28655 #: ../src/guestfs-actions.pod:6963
28656 msgid "guestfs_swapon_uuid"
28660 #: ../src/guestfs-actions.pod:6965
28664 " guestfs_swapon_uuid (guestfs_h *g,\n"
28665 " const char *uuid);\n"
28670 #: ../src/guestfs-actions.pod:6969
28672 "This command enables swap to a swap partition with the given UUID. See "
28673 "C<guestfs_swapon_device> for other notes."
28677 #: ../src/guestfs-actions.pod:6976
28678 msgid "guestfs_sync"
28682 #: ../src/guestfs-actions.pod:6978
28686 " guestfs_sync (guestfs_h *g);\n"
28691 #: ../src/guestfs-actions.pod:6991
28692 msgid "guestfs_tail"
28696 #: ../src/guestfs-actions.pod:6993
28700 " guestfs_tail (guestfs_h *g,\n"
28701 " const char *path);\n"
28706 #: ../src/guestfs-actions.pod:7009
28707 msgid "guestfs_tail_n"
28711 #: ../src/guestfs-actions.pod:7011
28715 " guestfs_tail_n (guestfs_h *g,\n"
28717 " const char *path);\n"
28722 #: ../src/guestfs-actions.pod:7033
28723 msgid "guestfs_tar_in"
28727 #: ../src/guestfs-actions.pod:7035
28731 " guestfs_tar_in (guestfs_h *g,\n"
28732 " const char *tarfile,\n"
28733 " const char *directory);\n"
28738 #: ../src/guestfs-actions.pod:7043
28739 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
28743 #: ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7065 ../src/guestfs-actions.pod:7081 ../src/guestfs-actions.pod:7097
28744 msgid "(Added in 1.0.3)"
28748 #: ../src/guestfs-actions.pod:7050
28749 msgid "guestfs_tar_out"
28753 #: ../src/guestfs-actions.pod:7052
28757 " guestfs_tar_out (guestfs_h *g,\n"
28758 " const char *directory,\n"
28759 " const char *tarfile);\n"
28764 #: ../src/guestfs-actions.pod:7060
28766 "To download a compressed tarball, use C<guestfs_tgz_out> or "
28767 "C<guestfs_txz_out>."
28771 #: ../src/guestfs-actions.pod:7067
28772 msgid "guestfs_tgz_in"
28776 #: ../src/guestfs-actions.pod:7069
28780 " guestfs_tgz_in (guestfs_h *g,\n"
28781 " const char *tarball,\n"
28782 " const char *directory);\n"
28787 #: ../src/guestfs-actions.pod:7077
28788 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
28792 #: ../src/guestfs-actions.pod:7083
28793 msgid "guestfs_tgz_out"
28797 #: ../src/guestfs-actions.pod:7085
28801 " guestfs_tgz_out (guestfs_h *g,\n"
28802 " const char *directory,\n"
28803 " const char *tarball);\n"
28808 #: ../src/guestfs-actions.pod:7093
28809 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
28813 #: ../src/guestfs-actions.pod:7099
28814 msgid "guestfs_touch"
28818 #: ../src/guestfs-actions.pod:7101
28822 " guestfs_touch (guestfs_h *g,\n"
28823 " const char *path);\n"
28828 #: ../src/guestfs-actions.pod:7116
28829 msgid "guestfs_truncate"
28833 #: ../src/guestfs-actions.pod:7118
28837 " guestfs_truncate (guestfs_h *g,\n"
28838 " const char *path);\n"
28843 #: ../src/guestfs-actions.pod:7129
28844 msgid "guestfs_truncate_size"
28848 #: ../src/guestfs-actions.pod:7131
28852 " guestfs_truncate_size (guestfs_h *g,\n"
28853 " const char *path,\n"
28854 " int64_t size);\n"
28859 #: ../src/guestfs-actions.pod:7139
28861 "If the current file size is less than C<size> then the file is extended to "
28862 "the required size with zero bytes. This creates a sparse file (ie. disk "
28863 "blocks are not allocated for the file until you write to it). To create a "
28864 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
28868 #: ../src/guestfs-actions.pod:7149
28869 msgid "guestfs_tune2fs_l"
28873 #: ../src/guestfs-actions.pod:7151
28877 " guestfs_tune2fs_l (guestfs_h *g,\n"
28878 " const char *device);\n"
28883 #: ../src/guestfs-actions.pod:7171
28884 msgid "guestfs_txz_in"
28888 #: ../src/guestfs-actions.pod:7173
28892 " guestfs_txz_in (guestfs_h *g,\n"
28893 " const char *tarball,\n"
28894 " const char *directory);\n"
28899 #: ../src/guestfs-actions.pod:7185
28900 msgid "guestfs_txz_out"
28904 #: ../src/guestfs-actions.pod:7187
28908 " guestfs_txz_out (guestfs_h *g,\n"
28909 " const char *directory,\n"
28910 " const char *tarball);\n"
28915 #: ../src/guestfs-actions.pod:7199
28916 msgid "guestfs_umask"
28920 #: ../src/guestfs-actions.pod:7201
28924 " guestfs_umask (guestfs_h *g,\n"
28930 #: ../src/guestfs-actions.pod:7217
28932 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
28933 "C<guestfs_mkdir>."
28937 #: ../src/guestfs-actions.pod:7226
28938 msgid "guestfs_umount"
28942 #: ../src/guestfs-actions.pod:7228
28946 " guestfs_umount (guestfs_h *g,\n"
28947 " const char *pathordevice);\n"
28952 #: ../src/guestfs-actions.pod:7240
28953 msgid "guestfs_umount_all"
28957 #: ../src/guestfs-actions.pod:7242
28961 " guestfs_umount_all (guestfs_h *g);\n"
28966 #: ../src/guestfs-actions.pod:7253
28967 msgid "guestfs_upload"
28971 #: ../src/guestfs-actions.pod:7255
28975 " guestfs_upload (guestfs_h *g,\n"
28976 " const char *filename,\n"
28977 " const char *remotefilename);\n"
28982 #: ../src/guestfs-actions.pod:7265
28983 msgid "See also C<guestfs_download>."
28987 #: ../src/guestfs-actions.pod:7276
28988 msgid "guestfs_upload_offset"
28992 #: ../src/guestfs-actions.pod:7278
28996 " guestfs_upload_offset (guestfs_h *g,\n"
28997 " const char *filename,\n"
28998 " const char *remotefilename,\n"
28999 " int64_t offset);\n"
29004 #: ../src/guestfs-actions.pod:7294
29006 "Note that there is no limit on the amount of data that can be uploaded with "
29007 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29008 "full amount unless an error occurs."
29012 #: ../src/guestfs-actions.pod:7299
29013 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29017 #: ../src/guestfs-actions.pod:7310
29018 msgid "guestfs_utimens"
29022 #: ../src/guestfs-actions.pod:7312
29026 " guestfs_utimens (guestfs_h *g,\n"
29027 " const char *path,\n"
29028 " int64_t atsecs,\n"
29029 " int64_t atnsecs,\n"
29030 " int64_t mtsecs,\n"
29031 " int64_t mtnsecs);\n"
29036 #: ../src/guestfs-actions.pod:7341 ../src/guestfs-structs.pod:175
29037 msgid "guestfs_version"
29041 #: ../src/guestfs-actions.pod:7343
29044 " struct guestfs_version *\n"
29045 " guestfs_version (guestfs_h *g);\n"
29050 #: ../src/guestfs-actions.pod:7371
29052 "I<Note:> Don't use this call to test for availability of features. In "
29053 "enterprise distributions we backport features from later versions into "
29054 "earlier versions, making this an unreliable way to test for features. Use "
29055 "C<guestfs_available> instead."
29059 #: ../src/guestfs-actions.pod:7377
29061 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29062 "error. I<The caller must call C<guestfs_free_version> after use>."
29066 #: ../src/guestfs-actions.pod:7381
29067 msgid "(Added in 1.0.58)"
29071 #: ../src/guestfs-actions.pod:7383
29072 msgid "guestfs_vfs_label"
29076 #: ../src/guestfs-actions.pod:7385
29080 " guestfs_vfs_label (guestfs_h *g,\n"
29081 " const char *device);\n"
29086 #: ../src/guestfs-actions.pod:7394
29087 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29091 #: ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7436
29092 msgid "(Added in 1.3.18)"
29096 #: ../src/guestfs-actions.pod:7401
29097 msgid "guestfs_vfs_type"
29101 #: ../src/guestfs-actions.pod:7403
29105 " guestfs_vfs_type (guestfs_h *g,\n"
29106 " const char *device);\n"
29111 #: ../src/guestfs-actions.pod:7420
29112 msgid "guestfs_vfs_uuid"
29116 #: ../src/guestfs-actions.pod:7422
29120 " guestfs_vfs_uuid (guestfs_h *g,\n"
29121 " const char *device);\n"
29126 #: ../src/guestfs-actions.pod:7431
29127 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29131 #: ../src/guestfs-actions.pod:7438
29132 msgid "guestfs_vg_activate"
29136 #: ../src/guestfs-actions.pod:7440
29140 " guestfs_vg_activate (guestfs_h *g,\n"
29142 " char *const *volgroups);\n"
29147 #: ../src/guestfs-actions.pod:7457
29148 msgid "guestfs_vg_activate_all"
29152 #: ../src/guestfs-actions.pod:7459
29156 " guestfs_vg_activate_all (guestfs_h *g,\n"
29157 " int activate);\n"
29162 #: ../src/guestfs-actions.pod:7472
29163 msgid "guestfs_vgcreate"
29167 #: ../src/guestfs-actions.pod:7474
29171 " guestfs_vgcreate (guestfs_h *g,\n"
29172 " const char *volgroup,\n"
29173 " char *const *physvols);\n"
29178 #: ../src/guestfs-actions.pod:7486
29179 msgid "guestfs_vglvuuids"
29183 #: ../src/guestfs-actions.pod:7488
29187 " guestfs_vglvuuids (guestfs_h *g,\n"
29188 " const char *vgname);\n"
29193 #: ../src/guestfs-actions.pod:7495
29195 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29196 "associate logical volumes and volume groups."
29200 #: ../src/guestfs-actions.pod:7498
29201 msgid "See also C<guestfs_vgpvuuids>."
29205 #: ../src/guestfs-actions.pod:7506
29206 msgid "guestfs_vgpvuuids"
29210 #: ../src/guestfs-actions.pod:7508
29214 " guestfs_vgpvuuids (guestfs_h *g,\n"
29215 " const char *vgname);\n"
29220 #: ../src/guestfs-actions.pod:7515
29222 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29223 "associate physical volumes and volume groups."
29227 #: ../src/guestfs-actions.pod:7518
29228 msgid "See also C<guestfs_vglvuuids>."
29232 #: ../src/guestfs-actions.pod:7526
29233 msgid "guestfs_vgremove"
29237 #: ../src/guestfs-actions.pod:7528
29241 " guestfs_vgremove (guestfs_h *g,\n"
29242 " const char *vgname);\n"
29247 #: ../src/guestfs-actions.pod:7541
29248 msgid "guestfs_vgrename"
29252 #: ../src/guestfs-actions.pod:7543
29256 " guestfs_vgrename (guestfs_h *g,\n"
29257 " const char *volgroup,\n"
29258 " const char *newvolgroup);\n"
29263 #: ../src/guestfs-actions.pod:7554
29264 msgid "guestfs_vgs"
29268 #: ../src/guestfs-actions.pod:7556
29272 " guestfs_vgs (guestfs_h *g);\n"
29277 #: ../src/guestfs-actions.pod:7565
29278 msgid "See also C<guestfs_vgs_full>."
29282 #: ../src/guestfs-actions.pod:7573
29283 msgid "guestfs_vgs_full"
29287 #: ../src/guestfs-actions.pod:7575
29290 " struct guestfs_lvm_vg_list *\n"
29291 " guestfs_vgs_full (guestfs_h *g);\n"
29296 #: ../src/guestfs-actions.pod:7581
29298 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29299 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
29304 #: ../src/guestfs-actions.pod:7587
29305 msgid "guestfs_vgscan"
29309 #: ../src/guestfs-actions.pod:7589
29313 " guestfs_vgscan (guestfs_h *g);\n"
29318 #: ../src/guestfs-actions.pod:7599
29319 msgid "guestfs_vguuid"
29323 #: ../src/guestfs-actions.pod:7601
29327 " guestfs_vguuid (guestfs_h *g,\n"
29328 " const char *vgname);\n"
29333 #: ../src/guestfs-actions.pod:7612
29334 msgid "guestfs_wait_ready"
29338 #: ../src/guestfs-actions.pod:7614
29342 " guestfs_wait_ready (guestfs_h *g);\n"
29347 #: ../src/guestfs-actions.pod:7617
29349 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
29354 #: ../src/guestfs-actions.pod:7624
29355 msgid "This function is a no op."
29359 #: ../src/guestfs-actions.pod:7626
29361 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29362 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29363 "is no longer necessary because C<guestfs_launch> now does the waiting."
29367 #: ../src/guestfs-actions.pod:7631
29369 "If you see any calls to this function in code then you can just remove them, "
29370 "unless you want to retain compatibility with older versions of the API."
29374 #: ../src/guestfs-actions.pod:7639
29375 msgid "guestfs_wc_c"
29379 #: ../src/guestfs-actions.pod:7641
29383 " guestfs_wc_c (guestfs_h *g,\n"
29384 " const char *path);\n"
29389 #: ../src/guestfs-actions.pod:7652
29390 msgid "guestfs_wc_l"
29394 #: ../src/guestfs-actions.pod:7654
29398 " guestfs_wc_l (guestfs_h *g,\n"
29399 " const char *path);\n"
29404 #: ../src/guestfs-actions.pod:7665
29405 msgid "guestfs_wc_w"
29409 #: ../src/guestfs-actions.pod:7667
29413 " guestfs_wc_w (guestfs_h *g,\n"
29414 " const char *path);\n"
29419 #: ../src/guestfs-actions.pod:7678
29420 msgid "guestfs_write"
29424 #: ../src/guestfs-actions.pod:7680
29428 " guestfs_write (guestfs_h *g,\n"
29429 " const char *path,\n"
29430 " const char *content,\n"
29431 " size_t content_size);\n"
29436 #: ../src/guestfs-actions.pod:7689
29437 msgid "See also C<guestfs_write_append>."
29441 #: ../src/guestfs-actions.pod:7698
29442 msgid "guestfs_write_append"
29446 #: ../src/guestfs-actions.pod:7700
29450 " guestfs_write_append (guestfs_h *g,\n"
29451 " const char *path,\n"
29452 " const char *content,\n"
29453 " size_t content_size);\n"
29458 #: ../src/guestfs-actions.pod:7709
29459 msgid "See also C<guestfs_write>."
29463 #: ../src/guestfs-actions.pod:7718
29464 msgid "guestfs_write_file"
29468 #: ../src/guestfs-actions.pod:7720
29472 " guestfs_write_file (guestfs_h *g,\n"
29473 " const char *path,\n"
29474 " const char *content,\n"
29480 #: ../src/guestfs-actions.pod:7726
29482 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
29487 #: ../src/guestfs-actions.pod:7751
29488 msgid "guestfs_zegrep"
29492 #: ../src/guestfs-actions.pod:7753
29496 " guestfs_zegrep (guestfs_h *g,\n"
29497 " const char *regex,\n"
29498 " const char *path);\n"
29503 #: ../src/guestfs-actions.pod:7770
29504 msgid "guestfs_zegrepi"
29508 #: ../src/guestfs-actions.pod:7772
29512 " guestfs_zegrepi (guestfs_h *g,\n"
29513 " const char *regex,\n"
29514 " const char *path);\n"
29519 #: ../src/guestfs-actions.pod:7789
29520 msgid "guestfs_zero"
29524 #: ../src/guestfs-actions.pod:7791
29528 " guestfs_zero (guestfs_h *g,\n"
29529 " const char *device);\n"
29534 #: ../src/guestfs-actions.pod:7805
29536 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29537 "C<guestfs_is_zero_device>"
29541 #: ../src/guestfs-actions.pod:7817
29542 msgid "guestfs_zero_device"
29546 #: ../src/guestfs-actions.pod:7819
29550 " guestfs_zero_device (guestfs_h *g,\n"
29551 " const char *device);\n"
29556 #: ../src/guestfs-actions.pod:7823
29558 "This command writes zeroes over the entire C<device>. Compare with "
29559 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29563 #: ../src/guestfs-actions.pod:7841
29564 msgid "(Added in 1.3.1)"
29568 #: ../src/guestfs-actions.pod:7843
29569 msgid "guestfs_zerofree"
29573 #: ../src/guestfs-actions.pod:7845
29577 " guestfs_zerofree (guestfs_h *g,\n"
29578 " const char *device);\n"
29583 #: ../src/guestfs-actions.pod:7864
29584 msgid "guestfs_zfgrep"
29588 #: ../src/guestfs-actions.pod:7866
29592 " guestfs_zfgrep (guestfs_h *g,\n"
29593 " const char *pattern,\n"
29594 " const char *path);\n"
29599 #: ../src/guestfs-actions.pod:7883
29600 msgid "guestfs_zfgrepi"
29604 #: ../src/guestfs-actions.pod:7885
29608 " guestfs_zfgrepi (guestfs_h *g,\n"
29609 " const char *pattern,\n"
29610 " const char *path);\n"
29615 #: ../src/guestfs-actions.pod:7902
29616 msgid "guestfs_zfile"
29620 #: ../src/guestfs-actions.pod:7904
29624 " guestfs_zfile (guestfs_h *g,\n"
29625 " const char *meth,\n"
29626 " const char *path);\n"
29631 #: ../src/guestfs-actions.pod:7909
29633 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
29638 #: ../src/guestfs-actions.pod:7921
29640 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29645 #: ../src/guestfs-actions.pod:7929
29646 msgid "guestfs_zgrep"
29650 #: ../src/guestfs-actions.pod:7931
29654 " guestfs_zgrep (guestfs_h *g,\n"
29655 " const char *regex,\n"
29656 " const char *path);\n"
29661 #: ../src/guestfs-actions.pod:7948
29662 msgid "guestfs_zgrepi"
29666 #: ../src/guestfs-actions.pod:7950
29670 " guestfs_zgrepi (guestfs_h *g,\n"
29671 " const char *regex,\n"
29672 " const char *path);\n"
29677 #: ../src/guestfs-availability.pod:3
29682 #: ../src/guestfs-availability.pod:5
29684 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29685 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29686 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29687 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29688 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29692 #: ../src/guestfs-availability.pod:21
29697 #: ../src/guestfs-availability.pod:23
29698 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
29702 #: ../src/guestfs-availability.pod:26
29707 #: ../src/guestfs-availability.pod:28
29708 msgid "The following functions: L</guestfs_grub_install>"
29712 #: ../src/guestfs-availability.pod:31
29717 #: ../src/guestfs-availability.pod:33
29719 "The following functions: L</guestfs_inotify_add_watch> "
29720 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
29721 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
29725 #: ../src/guestfs-availability.pod:41
29726 msgid "B<linuxfsuuid>"
29730 #: ../src/guestfs-availability.pod:43
29732 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
29733 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
29737 #: ../src/guestfs-availability.pod:50
29738 msgid "B<linuxmodules>"
29742 #: ../src/guestfs-availability.pod:52
29743 msgid "The following functions: L</guestfs_modprobe>"
29747 #: ../src/guestfs-availability.pod:55
29748 msgid "B<linuxxattrs>"
29752 #: ../src/guestfs-availability.pod:57
29754 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
29755 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
29756 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
29757 "L</guestfs_setxattr>"
29761 #: ../src/guestfs-availability.pod:68
29766 #: ../src/guestfs-availability.pod:70
29768 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
29769 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
29770 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
29774 #: ../src/guestfs-availability.pod:79
29779 #: ../src/guestfs-availability.pod:81
29781 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
29782 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
29783 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
29784 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
29785 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
29786 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
29787 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
29788 "L</guestfs_vgs_full>"
29792 #: ../src/guestfs-availability.pod:104
29797 #: ../src/guestfs-availability.pod:106
29799 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
29800 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
29804 #: ../src/guestfs-availability.pod:112
29809 #: ../src/guestfs-availability.pod:114
29810 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
29814 #: ../src/guestfs-availability.pod:117
29815 msgid "B<ntfsprogs>"
29819 #: ../src/guestfs-availability.pod:119
29821 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
29822 "L</guestfs_ntfsresize_size>"
29826 #: ../src/guestfs-availability.pod:124
29827 msgid "B<realpath>"
29831 #: ../src/guestfs-availability.pod:126
29832 msgid "The following functions: L</guestfs_realpath>"
29836 #: ../src/guestfs-availability.pod:129
29841 #: ../src/guestfs-availability.pod:131
29843 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
29844 "L</guestfs_scrub_freespace>"
29848 #: ../src/guestfs-availability.pod:136
29853 #: ../src/guestfs-availability.pod:138
29854 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
29858 #: ../src/guestfs-availability.pod:142
29863 #: ../src/guestfs-availability.pod:144
29864 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
29868 #: ../src/guestfs-availability.pod:148
29869 msgid "B<zerofree>"
29873 #: ../src/guestfs-availability.pod:150
29874 msgid "The following functions: L</guestfs_zerofree>"
29878 #: ../src/guestfs-structs.pod:1
29879 msgid "guestfs_int_bool"
29883 #: ../src/guestfs-structs.pod:3
29886 " struct guestfs_int_bool {\n"
29894 #: ../src/guestfs-structs.pod:8
29897 " struct guestfs_int_bool_list {\n"
29898 " uint32_t len; /* Number of elements in list. */\n"
29899 " struct guestfs_int_bool *val; /* Elements. */\n"
29905 #: ../src/guestfs-structs.pod:13
29908 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
29909 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
29914 #: ../src/guestfs-structs.pod:16
29915 msgid "guestfs_lvm_pv"
29919 #: ../src/guestfs-structs.pod:18
29922 " struct guestfs_lvm_pv {\n"
29923 " char *pv_name;\n"
29924 " /* The next field is NOT nul-terminated, be careful when printing it: "
29926 " char pv_uuid[32];\n"
29928 " uint64_t pv_size;\n"
29929 " uint64_t dev_size;\n"
29930 " uint64_t pv_free;\n"
29931 " uint64_t pv_used;\n"
29932 " char *pv_attr;\n"
29933 " int64_t pv_pe_count;\n"
29934 " int64_t pv_pe_alloc_count;\n"
29935 " char *pv_tags;\n"
29936 " uint64_t pe_start;\n"
29937 " int64_t pv_mda_count;\n"
29938 " uint64_t pv_mda_free;\n"
29944 #: ../src/guestfs-structs.pod:36
29947 " struct guestfs_lvm_pv_list {\n"
29948 " uint32_t len; /* Number of elements in list. */\n"
29949 " struct guestfs_lvm_pv *val; /* Elements. */\n"
29955 #: ../src/guestfs-structs.pod:41
29958 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
29959 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
29964 #: ../src/guestfs-structs.pod:44
29965 msgid "guestfs_lvm_vg"
29969 #: ../src/guestfs-structs.pod:46
29972 " struct guestfs_lvm_vg {\n"
29973 " char *vg_name;\n"
29974 " /* The next field is NOT nul-terminated, be careful when printing it: "
29976 " char vg_uuid[32];\n"
29978 " char *vg_attr;\n"
29979 " uint64_t vg_size;\n"
29980 " uint64_t vg_free;\n"
29981 " char *vg_sysid;\n"
29982 " uint64_t vg_extent_size;\n"
29983 " int64_t vg_extent_count;\n"
29984 " int64_t vg_free_count;\n"
29985 " int64_t max_lv;\n"
29986 " int64_t max_pv;\n"
29987 " int64_t pv_count;\n"
29988 " int64_t lv_count;\n"
29989 " int64_t snap_count;\n"
29990 " int64_t vg_seqno;\n"
29991 " char *vg_tags;\n"
29992 " int64_t vg_mda_count;\n"
29993 " uint64_t vg_mda_free;\n"
29999 #: ../src/guestfs-structs.pod:69
30002 " struct guestfs_lvm_vg_list {\n"
30003 " uint32_t len; /* Number of elements in list. */\n"
30004 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30010 #: ../src/guestfs-structs.pod:74
30013 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30014 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30019 #: ../src/guestfs-structs.pod:77
30020 msgid "guestfs_lvm_lv"
30024 #: ../src/guestfs-structs.pod:79
30027 " struct guestfs_lvm_lv {\n"
30028 " char *lv_name;\n"
30029 " /* The next field is NOT nul-terminated, be careful when printing it: "
30031 " char lv_uuid[32];\n"
30032 " char *lv_attr;\n"
30033 " int64_t lv_major;\n"
30034 " int64_t lv_minor;\n"
30035 " int64_t lv_kernel_major;\n"
30036 " int64_t lv_kernel_minor;\n"
30037 " uint64_t lv_size;\n"
30038 " int64_t seg_count;\n"
30040 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30041 " float snap_percent;\n"
30042 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30043 " float copy_percent;\n"
30044 " char *move_pv;\n"
30045 " char *lv_tags;\n"
30046 " char *mirror_log;\n"
30047 " char *modules;\n"
30053 #: ../src/guestfs-structs.pod:101
30056 " struct guestfs_lvm_lv_list {\n"
30057 " uint32_t len; /* Number of elements in list. */\n"
30058 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30064 #: ../src/guestfs-structs.pod:106
30067 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30068 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30073 #: ../src/guestfs-structs.pod:111
30076 " struct guestfs_stat {\n"
30080 " int64_t nlink;\n"
30085 " int64_t blksize;\n"
30086 " int64_t blocks;\n"
30087 " int64_t atime;\n"
30088 " int64_t mtime;\n"
30089 " int64_t ctime;\n"
30095 #: ../src/guestfs-structs.pod:127
30098 " struct guestfs_stat_list {\n"
30099 " uint32_t len; /* Number of elements in list. */\n"
30100 " struct guestfs_stat *val; /* Elements. */\n"
30106 #: ../src/guestfs-structs.pod:132
30109 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30110 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30115 #: ../src/guestfs-structs.pod:137
30118 " struct guestfs_statvfs {\n"
30119 " int64_t bsize;\n"
30120 " int64_t frsize;\n"
30121 " int64_t blocks;\n"
30122 " int64_t bfree;\n"
30123 " int64_t bavail;\n"
30124 " int64_t files;\n"
30125 " int64_t ffree;\n"
30126 " int64_t favail;\n"
30129 " int64_t namemax;\n"
30135 #: ../src/guestfs-structs.pod:151
30138 " struct guestfs_statvfs_list {\n"
30139 " uint32_t len; /* Number of elements in list. */\n"
30140 " struct guestfs_statvfs *val; /* Elements. */\n"
30146 #: ../src/guestfs-structs.pod:156
30149 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30150 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30155 #: ../src/guestfs-structs.pod:159
30156 msgid "guestfs_dirent"
30160 #: ../src/guestfs-structs.pod:161
30163 " struct guestfs_dirent {\n"
30172 #: ../src/guestfs-structs.pod:167
30175 " struct guestfs_dirent_list {\n"
30176 " uint32_t len; /* Number of elements in list. */\n"
30177 " struct guestfs_dirent *val; /* Elements. */\n"
30183 #: ../src/guestfs-structs.pod:172
30186 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30187 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30192 #: ../src/guestfs-structs.pod:177
30195 " struct guestfs_version {\n"
30196 " int64_t major;\n"
30197 " int64_t minor;\n"
30198 " int64_t release;\n"
30205 #: ../src/guestfs-structs.pod:184
30208 " struct guestfs_version_list {\n"
30209 " uint32_t len; /* Number of elements in list. */\n"
30210 " struct guestfs_version *val; /* Elements. */\n"
30216 #: ../src/guestfs-structs.pod:189
30219 " void guestfs_free_version (struct guestfs_free_version *);\n"
30220 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30225 #: ../src/guestfs-structs.pod:192
30226 msgid "guestfs_xattr"
30230 #: ../src/guestfs-structs.pod:194
30233 " struct guestfs_xattr {\n"
30234 " char *attrname;\n"
30235 " /* The next two fields describe a byte array. */\n"
30236 " uint32_t attrval_len;\n"
30237 " char *attrval;\n"
30243 #: ../src/guestfs-structs.pod:201
30246 " struct guestfs_xattr_list {\n"
30247 " uint32_t len; /* Number of elements in list. */\n"
30248 " struct guestfs_xattr *val; /* Elements. */\n"
30254 #: ../src/guestfs-structs.pod:206
30257 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30258 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30263 #: ../src/guestfs-structs.pod:209
30264 msgid "guestfs_inotify_event"
30268 #: ../src/guestfs-structs.pod:211
30271 " struct guestfs_inotify_event {\n"
30272 " int64_t in_wd;\n"
30273 " uint32_t in_mask;\n"
30274 " uint32_t in_cookie;\n"
30275 " char *in_name;\n"
30281 #: ../src/guestfs-structs.pod:218
30284 " struct guestfs_inotify_event_list {\n"
30285 " uint32_t len; /* Number of elements in list. */\n"
30286 " struct guestfs_inotify_event *val; /* Elements. */\n"
30292 #: ../src/guestfs-structs.pod:223
30295 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30296 " void guestfs_free_inotify_event_list (struct "
30297 "guestfs_free_inotify_event_list *);\n"
30302 #: ../src/guestfs-structs.pod:226
30303 msgid "guestfs_partition"
30307 #: ../src/guestfs-structs.pod:228
30310 " struct guestfs_partition {\n"
30311 " int32_t part_num;\n"
30312 " uint64_t part_start;\n"
30313 " uint64_t part_end;\n"
30314 " uint64_t part_size;\n"
30320 #: ../src/guestfs-structs.pod:235
30323 " struct guestfs_partition_list {\n"
30324 " uint32_t len; /* Number of elements in list. */\n"
30325 " struct guestfs_partition *val; /* Elements. */\n"
30331 #: ../src/guestfs-structs.pod:240
30334 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30335 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30340 #: ../src/guestfs-structs.pod:243
30341 msgid "guestfs_application"
30345 #: ../src/guestfs-structs.pod:245
30348 " struct guestfs_application {\n"
30349 " char *app_name;\n"
30350 " char *app_display_name;\n"
30351 " int32_t app_epoch;\n"
30352 " char *app_version;\n"
30353 " char *app_release;\n"
30354 " char *app_install_path;\n"
30355 " char *app_trans_path;\n"
30356 " char *app_publisher;\n"
30357 " char *app_url;\n"
30358 " char *app_source_package;\n"
30359 " char *app_summary;\n"
30360 " char *app_description;\n"
30366 #: ../src/guestfs-structs.pod:260
30369 " struct guestfs_application_list {\n"
30370 " uint32_t len; /* Number of elements in list. */\n"
30371 " struct guestfs_application *val; /* Elements. */\n"
30377 #: ../src/guestfs-structs.pod:265
30380 " void guestfs_free_application (struct guestfs_free_application *);\n"
30381 " void guestfs_free_application_list (struct guestfs_free_application_list "
30387 #: ../src/guestfs.pod:5
30388 msgid "guestfs - Library for accessing and modifying virtual machine images"
30392 #: ../src/guestfs.pod:11
30395 " guestfs_h *g = guestfs_create ();\n"
30396 " guestfs_add_drive (g, \"guest.img\");\n"
30397 " guestfs_launch (g);\n"
30398 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30399 " guestfs_touch (g, \"/hello\");\n"
30400 " guestfs_umount (g, \"/\");\n"
30401 " guestfs_close (g);\n"
30406 #: ../src/guestfs.pod:25
30408 "Libguestfs is a library for accessing and modifying guest disk images. "
30409 "Amongst the things this is good for: making batch configuration changes to "
30410 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30411 "between virtualization systems (see also: virt-p2v), performing partial "
30412 "backups, performing partial guest clones, cloning guests and changing "
30413 "registry/UUID/hostname info, and much else besides."
30417 #: ../src/guestfs.pod:33
30419 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30420 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30421 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30426 #: ../src/guestfs.pod:38
30428 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30429 "what filesystem is in each LV, etc.). It can also run commands in the "
30430 "context of the guest. Also you can access filesystems over FUSE."
30434 #: ../src/guestfs.pod:43
30436 "Libguestfs is a library that can be linked with C and C++ management "
30437 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30438 "PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
30443 #: ../src/guestfs.pod:48
30445 "You don't need to be root to use libguestfs, although obviously you do need "
30446 "enough permissions to access the disk images."
30450 #: ../src/guestfs.pod:51
30452 "Libguestfs is a large API because it can do many things. For a gentle "
30453 "introduction, please read the L</API OVERVIEW> section next."
30457 #: ../src/guestfs.pod:54
30459 "There are also some example programs in the L<guestfs-examples(3)> manual "
30464 #: ../src/guestfs.pod:57
30465 msgid "API OVERVIEW"
30469 #: ../src/guestfs.pod:59
30471 "This section provides a gentler overview of the libguestfs API. We also try "
30472 "to group API calls together, where that may not be obvious from reading "
30473 "about the individual calls in the main section of this manual."
30477 #: ../src/guestfs.pod:64
30482 #: ../src/guestfs.pod:66
30484 "Before you can use libguestfs calls, you have to create a handle. Then you "
30485 "must add at least one disk image to the handle, followed by launching the "
30486 "handle, then performing whatever operations you want, and finally closing "
30487 "the handle. By convention we use the single letter C<g> for the name of the "
30488 "handle variable, although of course you can use any name you want."
30492 #: ../src/guestfs.pod:73
30493 msgid "The general structure of all libguestfs-using programs looks like this:"
30497 #: ../src/guestfs.pod:76
30500 " guestfs_h *g = guestfs_create ();\n"
30505 #: ../src/guestfs.pod:78
30508 " /* Call guestfs_add_drive additional times if there are\n"
30509 " * multiple disk images.\n"
30511 " guestfs_add_drive (g, \"guest.img\");\n"
30516 #: ../src/guestfs.pod:83
30519 " /* Most manipulation calls won't work until you've launched\n"
30520 " * the handle 'g'. You have to do this _after_ adding drives\n"
30521 " * and _before_ other commands.\n"
30523 " guestfs_launch (g);\n"
30528 #: ../src/guestfs.pod:89
30531 " /* Now you can examine what partitions, LVs etc are available.\n"
30533 " char **partitions = guestfs_list_partitions (g);\n"
30534 " char **logvols = guestfs_lvs (g);\n"
30539 #: ../src/guestfs.pod:94
30542 " /* To access a filesystem in the image, you must mount it.\n"
30544 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30549 #: ../src/guestfs.pod:98
30552 " /* Now you can perform filesystem actions on the guest\n"
30555 " guestfs_touch (g, \"/hello\");\n"
30560 #: ../src/guestfs.pod:103
30563 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30564 " * it is done automatically when you close the handle. See\n"
30565 " * discussion of autosync in this page.\n"
30567 " guestfs_sync (g);\n"
30572 #: ../src/guestfs.pod:109
30575 " /* Close the handle 'g'. */\n"
30576 " guestfs_close (g);\n"
30581 #: ../src/guestfs.pod:112
30583 "The code above doesn't include any error checking. In real code you should "
30584 "check return values carefully for errors. In general all functions that "
30585 "return integers return C<-1> on error, and all functions that return "
30586 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30587 "how to handle errors, and consult the documentation for each function call "
30588 "below to see precisely how they return error indications. See "
30589 "L<guestfs-examples(3)> for fully worked examples."
30593 #: ../src/guestfs.pod:121
30594 msgid "DISK IMAGES"
30598 #: ../src/guestfs.pod:123
30600 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30601 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30602 "actual block device, or simply an empty file of zeroes that you have created "
30603 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30608 #: ../src/guestfs.pod:129
30610 "The call you should use in modern code for adding drives is "
30611 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30612 "specifying that the format is raw, do:"
30616 #: ../src/guestfs.pod:133
30619 " guestfs_add_drive_opts (g, filename,\n"
30620 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30626 #: ../src/guestfs.pod:137
30627 msgid "You can add a disk read-only using:"
30631 #: ../src/guestfs.pod:139
30634 " guestfs_add_drive_opts (g, filename,\n"
30635 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30636 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30642 #: ../src/guestfs.pod:144
30644 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30645 "libguestfs won't modify the file."
30649 #: ../src/guestfs.pod:147
30651 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30652 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30653 "corruption, but adding it read-only is safe."
30657 #: ../src/guestfs.pod:151
30659 "You must add at least one disk image, and you may add multiple disk images. "
30660 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30661 "first one you added), C</dev/sdb> (for the second one you added), etc."
30665 #: ../src/guestfs.pod:156
30667 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30668 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30669 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
30673 #: ../src/guestfs.pod:161
30678 #: ../src/guestfs.pod:163
30680 "Before you can read or write files, create directories and so on in a disk "
30681 "image that contains filesystems, you have to mount those filesystems using "
30682 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
30683 "a disk image contains (for example) one partition with a filesystem on that "
30684 "partition, then you can mount it directly:"
30688 #: ../src/guestfs.pod:170
30691 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
30696 #: ../src/guestfs.pod:172
30698 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
30699 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
30700 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
30701 "that these are libguestfs virtual devices, and are nothing to do with host "
30706 #: ../src/guestfs.pod:178
30708 "If you are given a disk image and you don't know what it contains then you "
30709 "have to find out. Libguestfs can do that too: use "
30710 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
30711 "and LVs, and either try mounting each to see what is mountable, or else "
30712 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
30713 "filesystems, use L</guestfs_list_filesystems>."
30717 #: ../src/guestfs.pod:186
30719 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
30720 "L</INSPECTION> below). But you might find it easier to look at higher level "
30721 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
30725 #: ../src/guestfs.pod:191
30727 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
30728 "several other variations of the C<guestfs_mount_*> call."
30732 #: ../src/guestfs.pod:194
30733 msgid "FILESYSTEM ACCESS AND MODIFICATION"
30737 #: ../src/guestfs.pod:196
30739 "The majority of the libguestfs API consists of fairly low-level calls for "
30740 "accessing and modifying the files, directories, symlinks etc on mounted "
30741 "filesystems. There are over a hundred such calls which you can find listed "
30742 "in detail below in this man page, and we don't even pretend to cover them "
30743 "all in this overview."
30747 #: ../src/guestfs.pod:202
30749 "Specify filenames as full paths, starting with C<\"/\"> and including the "
30754 #: ../src/guestfs.pod:205
30756 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
30757 "the file called C<\"etc/passwd\"> then you could do:"
30761 #: ../src/guestfs.pod:208
30764 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
30769 #: ../src/guestfs.pod:210
30771 "This would return C<data> as a newly allocated buffer containing the full "
30772 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
30773 "or C<NULL> if there was an error."
30777 #: ../src/guestfs.pod:214
30779 "As another example, to create a top-level directory on that filesystem "
30780 "called C<\"var\"> you would do:"
30784 #: ../src/guestfs.pod:217
30787 " guestfs_mkdir (g, \"/var\");\n"
30792 #: ../src/guestfs.pod:219
30793 msgid "To create a symlink you could do:"
30797 #: ../src/guestfs.pod:221
30800 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
30801 " \"/etc/rc3.d/S30portmap\");\n"
30806 #: ../src/guestfs.pod:224
30808 "Libguestfs will reject attempts to use relative paths and there is no "
30809 "concept of a current working directory."
30813 #: ../src/guestfs.pod:227
30815 "Libguestfs can return errors in many situations: for example if the "
30816 "filesystem isn't writable, or if a file or directory that you requested "
30817 "doesn't exist. If you are using the C API (documented here) you have to "
30818 "check for those error conditions after each call. (Other language bindings "
30819 "turn these errors into exceptions)."
30823 #: ../src/guestfs.pod:233
30825 "File writes are affected by the per-handle umask, set by calling "
30826 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
30830 #: ../src/guestfs.pod:236
30831 msgid "PARTITIONING"
30835 #: ../src/guestfs.pod:238
30837 "Libguestfs contains API calls to read, create and modify partition tables on "
30842 #: ../src/guestfs.pod:241
30844 "In the common case where you want to create a single partition covering the "
30845 "whole disk, you should use the L</guestfs_part_disk> call:"
30849 #: ../src/guestfs.pod:245
30852 " const char *parttype = \"mbr\";\n"
30853 " if (disk_is_larger_than_2TB)\n"
30854 " parttype = \"gpt\";\n"
30855 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
30860 #: ../src/guestfs.pod:250
30862 "Obviously this effectively wipes anything that was on that disk image "
30867 #: ../src/guestfs.pod:253
30872 #: ../src/guestfs.pod:255
30874 "Libguestfs provides access to a large part of the LVM2 API, such as "
30875 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
30876 "unless you familiarize yourself with the concepts of physical volumes, "
30877 "volume groups and logical volumes."
30881 #: ../src/guestfs.pod:260
30883 "This author strongly recommends reading the LVM HOWTO, online at "
30884 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
30888 #: ../src/guestfs.pod:263
30889 msgid "DOWNLOADING"
30893 #: ../src/guestfs.pod:265
30895 "Use L</guestfs_cat> to download small, text only files. This call is "
30896 "limited to files which are less than 2 MB and which cannot contain any ASCII "
30897 "NUL (C<\\0>) characters. However the API is very simple to use."
30901 #: ../src/guestfs.pod:269
30903 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
30904 "bit data, since it returns a (pointer, size) pair. However it is still "
30905 "limited to \"small\" files, less than 2 MB."
30909 #: ../src/guestfs.pod:273
30911 "L</guestfs_download> can be used to download any file, with no limits on "
30912 "content or size (even files larger than 4 GB)."
30916 #: ../src/guestfs.pod:276
30917 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
30921 #: ../src/guestfs.pod:279
30926 #: ../src/guestfs.pod:281
30928 "It's often the case that you want to write a file or files to the disk "
30933 #: ../src/guestfs.pod:284
30935 "To write a small file with fixed content, use L</guestfs_write>. To create "
30936 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
30937 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
30938 "variety of other functions for creating test files, for example "
30939 "L</guestfs_fill> and L</guestfs_fill_pattern>."
30943 #: ../src/guestfs.pod:290
30945 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
30946 "file content or size (even files larger than 4 GB)."
30950 #: ../src/guestfs.pod:293
30951 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
30955 #: ../src/guestfs.pod:295
30957 "However the fastest way to upload I<large numbers of arbitrary files> is to "
30958 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
30959 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
30960 "the drive in a predictable way (eg. adding it last after all other drives) "
30961 "then you can get the device name from L</guestfs_list_devices> and mount it "
30962 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
30963 "sometimes non-portable between kernel versions, and they don't support "
30964 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
30965 "using a label or UUID, use an ISO image instead."
30969 #: ../src/guestfs.pod:306
30974 #: ../src/guestfs.pod:308
30976 "There are various different commands for copying between files and devices "
30977 "and in and out of the guest filesystem. These are summarised in the table "
30982 #: ../src/guestfs.pod:314
30983 msgid "B<file> to B<file>"
30987 #: ../src/guestfs.pod:316
30989 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
30990 "directories recursively."
30994 #: ../src/guestfs.pod:319
30995 msgid "B<file or device> to B<file or device>"
30999 #: ../src/guestfs.pod:321
31001 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31002 "devices in the guest."
31006 #: ../src/guestfs.pod:324
31007 msgid "Example: duplicate the contents of an LV:"
31011 #: ../src/guestfs.pod:326
31014 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31019 #: ../src/guestfs.pod:328
31021 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31022 "(C</dev/VG/Original>). To copy less than the whole source device, use "
31023 "L</guestfs_copy_size>."
31027 #: ../src/guestfs.pod:332
31028 msgid "B<file on the host> to B<file or device>"
31032 #: ../src/guestfs.pod:334
31033 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31037 #: ../src/guestfs.pod:336
31038 msgid "B<file or device> to B<file on the host>"
31042 #: ../src/guestfs.pod:338
31043 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31047 #: ../src/guestfs.pod:342
31048 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31052 #: ../src/guestfs.pod:344
31054 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
31055 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31056 "appears you can only upload and download to files. However many Un*x-like "
31057 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
31058 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
31059 "stderr, and arbitrary file descriptor N."
31063 #: ../src/guestfs.pod:352
31064 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31068 #: ../src/guestfs.pod:355
31071 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31076 #: ../src/guestfs.pod:357
31077 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31081 #: ../src/guestfs.pod:359
31084 " char devfd[64];\n"
31085 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31086 " guestfs_tar_out (g, \"/\", devfd);\n"
31091 #: ../src/guestfs.pod:363
31092 msgid "LISTING FILES"
31096 #: ../src/guestfs.pod:365
31098 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31099 "L<guestfish(1)>-equivalent command C<ll>)."
31103 #: ../src/guestfs.pod:368
31105 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31106 "programs, as a flat list of strings."
31110 #: ../src/guestfs.pod:371
31112 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31113 "directory, plus additional information about each one. It is more "
31114 "equivalent to using the L<readdir(3)> call on a local filesystem."
31118 #: ../src/guestfs.pod:375
31120 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
31125 #: ../src/guestfs.pod:378
31126 msgid "RUNNING COMMANDS"
31130 #: ../src/guestfs.pod:380
31132 "Although libguestfs is primarily an API for manipulating files inside guest "
31133 "images, we also provide some limited facilities for running commands inside "
31138 #: ../src/guestfs.pod:384
31139 msgid "There are many limitations to this:"
31143 #: ../src/guestfs.pod:390
31145 "The kernel version that the command runs under will be different from what "
31150 #: ../src/guestfs.pod:395
31152 "If the command needs to communicate with daemons, then most likely they "
31153 "won't be running."
31157 #: ../src/guestfs.pod:400
31158 msgid "The command will be running in limited memory."
31162 #: ../src/guestfs.pod:404
31164 "The network may not be available unless you enable it (see "
31165 "L</guestfs_set_network>)."
31169 #: ../src/guestfs.pod:409
31170 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31174 #: ../src/guestfs.pod:413
31175 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31179 #: ../src/guestfs.pod:418
31181 "For SELinux guests, you may need to enable SELinux and load policy first. "
31182 "See L</SELINUX> in this manpage."
31186 #: ../src/guestfs.pod:423
31188 "I<Security:> It is not safe to run commands from untrusted, possibly "
31189 "malicious guests. These commands may attempt to exploit your program by "
31190 "sending unexpected output. They could also try to exploit the Linux kernel "
31191 "or qemu provided by the libguestfs appliance. They could use the network "
31192 "provided by the libguestfs appliance to bypass ordinary network partitions "
31193 "and firewalls. They could use the elevated privileges or different SELinux "
31194 "context of your program to their advantage."
31198 #: ../src/guestfs.pod:432
31200 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31201 "(a script which runs when the guest next boots normally), and to have this "
31202 "script run the commands you want in the normal context of the running guest, "
31203 "network security and so on. For information about other security issues, "
31204 "see L</SECURITY>."
31208 #: ../src/guestfs.pod:440
31210 "The two main API calls to run commands are L</guestfs_command> and "
31211 "L</guestfs_sh> (there are also variations)."
31215 #: ../src/guestfs.pod:443
31217 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31218 "shell globs, redirections, etc will work."
31222 #: ../src/guestfs.pod:446
31223 msgid "CONFIGURATION FILES"
31227 #: ../src/guestfs.pod:448
31229 "To read and write configuration files in Linux guest filesystems, we "
31230 "strongly recommend using Augeas. For example, Augeas understands how to "
31231 "read and write, say, a Linux shadow password file or X.org configuration "
31232 "file, and so avoids you having to write that code."
31236 #: ../src/guestfs.pod:453
31238 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31239 "document Augeas itself here because there is excellent documentation on the "
31240 "L<http://augeas.net/> website."
31244 #: ../src/guestfs.pod:457
31246 "If you don't want to use Augeas (you fool!) then try calling "
31247 "L</guestfs_read_lines> to get the file as a list of lines which you can "
31252 #: ../src/guestfs.pod:461
31257 #: ../src/guestfs.pod:463
31259 "We support SELinux guests. To ensure that labeling happens correctly in "
31260 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31264 #: ../src/guestfs.pod:471
31265 msgid "Before launching, do:"
31269 #: ../src/guestfs.pod:473
31272 " guestfs_set_selinux (g, 1);\n"
31277 #: ../src/guestfs.pod:477
31279 "After mounting the guest's filesystem(s), load the policy. This is best "
31280 "done by running the L<load_policy(8)> command in the guest itself:"
31284 #: ../src/guestfs.pod:481
31287 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31292 #: ../src/guestfs.pod:483
31294 "(Older versions of C<load_policy> require you to specify the name of the "
31299 #: ../src/guestfs.pod:488
31301 "Optionally, set the security context for the API. The correct security "
31302 "context to use can only be known by inspecting the guest. As an example:"
31306 #: ../src/guestfs.pod:492
31309 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31314 #: ../src/guestfs.pod:496
31315 msgid "This will work for running commands and editing existing files."
31319 #: ../src/guestfs.pod:498
31321 "When new files are created, you may need to label them explicitly, for "
31322 "example by running the external command C<restorecon pathname>."
31326 #: ../src/guestfs.pod:502
31331 #: ../src/guestfs.pod:504
31333 "Certain calls are affected by the current file mode creation mask (the "
31334 "\"umask\"). In particular ones which create files or directories, such as "
31335 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
31336 "either the default mode that the file is created with or modifies the mode "
31341 #: ../src/guestfs.pod:510
31343 "The default umask is C<022>, so files are created with modes such as C<0644> "
31344 "and directories with C<0755>."
31348 #: ../src/guestfs.pod:513
31350 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31351 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
31352 "L</guestfs_chmod> after creating each file or directory."
31356 #: ../src/guestfs.pod:517
31357 msgid "For more information about umask, see L<umask(2)>."
31361 #: ../src/guestfs.pod:521
31363 "Libguestfs allows you to access Linux guests which have been encrypted using "
31364 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31365 "standard. This includes nearly all whole disk encryption systems used by "
31366 "modern Linux guests."
31370 #: ../src/guestfs.pod:527
31372 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31373 "returns the string C<crypto_LUKS>)."
31377 #: ../src/guestfs.pod:530
31379 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31380 "will require the passphrase!"
31384 #: ../src/guestfs.pod:533
31386 "Opening a LUKS device creates a new device mapper device called "
31387 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
31388 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
31389 "decrypted from and encrypted to the underlying block device respectively."
31393 #: ../src/guestfs.pod:539
31395 "LVM volume groups on the device can be made visible by calling "
31396 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
31397 "volume(s) can now be mounted in the usual way."
31401 #: ../src/guestfs.pod:543
31403 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31404 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31405 "[\"/dev/VG\"])>. Then close the mapper device by calling "
31406 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31407 "underlying encrypted block device)."
31411 #: ../src/guestfs.pod:550
31416 #: ../src/guestfs.pod:552
31418 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31419 "contains operating systems, an install CD or a live CD. (These APIs used to "
31420 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31421 "version 1.5.3 the most frequently used part of this library has been "
31422 "rewritten in C and moved into the core code)."
31426 #: ../src/guestfs.pod:559
31428 "Add all disks belonging to the unknown virtual machine and call "
31429 "L</guestfs_launch> in the usual way."
31433 #: ../src/guestfs.pod:562
31435 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31436 "and certain heuristics, and returns a list of operating systems that were "
31437 "found. An empty list means none were found. A single element is the root "
31438 "filesystem of the operating system. For dual- or multi-boot guests, "
31439 "multiple roots can be returned, each one corresponding to a separate "
31440 "operating system. (Multi-boot virtual machines are extremely rare in the "
31441 "world of virtualization, but since this scenario can happen, we have built "
31442 "libguestfs to deal with it.)"
31446 #: ../src/guestfs.pod:571
31448 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31449 "to get additional details about that operating system. For example, call "
31450 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31451 "Windows and Linux-based operating systems respectively."
31455 #: ../src/guestfs.pod:577
31457 "Un*x-like and Linux-based operating systems usually consist of several "
31458 "filesystems which are mounted at boot time (for example, a separate boot "
31459 "partition mounted on C</boot>). The inspection rules are able to detect how "
31460 "filesystems correspond to mount points. Call "
31461 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31462 "hash table like this example:"
31466 #: ../src/guestfs.pod:584
31469 " /boot => /dev/sda1\n"
31470 " / => /dev/vg_guest/lv_root\n"
31471 " /usr => /dev/vg_guest/lv_usr\n"
31476 #: ../src/guestfs.pod:588
31478 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31479 "filesystems as suggested."
31483 #: ../src/guestfs.pod:591
31485 "Be careful to mount filesystems in the right order (eg. C</> before "
31486 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
31491 #: ../src/guestfs.pod:595
31493 "Inspection currently only works for some common operating systems. "
31494 "Contributors are welcome to send patches for other operating systems that we "
31495 "currently cannot detect."
31499 #: ../src/guestfs.pod:599
31501 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31502 "for more details. The L</guestfs_inspect_os> function just ignores any "
31503 "encrypted devices."
31507 #: ../src/guestfs.pod:603
31509 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31510 "inspection and caches the results in the guest handle. Subsequent calls to "
31511 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31512 "re-read the disks. If you change the content of the guest disks, you can "
31513 "redo inspection by calling L</guestfs_inspect_os> again. "
31514 "(L</guestfs_inspect_list_applications> works a little differently from the "
31515 "other calls and does read the disks. See documentation for that function "
31520 #: ../src/guestfs.pod:612
31521 msgid "INSPECTING INSTALL DISKS"
31525 #: ../src/guestfs.pod:614
31527 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31532 #: ../src/guestfs.pod:617
31534 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31535 "system, which currently can be C<installed> (a regular operating system) or "
31536 "C<installer> (some sort of install disk)."
31540 #: ../src/guestfs.pod:621
31542 "Further information is available about the operating system that can be "
31543 "installed using the regular inspection APIs like "
31544 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31549 #: ../src/guestfs.pod:626
31551 "Some additional information specific to installer disks is also available "
31552 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31553 "L</guestfs_inspect_is_multipart> calls."
31557 #: ../src/guestfs.pod:631
31558 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31562 #: ../src/guestfs.pod:633
31564 "Libguestfs can mount NTFS partitions. It does this using the "
31565 "L<http://www.ntfs-3g.org/> driver."
31569 #: ../src/guestfs.pod:636
31570 msgid "DRIVE LETTERS AND PATHS"
31574 #: ../src/guestfs.pod:638
31576 "DOS and Windows still use drive letters, and the filesystems are always "
31577 "treated as case insensitive by Windows itself, and therefore you might find "
31578 "a Windows configuration file referring to a path like "
31579 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
31580 "that directory might be referred to as C</WINDOWS/System32>."
31584 #: ../src/guestfs.pod:644
31586 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31587 "L</guestfs_inspect_get_drive_mappings>)"
31591 #: ../src/guestfs.pod:647
31593 "Dealing with separator characters (backslash vs forward slash) is outside "
31594 "the scope of libguestfs, but usually a simple character replacement will "
31599 #: ../src/guestfs.pod:651
31601 "To resolve the case insensitivity of paths, call "
31602 "L</guestfs_case_sensitive_path>."
31606 #: ../src/guestfs.pod:654
31607 msgid "ACCESSING THE WINDOWS REGISTRY"
31611 #: ../src/guestfs.pod:656
31613 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31614 "files, through the library C<hivex> which is part of the libguestfs project "
31615 "although ships as a separate tarball. You have to locate and download the "
31616 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31617 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31618 "L<virt-win-reg(1)> for more help on this issue."
31622 #: ../src/guestfs.pod:664
31623 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31627 #: ../src/guestfs.pod:666
31629 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31630 "provide something which looks like a Linux symlink. The way it tries to do "
31631 "the rewriting is described here:"
31635 #: ../src/guestfs.pod:670
31636 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31640 #: ../src/guestfs.pod:672
31642 "The essential problem is that ntfs-3g simply does not have enough "
31643 "information to do a correct job. NTFS links can contain drive letters and "
31644 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31645 "It is almost certainly the case that libguestfs callers should ignore what "
31646 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31650 #: ../src/guestfs.pod:679
31652 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31653 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31654 "attribute, and read the raw reparse data from that (you can find the format "
31655 "documented in various places around the web)."
31659 #: ../src/guestfs.pod:684
31660 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31664 #: ../src/guestfs.pod:686
31666 "There are other useful extended attributes that can be read from ntfs-3g "
31667 "filesystems (using L</guestfs_getxattr>). See:"
31671 #: ../src/guestfs.pod:689
31672 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31676 #: ../src/guestfs.pod:691
31677 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31681 #: ../src/guestfs.pod:693
31683 "Although we don't want to discourage you from using the C API, we will "
31684 "mention here that the same API is also available in other languages."
31688 #: ../src/guestfs.pod:696
31690 "The API is broadly identical in all supported languages. This means that "
31691 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
31692 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
31693 "OCaml. In other words, a straightforward, predictable isomorphism between "
31698 #: ../src/guestfs.pod:702
31700 "Error messages are automatically transformed into exceptions if the language "
31705 #: ../src/guestfs.pod:705
31707 "We don't try to \"object orientify\" parts of the API in OO languages, "
31708 "although contributors are welcome to write higher level APIs above what we "
31709 "provide in their favourite languages if they wish."
31713 #: ../src/guestfs.pod:711
31718 #: ../src/guestfs.pod:713
31720 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
31721 "identical to the C API. C++ classes and exceptions are not used."
31725 #: ../src/guestfs.pod:717
31730 #: ../src/guestfs.pod:719
31732 "The C# bindings are highly experimental. Please read the warnings at the "
31733 "top of C<csharp/Libguestfs.cs>."
31737 #: ../src/guestfs.pod:722
31742 #: ../src/guestfs.pod:724
31743 msgid "See L<guestfs-erlang(3)>."
31747 #: ../src/guestfs.pod:726
31752 #: ../src/guestfs.pod:728
31754 "This is the only language binding that is working but incomplete. Only "
31755 "calls which return simple integers have been bound in Haskell, and we are "
31756 "looking for help to complete this binding."
31760 #: ../src/guestfs.pod:732
31765 #: ../src/guestfs.pod:734
31767 "Full documentation is contained in the Javadoc which is distributed with "
31768 "libguestfs. For examples, see L<guestfs-java(3)>."
31772 #: ../src/guestfs.pod:737
31777 #: ../src/guestfs.pod:739
31778 msgid "See L<guestfs-ocaml(3)>."
31782 #: ../src/guestfs.pod:741
31787 #: ../src/guestfs.pod:743
31788 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
31792 #: ../src/guestfs.pod:745
31797 #: ../src/guestfs.pod:747
31799 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
31800 "the php-libguestfs package for your distribution."
31804 #: ../src/guestfs.pod:750
31805 msgid "The PHP binding only works correctly on 64 bit machines."
31809 #: ../src/guestfs.pod:752
31814 #: ../src/guestfs.pod:754
31815 msgid "See L<guestfs-python(3)>."
31819 #: ../src/guestfs.pod:756
31824 #: ../src/guestfs.pod:758
31825 msgid "See L<guestfs-ruby(3)>."
31829 #: ../src/guestfs.pod:760
31830 msgid "B<shell scripts>"
31834 #: ../src/guestfs.pod:762
31835 msgid "See L<guestfish(1)>."
31839 #: ../src/guestfs.pod:766
31840 msgid "LIBGUESTFS GOTCHAS"
31844 #: ../src/guestfs.pod:768
31846 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
31847 "system [...] that works in the way it is documented but is counterintuitive "
31848 "and almost invites mistakes.\""
31852 #: ../src/guestfs.pod:772
31854 "Since we developed libguestfs and the associated tools, there are several "
31855 "things we would have designed differently, but are now stuck with for "
31856 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
31857 "release, you can expect these to change. Beware of them."
31861 #: ../src/guestfs.pod:780
31862 msgid "Autosync / forgetting to sync."
31866 #: ../src/guestfs.pod:782
31868 "I<Update:> Autosync is enabled by default for all API users starting from "
31869 "libguestfs 1.5.24. This section only applies to older versions."
31873 #: ../src/guestfs.pod:785
31875 "When modifying a filesystem from C or another language, you B<must> unmount "
31876 "all filesystems and call L</guestfs_sync> explicitly before you close the "
31877 "libguestfs handle. You can also call:"
31881 #: ../src/guestfs.pod:789
31884 " guestfs_set_autosync (g, 1);\n"
31889 #: ../src/guestfs.pod:791
31891 "to have the unmount/sync done automatically for you when the handle 'g' is "
31892 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
31897 #: ../src/guestfs.pod:795
31899 "If you forget to do this, then it is entirely possible that your changes "
31900 "won't be written out, or will be partially written, or (very rarely) that "
31901 "you'll get disk corruption."
31905 #: ../src/guestfs.pod:799
31907 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
31908 "guestfish scripts that forget to sync will work just fine, which can make "
31909 "this very puzzling if you are trying to debug a problem."
31913 #: ../src/guestfs.pod:803
31914 msgid "Mount option C<-o sync> should not be the default."
31918 #: ../src/guestfs.pod:805
31920 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
31921 "However C<-o sync> does not add any reliability benefit, but does have a "
31922 "very large performance impact."
31926 #: ../src/guestfs.pod:809
31928 "The work around is to use L</guestfs_mount_options> and set the mount "
31929 "options that you actually want to use."
31933 #: ../src/guestfs.pod:812
31934 msgid "Read-only should be the default."
31938 #: ../src/guestfs.pod:814
31940 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
31941 "specify I<--rw> if you want to make changes to the image."
31945 #: ../src/guestfs.pod:817
31946 msgid "This would reduce the potential to corrupt live VM images."
31950 #: ../src/guestfs.pod:819
31952 "Note that many filesystems change the disk when you just mount and unmount, "
31953 "even if you didn't perform any writes. You need to use "
31954 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
31958 #: ../src/guestfs.pod:823
31959 msgid "guestfish command line is hard to use."
31963 #: ../src/guestfs.pod:825
31965 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
31966 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
31967 "exist, so it fails. In earlier versions of guestfish the error message was "
31968 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
31969 "we should have used C<guestfish -c command> to run commands."
31973 #: ../src/guestfs.pod:832
31974 msgid "guestfish megabyte modifiers don't work right on all commands"
31978 #: ../src/guestfs.pod:834
31980 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
31981 "other modifiers). What guestfish actually does is to multiply the number "
31982 "part by the modifier part and pass the result to the C API. However this "
31983 "doesn't work for a few APIs which aren't expecting bytes, but are already "
31984 "expecting some other unit (eg. megabytes)."
31988 #: ../src/guestfs.pod:841
31989 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
31993 #: ../src/guestfs.pod:843
31996 " lvcreate LV VG 100M\n"
32001 #: ../src/guestfs.pod:845
32003 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32004 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32005 "megabytes * megabytes) logical volume. The error message you get from this "
32006 "is also a little obscure."
32010 #: ../src/guestfs.pod:850
32012 "This could be fixed in the generator by specially marking parameters and "
32013 "return values which take bytes or other units."
32017 #: ../src/guestfs.pod:853
32018 msgid "Ambiguity between devices and paths"
32022 #: ../src/guestfs.pod:855
32024 "There is a subtle ambiguity in the API between a device name "
32025 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
32026 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32030 #: ../src/guestfs.pod:860
32032 "In the current API we usually resolve this ambiguity by having two separate "
32033 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32034 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32035 "detecting if the path supplied begins with C</dev/>."
32039 #: ../src/guestfs.pod:866
32041 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32042 "make paths/devices into structured names. One way to do this would be to "
32043 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32044 "aspect of grub. Another way would be to use a structured type, equivalent "
32045 "to this OCaml type:"
32049 #: ../src/guestfs.pod:872
32052 " type path = Path of string | Device of int | Partition of int * int\n"
32057 #: ../src/guestfs.pod:874
32058 msgid "which would allow you to pass arguments like:"
32062 #: ../src/guestfs.pod:876
32065 " Path \"/foo/bar\"\n"
32066 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32067 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32068 " Path \"/dev/sdb2\" (* not a device *)\n"
32073 #: ../src/guestfs.pod:881
32075 "As you can see there are still problems to resolve even with this "
32076 "representation. Also consider how it might work in guestfish."
32080 #: ../src/guestfs.pod:886
32081 msgid "KEYS AND PASSPHRASES"
32085 #: ../src/guestfs.pod:888
32087 "Certain libguestfs calls take a parameter that contains sensitive key "
32088 "material, passed in as a C string."
32092 #: ../src/guestfs.pod:891
32094 "In the future we would hope to change the libguestfs implementation so that "
32095 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32096 "swap. However this is I<not> done at the moment, because of the complexity "
32097 "of such an implementation."
32101 #: ../src/guestfs.pod:896
32103 "Therefore you should be aware that any key parameter you pass to libguestfs "
32104 "might end up being written out to the swap partition. If this is a concern, "
32105 "scrub the swap partition or don't use libguestfs on encrypted devices."
32109 #: ../src/guestfs.pod:901
32110 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32114 #: ../src/guestfs.pod:903
32116 "All high-level libguestfs actions are synchronous. If you want to use "
32117 "libguestfs asynchronously then you must create a thread."
32121 #: ../src/guestfs.pod:906
32123 "Only use the handle from a single thread. Either use the handle exclusively "
32124 "from one thread, or provide your own mutex so that two threads cannot issue "
32125 "calls on the same handle at the same time."
32129 #: ../src/guestfs.pod:910
32131 "See the graphical program guestfs-browser for one possible architecture for "
32132 "multithreaded programs using libvirt and libguestfs."
32136 #: ../src/guestfs.pod:913
32141 #: ../src/guestfs.pod:915
32143 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32148 #: ../src/guestfs.pod:918
32150 "By default it looks for these in the directory C<$libdir/guestfs> "
32151 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32155 #: ../src/guestfs.pod:921
32157 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32158 "to change the directories that libguestfs will search in. The value is a "
32159 "colon-separated list of paths. The current directory is I<not> searched "
32160 "unless the path contains an empty element or C<.>. For example "
32161 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32162 "then C</usr/lib/guestfs>."
32166 #: ../src/guestfs.pod:928
32167 msgid "QEMU WRAPPERS"
32171 #: ../src/guestfs.pod:930
32173 "If you want to compile your own qemu, run qemu from a non-standard location, "
32174 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32179 #: ../src/guestfs.pod:934
32181 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32182 "last command in the shell script (so that qemu replaces the shell and "
32183 "becomes the direct child of the libguestfs-using program). If you don't do "
32184 "this, then the qemu process won't be cleaned up correctly."
32188 #: ../src/guestfs.pod:939
32190 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32195 #: ../src/guestfs.pod:942
32199 " qemudir=/home/rjones/d/qemu\n"
32200 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
32206 #: ../src/guestfs.pod:946
32208 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32209 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
32214 #: ../src/guestfs.pod:950
32217 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32222 #: ../src/guestfs.pod:952
32224 "Note that libguestfs also calls qemu with the -help and -version options in "
32225 "order to determine features."
32229 #: ../src/guestfs.pod:955
32230 msgid "ATTACHING TO RUNNING DAEMONS"
32234 #: ../src/guestfs.pod:957
32236 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32237 "babies. Use with caution."
32241 #: ../src/guestfs.pod:960
32243 "I<Note (2):> This section explains how to attach to a running daemon from a "
32244 "low level perspective. For most users, simply using virt tools such as "
32245 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32249 #: ../src/guestfs.pod:964
32250 msgid "Using guestfs_set_attach_method"
32254 #: ../src/guestfs.pod:966
32256 "By calling L</guestfs_set_attach_method> you can change how the library "
32257 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
32258 "L</ARCHITECTURE> for some background)."
32262 #: ../src/guestfs.pod:970
32264 "The normal attach method is C<appliance>, where a small appliance is created "
32265 "containing the daemon, and then the library connects to this."
32269 #: ../src/guestfs.pod:973
32271 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32272 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32273 "daemon over the Unix domain socket."
32277 #: ../src/guestfs.pod:977
32279 "The normal use for this is to connect to a running virtual machine that "
32280 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32281 "files inside the live virtual machine."
32285 #: ../src/guestfs.pod:981
32286 msgid "Using guestfs_add_domain with live flag"
32290 #: ../src/guestfs.pod:983
32292 "L</guestfs_add_domain> provides some help for getting the correct attach "
32293 "method. If you pass the C<live> option to this function, then (if the "
32294 "virtual machine is running) it will examine the libvirt XML looking for a "
32295 "virtio-serial channel to connect to:"
32299 #: ../src/guestfs.pod:989
32306 " <channel type='unix'>\n"
32307 " <source mode='bind' path='/path/to/socket'/>\n"
32308 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32317 #: ../src/guestfs.pod:1001
32319 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32320 "method to C<unix:/path/to/socket>."
32324 #: ../src/guestfs.pod:1004
32326 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32327 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32328 "to attach to and modify live virtual machines."
32332 #: ../src/guestfs.pod:1008
32334 "The virtual machine needs to have been set up beforehand so that it has the "
32335 "virtio-serial channel and so that guestfsd is running inside it."
32339 #: ../src/guestfs.pod:1012
32340 msgid "ABI GUARANTEE"
32344 #: ../src/guestfs.pod:1014
32346 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32347 "actions as outlined in this section. Although we will deprecate some "
32348 "actions, for example if they get replaced by newer calls, we will keep the "
32349 "old actions forever. This allows you the developer to program in confidence "
32350 "against the libguestfs API."
32354 #: ../src/guestfs.pod:1020
32355 msgid "BLOCK DEVICE NAMING"
32359 #: ../src/guestfs.pod:1022
32361 "In the kernel there is now quite a profusion of schemata for naming block "
32362 "devices (in this context, by I<block device> I mean a physical or virtual "
32363 "hard drive). The original Linux IDE driver used names starting with "
32364 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
32365 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
32366 "replacement for the old IDE driver (particularly for SATA devices) those "
32367 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
32368 "machines with paravirtualized drivers. This has created several different "
32369 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
32374 #: ../src/guestfs.pod:1034
32376 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32377 "Linux kernel to access block devices. We can run a variety of appliances "
32378 "based on a variety of Linux kernels."
32382 #: ../src/guestfs.pod:1038
32384 "This causes a problem for libguestfs because many API calls use device or "
32385 "partition names. Working scripts and the recipe (example) scripts that we "
32386 "make available over the internet could fail if the naming scheme changes."
32390 #: ../src/guestfs.pod:1043
32392 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32393 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32394 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32395 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32399 #: ../src/guestfs.pod:1049
32401 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32402 "L</guestfs_list_partitions> and similar calls return the true names of the "
32403 "devices and partitions as known to the appliance."
32407 #: ../src/guestfs.pod:1054
32408 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32412 #: ../src/guestfs.pod:1056
32414 "Usually this translation is transparent. However in some (very rare) cases "
32415 "you may need to know the exact algorithm. Such cases include where you use "
32416 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
32417 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
32422 #: ../src/guestfs.pod:1062
32424 "The algorithm is applied only to I<parameters> which are known to be either "
32425 "device or partition names. Return values from functions such as "
32426 "L</guestfs_list_devices> are never changed."
32430 #: ../src/guestfs.pod:1070
32431 msgid "Is the string a parameter which is a device or partition name?"
32435 #: ../src/guestfs.pod:1074
32436 msgid "Does the string begin with C</dev/sd>?"
32440 #: ../src/guestfs.pod:1078
32442 "Does the named device exist? If so, we use that device. However if I<not> "
32443 "then we continue with this algorithm."
32447 #: ../src/guestfs.pod:1083
32448 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32452 #: ../src/guestfs.pod:1085
32453 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32457 #: ../src/guestfs.pod:1087
32458 msgid "If that named device exists, use it. If not, continue."
32462 #: ../src/guestfs.pod:1091
32463 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32467 #: ../src/guestfs.pod:1093
32468 msgid "If that named device exists, use it. If not, return an error."
32472 #: ../src/guestfs.pod:1097
32473 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32477 #: ../src/guestfs.pod:1099
32479 "Although the standard naming scheme and automatic translation is useful for "
32480 "simple programs and guestfish scripts, for larger programs it is best not to "
32481 "rely on this mechanism."
32485 #: ../src/guestfs.pod:1103
32487 "Where possible for maximum future portability programs using libguestfs "
32488 "should use these future-proof techniques:"
32492 #: ../src/guestfs.pod:1110
32494 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32495 "device names, and then use those names directly."
32499 #: ../src/guestfs.pod:1113
32500 msgid "Since those device names exist by definition, they will never be translated."
32504 #: ../src/guestfs.pod:1118
32506 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32507 "filesystem labels."
32511 #: ../src/guestfs.pod:1123
32516 #: ../src/guestfs.pod:1125
32518 "This section discusses security implications of using libguestfs, "
32519 "particularly with untrusted or malicious guests or disk images."
32523 #: ../src/guestfs.pod:1128
32524 msgid "GENERAL SECURITY CONSIDERATIONS"
32528 #: ../src/guestfs.pod:1130
32530 "Be careful with any files or data that you download from a guest (by "
32531 "\"download\" we mean not just the L</guestfs_download> command but any "
32532 "command that reads files, filenames, directories or anything else from a "
32533 "disk image). An attacker could manipulate the data to fool your program "
32534 "into doing the wrong thing. Consider cases such as:"
32538 #: ../src/guestfs.pod:1140
32539 msgid "the data (file etc) not being present"
32543 #: ../src/guestfs.pod:1144
32544 msgid "being present but empty"
32548 #: ../src/guestfs.pod:1148
32549 msgid "being much larger than normal"
32553 #: ../src/guestfs.pod:1152
32554 msgid "containing arbitrary 8 bit data"
32558 #: ../src/guestfs.pod:1156
32559 msgid "being in an unexpected character encoding"
32563 #: ../src/guestfs.pod:1160
32564 msgid "containing homoglyphs."
32568 #: ../src/guestfs.pod:1164
32569 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32573 #: ../src/guestfs.pod:1166
32575 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32576 "(VFS) module can sometimes be escalated into exploits by deliberately "
32577 "creating a malicious, malformed filesystem. These exploits are very severe "
32578 "for two reasons. Firstly there are very many filesystem drivers in the "
32579 "kernel, and many of them are infrequently used and not much developer "
32580 "attention has been paid to the code. Linux userspace helps potential "
32581 "crackers by detecting the filesystem type and automatically choosing the "
32582 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32583 "the administrator. Secondly, a kernel-level exploit is like a local root "
32584 "exploit (worse in some ways), giving immediate and total access to the "
32585 "system right down to the hardware level."
32589 #: ../src/guestfs.pod:1179
32591 "That explains why you should never mount a filesystem from an untrusted "
32592 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32593 "inside a qemu virtual machine, usually running as a non-root user. The "
32594 "attacker would need to write a filesystem which first exploited the kernel, "
32595 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32596 "the libguestfs protocol, and finally to be as serious as the host kernel "
32597 "exploit it would need to escalate its privileges to root. This multi-step "
32598 "escalation, performed by a static piece of data, is thought to be extremely "
32599 "hard to do, although we never say 'never' about security issues."
32603 #: ../src/guestfs.pod:1190
32605 "In any case callers can reduce the attack surface by forcing the filesystem "
32606 "type when mounting (use L</guestfs_mount_vfs>)."
32610 #: ../src/guestfs.pod:1193
32611 msgid "PROTOCOL SECURITY"
32615 #: ../src/guestfs.pod:1195
32617 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32618 "defined upper message size. However a program that uses libguestfs must "
32619 "also take care - for example you can write a program that downloads a binary "
32620 "from a disk image and executes it locally, and no amount of protocol "
32621 "security will save you from the consequences."
32625 #: ../src/guestfs.pod:1201
32626 msgid "INSPECTION SECURITY"
32630 #: ../src/guestfs.pod:1203
32632 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32633 "directly from the guest, and these could contain any 8 bit data. Callers "
32634 "should be careful to escape these before printing them to a structured file "
32635 "(for example, use HTML escaping if creating a web page)."
32639 #: ../src/guestfs.pod:1209
32641 "Guest configuration may be altered in unusual ways by the administrator of "
32642 "the virtual machine, and may not reflect reality (particularly for untrusted "
32643 "or actively malicious guests). For example we parse the hostname from "
32644 "configuration files like C</etc/sysconfig/network> that we find in the "
32645 "guest, but the guest administrator can easily manipulate these files to "
32646 "provide the wrong hostname."
32650 #: ../src/guestfs.pod:1217
32652 "The inspection API parses guest configuration using two external libraries: "
32653 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32654 "designed to be robust in the face of malicious data, although denial of "
32655 "service attacks are still possible, for example with oversized configuration "
32660 #: ../src/guestfs.pod:1223
32661 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
32665 #: ../src/guestfs.pod:1225
32667 "Be very cautious about running commands from the guest. By running a "
32668 "command in the guest, you are giving CPU time to a binary that you do not "
32669 "control, under the same user account as the library, albeit wrapped in qemu "
32670 "virtualization. More information and alternatives can be found in the "
32671 "section L</RUNNING COMMANDS>."
32675 #: ../src/guestfs.pod:1231
32676 msgid "CVE-2010-3851"
32680 #: ../src/guestfs.pod:1233
32681 msgid "https://bugzilla.redhat.com/642934"
32685 #: ../src/guestfs.pod:1235
32687 "This security bug concerns the automatic disk format detection that qemu "
32688 "does on disk images."
32692 #: ../src/guestfs.pod:1238
32694 "A raw disk image is just the raw bytes, there is no header. Other disk "
32695 "images like qcow2 contain a special header. Qemu deals with this by looking "
32696 "for one of the known headers, and if none is found then assuming the disk "
32697 "image must be raw."
32701 #: ../src/guestfs.pod:1243
32703 "This allows a guest which has been given a raw disk image to write some "
32704 "other header. At next boot (or when the disk image is accessed by "
32705 "libguestfs) qemu would do autodetection and think the disk image format was, "
32706 "say, qcow2 based on the header written by the guest."
32710 #: ../src/guestfs.pod:1248
32712 "This in itself would not be a problem, but qcow2 offers many features, one "
32713 "of which is to allow a disk image to refer to another image (called the "
32714 "\"backing disk\"). It does this by placing the path to the backing disk "
32715 "into the qcow2 header. This path is not validated and could point to any "
32716 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
32717 "\"holes\" in the qcow2 disk image, which of course is completely under the "
32718 "control of the attacker."
32722 #: ../src/guestfs.pod:1256
32723 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
32727 #: ../src/guestfs.pod:1263
32728 msgid "You have enabled the network or have opened the disk in write mode."
32732 #: ../src/guestfs.pod:1267
32734 "You are also running untrusted code from the guest (see L</RUNNING "
32739 #: ../src/guestfs.pod:1272
32741 "The way to avoid this is to specify the expected disk format when adding "
32742 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
32743 "should always do this if the disk is raw format, and it's a good idea for "
32748 #: ../src/guestfs.pod:1277
32750 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
32751 "format is fetched from libvirt and passed through."
32755 #: ../src/guestfs.pod:1280
32757 "For libguestfs tools, use the I<--format> command line parameter as "
32762 #: ../src/guestfs.pod:1283
32763 msgid "CONNECTION MANAGEMENT"
32767 #: ../src/guestfs.pod:1285
32768 msgid "guestfs_h *"
32772 #: ../src/guestfs.pod:1287
32774 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
32775 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
32776 "handle and release all resources used."
32780 #: ../src/guestfs.pod:1291
32782 "For information on using multiple handles and threads, see the section "
32783 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
32787 #: ../src/guestfs.pod:1294
32788 msgid "guestfs_create"
32792 #: ../src/guestfs.pod:1296
32795 " guestfs_h *guestfs_create (void);\n"
32800 #: ../src/guestfs.pod:1298
32801 msgid "Create a connection handle."
32805 #: ../src/guestfs.pod:1300
32807 "On success this returns a non-NULL pointer to a handle. On error it returns "
32812 #: ../src/guestfs.pod:1303
32814 "You have to \"configure\" the handle after creating it. This includes "
32815 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
32816 "handle at least once."
32820 #: ../src/guestfs.pod:1307
32821 msgid "After configuring the handle, you have to call L</guestfs_launch>."
32825 #: ../src/guestfs.pod:1309
32827 "You may also want to configure error handling for the handle. See the "
32828 "L</ERROR HANDLING> section below."
32832 #: ../src/guestfs.pod:1312
32833 msgid "guestfs_close"
32837 #: ../src/guestfs.pod:1314
32840 " void guestfs_close (guestfs_h *g);\n"
32845 #: ../src/guestfs.pod:1316
32846 msgid "This closes the connection handle and frees up all resources used."
32850 #: ../src/guestfs.pod:1318
32852 "If autosync was set on the handle and the handle was launched, then this "
32853 "implicitly calls various functions to unmount filesystems and sync the "
32854 "disk. See L</guestfs_set_autosync> for more details."
32858 #: ../src/guestfs.pod:1322
32859 msgid "If a close callback was set on the handle, then it is called."
32863 #: ../src/guestfs.pod:1324
32864 msgid "ERROR HANDLING"
32868 #: ../src/guestfs.pod:1326
32870 "API functions can return errors. For example, almost all functions that "
32871 "return C<int> will return C<-1> to indicate an error."
32875 #: ../src/guestfs.pod:1329
32877 "Additional information is available for errors: an error message string and "
32878 "optionally an error number (errno) if the thing that failed was a system "
32883 #: ../src/guestfs.pod:1333
32885 "You can get at the additional information about the last error on the handle "
32886 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
32887 "up an error handler with L</guestfs_set_error_handler>."
32891 #: ../src/guestfs.pod:1338
32893 "When the handle is created, a default error handler is installed which "
32894 "prints the error message string to C<stderr>. For small short-running "
32895 "command line programs it is sufficient to do:"
32899 #: ../src/guestfs.pod:1342
32902 " if (guestfs_launch (g) == -1)\n"
32903 " exit (EXIT_FAILURE);\n"
32908 #: ../src/guestfs.pod:1345
32910 "since the default error handler will ensure that an error message has been "
32911 "printed to C<stderr> before the program exits."
32915 #: ../src/guestfs.pod:1348
32917 "For other programs the caller will almost certainly want to install an "
32918 "alternate error handler or do error handling in-line like this:"
32922 #: ../src/guestfs.pod:1351
32925 " /* This disables the default behaviour of printing errors\n"
32927 " guestfs_set_error_handler (g, NULL, NULL);\n"
32932 #: ../src/guestfs.pod:1355
32935 " if (guestfs_launch (g) == -1) {\n"
32936 " /* Examine the error message and print it etc. */\n"
32937 " char *msg = guestfs_last_error (g);\n"
32938 " int errnum = guestfs_last_errno (g);\n"
32939 " fprintf (stderr, \"%s\", msg);\n"
32940 " if (errnum != 0)\n"
32941 " fprintf (stderr, \": %s\", strerror (errnum));\n"
32942 " fprintf (stderr, \"\\n\");\n"
32949 #: ../src/guestfs.pod:1366
32951 "Out of memory errors are handled differently. The default action is to call "
32952 "L<abort(3)>. If this is undesirable, then you can set a handler using "
32953 "L</guestfs_set_out_of_memory_handler>."
32957 #: ../src/guestfs.pod:1370
32959 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
32960 "because there is no handle if this happens there is no way to get additional "
32961 "error information. However L</guestfs_create> is supposed to be a "
32962 "lightweight operation which can only fail because of insufficient memory (it "
32963 "returns NULL in this case)."
32967 #: ../src/guestfs.pod:1376
32968 msgid "guestfs_last_error"
32972 #: ../src/guestfs.pod:1378
32975 " const char *guestfs_last_error (guestfs_h *g);\n"
32980 #: ../src/guestfs.pod:1380
32982 "This returns the last error message that happened on C<g>. If there has not "
32983 "been an error since the handle was created, then this returns C<NULL>."
32987 #: ../src/guestfs.pod:1384
32989 "The lifetime of the returned string is until the next error occurs, or "
32990 "L</guestfs_close> is called."
32994 #: ../src/guestfs.pod:1387
32995 msgid "guestfs_last_errno"
32999 #: ../src/guestfs.pod:1389
33002 " int guestfs_last_errno (guestfs_h *g);\n"
33007 #: ../src/guestfs.pod:1391
33008 msgid "This returns the last error number (errno) that happened on C<g>."
33012 #: ../src/guestfs.pod:1393
33013 msgid "If successful, an errno integer not equal to zero is returned."
33017 #: ../src/guestfs.pod:1395
33018 msgid "If no error, this returns 0. This call can return 0 in three situations:"
33022 #: ../src/guestfs.pod:1402
33023 msgid "There has not been any error on the handle."
33027 #: ../src/guestfs.pod:1406
33029 "There has been an error but the errno was meaningless. This corresponds to "
33030 "the case where the error did not come from a failed system call, but for "
33031 "some other reason."
33035 #: ../src/guestfs.pod:1412
33037 "There was an error from a failed system call, but for some reason the errno "
33038 "was not captured and returned. This usually indicates a bug in libguestfs."
33042 #: ../src/guestfs.pod:1418
33044 "Libguestfs tries to convert the errno from inside the applicance into a "
33045 "corresponding errno for the caller (not entirely trivial: the appliance "
33046 "might be running a completely different operating system from the library "
33047 "and error numbers are not standardized across Un*xen). If this could not be "
33048 "done, then the error is translated to C<EINVAL>. In practice this should "
33049 "only happen in very rare circumstances."
33053 #: ../src/guestfs.pod:1426
33054 msgid "guestfs_set_error_handler"
33058 #: ../src/guestfs.pod:1428
33061 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33063 " const char *msg);\n"
33064 " void guestfs_set_error_handler (guestfs_h *g,\n"
33065 " guestfs_error_handler_cb cb,\n"
33066 " void *opaque);\n"
33071 #: ../src/guestfs.pod:1435
33073 "The callback C<cb> will be called if there is an error. The parameters "
33074 "passed to the callback are an opaque data pointer and the error message "
33079 #: ../src/guestfs.pod:1439
33081 "C<errno> is not passed to the callback. To get that the callback must call "
33082 "L</guestfs_last_errno>."
33086 #: ../src/guestfs.pod:1442
33088 "Note that the message string C<msg> is freed as soon as the callback "
33089 "function returns, so if you want to stash it somewhere you must make your "
33094 #: ../src/guestfs.pod:1446
33095 msgid "The default handler prints messages on C<stderr>."
33099 #: ../src/guestfs.pod:1448
33100 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33104 #: ../src/guestfs.pod:1450
33105 msgid "guestfs_get_error_handler"
33109 #: ../src/guestfs.pod:1452
33112 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33113 " void **opaque_rtn);\n"
33118 #: ../src/guestfs.pod:1455
33119 msgid "Returns the current error handler callback."
33123 #: ../src/guestfs.pod:1457
33124 msgid "guestfs_set_out_of_memory_handler"
33128 #: ../src/guestfs.pod:1459
33131 " typedef void (*guestfs_abort_cb) (void);\n"
33132 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33133 " guestfs_abort_cb);\n"
33138 #: ../src/guestfs.pod:1463
33140 "The callback C<cb> will be called if there is an out of memory situation. "
33141 "I<Note this callback must not return>."
33145 #: ../src/guestfs.pod:1466
33146 msgid "The default is to call L<abort(3)>."
33150 #: ../src/guestfs.pod:1468
33151 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
33155 #: ../src/guestfs.pod:1471
33156 msgid "guestfs_get_out_of_memory_handler"
33160 #: ../src/guestfs.pod:1473
33163 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33168 #: ../src/guestfs.pod:1475
33169 msgid "This returns the current out of memory handler."
33173 #: ../src/guestfs.pod:1477
33178 #: ../src/guestfs.pod:1481
33183 #: ../src/guestfs.pod:1483
33188 #: ../src/guestfs.pod:1485
33189 msgid "AVAILABILITY"
33193 #: ../src/guestfs.pod:1487
33194 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33198 #: ../src/guestfs.pod:1489
33200 "Using L</guestfs_available> you can test availability of the following "
33201 "groups of functions. This test queries the appliance to see if the "
33202 "appliance you are currently using supports the functionality."
33206 #: ../src/guestfs.pod:1494
33207 msgid "@AVAILABILITY@"
33211 #: ../src/guestfs.pod:1496
33212 msgid "GUESTFISH supported COMMAND"
33216 #: ../src/guestfs.pod:1498
33218 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33219 "prints out the available groups and whether they are supported by this build "
33220 "of libguestfs. Note however that you have to do C<run> first."
33224 #: ../src/guestfs.pod:1503
33225 msgid "SINGLE CALLS AT COMPILE TIME"
33229 #: ../src/guestfs.pod:1505
33231 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33232 "function, such as:"
33236 #: ../src/guestfs.pod:1508
33239 " #define LIBGUESTFS_HAVE_DD 1\n"
33244 #: ../src/guestfs.pod:1510
33245 msgid "if L</guestfs_dd> is available."
33249 #: ../src/guestfs.pod:1512
33251 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33252 "function is available at compile time, we recommended using build tools such "
33253 "as autoconf or cmake. For example in autotools you could use:"
33257 #: ../src/guestfs.pod:1517
33260 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33261 " AC_CHECK_FUNCS([guestfs_dd])\n"
33266 #: ../src/guestfs.pod:1520
33268 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33273 #: ../src/guestfs.pod:1523
33274 msgid "SINGLE CALLS AT RUN TIME"
33278 #: ../src/guestfs.pod:1525
33280 "Testing at compile time doesn't guarantee that a function really exists in "
33281 "the library. The reason is that you might be dynamically linked against a "
33282 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33283 "This situation unfortunately results in a segmentation fault, which is a "
33284 "shortcoming of the C dynamic linking system itself."
33288 #: ../src/guestfs.pod:1532
33290 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33291 "in this example program (note that you still need the compile time check as "
33296 #: ../src/guestfs.pod:1536
33299 " #include <stdio.h>\n"
33300 " #include <stdlib.h>\n"
33301 " #include <unistd.h>\n"
33302 " #include <dlfcn.h>\n"
33303 " #include <guestfs.h>\n"
33308 #: ../src/guestfs.pod:1542
33313 " #ifdef LIBGUESTFS_HAVE_DD\n"
33315 " int has_function;\n"
33320 #: ../src/guestfs.pod:1548
33323 " /* Test if the function guestfs_dd is really available. */\n"
33324 " dl = dlopen (NULL, RTLD_LAZY);\n"
33326 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33327 " exit (EXIT_FAILURE);\n"
33329 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33335 #: ../src/guestfs.pod:1557
33338 " if (!has_function)\n"
33339 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33341 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33342 " /* Now it's safe to call\n"
33343 " guestfs_dd (g, \"foo\", \"bar\");\n"
33347 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33354 #: ../src/guestfs.pod:1570
33356 "You may think the above is an awful lot of hassle, and it is. There are "
33357 "other ways outside of the C linking system to ensure that this kind of "
33358 "incompatibility never arises, such as using package versioning:"
33362 #: ../src/guestfs.pod:1575
33365 " Requires: libguestfs >= 1.0.80\n"
33370 #: ../src/guestfs.pod:1577
33371 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33375 #: ../src/guestfs.pod:1579
33377 "A recent feature of the API is the introduction of calls which take optional "
33378 "arguments. In C these are declared 3 ways. The main way is as a call which "
33379 "takes variable arguments (ie. C<...>), as in this example:"
33383 #: ../src/guestfs.pod:1584
33386 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33391 #: ../src/guestfs.pod:1586
33393 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33394 "call with no optional arguments specified:"
33398 #: ../src/guestfs.pod:1589
33401 " guestfs_add_drive_opts (g, filename, -1);\n"
33406 #: ../src/guestfs.pod:1591
33407 msgid "With a single optional argument:"
33411 #: ../src/guestfs.pod:1593
33414 " guestfs_add_drive_opts (g, filename,\n"
33415 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33421 #: ../src/guestfs.pod:1597
33426 #: ../src/guestfs.pod:1599
33429 " guestfs_add_drive_opts (g, filename,\n"
33430 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33431 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33437 #: ../src/guestfs.pod:1604
33439 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33444 #: ../src/guestfs.pod:1607
33445 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33449 #: ../src/guestfs.pod:1609
33451 "The second variant has the same name with the suffix C<_va>, which works the "
33452 "same way but takes a C<va_list>. See the C manual for details. For the "
33453 "example function, this is declared:"
33457 #: ../src/guestfs.pod:1613
33460 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33461 " va_list args);\n"
33466 #: ../src/guestfs.pod:1616
33467 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33471 #: ../src/guestfs.pod:1618
33473 "The third variant is useful where you need to construct these calls. You "
33474 "pass in a structure where you fill in the optional fields. The structure "
33475 "has a bitmask as the first element which you must set to indicate which "
33476 "fields you have filled in. For our example function the structure and call "
33481 #: ../src/guestfs.pod:1624
33484 " struct guestfs_add_drive_opts_argv {\n"
33485 " uint64_t bitmask;\n"
33487 " const char *format;\n"
33490 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33491 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33496 #: ../src/guestfs.pod:1633
33497 msgid "You could call it like this:"
33501 #: ../src/guestfs.pod:1635
33504 " struct guestfs_add_drive_opts_argv optargs = {\n"
33505 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33506 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33507 " .readonly = 1,\n"
33508 " .format = \"qcow2\"\n"
33514 #: ../src/guestfs.pod:1642
33517 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33522 #: ../src/guestfs.pod:1650
33523 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33527 #: ../src/guestfs.pod:1655
33528 msgid "You do not need to fill in all fields of the structure."
33532 #: ../src/guestfs.pod:1659
33534 "There must be a one-to-one correspondence between fields of the structure "
33535 "that are filled in, and bits set in the bitmask."
33539 #: ../src/guestfs.pod:1664
33540 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33544 #: ../src/guestfs.pod:1666
33546 "In other languages, optional arguments are expressed in the way that is "
33547 "natural for that language. We refer you to the language-specific "
33548 "documentation for more details on that."
33552 #: ../src/guestfs.pod:1670
33553 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33557 #: ../src/guestfs.pod:1672
33558 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33562 #: ../src/guestfs.pod:1674
33564 "B<Note:> This section documents the generic event mechanism introduced in "
33565 "libguestfs 1.10, which you should use in new code if possible. The old "
33566 "functions C<guestfs_set_log_message_callback>, "
33567 "C<guestfs_set_subprocess_quit_callback>, "
33568 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33569 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33570 "page. Because of the ABI guarantee, the old functions continue to work."
33574 #: ../src/guestfs.pod:1683
33576 "Handles generate events when certain things happen, such as log messages "
33577 "being generated, progress messages during long-running operations, or the "
33578 "handle being closed. The API calls described below let you register a "
33579 "callback to be called when events happen. You can register multiple "
33580 "callbacks (for the same, different or overlapping sets of events), and "
33581 "individually remove callbacks. If callbacks are not removed, then they "
33582 "remain in force until the handle is closed."
33586 #: ../src/guestfs.pod:1691
33588 "In the current implementation, events are only generated synchronously: that "
33589 "means that events (and hence callbacks) can only happen while you are in the "
33590 "middle of making another libguestfs call. The callback is called in the "
33595 #: ../src/guestfs.pod:1696
33597 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33598 "unsigned integers, or a message buffer. Payloads are discussed later on."
33602 #: ../src/guestfs.pod:1700
33603 msgid "CLASSES OF EVENTS"
33607 #: ../src/guestfs.pod:1704
33608 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33612 #: ../src/guestfs.pod:1707
33614 "The callback function will be called while the handle is being closed "
33615 "(synchronously from L</guestfs_close>)."
33619 #: ../src/guestfs.pod:1710
33621 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33622 "handles that are open when the program exits. This means that this callback "
33623 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33624 "problems in higher-level languages (eg. if your HLL interpreter has already "
33625 "been cleaned up by the time this is called, and if your callback then jumps "
33626 "into some HLL function)."
33630 #: ../src/guestfs.pod:1717
33632 "If no callback is registered: the handle is closed without any callback "
33637 #: ../src/guestfs.pod:1720
33638 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33642 #: ../src/guestfs.pod:1723
33644 "The callback function will be called when the child process quits, either "
33645 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33646 "corresponds to a transition from any state to the CONFIG state)."
33650 #: ../src/guestfs.pod:1727 ../src/guestfs.pod:1736 ../src/guestfs.pod:1853
33651 msgid "If no callback is registered: the event is ignored."
33655 #: ../src/guestfs.pod:1729
33656 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
33660 #: ../src/guestfs.pod:1732
33662 "The callback function will be called when the child process becomes ready "
33663 "first time after it has been launched. (This corresponds to a transition "
33664 "from LAUNCHING to the READY state)."
33668 #: ../src/guestfs.pod:1738
33669 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
33673 #: ../src/guestfs.pod:1741
33675 "Some long-running operations can generate progress messages. If this "
33676 "callback is registered, then it will be called each time a progress message "
33677 "is generated (usually two seconds after the operation started, and three "
33678 "times per second thereafter until it completes, although the frequency may "
33679 "change in future versions)."
33683 #: ../src/guestfs.pod:1747
33685 "The callback receives in the payload four unsigned 64 bit numbers which are "
33686 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
33690 #: ../src/guestfs.pod:1750
33692 "The units of C<total> are not defined, although for some operations C<total> "
33693 "may relate in some way to the amount of data to be transferred (eg. in bytes "
33694 "or megabytes), and C<position> may be the portion which has been "
33699 #: ../src/guestfs.pod:1755
33700 msgid "The only defined and stable parts of the API are:"
33704 #: ../src/guestfs.pod:1761
33706 "The callback can display to the user some type of progress bar or indicator "
33707 "which shows the ratio of C<position>:C<total>."
33711 #: ../src/guestfs.pod:1766
33712 msgid "0 E<lt>= C<position> E<lt>= C<total>"
33716 #: ../src/guestfs.pod:1770
33718 "If any progress notification is sent during a call, then a final progress "
33719 "notification is always sent when C<position> = C<total> (I<unless> the call "
33720 "fails with an error)."
33724 #: ../src/guestfs.pod:1774
33726 "This is to simplify caller code, so callers can easily set the progress "
33727 "indicator to \"100%\" at the end of the operation, without requiring special "
33728 "code to detect this case."
33732 #: ../src/guestfs.pod:1780
33734 "For some calls we are unable to estimate the progress of the call, but we "
33735 "can still generate progress messages to indicate activity. This is known as "
33736 "\"pulse mode\", and is directly supported by certain progress bar "
33737 "implementations (eg. GtkProgressBar)."
33741 #: ../src/guestfs.pod:1785
33743 "For these calls, zero or more progress messages are generated with "
33744 "C<position = 0> and C<total = 1>, followed by a final message with "
33745 "C<position = total = 1>."
33749 #: ../src/guestfs.pod:1789
33751 "As noted above, if the call fails with an error then the final message may "
33752 "not be generated."
33756 #: ../src/guestfs.pod:1794
33758 "The callback also receives the procedure number (C<proc_nr>) and serial "
33759 "number (C<serial>) of the call. These are only useful for debugging "
33760 "protocol issues, and the callback can normally ignore them. The callback "
33761 "may want to print these numbers in error messages or debugging messages."
33765 #: ../src/guestfs.pod:1800
33766 msgid "If no callback is registered: progress messages are discarded."
33770 #: ../src/guestfs.pod:1802
33771 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
33775 #: ../src/guestfs.pod:1805
33777 "The callback function is called whenever a log message is generated by qemu, "
33778 "the appliance kernel, guestfsd (daemon), or utility programs."
33782 #: ../src/guestfs.pod:1808
33784 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
33785 "(L</guestfs_launch>) then additional debug messages are generated."
33789 #: ../src/guestfs.pod:1811 ../src/guestfs.pod:1825
33791 "If no callback is registered: the messages are discarded unless the verbose "
33792 "flag is set in which case they are sent to stderr. You can override the "
33793 "printing of verbose messages to stderr by setting up a callback."
33797 #: ../src/guestfs.pod:1816
33798 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
33802 #: ../src/guestfs.pod:1819
33804 "The callback function is called whenever a log message is generated by the "
33805 "library part of libguestfs."
33809 #: ../src/guestfs.pod:1822
33811 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
33812 "messages are generated."
33816 #: ../src/guestfs.pod:1830
33817 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
33821 #: ../src/guestfs.pod:1833
33823 "The callback function is called whenever a trace message is generated. This "
33824 "only applies if the trace flag (L</guestfs_set_trace>) is set."
33828 #: ../src/guestfs.pod:1836
33830 "If no callback is registered: the messages are sent to stderr. You can "
33831 "override the printing of trace messages to stderr by setting up a callback."
33835 #: ../src/guestfs.pod:1840
33836 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
33840 #: ../src/guestfs.pod:1843
33841 msgid "The callback function is called whenever a libguestfs function is entered."
33845 #: ../src/guestfs.pod:1846
33847 "The payload is a string which contains the name of the function that we are "
33848 "entering (not including C<guestfs_> prefix)."
33852 #: ../src/guestfs.pod:1849
33854 "Note that libguestfs functions can call themselves, so you may see many "
33855 "events from a single call. A few libguestfs functions do not generate this "
33860 #: ../src/guestfs.pod:1857
33861 msgid "guestfs_set_event_callback"
33865 #: ../src/guestfs.pod:1859
33868 " int guestfs_set_event_callback (guestfs_h *g,\n"
33869 " guestfs_event_callback cb,\n"
33870 " uint64_t event_bitmask,\n"
33872 " void *opaque);\n"
33877 #: ../src/guestfs.pod:1865
33879 "This function registers a callback (C<cb>) for all event classes in the "
33880 "C<event_bitmask>."
33884 #: ../src/guestfs.pod:1868
33886 "For example, to register for all log message events, you could call this "
33887 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
33888 "To register a single callback for all possible classes of events, use "
33889 "C<GUESTFS_EVENT_ALL>."
33893 #: ../src/guestfs.pod:1874
33894 msgid "C<flags> should always be passed as 0."
33898 #: ../src/guestfs.pod:1876
33900 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
33901 "it for any purpose."
33905 #: ../src/guestfs.pod:1879
33907 "The return value is the event handle (an integer) which you can use to "
33908 "delete the callback (see below)."
33912 #: ../src/guestfs.pod:1882
33914 "If there is an error, this function returns C<-1>, and sets the error in the "
33915 "handle in the usual way (see L</guestfs_last_error> etc.)"
33919 #: ../src/guestfs.pod:1885
33921 "Callbacks remain in effect until they are deleted, or until the handle is "
33926 #: ../src/guestfs.pod:1888
33928 "In the case where multiple callbacks are registered for a particular event "
33929 "class, all of the callbacks are called. The order in which multiple "
33930 "callbacks are called is not defined."
33934 #: ../src/guestfs.pod:1892
33935 msgid "guestfs_delete_event_callback"
33939 #: ../src/guestfs.pod:1894
33942 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
33947 #: ../src/guestfs.pod:1896
33949 "Delete a callback that was previously registered. C<event_handle> should be "
33950 "the integer that was returned by a previous call to "
33951 "C<guestfs_set_event_callback> on the same handle."
33955 #: ../src/guestfs.pod:1900
33956 msgid "guestfs_event_callback"
33960 #: ../src/guestfs.pod:1902
33963 " typedef void (*guestfs_event_callback) (\n"
33966 " uint64_t event,\n"
33967 " int event_handle,\n"
33969 " const char *buf, size_t buf_len,\n"
33970 " const uint64_t *array, size_t array_len);\n"
33975 #: ../src/guestfs.pod:1911
33976 msgid "This is the type of the event callback function that you have to provide."
33980 #: ../src/guestfs.pod:1914
33982 "The basic parameters are: the handle (C<g>), the opaque user pointer "
33983 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
33984 "handle, and C<flags> which in the current API you should ignore."
33988 #: ../src/guestfs.pod:1918
33990 "The remaining parameters contain the event payload (if any). Each event may "
33991 "contain a payload, which usually relates to the event class, but for future "
33992 "proofing your code should be written to handle any payload for any event "
33997 #: ../src/guestfs.pod:1923
33999 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34000 "there is no message buffer). Note that this message buffer can contain "
34001 "arbitrary 8 bit data, including NUL bytes."
34005 #: ../src/guestfs.pod:1927
34007 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34008 "moment this is only used for progress messages."
34012 #: ../src/guestfs.pod:1930
34013 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34017 #: ../src/guestfs.pod:1932
34019 "One motivation for the generic event API was to allow GUI programs to "
34020 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34021 "unconditionally to C<stderr>."
34025 #: ../src/guestfs.pod:1936
34027 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34028 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34029 "messages are not events; you must capture error messages separately)."
34033 #: ../src/guestfs.pod:1941
34035 "Programs have to set up a callback to capture the classes of events of "
34040 #: ../src/guestfs.pod:1944
34044 " guestfs_set_event_callback\n"
34045 " (g, message_callback,\n"
34046 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34047 " GUESTFS_EVENT_TRACE,\n"
34048 " 0, NULL) == -1)\n"
34049 " if (eh == -1) {\n"
34050 " // handle error in the usual way\n"
34056 #: ../src/guestfs.pod:1954
34058 "The callback can then direct messages to the appropriate place. In this "
34059 "example, messages are directed to syslog:"
34063 #: ../src/guestfs.pod:1957
34067 " message_callback (\n"
34070 " uint64_t event,\n"
34071 " int event_handle,\n"
34073 " const char *buf, size_t buf_len,\n"
34074 " const uint64_t *array, size_t array_len)\n"
34076 " const int priority = LOG_USER|LOG_INFO;\n"
34077 " if (buf_len > 0)\n"
34078 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34084 #: ../src/guestfs.pod:1972
34085 msgid "CANCELLING LONG TRANSFERS"
34089 #: ../src/guestfs.pod:1974
34091 "Some operations can be cancelled by the caller while they are in progress. "
34092 "Currently only operations that involve uploading or downloading data can be "
34093 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34094 "parameters in the generator)."
34098 #: ../src/guestfs.pod:1979
34099 msgid "guestfs_user_cancel"
34103 #: ../src/guestfs.pod:1981
34106 " void guestfs_user_cancel (guestfs_h *g);\n"
34111 #: ../src/guestfs.pod:1983
34112 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
34116 #: ../src/guestfs.pod:1986
34118 "Unlike most other libguestfs calls, this function is signal safe and thread "
34119 "safe. You can call it from a signal handler or from another thread, without "
34120 "needing to do any locking."
34124 #: ../src/guestfs.pod:1990
34126 "The transfer that was in progress (if there is one) will stop shortly "
34127 "afterwards, and will return an error. The errno (see "
34128 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34129 "out if the operation was cancelled or failed because of another error."
34133 #: ../src/guestfs.pod:1996
34135 "No cleanup is performed: for example, if a file was being uploaded then "
34136 "after cancellation there may be a partially uploaded file. It is the "
34137 "caller's responsibility to clean up if necessary."
34141 #: ../src/guestfs.pod:2000
34142 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34146 #: ../src/guestfs.pod:2002
34148 "In an interactive text-based program, you might call it from a C<SIGINT> "
34149 "signal handler so that pressing C<^C> cancels the current operation. (You "
34150 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34151 "receive the C<^C> signal)."
34155 #: ../src/guestfs.pod:2007
34157 "In a graphical program, when the main thread is displaying a progress bar "
34158 "with a cancel button, wire up the cancel button to call this function."
34162 #: ../src/guestfs.pod:2011
34163 msgid "PRIVATE DATA AREA"
34167 #: ../src/guestfs.pod:2013
34169 "You can attach named pieces of private data to the libguestfs handle, fetch "
34170 "them by name, and walk over them, for the lifetime of the handle. This is "
34171 "called the private data area and is only available from the C API."
34175 #: ../src/guestfs.pod:2018
34176 msgid "To attach a named piece of data, use the following call:"
34180 #: ../src/guestfs.pod:2020
34183 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34188 #: ../src/guestfs.pod:2022
34190 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34191 "pointer (which can be C<NULL>). Any previous item with the same key is "
34196 #: ../src/guestfs.pod:2026
34198 "You can use any C<key> you want, but your key should I<not> start with an "
34199 "underscore character. Keys beginning with an underscore character are "
34200 "reserved for internal libguestfs purposes (eg. for implementing language "
34201 "bindings). It is recommended that you prefix the key with some unique "
34202 "string to avoid collisions with other users."
34206 #: ../src/guestfs.pod:2032
34207 msgid "To retrieve the pointer, use:"
34211 #: ../src/guestfs.pod:2034
34214 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34219 #: ../src/guestfs.pod:2036
34221 "This function returns C<NULL> if either no data is found associated with "
34222 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34227 #: ../src/guestfs.pod:2040
34229 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34230 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34231 "all. In particular, libguestfs does I<not> try to free the data when the "
34232 "handle is closed. If the data must be freed, then the caller must either "
34233 "free it before calling L</guestfs_close> or must set up a close callback to "
34234 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34238 #: ../src/guestfs.pod:2047
34239 msgid "To walk over all entries, use these two functions:"
34243 #: ../src/guestfs.pod:2049
34246 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34251 #: ../src/guestfs.pod:2051
34254 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34259 #: ../src/guestfs.pod:2053
34261 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34262 "not have any particular meaning -- keys are not returned in any defined "
34263 "order). A pointer to the key is returned in C<*key_rtn> and the "
34264 "corresponding data pointer is returned from the function. C<NULL> is "
34265 "returned if there are no keys stored in the handle."
34269 #: ../src/guestfs.pod:2059
34271 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34272 "value of this function is also C<NULL> is there are no further entries to "
34277 #: ../src/guestfs.pod:2063
34278 msgid "Notes about walking over entries:"
34282 #: ../src/guestfs.pod:2069
34283 msgid "You must not call C<guestfs_set_private> while walking over the entries."
34287 #: ../src/guestfs.pod:2074
34289 "The handle maintains an internal iterator which is reset when you call "
34290 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34291 "call C<guestfs_set_private>."
34295 #: ../src/guestfs.pod:2080
34296 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34300 #: ../src/guestfs.pod:2082
34303 " guestfs_set_private (g, key, NULL);\n"
34308 #: ../src/guestfs.pod:2084
34309 msgid "then that C<key> is not returned when walking."
34313 #: ../src/guestfs.pod:2088
34315 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34316 "C<guestfs_next_private> or C<guestfs_set_private>."
34320 #: ../src/guestfs.pod:2094
34322 "The following example code shows how to print all keys and data pointers "
34323 "that are associated with the handle C<g>:"
34327 #: ../src/guestfs.pod:2097
34330 " const char *key;\n"
34331 " void *data = guestfs_first_private (g, &key);\n"
34332 " while (data != NULL)\n"
34334 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34335 " data = guestfs_next_private (g, &key);\n"
34341 #: ../src/guestfs.pod:2105
34343 "More commonly you are only interested in keys that begin with an "
34344 "application-specific prefix C<foo_>. Modify the loop like so:"
34348 #: ../src/guestfs.pod:2108
34351 " const char *key;\n"
34352 " void *data = guestfs_first_private (g, &key);\n"
34353 " while (data != NULL)\n"
34355 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34356 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34357 " data = guestfs_next_private (g, &key);\n"
34363 #: ../src/guestfs.pod:2117
34365 "If you need to modify keys while walking, then you have to jump back to the "
34366 "beginning of the loop. For example, to delete all keys prefixed with "
34371 #: ../src/guestfs.pod:2121
34374 " const char *key;\n"
34377 " data = guestfs_first_private (g, &key);\n"
34378 " while (data != NULL)\n"
34380 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34382 " guestfs_set_private (g, key, NULL);\n"
34383 " /* note that 'key' pointer is now invalid, and so is\n"
34384 " the internal iterator */\n"
34387 " data = guestfs_next_private (g, &key);\n"
34393 #: ../src/guestfs.pod:2137
34395 "Note that the above loop is guaranteed to terminate because the keys are "
34396 "being deleted, but other manipulations of keys within the loop might not "
34397 "terminate unless you also maintain an indication of which keys have been "
34402 #: ../src/guestfs.pod:2142 ../src/guestfs.pod:2147
34407 #: ../src/guestfs.pod:2144
34409 "<!-- old anchor for the next section --> <a "
34410 "name=\"state_machine_and_low_level_event_api\"/>"
34414 #: ../src/guestfs.pod:2149
34415 msgid "ARCHITECTURE"
34419 #: ../src/guestfs.pod:2151
34421 "Internally, libguestfs is implemented by running an appliance (a special "
34422 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34423 "process of the main program."
34427 #: ../src/guestfs.pod:2155
34430 " ___________________\n"
34432 " | main program |\n"
34434 " | | child process / appliance\n"
34435 " | | __________________________\n"
34437 " +-------------------+ RPC | +-----------------+ |\n"
34438 " | libguestfs <--------------------> guestfsd | |\n"
34439 " | | | +-----------------+ |\n"
34440 " \\___________________/ | | Linux kernel | |\n"
34441 " | +--^--------------+ |\n"
34442 " \\_________|________________/\n"
34444 " _______v______\n"
34447 " | disk image |\n"
34448 " \\______________/\n"
34453 #: ../src/guestfs.pod:2175
34455 "The library, linked to the main program, creates the child process and hence "
34456 "the appliance in the L</guestfs_launch> function."
34460 #: ../src/guestfs.pod:2178
34462 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34463 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34464 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34465 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34466 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34467 "attached to the qemu process which translates device access by the "
34468 "appliance's Linux kernel into accesses to the image."
34472 #: ../src/guestfs.pod:2187
34474 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34475 "Although the disk image you are attached to might also be used by some "
34476 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34477 "care if both libguestfs's qemu process and your virtual machine are trying "
34478 "to update the disk image at the same time, since these usually results in "
34479 "massive disk corruption)."
34483 #: ../src/guestfs.pod:2194
34484 msgid "STATE MACHINE"
34488 #: ../src/guestfs.pod:2196
34489 msgid "libguestfs uses a state machine to model the child process:"
34493 #: ../src/guestfs.pod:2198
34497 " guestfs_create\n"
34505 " / | \\ \\ guestfs_launch\n"
34506 " / | _\\__V______\n"
34508 " / | | LAUNCHING |\n"
34509 " / | \\___________/\n"
34511 " / | guestfs_launch\n"
34513 " ______ / __|____V\n"
34514 " / \\ ------> / \\\n"
34515 " | BUSY | | READY |\n"
34516 " \\______/ <------ \\________/\n"
34521 #: ../src/guestfs.pod:2220
34523 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34524 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34525 "(3) alternating between READY and BUSY as commands are issued to, and "
34526 "carried out by, the child process."
34530 #: ../src/guestfs.pod:2225
34532 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34533 "asynchronously at any time (eg. due to some internal error), and that causes "
34534 "the state to transition back to CONFIG."
34538 #: ../src/guestfs.pod:2229
34540 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34541 "issued when in the CONFIG state."
34545 #: ../src/guestfs.pod:2232
34547 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34548 "L</guestfs_launch> blocks until the child process is READY to accept "
34549 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34550 "moves the state from CONFIG to LAUNCHING while it is running."
34554 #: ../src/guestfs.pod:2238
34556 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34557 "state. These API calls block waiting for the command to be carried out "
34558 "(ie. the state to transition to BUSY and then back to READY). There are no "
34559 "non-blocking versions, and no way to issue more than one command per handle "
34560 "at the same time."
34564 #: ../src/guestfs.pod:2244
34566 "Finally, the child process sends asynchronous messages back to the main "
34567 "program, such as kernel log messages. You can register a callback to "
34568 "receive these messages."
34572 #: ../src/guestfs.pod:2248
34577 #: ../src/guestfs.pod:2250
34578 msgid "APPLIANCE BOOT PROCESS"
34582 #: ../src/guestfs.pod:2252
34584 "This process has evolved and continues to evolve. The description here "
34585 "corresponds only to the current version of libguestfs and is provided for "
34586 "information only."
34590 #: ../src/guestfs.pod:2256
34592 "In order to follow the stages involved below, enable libguestfs debugging "
34593 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
34597 #: ../src/guestfs.pod:2261
34598 msgid "Create the appliance"
34602 #: ../src/guestfs.pod:2263
34604 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
34605 "initrd and the appliance."
34609 #: ../src/guestfs.pod:2266
34611 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
34612 "directory if C<TMPDIR> is set)."
34616 #: ../src/guestfs.pod:2269
34618 "For a complete description of how the appliance is created and cached, read "
34619 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
34623 #: ../src/guestfs.pod:2273
34624 msgid "Start qemu and boot the kernel"
34628 #: ../src/guestfs.pod:2275
34629 msgid "qemu is invoked to boot the kernel."
34633 #: ../src/guestfs.pod:2277
34634 msgid "Run the initrd"
34638 #: ../src/guestfs.pod:2279
34640 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
34641 "appliance. The purpose of the initrd is to load enough kernel modules in "
34642 "order that the appliance itself can be mounted and started."
34646 #: ../src/guestfs.pod:2283
34648 "The initrd is a cpio archive called "
34649 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
34653 #: ../src/guestfs.pod:2286
34655 "When the initrd has started you will see messages showing that kernel "
34656 "modules are being loaded, similar to this:"
34660 #: ../src/guestfs.pod:2289
34663 " febootstrap: ext2 mini initrd starting up\n"
34664 " febootstrap: mounting /sys\n"
34665 " febootstrap: internal insmod libcrc32c.ko\n"
34666 " febootstrap: internal insmod crc32c-intel.ko\n"
34671 #: ../src/guestfs.pod:2294
34672 msgid "Find and mount the appliance device"
34676 #: ../src/guestfs.pod:2296
34678 "The appliance is a sparse file containing an ext2 filesystem which contains "
34679 "a familiar (although reduced in size) Linux operating system. It would "
34680 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
34684 #: ../src/guestfs.pod:2300
34686 "The regular disks being inspected by libguestfs are the first devices "
34687 "exposed by qemu (eg. as C</dev/vda>)."
34691 #: ../src/guestfs.pod:2303
34693 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
34694 "there was only one regular disk)."
34698 #: ../src/guestfs.pod:2306
34700 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
34701 "and switch root into the appliance, and run C</init> from the appliance."
34705 #: ../src/guestfs.pod:2310
34706 msgid "If this works successfully you will see messages such as:"
34710 #: ../src/guestfs.pod:2312
34713 " febootstrap: picked /sys/block/vdb/dev as root device\n"
34714 " febootstrap: creating /dev/root as block special 252:16\n"
34715 " febootstrap: mounting new root on /root\n"
34716 " febootstrap: chroot\n"
34717 " Starting /init script ...\n"
34722 #: ../src/guestfs.pod:2318
34724 "Note that C<Starting /init script ...> indicates that the appliance's init "
34725 "script is now running."
34729 #: ../src/guestfs.pod:2321
34730 msgid "Initialize the appliance"
34734 #: ../src/guestfs.pod:2323
34736 "The appliance itself now initializes itself. This involves starting certain "
34737 "processes like C<udev>, possibly printing some debug information, and "
34738 "finally running the daemon (C<guestfsd>)."
34742 #: ../src/guestfs.pod:2327
34747 #: ../src/guestfs.pod:2329
34749 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
34754 #: ../src/guestfs.pod:2332
34757 " verbose daemon enabled\n"
34762 #: ../src/guestfs.pod:2334
34764 "The daemon expects to see a named virtio-serial port exposed by qemu and "
34765 "connected on the other end to the library."
34769 #: ../src/guestfs.pod:2337
34771 "The daemon connects to this port (and hence to the library) and sends a four "
34772 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
34773 "protocol (see below)."
34777 #: ../src/guestfs.pod:2343
34778 msgid "COMMUNICATION PROTOCOL"
34782 #: ../src/guestfs.pod:2345
34784 "Don't rely on using this protocol directly. This section documents how it "
34785 "currently works, but it may change at any time."
34789 #: ../src/guestfs.pod:2348
34791 "The protocol used to talk between the library and the daemon running inside "
34792 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
34793 "1014, RFC 1832, RFC 4506)."
34797 #: ../src/guestfs.pod:2352
34799 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
34800 "this file is automatically generated)."
34804 #: ../src/guestfs.pod:2355
34806 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
34807 "and C<FileOut> parameters, which are handled with very simple request/reply "
34808 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
34809 "parameters, which use the same request and reply messages, but they may also "
34810 "be followed by files sent using a chunked encoding."
34814 #: ../src/guestfs.pod:2362
34815 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
34819 #: ../src/guestfs.pod:2364
34820 msgid "For ordinary functions, the request message is:"
34824 #: ../src/guestfs.pod:2366
34827 " total length (header + arguments,\n"
34828 " but not including the length word itself)\n"
34829 " struct guestfs_message_header (encoded as XDR)\n"
34830 " struct guestfs_<foo>_args (encoded as XDR)\n"
34835 #: ../src/guestfs.pod:2371
34837 "The total length field allows the daemon to allocate a fixed size buffer "
34838 "into which it slurps the rest of the message. As a result, the total length "
34839 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
34840 "effective size of any request is limited to somewhere under this size."
34844 #: ../src/guestfs.pod:2377
34846 "Note also that many functions don't take any arguments, in which case the "
34847 "C<guestfs_I<foo>_args> is completely omitted."
34851 #: ../src/guestfs.pod:2380
34853 "The header contains the procedure number (C<guestfs_proc>) which is how the "
34854 "receiver knows what type of args structure to expect, or none at all."
34858 #: ../src/guestfs.pod:2384
34860 "For functions that take optional arguments, the optional arguments are "
34861 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
34862 "arguments. A bitmask in the header indicates which optional arguments are "
34863 "meaningful. The bitmask is also checked to see if it contains bits set "
34864 "which the daemon does not know about (eg. if more optional arguments were "
34865 "added in a later version of the library), and this causes the call to be "
34870 #: ../src/guestfs.pod:2392
34871 msgid "The reply message for ordinary functions is:"
34875 #: ../src/guestfs.pod:2394
34878 " total length (header + ret,\n"
34879 " but not including the length word itself)\n"
34880 " struct guestfs_message_header (encoded as XDR)\n"
34881 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34886 #: ../src/guestfs.pod:2399
34888 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
34889 "functions that return no formal return values."
34893 #: ../src/guestfs.pod:2402
34894 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
34898 #: ../src/guestfs.pod:2405
34900 "In the case of an error, a flag is set in the header, and the reply message "
34901 "is slightly changed:"
34905 #: ../src/guestfs.pod:2408
34908 " total length (header + error,\n"
34909 " but not including the length word itself)\n"
34910 " struct guestfs_message_header (encoded as XDR)\n"
34911 " struct guestfs_message_error (encoded as XDR)\n"
34916 #: ../src/guestfs.pod:2413
34918 "The C<guestfs_message_error> structure contains the error message as a "
34923 #: ../src/guestfs.pod:2416
34924 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
34928 #: ../src/guestfs.pod:2418
34930 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
34931 "The normal request message is sent (see above). However this is followed by "
34932 "a sequence of file chunks."
34936 #: ../src/guestfs.pod:2422
34939 " total length (header + arguments,\n"
34940 " but not including the length word itself,\n"
34941 " and not including the chunks)\n"
34942 " struct guestfs_message_header (encoded as XDR)\n"
34943 " struct guestfs_<foo>_args (encoded as XDR)\n"
34944 " sequence of chunks for FileIn param #0\n"
34945 " sequence of chunks for FileIn param #1 etc.\n"
34950 #: ../src/guestfs.pod:2430
34951 msgid "The \"sequence of chunks\" is:"
34955 #: ../src/guestfs.pod:2432
34958 " length of chunk (not including length word itself)\n"
34959 " struct guestfs_chunk (encoded as XDR)\n"
34960 " length of chunk\n"
34961 " struct guestfs_chunk (encoded as XDR)\n"
34963 " length of chunk\n"
34964 " struct guestfs_chunk (with data.data_len == 0)\n"
34969 #: ../src/guestfs.pod:2440
34971 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
34972 "is set in the final chunk to indicate either successful completion or early "
34977 #: ../src/guestfs.pod:2444
34979 "At time of writing there are no functions that have more than one FileIn "
34980 "parameter. However this is (theoretically) supported, by sending the "
34981 "sequence of chunks for each FileIn parameter one after another (from left to "
34986 #: ../src/guestfs.pod:2449
34988 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
34989 "transfer. The library does this by sending a chunk with a special flag set "
34990 "to indicate cancellation. When the daemon sees this, it cancels the whole "
34991 "RPC, does I<not> send any reply, and goes back to reading the next request."
34995 #: ../src/guestfs.pod:2455
34997 "The daemon may also cancel. It does this by writing a special word "
34998 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
34999 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35000 "cancel chunk). The special word is chosen so that even if cancellation "
35001 "happens right at the end of the transfer (after the library has finished "
35002 "writing and has started listening for the reply), the \"spurious\" cancel "
35003 "flag will not be confused with the reply message."
35007 #: ../src/guestfs.pod:2464
35009 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35010 "limit), and also files where the size is not known in advance (eg. from "
35011 "pipes or sockets). However the chunks are rather small "
35012 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35013 "to keep much in memory."
35017 #: ../src/guestfs.pod:2470
35018 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35022 #: ../src/guestfs.pod:2472
35024 "The protocol for FileOut parameters is exactly the same as for FileIn "
35025 "parameters, but with the roles of daemon and library reversed."
35029 #: ../src/guestfs.pod:2475
35032 " total length (header + ret,\n"
35033 " but not including the length word itself,\n"
35034 " and not including the chunks)\n"
35035 " struct guestfs_message_header (encoded as XDR)\n"
35036 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35037 " sequence of chunks for FileOut param #0\n"
35038 " sequence of chunks for FileOut param #1 etc.\n"
35043 #: ../src/guestfs.pod:2483
35044 msgid "INITIAL MESSAGE"
35048 #: ../src/guestfs.pod:2485
35050 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35051 "which indicates that the guest and daemon is alive. This is what "
35052 "L</guestfs_launch> waits for."
35056 #: ../src/guestfs.pod:2489
35057 msgid "PROGRESS NOTIFICATION MESSAGES"
35061 #: ../src/guestfs.pod:2491
35063 "The daemon may send progress notification messages at any time. These are "
35064 "distinguished by the normal length word being replaced by "
35065 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35069 #: ../src/guestfs.pod:2495
35071 "The library turns them into progress callbacks (see "
35072 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
35077 #: ../src/guestfs.pod:2499
35079 "The daemon self-limits the frequency of progress messages it sends (see "
35080 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
35085 #: ../src/guestfs.pod:2503
35086 msgid "LIBGUESTFS VERSION NUMBERS"
35090 #: ../src/guestfs.pod:2505
35092 "Since April 2010, libguestfs has started to make separate development and "
35093 "stable releases, along with corresponding branches in our git repository. "
35094 "These separate releases can be identified by version number:"
35098 #: ../src/guestfs.pod:2510
35101 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
35102 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35108 " | `-------- sub-version\n"
35110 " `------ always '1' because we don't change the ABI\n"
35115 #: ../src/guestfs.pod:2521
35116 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35120 #: ../src/guestfs.pod:2523
35122 "As time passes we cherry pick fixes from the development branch and backport "
35123 "those into the stable branch, the effect being that the stable branch should "
35124 "get more stable and less buggy over time. So the stable releases are ideal "
35125 "for people who don't need new features but would just like the software to "
35130 #: ../src/guestfs.pod:2529
35131 msgid "Our criteria for backporting changes are:"
35135 #: ../src/guestfs.pod:2535
35137 "Documentation changes which don't affect any code are backported unless the "
35138 "documentation refers to a future feature which is not in stable."
35142 #: ../src/guestfs.pod:2541
35144 "Bug fixes which are not controversial, fix obvious problems, and have been "
35145 "well tested are backported."
35149 #: ../src/guestfs.pod:2546
35151 "Simple rearrangements of code which shouldn't affect how it works get "
35152 "backported. This is so that the code in the two branches doesn't get too "
35153 "far out of step, allowing us to backport future fixes more easily."
35157 #: ../src/guestfs.pod:2552
35159 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35160 "exceptional case: the new feature is required in order to implement an "
35161 "important bug fix."
35165 #: ../src/guestfs.pod:2558
35167 "A new stable branch starts when we think the new features in development are "
35168 "substantial and compelling enough over the current stable branch to warrant "
35169 "it. When that happens we create new stable and development versions 1.N.0 "
35170 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
35171 "stable at this point, but by backporting fixes from development, that branch "
35172 "will stabilize over time."
35176 #: ../src/guestfs.pod:2566
35177 msgid "EXTENDING LIBGUESTFS"
35181 #: ../src/guestfs.pod:2568
35182 msgid "ADDING A NEW API ACTION"
35186 #: ../src/guestfs.pod:2570
35188 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35189 "documentation) are generated, and this makes it easy to extend the "
35194 #: ../src/guestfs.pod:2574
35195 msgid "To add a new API action there are two changes:"
35199 #: ../src/guestfs.pod:2580
35201 "You need to add a description of the call (name, parameters, return type, "
35202 "tests, documentation) to C<generator/generator_actions.ml>."
35206 #: ../src/guestfs.pod:2583
35208 "There are two sorts of API action, depending on whether the call goes "
35209 "through to the daemon in the appliance, or is serviced entirely by the "
35210 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35211 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35212 "an example of the latter, since a trace flag is maintained in the handle and "
35213 "all tracing is done on the library side."
35217 #: ../src/guestfs.pod:2591
35219 "Most new actions are of the first type, and get added to the "
35220 "C<daemon_functions> list. Each function has a unique procedure number used "
35221 "in the RPC protocol which is assigned to that action when we publish "
35222 "libguestfs and cannot be reused. Take the latest procedure number and "
35227 #: ../src/guestfs.pod:2597
35229 "For library-only actions of the second type, add to the "
35230 "C<non_daemon_functions> list. Since these functions are serviced by the "
35231 "library and do not travel over the RPC mechanism to the daemon, these "
35232 "functions do not need a procedure number, and so the procedure number is set "
35237 #: ../src/guestfs.pod:2605
35238 msgid "Implement the action (in C):"
35242 #: ../src/guestfs.pod:2607
35244 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35245 "C<daemon/> directory."
35249 #: ../src/guestfs.pod:2610
35251 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35252 "(note: double underscore) in the C<src/> directory."
35256 #: ../src/guestfs.pod:2613
35257 msgid "In either case, use another function as an example of what to do."
35261 #: ../src/guestfs.pod:2617
35262 msgid "After making these changes, use C<make> to compile."
35266 #: ../src/guestfs.pod:2619
35268 "Note that you don't need to implement the RPC, language bindings, manual "
35269 "pages or anything else. It's all automatically generated from the OCaml "
35274 #: ../src/guestfs.pod:2623
35275 msgid "ADDING TESTS FOR AN API ACTION"
35279 #: ../src/guestfs.pod:2625
35281 "You can supply zero or as many tests as you want per API call. The tests "
35282 "can either be added as part of the API description "
35283 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
35284 "drop a script into C<regressions/>. Note that adding a script to "
35285 "C<regressions/> is slower, so if possible use the first method."
35289 #: ../src/guestfs.pod:2631
35291 "The following describes the test environment used when you add an API test "
35292 "in C<generator_actions.ml>."
35296 #: ../src/guestfs.pod:2634
35297 msgid "The test environment has 4 block devices:"
35301 #: ../src/guestfs.pod:2638
35302 msgid "C</dev/sda> 500MB"
35306 #: ../src/guestfs.pod:2640
35307 msgid "General block device for testing."
35311 #: ../src/guestfs.pod:2642
35312 msgid "C</dev/sdb> 50MB"
35316 #: ../src/guestfs.pod:2644
35318 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35323 #: ../src/guestfs.pod:2647
35324 msgid "C</dev/sdc> 10MB"
35328 #: ../src/guestfs.pod:2649
35329 msgid "Used in a few tests where two block devices are needed."
35333 #: ../src/guestfs.pod:2651
35334 msgid "C</dev/sdd>"
35338 #: ../src/guestfs.pod:2653
35339 msgid "ISO with fixed content (see C<images/test.iso>)."
35343 #: ../src/guestfs.pod:2657
35345 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35346 "appliance and block devices are reused between tests. So don't try testing "
35347 "L</guestfs_kill_subprocess> :-x"
35351 #: ../src/guestfs.pod:2661
35353 "Each test starts with an initial scenario, selected using one of the "
35354 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35355 "initialize the disks mentioned above in a particular way as documented in "
35356 "C<generator_types.ml>. You should not assume anything about the previous "
35357 "contents of other disks that are not initialized."
35361 #: ../src/guestfs.pod:2667
35363 "You can add a prerequisite clause to any individual test. This is a "
35364 "run-time check, which, if it fails, causes the test to be skipped. Useful "
35365 "if testing a command which might not work on all variations of libguestfs "
35366 "builds. A test that has prerequisite of C<Always> means to run "
35371 #: ../src/guestfs.pod:2673
35373 "In addition, packagers can skip individual tests by setting environment "
35374 "variables before running C<make check>."
35378 #: ../src/guestfs.pod:2676
35381 " SKIP_TEST_<CMD>_<NUM>=1\n"
35386 #: ../src/guestfs.pod:2678
35387 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35391 #: ../src/guestfs.pod:2680
35396 #: ../src/guestfs.pod:2682
35399 " SKIP_TEST_<CMD>=1\n"
35404 #: ../src/guestfs.pod:2684
35405 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35409 #: ../src/guestfs.pod:2686
35410 msgid "Packagers can run only certain tests by setting for example:"
35414 #: ../src/guestfs.pod:2688
35417 " TEST_ONLY=\"vfs_type zerofree\"\n"
35422 #: ../src/guestfs.pod:2690
35424 "See C<capitests/tests.c> for more details of how these environment variables "
35429 #: ../src/guestfs.pod:2693
35430 msgid "DEBUGGING NEW API ACTIONS"
35434 #: ../src/guestfs.pod:2695
35435 msgid "Test new actions work before submitting them."
35439 #: ../src/guestfs.pod:2697
35440 msgid "You can use guestfish to try out new commands."
35444 #: ../src/guestfs.pod:2699
35446 "Debugging the daemon is a problem because it runs inside a minimal "
35447 "environment. However you can fprintf messages in the daemon to stderr, and "
35448 "they will show up if you use C<guestfish -v>."
35452 #: ../src/guestfs.pod:2703
35453 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35457 #: ../src/guestfs.pod:2705
35459 "Our C source code generally adheres to some basic code-formatting "
35460 "conventions. The existing code base is not totally consistent on this "
35461 "front, but we do prefer that contributed code be formatted similarly. In "
35462 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35463 "indentation level, and other than that, follow the K&R style."
35467 #: ../src/guestfs.pod:2711
35469 "If you use Emacs, add the following to one of one of your start-up files "
35470 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
35474 #: ../src/guestfs.pod:2714
35477 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35478 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35479 " (add-hook 'find-file-hook\n"
35480 " '(lambda () (if (and buffer-file-name\n"
35481 " (string-match \"/libguestfs\\\\>\"\n"
35482 " (buffer-file-name))\n"
35483 " (not (string-equal mode-name \"Change Log\"))\n"
35484 " (not (string-equal mode-name \"Makefile\")))\n"
35485 " (setq indent-tabs-mode nil))))\n"
35490 #: ../src/guestfs.pod:2724
35493 " ;;; When editing C sources in libguestfs, use this style.\n"
35494 " (defun libguestfs-c-mode ()\n"
35495 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35497 " (c-set-style \"K&R\")\n"
35498 " (setq c-indent-level 2)\n"
35499 " (setq c-basic-offset 2))\n"
35500 " (add-hook 'c-mode-hook\n"
35501 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35502 " (buffer-file-name))\n"
35503 " (libguestfs-c-mode))))\n"
35508 #: ../src/guestfs.pod:2736
35509 msgid "Enable warnings when compiling (and fix any problems this finds):"
35513 #: ../src/guestfs.pod:2739
35516 " ./configure --enable-gcc-warnings\n"
35521 #: ../src/guestfs.pod:2741
35522 msgid "Useful targets are:"
35526 #: ../src/guestfs.pod:2743
35529 " make syntax-check # checks the syntax of the C code\n"
35530 " make check # runs the test suite\n"
35535 #: ../src/guestfs.pod:2746
35536 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35540 #: ../src/guestfs.pod:2748
35542 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35543 "which are used to do shell quoting."
35547 #: ../src/guestfs.pod:2753
35552 #: ../src/guestfs.pod:2755
35554 "Simple shell quoted string. Any spaces or other shell characters are "
35559 #: ../src/guestfs.pod:2758
35564 #: ../src/guestfs.pod:2760
35566 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35571 #: ../src/guestfs.pod:2767
35574 " asprintf (&cmd, \"cat %R\", path);\n"
35579 #: ../src/guestfs.pod:2769
35580 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35584 #: ../src/guestfs.pod:2771
35586 "I<Note:> Do I<not> use these when you are passing parameters to the "
35587 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
35588 "because they are not passed via the shell (instead, straight to exec). You "
35589 "probably want to use the C<sysroot_path()> function however."
35593 #: ../src/guestfs.pod:2777
35594 msgid "SUBMITTING YOUR NEW API ACTIONS"
35598 #: ../src/guestfs.pod:2779
35600 "Submit patches to the mailing list: "
35601 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
35602 "L<rjones@redhat.com>."
35606 #: ../src/guestfs.pod:2783
35607 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35611 #: ../src/guestfs.pod:2785
35612 msgid "We support i18n (gettext anyhow) in the library."
35616 #: ../src/guestfs.pod:2787
35618 "However many messages come from the daemon, and we don't translate those at "
35619 "the moment. One reason is that the appliance generally has all locale files "
35620 "removed from it, because they take up a lot of space. So we'd have to readd "
35621 "some of those, as well as copying our PO files into the appliance."
35625 #: ../src/guestfs.pod:2793
35627 "Debugging messages are never translated, since they are intended for the "
35632 #: ../src/guestfs.pod:2796
35633 msgid "SOURCE CODE SUBDIRECTORIES"
35637 #: ../src/guestfs.pod:2802
35638 msgid "The libguestfs appliance, build scripts and so on."
35642 #: ../src/guestfs.pod:2804
35643 msgid "C<capitests>"
35647 #: ../src/guestfs.pod:2806
35648 msgid "Automated tests of the C API."
35652 #: ../src/guestfs.pod:2808
35657 #: ../src/guestfs.pod:2810
35659 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35664 #: ../src/guestfs.pod:2813
35669 #: ../src/guestfs.pod:2815
35671 "Safety and liveness tests of components that libguestfs depends upon (not of "
35672 "libguestfs itself). Mainly this is for qemu and the kernel."
35676 #: ../src/guestfs.pod:2818
35681 #: ../src/guestfs.pod:2820
35682 msgid "Outside contributions, experimental parts."
35686 #: ../src/guestfs.pod:2822
35691 #: ../src/guestfs.pod:2824
35693 "The daemon that runs inside the libguestfs appliance and carries out "
35698 #: ../src/guestfs.pod:2827
35703 #: ../src/guestfs.pod:2829
35704 msgid "L<virt-df(1)> command and documentation."
35708 #: ../src/guestfs.pod:2831
35713 #: ../src/guestfs.pod:2833
35714 msgid "L<virt-edit(1)> command and documentation."
35718 #: ../src/guestfs.pod:2835
35719 msgid "C<examples>"
35723 #: ../src/guestfs.pod:2837
35724 msgid "C API example code."
35728 #: ../src/guestfs.pod:2839
35733 #: ../src/guestfs.pod:2841
35735 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
35736 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
35737 "L<virt-tar-out(1)>."
35741 #: ../src/guestfs.pod:2845
35746 #: ../src/guestfs.pod:2847
35747 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
35751 #: ../src/guestfs.pod:2849
35752 msgid "C<generator>"
35756 #: ../src/guestfs.pod:2851
35758 "The crucially important generator, used to automatically generate large "
35759 "amounts of boilerplate C code for things like RPC and bindings."
35763 #: ../src/guestfs.pod:2854
35768 #: ../src/guestfs.pod:2856
35769 msgid "Files used by the test suite."
35773 #: ../src/guestfs.pod:2858
35774 msgid "Some \"phony\" guest images which we test against."
35778 #: ../src/guestfs.pod:2860
35779 msgid "C<inspector>"
35783 #: ../src/guestfs.pod:2862
35784 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
35788 #: ../src/guestfs.pod:2864
35793 #: ../src/guestfs.pod:2866
35794 msgid "Logo used on the website. The fish is called Arthur by the way."
35798 #: ../src/guestfs.pod:2868
35803 #: ../src/guestfs.pod:2870
35804 msgid "M4 macros used by autoconf."
35808 #: ../src/guestfs.pod:2872
35813 #: ../src/guestfs.pod:2874
35814 msgid "Translations of simple gettext strings."
35818 #: ../src/guestfs.pod:2876
35823 #: ../src/guestfs.pod:2878
35825 "The build infrastructure and PO files for translations of manpages and POD "
35826 "files. Eventually this will be combined with the C<po> directory, but that "
35827 "is rather complicated."
35831 #: ../src/guestfs.pod:2882
35832 msgid "C<regressions>"
35836 #: ../src/guestfs.pod:2884
35837 msgid "Regression tests."
35841 #: ../src/guestfs.pod:2886
35846 #: ../src/guestfs.pod:2888
35847 msgid "L<virt-rescue(1)> command and documentation."
35851 #: ../src/guestfs.pod:2890
35856 #: ../src/guestfs.pod:2892
35857 msgid "Source code to the C library."
35861 #: ../src/guestfs.pod:2894
35866 #: ../src/guestfs.pod:2896
35867 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
35871 #: ../src/guestfs.pod:2898
35872 msgid "C<test-tool>"
35876 #: ../src/guestfs.pod:2900
35878 "Test tool for end users to test if their qemu/kernel combination will work "
35883 #: ../src/guestfs.pod:2903
35888 #: ../src/guestfs.pod:2905
35893 #: ../src/guestfs.pod:2907
35898 #: ../src/guestfs.pod:2909
35903 #: ../src/guestfs.pod:2911
35908 #: ../src/guestfs.pod:2913
35913 #: ../src/guestfs.pod:2915
35918 #: ../src/guestfs.pod:2917
35923 #: ../src/guestfs.pod:2919
35928 #: ../src/guestfs.pod:2921
35929 msgid "Language bindings."
35933 #: ../src/guestfs.pod:2925
35934 msgid "MAKING A STABLE RELEASE"
35938 #: ../src/guestfs.pod:2927
35940 "When we make a stable release, there are several steps documented here. See "
35941 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
35946 #: ../src/guestfs.pod:2935
35947 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
35951 #: ../src/guestfs.pod:2940
35952 msgid "Finalize RELEASE-NOTES."
35956 #: ../src/guestfs.pod:2944
35957 msgid "Update ROADMAP."
35961 #: ../src/guestfs.pod:2948
35962 msgid "Run C<src/api-support/update-from-tarballs.sh>."
35966 #: ../src/guestfs.pod:2952
35967 msgid "Push and pull from Transifex."
35971 #: ../src/guestfs.pod:2954
35976 #: ../src/guestfs.pod:2956
35984 #: ../src/guestfs.pod:2958
35985 msgid "to push the latest POT files to Transifex. Then run:"
35989 #: ../src/guestfs.pod:2960
35997 #: ../src/guestfs.pod:2962
35998 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36002 #: ../src/guestfs.pod:2966
36004 "Create new stable and development directories under "
36005 "L<http://libguestfs.org/download>."
36009 #: ../src/guestfs.pod:2971
36010 msgid "Create the branch in git:"
36014 #: ../src/guestfs.pod:2973
36017 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36018 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36019 " git branch stable-1.XX\n"
36020 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36025 #: ../src/guestfs.pod:2980
36030 #: ../src/guestfs.pod:2982
36031 msgid "PROTOCOL LIMITS"
36035 #: ../src/guestfs.pod:2984
36037 "Internally libguestfs uses a message-based protocol to pass API calls and "
36038 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36039 "plenty more detail about this). The maximum message size used by the "
36040 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36041 "aware of this limit. The API calls which may be affected are individually "
36042 "documented, with a link back to this section of the documentation."
36046 #: ../src/guestfs.pod:2992
36048 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36049 "a simple string. Because this string is at some point internally encoded as "
36050 "a message, the maximum size that it can return is slightly under 4 MB. If "
36051 "the requested file is larger than this then you will get an error."
36055 #: ../src/guestfs.pod:2998
36057 "In order to transfer large files into and out of the guest filesystem, you "
36058 "need to use particular calls that support this. The sections L</UPLOADING> "
36059 "and L</DOWNLOADING> document how to do this."
36063 #: ../src/guestfs.pod:3002
36065 "You might also consider mounting the disk image using our FUSE filesystem "
36066 "support (L<guestmount(1)>)."
36070 #: ../src/guestfs.pod:3005
36071 msgid "MAXIMUM NUMBER OF DISKS"
36075 #: ../src/guestfs.pod:3007
36076 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36080 #: ../src/guestfs.pod:3010
36082 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36083 "slots. However febootstrap only understands disks with names C</dev/vda> "
36084 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36089 #: ../src/guestfs.pod:3015
36091 "We are working to substantially raise this limit in future versions but it "
36092 "requires complex changes to qemu."
36096 #: ../src/guestfs.pod:3018
36098 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36099 "disks (add and remove disks after calling L</guestfs_launch>). This also "
36100 "requires changes to qemu."
36104 #: ../src/guestfs.pod:3022
36105 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36109 #: ../src/guestfs.pod:3024
36110 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36114 #: ../src/guestfs.pod:3026
36116 "This is because it reserves 4 bits for the minor device number (thus "
36117 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
36121 #: ../src/guestfs.pod:3029
36123 "If you attach a disk with more than 15 partitions, the extra partitions are "
36124 "ignored by libguestfs."
36128 #: ../src/guestfs.pod:3032
36129 msgid "MAXIMUM SIZE OF A DISK"
36133 #: ../src/guestfs.pod:3034
36134 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36138 #: ../src/guestfs.pod:3036
36140 "We have tested block devices up to 1 exabyte (2**60 or "
36141 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36146 #: ../src/guestfs.pod:3040
36148 "Although libguestfs probably does not impose any limit, the underlying host "
36149 "storage will. If you store disk images on a host ext4 filesystem, then the "
36150 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36151 "TB). If you store disk images as host logical volumes then you are limited "
36152 "by the maximum size of an LV."
36156 #: ../src/guestfs.pod:3046
36158 "For the hugest disk image files, we recommend using XFS on the host for "
36163 #: ../src/guestfs.pod:3049
36164 msgid "MAXIMUM SIZE OF A PARTITION"
36168 #: ../src/guestfs.pod:3051
36170 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36171 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
36172 "address a partition located beyond 2 TB on the disk."
36176 #: ../src/guestfs.pod:3055
36178 "It is recommended that you use GPT partitions on disks which are larger than "
36179 "this size. GPT uses 64 bit sector numbers and so can address partitions "
36180 "which are theoretically larger than the largest disk we could support."
36184 #: ../src/guestfs.pod:3060
36185 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36189 #: ../src/guestfs.pod:3062
36191 "This depends on the filesystem type. libguestfs itself does not impose any "
36192 "known limit. Consult Wikipedia or the filesystem documentation to find out "
36193 "what these limits are."
36197 #: ../src/guestfs.pod:3066
36198 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36202 #: ../src/guestfs.pod:3068
36204 "The API functions L</guestfs_upload>, L</guestfs_download>, "
36205 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36206 "uploads and downloads."
36210 #: ../src/guestfs.pod:3072
36211 msgid "INSPECTION LIMITS"
36215 #: ../src/guestfs.pod:3074
36217 "The inspection code has several arbitrary limits on things like the size of "
36218 "Windows Registry hive it will read, and the length of product name. These "
36219 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36220 "memory and disk space on the host, and should not be reached in practice. "
36221 "See the source code for more information."
36225 #: ../src/guestfs.pod:3100
36227 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36228 "effect as calling C<guestfs_set_verbose (g, 1)>."
36232 #: ../src/guestfs.pod:3112
36234 "Set the path that libguestfs uses to search for a supermin appliance. See "
36235 "the discussion of paths in section L</PATH> above."
36239 #: ../src/guestfs.pod:3121
36240 msgid "See also L</QEMU WRAPPERS> above."
36244 #: ../src/guestfs.pod:3125
36246 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36247 "effect as calling C<guestfs_set_trace (g, 1)>."
36251 #: ../src/guestfs.pod:3143
36253 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
36254 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
36255 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
36256 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
36257 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
36258 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
36259 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
36260 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36261 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36265 #: ../src/guestfs.pod:3174
36267 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
36268 "L<lvm(8)>, L<disktype(1)>."
36272 #: ../src/guestfs.pod:3181 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
36277 #: ../src/guestfs.pod:3183
36278 msgid "To get a list of bugs against libguestfs use this link:"
36282 #: ../src/guestfs.pod:3185
36283 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
36287 #: ../src/guestfs.pod:3187
36288 msgid "To report a new bug against libguestfs use this link:"
36292 #: ../src/guestfs.pod:3189
36293 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
36297 #: ../src/guestfs.pod:3191
36298 msgid "When reporting a bug, please check:"
36302 #: ../src/guestfs.pod:3197
36303 msgid "That the bug hasn't been reported already."
36307 #: ../src/guestfs.pod:3201
36308 msgid "That you are testing a recent version."
36312 #: ../src/guestfs.pod:3205
36313 msgid "Describe the bug accurately, and give a way to reproduce it."
36317 #: ../src/guestfs.pod:3209
36319 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36324 #: ../test-tool/libguestfs-test-tool.pod:5
36325 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
36329 #: ../test-tool/libguestfs-test-tool.pod:9
36332 " libguestfs-test-tool [--options]\n"
36337 #: ../test-tool/libguestfs-test-tool.pod:13
36339 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
36340 "to check basic libguestfs functionality is working. This is needed because "
36341 "libguestfs occasionally breaks for reasons beyond our control: usually "
36342 "because of changes in the underlying qemu or kernel packages, or the host "
36347 #: ../test-tool/libguestfs-test-tool.pod:19
36348 msgid "If you suspect a problem in libguestfs, then just run:"
36352 #: ../test-tool/libguestfs-test-tool.pod:21
36355 " libguestfs-test-tool\n"
36360 #: ../test-tool/libguestfs-test-tool.pod:23
36361 msgid "It will print lots of diagnostic messages."
36365 #: ../test-tool/libguestfs-test-tool.pod:25
36366 msgid "If it runs to completion successfully, you will see this near the end:"
36370 #: ../test-tool/libguestfs-test-tool.pod:27
36373 " ===== TEST FINISHED OK =====\n"
36378 #: ../test-tool/libguestfs-test-tool.pod:29
36379 msgid "and the test tool will exit with code 0."
36383 #: ../test-tool/libguestfs-test-tool.pod:31
36385 "If it fails (and/or exits with non-zero error code), please paste the "
36386 "I<complete, unedited> output of the test tool into a bug report. More "
36387 "information about reporting bugs can be found on the "
36388 "L<http://libguestfs.org/> website."
36392 #: ../test-tool/libguestfs-test-tool.pod:42
36393 msgid "Display short usage information and exit."
36397 #: ../test-tool/libguestfs-test-tool.pod:44
36398 msgid "B<--qemu qemu_binary>"
36402 #: ../test-tool/libguestfs-test-tool.pod:46
36404 "If you have downloaded another qemu binary, point this option at the full "
36405 "path of the binary to try it."
36409 #: ../test-tool/libguestfs-test-tool.pod:49
36410 msgid "B<--qemudir qemu_source_dir>"
36414 #: ../test-tool/libguestfs-test-tool.pod:51
36416 "If you have compiled qemu from source, point this option at the source "
36417 "directory to try it."
36421 #: ../test-tool/libguestfs-test-tool.pod:54
36426 #: ../test-tool/libguestfs-test-tool.pod:56
36427 msgid "B<--timeout N>"
36431 #: ../test-tool/libguestfs-test-tool.pod:58
36433 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
36434 "minutes) which does not usually need to be adjusted."
36438 #: ../test-tool/libguestfs-test-tool.pod:63
36439 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36443 #: ../test-tool/libguestfs-test-tool.pod:65
36445 "If you have compiled another version of qemu from source and would like to "
36446 "try that, then you can use the I<--qemudir> option to point to the qemu "
36447 "source directory."
36451 #: ../test-tool/libguestfs-test-tool.pod:69
36453 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36454 "option to point to the binary."
36458 #: ../test-tool/libguestfs-test-tool.pod:72
36460 "Note when using these options, you can ignore the business of qemu wrapper "
36461 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
36462 "wrapper script for you if one is needed."
36466 #: ../test-tool/libguestfs-test-tool.pod:76
36467 msgid "TRYING OUT A DIFFERENT KERNEL"
36471 #: ../test-tool/libguestfs-test-tool.pod:78
36473 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
36474 "libguestfs tries. You do this by setting the environment variables "
36475 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
36479 #: ../test-tool/libguestfs-test-tool.pod:82
36481 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
36486 #: ../test-tool/libguestfs-test-tool.pod:85
36487 msgid "SELF-DIAGNOSIS"
36491 #: ../test-tool/libguestfs-test-tool.pod:87
36493 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
36494 "produced by libguestfs-test-tool and/or possible errors."
36498 #: ../test-tool/libguestfs-test-tool.pod:92
36500 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36501 "I<1> if there was an error."
36505 #: ../test-tool/libguestfs-test-tool.pod:97
36507 "For the full list of environment variables which may affect libguestfs, "
36508 "please see the L<guestfs(3)> manual page."
36512 #: ../test-tool/libguestfs-test-tool.pod:102
36513 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36517 #: ../tools/virt-list-filesystems.pl:32
36518 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36522 #: ../tools/virt-list-filesystems.pl:36
36525 " virt-list-filesystems [--options] domname\n"
36530 #: ../tools/virt-list-filesystems.pl:38
36533 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36538 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36540 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36545 #: ../tools/virt-list-filesystems.pl:45
36547 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36548 "are contained in a virtual machine or disk image."
36552 #: ../tools/virt-list-filesystems.pl:49
36554 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36555 "functionality. For more complex cases you should look at the "
36556 "L<guestfish(1)> tool."
36560 #: ../tools/virt-list-filesystems.pl:112
36562 "With this option, C<virt-list-filesystems> displays the type of each "
36563 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36567 #: ../tools/virt-list-filesystems.pl:119
36572 #: ../tools/virt-list-filesystems.pl:123
36574 "Normally we only show mountable filesystems. If this option is given then "
36575 "swap devices are shown too."
36579 #: ../tools/virt-list-filesystems.pl:197
36581 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
36582 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
36583 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36587 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36588 msgid "Copyright (C) 2009 Red Hat Inc."
36592 #: ../tools/virt-list-partitions.pl:32
36593 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
36597 #: ../tools/virt-list-partitions.pl:36
36600 " virt-list-partitions [--options] domname\n"
36605 #: ../tools/virt-list-partitions.pl:38
36608 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36613 #: ../tools/virt-list-partitions.pl:45
36615 "C<virt-list-partitions> is a command line tool to list the partitions that "
36616 "are contained in a virtual machine or disk image. It is mainly useful as a "
36617 "first step to using L<virt-resize(1)>."
36621 #: ../tools/virt-list-partitions.pl:50
36623 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36624 "functionality. For more complex cases you should look at the "
36625 "L<guestfish(1)> tool."
36629 #: ../tools/virt-list-partitions.pl:113
36630 msgid "Show sizes in human-readable form (eg. \"1G\")."
36634 #: ../tools/virt-list-partitions.pl:123
36636 "With this option, C<virt-list-partitions> displays the type and size of each "
36637 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36641 #: ../tools/virt-list-partitions.pl:130
36646 #: ../tools/virt-list-partitions.pl:132
36651 #: ../tools/virt-list-partitions.pl:134
36652 msgid "Display the total size of each block device (as a separate row or rows)."
36656 #: ../tools/virt-list-partitions.pl:267
36658 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
36659 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
36660 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36664 #: ../tools/virt-list-partitions.pl:283
36665 msgid "Copyright (C) 2009-2010 Red Hat Inc."
36669 #: ../tools/virt-make-fs.pl:37
36670 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
36674 #: ../tools/virt-make-fs.pl:41
36677 " virt-make-fs [--options] input.tar output.img\n"
36682 #: ../tools/virt-make-fs.pl:43
36685 " virt-make-fs [--options] input.tar.gz output.img\n"
36690 #: ../tools/virt-make-fs.pl:45
36693 " virt-make-fs [--options] directory output.img\n"
36698 #: ../tools/virt-make-fs.pl:49
36700 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
36701 "archive or some files in a directory. It is similar to tools like "
36702 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
36703 "it can create common filesystem types like ext2/3 or NTFS, which can be "
36704 "useful if you want to attach these filesystems to existing virtual machines "
36705 "(eg. to import large amounts of read-only data to a VM)."
36709 #: ../tools/virt-make-fs.pl:57
36710 msgid "Basic usage is:"
36714 #: ../tools/virt-make-fs.pl:59
36717 " virt-make-fs input output\n"
36722 #: ../tools/virt-make-fs.pl:61
36724 "where C<input> is either a directory containing files that you want to add, "
36725 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
36726 "C<output> is a disk image. The input type is detected automatically. The "
36727 "output disk image defaults to a raw ext2 image unless you specify extra "
36728 "flags (see L</OPTIONS> below)."
36732 #: ../tools/virt-make-fs.pl:67
36733 msgid "EXTRA SPACE"
36737 #: ../tools/virt-make-fs.pl:69
36739 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
36740 "the files that it contains, but might have extra space. Depending on how "
36741 "you are going to use the output, you might think this extra space is wasted "
36742 "and want to minimize it, or you might want to leave space so that more files "
36743 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
36744 "but you can use the I<--size> flag to leave space in the filesystem if you "
36749 #: ../tools/virt-make-fs.pl:77
36751 "An alternative way to leave extra space but not make the output image any "
36752 "bigger is to use an alternative disk image format (instead of the default "
36753 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
36754 "image format (check your hypervisor supports this before using it). This "
36755 "allows you to choose a large I<--size> but the extra space won't actually be "
36756 "allocated in the image until you try to store something in it."
36760 #: ../tools/virt-make-fs.pl:85
36762 "Don't forget that you can also use local commands including L<resize2fs(8)> "
36763 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
36764 "to build another image from scratch."
36768 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
36773 #: ../tools/virt-make-fs.pl:91
36776 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
36781 #: ../tools/virt-make-fs.pl:93
36782 msgid "FILESYSTEM TYPE"
36786 #: ../tools/virt-make-fs.pl:95
36788 "The default filesystem type is C<ext2>. Just about any filesystem type that "
36789 "libguestfs supports can be used (but I<not> read-only formats like "
36790 "ISO9660). Here are some of the more common choices:"
36794 #: ../tools/virt-make-fs.pl:101
36799 #: ../tools/virt-make-fs.pl:103
36801 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
36802 "you are not going to use the filesystem in a way that requires the journal, "
36803 "then this is just wasted overhead."
36807 #: ../tools/virt-make-fs.pl:107
36808 msgid "I<ntfs> or I<vfat>"
36812 #: ../tools/virt-make-fs.pl:109
36813 msgid "Useful if exporting data to a Windows guest."
36817 #: ../tools/virt-make-fs.pl:111
36819 "I<Note for vfat>: The tar archive or local directory must only contain files "
36820 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
36821 "program running within libguestfs is unable to change the ownership of "
36822 "non-root files, since vfat itself does not support this."
36826 #: ../tools/virt-make-fs.pl:116
36831 #: ../tools/virt-make-fs.pl:118
36833 "Lower overhead than C<ext2>, but certain limitations on filename length and "
36834 "total filesystem size."
36838 #: ../tools/virt-make-fs.pl:125
36841 " virt-make-fs --type=minix input minixfs.img\n"
36846 #: ../tools/virt-make-fs.pl:127
36847 msgid "TO PARTITION OR NOT TO PARTITION"
36851 #: ../tools/virt-make-fs.pl:129
36852 msgid "Optionally virt-make-fs can add a partition table to the output disk."
36856 #: ../tools/virt-make-fs.pl:131
36858 "Adding a partition can make the disk image more compatible with certain "
36859 "virtualized operating systems which don't expect to see a filesystem "
36860 "directly located on a block device (Linux doesn't care and will happily "
36861 "handle both types)."
36865 #: ../tools/virt-make-fs.pl:136
36867 "On the other hand, if you have a partition table then the output image is no "
36868 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
36869 "directly on a partitioned disk image. (However libguestfs tools such as "
36870 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
36874 #: ../tools/virt-make-fs.pl:144
36875 msgid "Add an MBR partition:"
36879 #: ../tools/virt-make-fs.pl:146
36882 " virt-make-fs --partition -- input disk.img\n"
36887 #: ../tools/virt-make-fs.pl:148
36889 "If the output disk image could be terabyte-sized or larger, it's better to "
36890 "use an EFI/GPT-compatible partition table:"
36894 #: ../tools/virt-make-fs.pl:151
36897 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
36902 #: ../tools/virt-make-fs.pl:179
36903 msgid "Enable debugging information."
36907 #: ../tools/virt-make-fs.pl:185
36908 msgid "B<--size=E<lt>NE<gt>>"
36912 #: ../tools/virt-make-fs.pl:187
36913 msgid "B<--size=+E<lt>NE<gt>>"
36917 #: ../tools/virt-make-fs.pl:189
36918 msgid "B<-s E<lt>NE<gt>>"
36922 #: ../tools/virt-make-fs.pl:191
36923 msgid "B<-s +E<lt>NE<gt>>"
36927 #: ../tools/virt-make-fs.pl:193
36928 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
36932 #: ../tools/virt-make-fs.pl:196
36934 "If this option is I<not> given, then the output image will be just large "
36935 "enough to contain all the files, with not much wasted space."
36939 #: ../tools/virt-make-fs.pl:199
36941 "To choose a fixed size output disk, specify an absolute number followed by "
36942 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36943 "Petabytes or Exabytes. This must be large enough to contain all the input "
36944 "files, else you will get an error."
36948 #: ../tools/virt-make-fs.pl:204
36950 "To leave extra space, specify C<+> (plus sign) and a number followed by "
36951 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36952 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
36953 "the input files, and (approximately) an extra 200 MB free space."
36957 #: ../tools/virt-make-fs.pl:210
36959 "Note that virt-make-fs estimates free space, and therefore will not produce "
36960 "filesystems containing precisely the free space requested. (It is much more "
36961 "expensive and time-consuming to produce a filesystem which has precisely the "
36962 "desired free space)."
36966 #: ../tools/virt-make-fs.pl:219
36967 msgid "B<--format=E<lt>fmtE<gt>>"
36971 #: ../tools/virt-make-fs.pl:221
36972 msgid "B<-F E<lt>fmtE<gt>>"
36976 #: ../tools/virt-make-fs.pl:223
36977 msgid "Choose the output disk image format."
36981 #: ../tools/virt-make-fs.pl:225
36982 msgid "The default is C<raw> (raw disk image)."
36986 #: ../tools/virt-make-fs.pl:227
36988 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
36989 "that would really make sense here is C<qcow2>."
36993 #: ../tools/virt-make-fs.pl:234
36994 msgid "B<--type=E<lt>fsE<gt>>"
36998 #: ../tools/virt-make-fs.pl:236
36999 msgid "B<-t E<lt>fsE<gt>>"
37003 #: ../tools/virt-make-fs.pl:238
37004 msgid "Choose the output filesystem type."
37008 #: ../tools/virt-make-fs.pl:240
37009 msgid "The default is C<ext2>."
37013 #: ../tools/virt-make-fs.pl:242
37014 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
37018 #: ../tools/virt-make-fs.pl:249
37019 msgid "B<--partition>"
37023 #: ../tools/virt-make-fs.pl:251
37024 msgid "B<--partition=E<lt>parttypeE<gt>>"
37028 #: ../tools/virt-make-fs.pl:253
37030 "If specified, this flag adds an MBR partition table to the output disk "
37035 #: ../tools/virt-make-fs.pl:256
37037 "You can change the partition table type, eg. I<--partition=gpt> for large "
37042 #: ../tools/virt-make-fs.pl:259
37044 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37045 "might consider the next parameter to be the partition type. For example:"
37049 #: ../tools/virt-make-fs.pl:263
37052 " virt-make-fs --partition input.tar ...\n"
37057 #: ../tools/virt-make-fs.pl:265
37059 "would cause virt-make-fs to think you wanted to use a partition type of "
37060 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37061 "dash) between options and the input file argument:"
37065 #: ../tools/virt-make-fs.pl:269
37068 " virt-make-fs --partition -- input.tar ...\n"
37073 #: ../tools/virt-make-fs.pl:541
37075 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37076 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
37077 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37081 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37083 "When reporting bugs, please enable debugging and capture the I<complete> "
37088 #: ../tools/virt-make-fs.pl:558
37091 " export LIBGUESTFS_DEBUG=1\n"
37092 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37097 #: ../tools/virt-make-fs.pl:561
37099 "Attach /tmp/virt-make-fs.log to a new bug report at "
37100 "L<https://bugzilla.redhat.com/>"
37104 #: ../tools/virt-tar.pl:33
37105 msgid "virt-tar - Extract or upload files to a virtual machine"
37109 #: ../tools/virt-tar.pl:37
37112 " virt-tar [--options] -x domname directory tarball\n"
37117 #: ../tools/virt-tar.pl:39
37120 " virt-tar [--options] -u domname tarball directory\n"
37125 #: ../tools/virt-tar.pl:41
37128 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37133 #: ../tools/virt-tar.pl:43
37136 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37141 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37146 #: ../tools/virt-tar.pl:47
37148 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
37149 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
37153 #: ../tools/virt-tar.pl:52
37154 msgid "Download C</home> from the VM into a local tarball:"
37158 #: ../tools/virt-tar.pl:54
37161 " virt-tar -x domname /home home.tar\n"
37166 #: ../tools/virt-tar.pl:56
37169 " virt-tar -zx domname /home home.tar.gz\n"
37174 #: ../tools/virt-tar.pl:58
37175 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37179 #: ../tools/virt-tar.pl:60
37182 " virt-tar -u domname uploadstuff.tar /tmp\n"
37187 #: ../tools/virt-tar.pl:62
37190 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37195 #: ../tools/virt-tar.pl:66
37197 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37198 "virtual machines. If you do this, you risk disk corruption in the VM. "
37199 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37203 #: ../tools/virt-tar.pl:71
37205 "You can use I<-x> (extract) on live virtual machines, but you might get "
37206 "inconsistent results or errors if there is filesystem activity inside the "
37207 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37208 "work, but the only way to guarantee consistent results is if the virtual "
37209 "machine is shut down."
37213 #: ../tools/virt-tar.pl:79
37215 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37216 "parts of a guest filesystem. There are many possibilities: making backups, "
37217 "uploading data files, snooping on guest activity, fixing or customizing "
37222 #: ../tools/virt-tar.pl:84
37224 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37225 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37226 "should look at the L<guestfish(1)> tool."
37230 #: ../tools/virt-tar.pl:88
37232 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37233 "its contents (recursively) from the virtual machine into a local tarball. "
37234 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37235 "virtual machine. You cannot use these two options together."
37239 #: ../tools/virt-tar.pl:94
37241 "In addition, you may need to use the I<-z> (gZip) option to enable "
37242 "compression. When uploading, you have to specify I<-z> if the upload file "
37243 "is compressed because virt-tar won't detect this on its own."
37247 #: ../tools/virt-tar.pl:98
37249 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37250 "example it cannot do PKZip files or bzip2 compression. If you want that "
37251 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37252 "the L<libguestfs(3)> API)."
37256 #: ../tools/virt-tar.pl:160
37257 msgid "B<--extract>"
37261 #: ../tools/virt-tar.pl:162
37262 msgid "B<--download>"
37266 #: ../tools/virt-tar.pl:164
37271 #: ../tools/virt-tar.pl:166
37272 msgid "B<--upload>"
37276 #: ../tools/virt-tar.pl:168
37278 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37283 #: ../tools/virt-tar.pl:171
37285 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37286 "Please read the L</WARNING> section above before using this option."
37290 #: ../tools/virt-tar.pl:175
37291 msgid "You must specify exactly one of these options."
37295 #: ../tools/virt-tar.pl:181
37300 #: ../tools/virt-tar.pl:183
37305 #: ../tools/virt-tar.pl:185
37306 msgid "Specify that the input or output tarball is gzip-compressed."
37310 #: ../tools/virt-tar.pl:298
37312 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
37313 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
37314 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
37315 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37319 #: ../tools/virt-win-reg.pl:37
37321 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
37326 #: ../tools/virt-win-reg.pl:41
37329 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37334 #: ../tools/virt-win-reg.pl:43
37337 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37342 #: ../tools/virt-win-reg.pl:45
37345 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37350 #: ../tools/virt-win-reg.pl:47
37353 " virt-win-reg --merge domname [input.reg ...]\n"
37358 #: ../tools/virt-win-reg.pl:49
37361 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37366 #: ../tools/virt-win-reg.pl:53
37368 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37369 "virtual machines. If you do this, you I<will> get irreversible disk "
37370 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37371 "but doesn't catch all cases."
37375 #: ../tools/virt-win-reg.pl:58
37377 "Modifying the Windows Registry is an inherently risky operation. The format "
37378 "is deliberately obscure and undocumented, and Registry changes can leave the "
37379 "system unbootable. Therefore when using the I<--merge> option, make sure "
37380 "you have a reliable backup first."
37384 #: ../tools/virt-win-reg.pl:65
37386 "This program can export and merge Windows Registry entries from a Windows "
37391 #: ../tools/virt-win-reg.pl:68
37393 "The first parameter is the libvirt guest name or the raw disk image of a "
37398 #: ../tools/virt-win-reg.pl:71
37400 "If I<--merge> is I<not> specified, then the chosen registry key is "
37401 "displayed/exported (recursively). For example:"
37405 #: ../tools/virt-win-reg.pl:74
37408 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37413 #: ../tools/virt-win-reg.pl:76
37414 msgid "You can also display single values from within registry keys, for example:"
37418 #: ../tools/virt-win-reg.pl:79
37421 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37422 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37423 " Windows 7 Enterprise\n"
37428 #: ../tools/virt-win-reg.pl:83
37430 "With I<--merge>, you can merge a textual regedit file into the Windows "
37435 #: ../tools/virt-win-reg.pl:86
37438 " $ virt-win-reg --merge Windows7 changes.reg\n"
37443 #: ../tools/virt-win-reg.pl:90
37445 "This program is only meant for simple access to the registry. If you want "
37446 "to do complicated things with the registry, we suggest you download the "
37447 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37448 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37449 "L<hivexregedit(1)>."
37453 #: ../tools/virt-win-reg.pl:159
37458 #: ../tools/virt-win-reg.pl:161
37460 "In merge mode, this merges a textual regedit file into the Windows Registry "
37461 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37462 "displays or exports Registry entries instead."
37466 #: ../tools/virt-win-reg.pl:165
37468 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37469 "result in disk corruption. However exporting (without this flag) is always "
37474 #: ../tools/virt-win-reg.pl:173
37475 msgid "B<--encoding> UTF-16LE|ASCII"
37479 #: ../tools/virt-win-reg.pl:175
37481 "When merging (only), you may need to specify the encoding for strings to be "
37482 "used in the hive file. This is explained in detail in "
37483 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
37487 #: ../tools/virt-win-reg.pl:179
37489 "The default is to use UTF-16LE, which should work with recent versions of "
37494 #: ../tools/virt-win-reg.pl:186
37495 msgid "B<--unsafe-printable-strings>"
37499 #: ../tools/virt-win-reg.pl:188
37501 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37502 "instead of hex sequences. Remove the final zero codepoint from strings if "
37507 #: ../tools/virt-win-reg.pl:192
37509 "This is unsafe and does not preserve the fidelity of strings in the original "
37510 "Registry for various reasons:"
37514 #: ../tools/virt-win-reg.pl:199
37516 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37517 "other encodings will be corrupted by this transformation."
37521 #: ../tools/virt-win-reg.pl:204
37523 "Assumes that everything which has type 1 or 2 is really a string and that "
37524 "everything else is not a string, but the type field in real Registries is "
37529 #: ../tools/virt-win-reg.pl:210
37531 "Loses information about whether a zero codepoint followed the string in the "
37536 #: ../tools/virt-win-reg.pl:215
37538 "This all happens because the Registry itself contains no information about "
37539 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37543 #: ../tools/virt-win-reg.pl:219
37545 "You should only use this option for quick hacking and debugging of the "
37546 "Registry contents, and I<never> use it if the output is going to be passed "
37547 "into another program or stored in another Registry."
37551 #: ../tools/virt-win-reg.pl:556
37552 msgid "SUPPORTED SYSTEMS"
37556 #: ../tools/virt-win-reg.pl:558
37558 "The program currently supports Windows NT-derived guests starting with "
37559 "Windows XP through to at least Windows 7."
37563 #: ../tools/virt-win-reg.pl:561
37564 msgid "The following Registry keys are supported:"
37568 #: ../tools/virt-win-reg.pl:565
37569 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37573 #: ../tools/virt-win-reg.pl:567
37574 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37578 #: ../tools/virt-win-reg.pl:569
37579 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37583 #: ../tools/virt-win-reg.pl:571
37584 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37588 #: ../tools/virt-win-reg.pl:573
37589 msgid "C<HKEY_USERS\\.DEFAULT>"
37593 #: ../tools/virt-win-reg.pl:575
37594 msgid "C<HKEY_USERS\\I<SID>>"
37598 #: ../tools/virt-win-reg.pl:577
37599 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37603 #: ../tools/virt-win-reg.pl:579
37604 msgid "C<HKEY_USERS\\I<username>>"
37608 #: ../tools/virt-win-reg.pl:581
37609 msgid "where I<username> is a local user name (this is a libguestfs extension)."
37613 #: ../tools/virt-win-reg.pl:585
37615 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37620 #: ../tools/virt-win-reg.pl:588
37622 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37623 "supported (there is no \"current user\")."
37627 #: ../tools/virt-win-reg.pl:591
37632 #: ../tools/virt-win-reg.pl:593
37634 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37635 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
37636 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
37637 "with Windows-style line endings, you may need to reencode the whole file "
37638 "before or after processing."
37642 #: ../tools/virt-win-reg.pl:599
37644 "To reencode a file from Windows format to Linux (before processing it with "
37645 "the I<--merge> option), you would do something like this:"
37649 #: ../tools/virt-win-reg.pl:602
37652 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
37657 #: ../tools/virt-win-reg.pl:604
37659 "To go in the opposite direction, after exporting and before sending the file "
37660 "to a Windows user, do something like this:"
37664 #: ../tools/virt-win-reg.pl:607
37667 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
37672 #: ../tools/virt-win-reg.pl:609
37673 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37677 #: ../tools/virt-win-reg.pl:611
37679 "If you are unsure about the current encoding, use the L<file(1)> command. "
37680 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
37681 "Windows-style (CRLF) line endings, like this:"
37685 #: ../tools/virt-win-reg.pl:615
37688 " $ file software.reg\n"
37689 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37690 " with CRLF line terminators\n"
37695 #: ../tools/virt-win-reg.pl:619
37696 msgid "This file would need conversion before you could I<--merge> it."
37700 #: ../tools/virt-win-reg.pl:621
37701 msgid "CurrentControlSet etc."
37705 #: ../tools/virt-win-reg.pl:623
37707 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
37708 "Registry at the level of the hive file, and therefore you cannot modify "
37713 #: ../tools/virt-win-reg.pl:627
37715 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
37716 "circumstances it might refer to another control set. The way to find out is "
37717 "to look at the C<HKLM\\SYSTEM\\Select> key:"
37721 #: ../tools/virt-win-reg.pl:631
37724 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
37725 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
37726 " \"Current\"=dword:00000001\n"
37727 " \"Default\"=dword:00000001\n"
37728 " \"Failed\"=dword:00000000\n"
37729 " \"LastKnownGood\"=dword:00000002\n"
37734 #: ../tools/virt-win-reg.pl:638
37735 msgid "\"Current\" is the one which Windows will choose when it boots."
37739 #: ../tools/virt-win-reg.pl:640
37740 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
37744 #: ../tools/virt-win-reg.pl:643
37745 msgid "WINDOWS TIPS"
37749 #: ../tools/virt-win-reg.pl:645
37751 "Note that some of these tips modify the guest disk image. The guest I<must> "
37752 "be shut off, else you will get disk corruption."
37756 #: ../tools/virt-win-reg.pl:648
37757 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
37761 #: ../tools/virt-win-reg.pl:650
37763 "Prepare a DOS batch script, VBScript or executable. Upload this using "
37764 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
37765 "is uploaded into C<C:\\>:"
37769 #: ../tools/virt-win-reg.pl:654
37772 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
37777 #: ../tools/virt-win-reg.pl:656
37778 msgid "Prepare a regedit file containing the registry change:"
37782 #: ../tools/virt-win-reg.pl:658
37785 " cat > test.reg <<'EOF'\n"
37786 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
37787 " \"Test\"=\"c:\\\\test.bat\"\n"
37793 #: ../tools/virt-win-reg.pl:663
37795 "In this example we use the key C<RunOnce> which means that the script will "
37796 "run precisely once when the first user logs in. If you want it to run every "
37797 "time a user logs in, replace C<RunOnce> with C<Run>."
37801 #: ../tools/virt-win-reg.pl:667
37802 msgid "Now update the registry:"
37806 #: ../tools/virt-win-reg.pl:669
37809 " virt-win-reg --merge WindowsGuest test.reg\n"
37814 #: ../tools/virt-win-reg.pl:671
37815 msgid "INSTALLING A SERVICE"
37819 #: ../tools/virt-win-reg.pl:673
37821 "This section assumes you are familiar with Windows services, and you either "
37822 "have a program which handles the Windows Service Control Protocol directly "
37823 "or you want to run any program using a service wrapper like SrvAny or the "
37828 #: ../tools/virt-win-reg.pl:678
37830 "First upload the program and optionally the service wrapper. In this case "
37831 "the test program is called C<test.exe> and we are using the RHSrvAny "
37836 #: ../tools/virt-win-reg.pl:682
37839 " guestfish -i -d WindowsGuest <<EOF\n"
37840 " upload rhsrvany.exe /rhsrvany.exe\n"
37841 " upload test.exe /test.exe\n"
37847 #: ../tools/virt-win-reg.pl:687
37849 "Prepare a regedit file containing the registry changes. In this example, "
37850 "the first registry change is needed for the service itself or the service "
37851 "wrapper (if used). The second registry change is only needed because I am "
37852 "using the RHSrvAny service wrapper."
37856 #: ../tools/virt-win-reg.pl:692
37859 " cat > service.reg <<'EOF'\n"
37860 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
37861 " \"Type\"=dword:00000010\n"
37862 " \"Start\"=dword:00000002\n"
37863 " \"ErrorControl\"=dword:00000001\n"
37864 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
37865 " \"DisplayName\"=\"RHSrvAny\"\n"
37866 " \"ObjectName\"=\"NetworkService\"\n"
37871 #: ../tools/virt-win-reg.pl:701
37874 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
37875 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
37876 " \"PWD\"=\"c:\\\\Temp\"\n"
37882 #: ../tools/virt-win-reg.pl:712
37884 "For use of C<ControlSet001> see the section above in this manual page. You "
37885 "may need to adjust this according to the control set that is in use by the "
37890 #: ../tools/virt-win-reg.pl:718
37892 "C<\"ObjectName\"> controls the privileges that the service will have. An "
37893 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
37894 "privileged account."
37898 #: ../tools/virt-win-reg.pl:724
37900 "For the meaning of the magic numbers, see this Microsoft KB article: "
37901 "L<http://support.microsoft.com/kb/103000>."
37905 #: ../tools/virt-win-reg.pl:729
37906 msgid "Update the registry:"
37910 #: ../tools/virt-win-reg.pl:731
37913 " virt-win-reg --merge WindowsGuest service.reg\n"
37918 #: ../tools/virt-win-reg.pl:735
37920 "Be careful when passing parameters containing C<\\> (backslash) in the "
37921 "shell. Usually you will have to use 'single quotes' or double backslashes "
37922 "(but not both) to protect them from the shell."
37926 #: ../tools/virt-win-reg.pl:739
37927 msgid "Paths and value names are case-insensitive."
37931 #: ../tools/virt-win-reg.pl:748
37933 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
37934 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
37935 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
37936 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37940 #: ../tools/virt-win-reg.pl:766
37943 " export LIBGUESTFS_DEBUG=1\n"
37944 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
37949 #: ../tools/virt-win-reg.pl:769
37951 "Attach /tmp/virt-win-reg.log to a new bug report at "
37952 "L<https://bugzilla.redhat.com/>"