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.14.1\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-10-31 09:01+0000\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 #: ../align/virt-alignment-scan.pod:3 ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3 ../clone/virt-sysprep.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 ../sparsify/virt-sparsify.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 #: ../align/virt-alignment-scan.pod:5
27 msgid "virt-alignment-scan - Check alignment of virtual machine partitions"
31 #: ../align/virt-alignment-scan.pod:7 ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7 ../clone/virt-sysprep.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 ../sparsify/virt-sparsify.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 #: ../align/virt-alignment-scan.pod:9
39 " virt-alignment-scan [--options] -d domname\n"
44 #: ../align/virt-alignment-scan.pod:11
47 " virt-alignment-scan [--options] -a disk.img [-a disk.img ...]\n"
52 #: ../align/virt-alignment-scan.pod:13 ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../clone/virt-sysprep.pod:13 ../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 ../sparsify/virt-sparsify.pod:11 ../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
57 #: ../align/virt-alignment-scan.pod:15
59 "When older operating systems install themselves, the partitioning tools "
60 "place partitions at a sector misaligned with the underlying storage "
61 "(commonly the first partition starts on sector C<63>). Misaligned "
62 "partitions can result in an operating system issuing more I/O than should be "
67 #: ../align/virt-alignment-scan.pod:21
69 "The virt-alignment-scan tool checks the alignment of partitions in virtual "
70 "machines and disk images and warns you if there are alignment problems."
74 #: ../align/virt-alignment-scan.pod:25
76 "Currently there is no virt tool for fixing alignment problems. You can only "
77 "reinstall the guest operating system. The following NetApp document "
78 "summarises the problem and possible solutions: "
79 "L<http://media.netapp.com/documents/tr-3747.pdf>"
83 #: ../align/virt-alignment-scan.pod:30
88 #: ../align/virt-alignment-scan.pod:32
89 msgid "To run this tool on a disk image directly, use the I<-a> option:"
93 #: ../align/virt-alignment-scan.pod:34
96 " $ virt-alignment-scan -a winxp.img\n"
97 " /dev/sda1 32256 512 bad (alignment < 4K)\n"
102 #: ../align/virt-alignment-scan.pod:37
105 " $ virt-alignment-scan -a fedora16.img\n"
106 " /dev/sda1 1048576 1024K ok\n"
107 " /dev/sda2 2097152 2048K ok\n"
108 " /dev/sda3 526385152 2048K ok\n"
113 #: ../align/virt-alignment-scan.pod:42
115 "To run the tool on a guest known to libvirt, use the I<-d> option and "
116 "possibly the I<-c> option:"
120 #: ../align/virt-alignment-scan.pod:45
123 " # virt-alignment-scan -d RHEL5\n"
124 " /dev/sda1 32256 512 bad (alignment < 4K)\n"
125 " /dev/sda2 106928640 512 bad (alignment < 4K)\n"
130 #: ../align/virt-alignment-scan.pod:49
133 " $ virt-alignment-scan -c qemu:///system -d Win7TwoDisks\n"
134 " /dev/sda1 1048576 1024K ok\n"
135 " /dev/sda2 105906176 1024K ok\n"
136 " /dev/sdb1 65536 64K ok\n"
141 #: ../align/virt-alignment-scan.pod:54
143 "The output consists of 4 or more whitespace-separated columns. Only the "
144 "first 4 columns are signficant if you want to parse this from a program. "
149 #: ../align/virt-alignment-scan.pod:60
154 #: ../align/virt-alignment-scan.pod:62
156 "the device and partition name (eg. C</dev/sda1> meaning the first partition "
157 "on the first block device)"
161 #: ../align/virt-alignment-scan.pod:65
166 #: ../align/virt-alignment-scan.pod:67
167 msgid "the start of the partition in bytes"
171 #: ../align/virt-alignment-scan.pod:69
176 #: ../align/virt-alignment-scan.pod:71
177 msgid "the alignment in bytes or Kbytes (eg. C<512> or C<4K>)"
181 #: ../align/virt-alignment-scan.pod:73
186 #: ../align/virt-alignment-scan.pod:75
188 "C<ok> if the alignment is best for performance, or C<bad> if the alignment "
189 "can cause performance problems"
193 #: ../align/virt-alignment-scan.pod:78
198 #: ../align/virt-alignment-scan.pod:80
199 msgid "optional free-text explanation."
203 #: ../align/virt-alignment-scan.pod:84
205 "The exit code from the program changes depending on whether poorly aligned "
206 "partitions were found. See L</EXIT STATUS> below."
210 #: ../align/virt-alignment-scan.pod:87
211 msgid "If you just want the exit code with no output, use the I<-q> option."
215 #: ../align/virt-alignment-scan.pod:89 ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../clone/virt-sysprep.pod:42 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:92 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:262 ../sparsify/virt-sparsify.pod:99 ../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
220 #: ../align/virt-alignment-scan.pod:93 ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../clone/virt-sysprep.pod:46 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:160 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:266 ../sparsify/virt-sparsify.pod:103 ../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
225 #: ../align/virt-alignment-scan.pod:95 ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../clone/virt-sysprep.pod:48 ../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
226 msgid "Display brief help."
230 #: ../align/virt-alignment-scan.pod:97 ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../clone/virt-sysprep.pod:50 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
235 #: ../align/virt-alignment-scan.pod:99 ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../clone/virt-sysprep.pod:52 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
236 msgid "B<--add> file"
240 #: ../align/virt-alignment-scan.pod:101 ../clone/virt-sysprep.pod:54
241 msgid "Add I<file> which should be a disk image from a virtual machine."
245 #: ../align/virt-alignment-scan.pod:103 ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../clone/virt-sysprep.pod:56 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:102 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
247 "The format of the disk image is auto-detected. To override this and force a "
248 "particular format use the I<--format=..> option."
252 #: ../align/virt-alignment-scan.pod:106 ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../clone/virt-sysprep.pod:59 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
257 #: ../align/virt-alignment-scan.pod:108 ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../clone/virt-sysprep.pod:61 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
258 msgid "B<--connect> URI"
262 #: ../align/virt-alignment-scan.pod:110 ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../clone/virt-sysprep.pod:63 ../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
264 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
265 "to the default libvirt hypervisor."
269 #: ../align/virt-alignment-scan.pod:113 ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../clone/virt-sysprep.pod:66 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
271 "If you specify guest block devices directly (I<-a>), then libvirt is not "
276 #: ../align/virt-alignment-scan.pod:116 ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../clone/virt-sysprep.pod:69 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
281 #: ../align/virt-alignment-scan.pod:118 ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../clone/virt-sysprep.pod:71 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
282 msgid "B<--domain> guest"
286 #: ../align/virt-alignment-scan.pod:120 ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../clone/virt-sysprep.pod:73 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
288 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
293 #: ../align/virt-alignment-scan.pod:123 ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../clone/virt-sysprep.pod:95 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:142 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
294 msgid "B<--format=raw|qcow2|..>"
298 #: ../align/virt-alignment-scan.pod:125 ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../clone/virt-sysprep.pod:97 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:144 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
303 #: ../align/virt-alignment-scan.pod:127 ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../clone/virt-sysprep.pod:99 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:146 ../rescue/virt-rescue.pod:128
305 "The default for the I<-a> option is to auto-detect the format of the disk "
306 "image. Using this forces the disk format for I<-a> options which follow on "
307 "the command line. Using I<--format> with no argument switches back to "
308 "auto-detection for subsequent I<-a> options."
312 #: ../align/virt-alignment-scan.pod:132 ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../clone/virt-sysprep.pod:104 ../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:2877
317 #: ../align/virt-alignment-scan.pod:134
320 " virt-alignment-scan --format=raw -a disk.img\n"
325 #: ../align/virt-alignment-scan.pod:136 ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../clone/virt-sysprep.pod:108 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
326 msgid "forces raw format (no auto-detection) for C<disk.img>."
330 #: ../align/virt-alignment-scan.pod:138
333 " virt-alignment-scan --format=raw -a disk.img --format -a another.img\n"
338 #: ../align/virt-alignment-scan.pod:140 ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../clone/virt-sysprep.pod:112 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
340 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
341 "auto-detection for C<another.img>."
345 #: ../align/virt-alignment-scan.pod:143 ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../clone/virt-sysprep.pod:115 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
347 "If you have untrusted raw-format guest disk images, you should use this "
348 "option to specify the disk format. This avoids a possible security problem "
349 "with malicious guests (CVE-2010-3851)."
353 #: ../align/virt-alignment-scan.pod:147 ../resize/virt-resize.pod:491 ../sparsify/virt-sparsify.pod:153
358 #: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:493 ../sparsify/virt-sparsify.pod:155
363 #: ../align/virt-alignment-scan.pod:151
365 "Don't produce any output. Just set the exit code (see L</EXIT STATUS> "
370 #: ../align/virt-alignment-scan.pod:154 ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../clone/virt-sysprep.pod:138 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:266 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:182 ../sparsify/virt-sparsify.pod:159
375 #: ../align/virt-alignment-scan.pod:156 ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../clone/virt-sysprep.pod:140 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:268 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:184 ../sparsify/virt-sparsify.pod:161
380 #: ../align/virt-alignment-scan.pod:158 ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../clone/virt-sysprep.pod:142 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:186 ../sparsify/virt-sparsify.pod:163
381 msgid "Enable verbose messages for debugging."
385 #: ../align/virt-alignment-scan.pod:160 ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../clone/virt-sysprep.pod:144 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:272 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:561 ../sparsify/virt-sparsify.pod:165
390 #: ../align/virt-alignment-scan.pod:162 ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../clone/virt-sysprep.pod:146 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:274 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:190 ../resize/virt-resize.pod:563 ../sparsify/virt-sparsify.pod:167 ../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
395 #: ../align/virt-alignment-scan.pod:164 ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../clone/virt-sysprep.pod:148 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:192 ../resize/virt-resize.pod:565 ../sparsify/virt-sparsify.pod:169 ../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
396 msgid "Display version number and exit."
400 #: ../align/virt-alignment-scan.pod:166 ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../clone/virt-sysprep.pod:150 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:287 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:203 ../sparsify/virt-sparsify.pod:171 ../tools/virt-tar.pl:158
405 #: ../align/virt-alignment-scan.pod:168 ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../clone/virt-sysprep.pod:152 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:205 ../sparsify/virt-sparsify.pod:173
406 msgid "Enable tracing of libguestfs API calls."
410 #: ../align/virt-alignment-scan.pod:172
411 msgid "RECOMMENDED ALIGNMENT"
415 #: ../align/virt-alignment-scan.pod:174
417 "Operating systems older than Windows 2008 and Linux before ca.2010 place the "
418 "first sector of the first partition at sector 63, with a 512 byte sector "
419 "size. This happens because of a historical accident. Drives have to report "
420 "a cylinder / head / sector (CHS) geometry to the BIOS. The geometry is "
421 "completely meaningless on modern drives, but it happens that the geometry "
422 "reported always has 63 sectors per track. The operating system therefore "
423 "places the first partition at the start of the second \"track\", at sector "
428 #: ../align/virt-alignment-scan.pod:183
430 "When the guest OS is virtualized, the host operating system and hypervisor "
431 "may prefer accesses aligned to one of:"
435 #: ../align/virt-alignment-scan.pod:188
440 #: ../align/virt-alignment-scan.pod:190
442 "if the host OS uses local storage directly on hard drive partitions, and the "
443 "hard drive has 512 byte physical sectors."
447 #: ../align/virt-alignment-scan.pod:193
452 #: ../align/virt-alignment-scan.pod:195
454 "for local storage on new hard drives with 4Kbyte physical sectors; for "
455 "file-backed storage on filesystems with 4Kbyte block size; or for some types "
456 "of network-attached storage."
460 #: ../align/virt-alignment-scan.pod:199
465 #: ../align/virt-alignment-scan.pod:201
467 "for high-end network-attached storage. This is the optimal block size for "
468 "some NetApp hardware."
472 #: ../align/virt-alignment-scan.pod:204
477 #: ../align/virt-alignment-scan.pod:206
478 msgid "see L</1 MB PARTITION ALIGNMENT> below."
482 #: ../align/virt-alignment-scan.pod:210
484 "Partitions which are not aligned correctly to the underlying storage cause "
485 "extra I/O. For example:"
489 #: ../align/virt-alignment-scan.pod:213
493 " +--------------------------+------\n"
495 " | filesystem block |\n"
496 " ---+------------------+------+-------------------+-----+---\n"
497 " | host block | host block |\n"
499 " ---+-------------------------+-------------------------+---\n"
504 #: ../align/virt-alignment-scan.pod:222
506 "In this example, each time a 4K guest block is read, two blocks on the host "
507 "must be accessed (so twice as much I/O is done). When a 4K guest block is "
508 "written, two host blocks must first be read, the old and new data combined, "
509 "and the two blocks written back (4x I/O)."
513 #: ../align/virt-alignment-scan.pod:227
514 msgid "LINUX HOST BLOCK AND I/O SIZE"
518 #: ../align/virt-alignment-scan.pod:229
520 "New versions of the Linux kernel expose the physical and logical block size, "
521 "and minimum and recommended I/O size."
525 #: ../align/virt-alignment-scan.pod:232
526 msgid "For a typical consumer hard drive with 512 byte sectors:"
530 #: ../align/virt-alignment-scan.pod:234
533 " $ cat /sys/block/sda/queue/hw_sector_size\n"
535 " $ cat /sys/block/sda/queue/physical_block_size\n"
537 " $ cat /sys/block/sda/queue/logical_block_size\n"
539 " $ cat /sys/block/sda/queue/minimum_io_size\n"
541 " $ cat /sys/block/sda/queue/optimal_io_size\n"
547 #: ../align/virt-alignment-scan.pod:245
548 msgid "For a new consumer hard drive with 4Kbyte sectors:"
552 #: ../align/virt-alignment-scan.pod:247
555 " $ cat /sys/block/sda/queue/hw_sector_size\n"
557 " $ cat /sys/block/sda/queue/physical_block_size\n"
559 " $ cat /sys/block/sda/queue/logical_block_size\n"
561 " $ cat /sys/block/sda/queue/minimum_io_size\n"
563 " $ cat /sys/block/sda/queue/optimal_io_size\n"
569 #: ../align/virt-alignment-scan.pod:258
570 msgid "For a NetApp LUN:"
574 #: ../align/virt-alignment-scan.pod:260
577 " $ cat /sys/block/sdc/queue/logical_block_size\n"
579 " $ cat /sys/block/sdc/queue/physical_block_size\n"
581 " $ cat /sys/block/sdc/queue/minimum_io_size\n"
583 " $ cat /sys/block/sdc/queue/optimal_io_size\n"
589 #: ../align/virt-alignment-scan.pod:269
591 "The NetApp allows 512 byte accesses (but they will be very inefficient), "
592 "prefers a minimum 4K I/O size, but the optimal I/O size is 64K."
596 #: ../align/virt-alignment-scan.pod:273
598 "For detailed information about what these numbers mean, see "
599 "L<http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/newstorage-iolimits.html>"
603 #: ../align/virt-alignment-scan.pod:276
605 "[Thanks to Matt Booth for providing 4K drive data. Thanks to Mike Snitzer "
606 "for providing NetApp data and additional information.]"
610 #: ../align/virt-alignment-scan.pod:279
611 msgid "1 MB PARTITION ALIGNMENT"
615 #: ../align/virt-alignment-scan.pod:281
617 "Microsoft picked 1 MB as the default alignment for all partitions starting "
618 "with Windows 2008 Server, and Linux has followed this."
622 #: ../align/virt-alignment-scan.pod:284
624 "Assuming 512 byte sectors in the guest, you will now see the first partition "
625 "starting at sector 2048, and subsequent partitions (if any) will start at a "
626 "multiple of 2048 sectors."
630 #: ../align/virt-alignment-scan.pod:288
632 "1 MB alignment is compatible with all current alignment requirements (4K, "
633 "64K) and provides room for future growth in physical block sizes."
637 #: ../align/virt-alignment-scan.pod:291
638 msgid "SETTING ALIGNMENT"
642 #: ../align/virt-alignment-scan.pod:293
644 "L<virt-resize(1)> can change the alignment of the partitions of some "
645 "guests. Currently it can fully align all the partitions of all Windows "
646 "guests, and it will fix the bootloader where necessary. For Linux guests, "
647 "it can align the second and subsequent partitions, so the majority of OS "
648 "accesses except at boot will be aligned."
652 #: ../align/virt-alignment-scan.pod:299
654 "Another way to correct partition alignment problems is to reinstall your "
655 "guest operating systems. If you install operating systems from templates, "
656 "ensure these have correct partition alignment too."
660 #: ../align/virt-alignment-scan.pod:303
662 "For older versions of Windows, the following NetApp document contains useful "
663 "information: L<http://media.netapp.com/documents/tr-3747.pdf>"
667 #: ../align/virt-alignment-scan.pod:306
669 "For Red Hat Enterprise Linux E<le> 5, use a Kickstart script that contains "
670 "an explicit C<%pre> section that creates aligned partitions using "
671 "L<parted(8)>. Do not use the Kickstart C<part> command. The NetApp "
672 "document above contains an example."
676 #: ../align/virt-alignment-scan.pod:311 ../cat/virt-cat.pod:231 ../cat/virt-filesystems.pod:373 ../cat/virt-ls.pod:483 ../clone/virt-sysprep.pod:475 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:266 ../resize/virt-resize.pod:676 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:550 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:744
677 msgid "SHELL QUOTING"
681 #: ../align/virt-alignment-scan.pod:313 ../cat/virt-cat.pod:233 ../cat/virt-filesystems.pod:375 ../cat/virt-ls.pod:485 ../clone/virt-sysprep.pod:477 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:268 ../resize/virt-resize.pod:678 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:552 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:752
683 "Libvirt guest names can contain arbitrary characters, some of which have "
684 "meaning to the shell such as C<#> and space. You may need to quote or "
685 "escape these characters on the command line. See the shell manual page "
686 "L<sh(1)> for details."
690 #: ../align/virt-alignment-scan.pod:318 ../cat/virt-cat.pod:238 ../cat/virt-filesystems.pod:380 ../cat/virt-ls.pod:490 ../clone/virt-sysprep.pod:482 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:312 ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:683 ../sparsify/virt-sparsify.pod:227 ../test-tool/libguestfs-test-tool.pod:90
695 #: ../align/virt-alignment-scan.pod:320
696 msgid "This program returns:"
700 #: ../align/virt-alignment-scan.pod:324 ../align/virt-alignment-scan.pod:330 ../align/virt-alignment-scan.pod:336 ../align/virt-alignment-scan.pod:343 ../cat/virt-cat.pod:177 ../cat/virt-cat.pod:182 ../cat/virt-cat.pod:187 ../cat/virt-cat.pod:198 ../cat/virt-cat.pod:202 ../clone/virt-sysprep.pod:283 ../clone/virt-sysprep.pod:287 ../clone/virt-sysprep.pod:291 ../clone/virt-sysprep.pod:295 ../clone/virt-sysprep.pod:310 ../clone/virt-sysprep.pod:314 ../clone/virt-sysprep.pod:318 ../clone/virt-sysprep.pod:322 ../clone/virt-sysprep.pod:326 ../clone/virt-sysprep.pod:362 ../clone/virt-sysprep.pod:384 ../clone/virt-sysprep.pod:388 ../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:441 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1274 ../fish/guestfish-actions.pod:1282 ../fish/guestfish-actions.pod:1286 ../fish/guestfish-actions.pod:1290 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1304 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:1402 ../fish/guestfish-actions.pod:1407 ../fish/guestfish-actions.pod:1412 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:1458 ../fish/guestfish-actions.pod:1463 ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1726 ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:2136 ../fish/guestfish-actions.pod:2142 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2164 ../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:359 ../resize/virt-resize.pod:363 ../resize/virt-resize.pod:372 ../resize/virt-resize.pod:378 ../sparsify/virt-sparsify.pod:32 ../sparsify/virt-sparsify.pod:39 ../sparsify/virt-sparsify.pod:43 ../sparsify/virt-sparsify.pod:49 ../sparsify/virt-sparsify.pod:54 ../sparsify/virt-sparsify.pod:58 ../sparsify/virt-sparsify.pod:64 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:656 ../src/guestfs-actions.pod:663 ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:2272 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2338 ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:2347 ../src/guestfs-actions.pod:2762 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:3321 ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3335 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3349 ../src/guestfs.pod:403 ../src/guestfs.pod:408 ../src/guestfs.pod:413 ../src/guestfs.pod:417 ../src/guestfs.pod:422 ../src/guestfs.pod:426 ../src/guestfs.pod:431 ../src/guestfs.pod:436 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1122 ../src/guestfs.pod:1130 ../src/guestfs.pod:1149 ../src/guestfs.pod:1157 ../src/guestfs.pod:1179 ../src/guestfs.pod:1183 ../src/guestfs.pod:1187 ../src/guestfs.pod:1191 ../src/guestfs.pod:1195 ../src/guestfs.pod:1199 ../src/guestfs.pod:1689 ../src/guestfs.pod:1694 ../src/guestfs.pod:1698 ../src/guestfs.pod:1800 ../src/guestfs.pod:1805 ../src/guestfs.pod:1809 ../src/guestfs.pod:1819 ../src/guestfs.pod:2108 ../src/guestfs.pod:2113 ../src/guestfs.pod:2119 ../src/guestfs.pod:2127 ../src/guestfs.pod:2645 ../src/guestfs.pod:2651 ../src/guestfs.pod:2656 ../src/guestfs.pod:2662 ../src/guestfs.pod:3062 ../src/guestfs.pod:3067 ../src/guestfs.pod:3071 ../src/guestfs.pod:3075 ../src/guestfs.pod:3079 ../src/guestfs.pod:3093 ../src/guestfs.pod:3098 ../src/guestfs.pod:3329 ../src/guestfs.pod:3333 ../src/guestfs.pod:3337 ../src/guestfs.pod:3341 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:721 ../tools/virt-win-reg.pl:727 ../tools/virt-win-reg.pl:733
705 #: ../align/virt-alignment-scan.pod:326
710 #: ../align/virt-alignment-scan.pod:328
711 msgid "successful exit, all partitions are aligned E<ge> 64K for best performance"
715 #: ../align/virt-alignment-scan.pod:332
720 #: ../align/virt-alignment-scan.pod:334
721 msgid "an error scanning the disk image or guest"
725 #: ../align/virt-alignment-scan.pod:338
730 #: ../align/virt-alignment-scan.pod:340
732 "successful exit, some partitions have alignment E<lt> 64K which can result "
733 "in poor performance on high end network storage"
737 #: ../align/virt-alignment-scan.pod:345
742 #: ../align/virt-alignment-scan.pod:347
744 "successful exit, some partitions have alignment E<lt> 4K which can result in "
745 "poor performance on most hypervisors"
749 #: ../align/virt-alignment-scan.pod:352 ../cat/virt-cat.pod:243 ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:495 ../clone/virt-sysprep.pod:486 ../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:1268 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:317 ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:288 ../resize/virt-resize.pod:688 ../ruby/examples/guestfs-ruby.pod:36 ../sparsify/virt-sparsify.pod:251 ../src/guestfs.pod:3270 ../test-tool/libguestfs-test-tool.pod:100 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:557 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:757
754 #: ../align/virt-alignment-scan.pod:354
756 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-rescue(1)>, "
757 "L<virt-resize(1)>, L<http://libguestfs.org/>."
761 #: ../align/virt-alignment-scan.pod:361 ../cat/virt-cat.pod:252 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:507 ../clone/virt-sysprep.pod:501 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:711 ../sparsify/virt-sparsify.pod:264 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:783
766 #: ../align/virt-alignment-scan.pod:363 ../cat/virt-cat.pod:254 ../cat/virt-filesystems.pod:398 ../cat/virt-ls.pod:509 ../clone/virt-sysprep.pod:503 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:298 ../resize/virt-resize.pod:713 ../sparsify/virt-sparsify.pod:266 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:584 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:785
767 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
771 #: ../align/virt-alignment-scan.pod:365 ../cat/virt-cat.pod:256 ../cat/virt-filesystems.pod:400 ../cat/virt-ls.pod:511 ../clone/virt-sysprep.pod:505 ../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:1300 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:332 ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56 ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:715 ../ruby/examples/guestfs-ruby.pod:52 ../sparsify/virt-sparsify.pod:268 ../src/guestfs.pod:3352 ../test-tool/libguestfs-test-tool.pod:110 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:586 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:787
776 #: ../align/virt-alignment-scan.pod:367 ../clone/virt-sysprep.pod:507 ../sparsify/virt-sparsify.pod:270
777 msgid "Copyright (C) 2011 Red Hat Inc."
781 #: ../align/virt-alignment-scan.pod:369 ../cat/virt-cat.pod:260 ../cat/virt-filesystems.pod:404 ../cat/virt-ls.pod:515 ../clone/virt-sysprep.pod:509 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1305 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:337 ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:304 ../resize/virt-resize.pod:719 ../sparsify/virt-sparsify.pod:272 ../test-tool/libguestfs-test-tool.pod:115 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:590 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:791
783 "This program is free software; you can redistribute it and/or modify it "
784 "under the terms of the GNU General Public License as published by the Free "
785 "Software Foundation; either version 2 of the License, or (at your option) "
790 #: ../align/virt-alignment-scan.pod:374 ../cat/virt-cat.pod:265 ../cat/virt-filesystems.pod:409 ../cat/virt-ls.pod:520 ../clone/virt-sysprep.pod:514 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1310 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:342 ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:309 ../resize/virt-resize.pod:724 ../sparsify/virt-sparsify.pod:277 ../test-tool/libguestfs-test-tool.pod:120 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:595 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:796
792 "This program is distributed in the hope that it will be useful, but WITHOUT "
793 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
794 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
799 #: ../align/virt-alignment-scan.pod:379 ../cat/virt-cat.pod:270 ../cat/virt-filesystems.pod:414 ../cat/virt-ls.pod:525 ../clone/virt-sysprep.pod:519 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1315 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:347 ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:314 ../resize/virt-resize.pod:729 ../sparsify/virt-sparsify.pod:282 ../test-tool/libguestfs-test-tool.pod:125 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:600 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:801
801 "You should have received a copy of the GNU General Public License along with "
802 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
803 "Ave, Cambridge, MA 02139, USA."
807 #: ../cat/virt-cat.pod:5
808 msgid "virt-cat - Display files in a virtual machine"
812 #: ../cat/virt-cat.pod:9
815 " virt-cat [--options] -d domname file [file ...]\n"
820 #: ../cat/virt-cat.pod:11
823 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
828 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 ../inspector/virt-inspector.pod:13
833 #: ../cat/virt-cat.pod:15
836 " virt-cat domname file\n"
841 #: ../cat/virt-cat.pod:17
844 " virt-cat disk.img file\n"
849 #: ../cat/virt-cat.pod:21
851 "C<virt-cat> is a command line tool to display the contents of C<file> where "
852 "C<file> exists in the named virtual machine (or disk image)."
856 #: ../cat/virt-cat.pod:24
858 "Multiple filenames can be given, in which case they are concatenated "
859 "together. Each filename must be a full path, starting at the root directory "
860 "(starting with '/')."
864 #: ../cat/virt-cat.pod:28
866 "C<virt-cat> can be used to quickly view a file. To edit a file, use "
867 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
868 "tool (see L</USING GUESTFISH> below)."
872 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43 ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41 ../fish/guestfish.pod:1051 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../sparsify/virt-sparsify.pod:75 ../tools/virt-tar.pl:50
877 #: ../cat/virt-cat.pod:34
878 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
882 #: ../cat/virt-cat.pod:37
885 " virt-cat -d mydomain /etc/fstab\n"
890 #: ../cat/virt-cat.pod:39
891 msgid "List syslog messages from a VM disk image file:"
895 #: ../cat/virt-cat.pod:41
898 " virt-cat -a disk.img /var/log/messages | tail\n"
903 #: ../cat/virt-cat.pod:43
904 msgid "Find out what DHCP IP address a VM acquired:"
908 #: ../cat/virt-cat.pod:45
911 " virt-cat -d mydomain /var/log/messages | \\\n"
912 " grep 'dhclient: bound to' | tail\n"
917 #: ../cat/virt-cat.pod:48
918 msgid "Find out what packages were recently installed:"
922 #: ../cat/virt-cat.pod:50
925 " virt-cat -d mydomain /var/log/yum.log | tail\n"
930 #: ../cat/virt-cat.pod:52
931 msgid "Find out who is logged on inside a virtual machine:"
935 #: ../cat/virt-cat.pod:54
938 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
944 #: ../cat/virt-cat.pod:57
945 msgid "or who was logged on:"
949 #: ../cat/virt-cat.pod:59
952 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
953 " last -f /tmp/wtmp\n"
958 #: ../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
960 "Add I<file> which should be a disk image from a virtual machine. If the "
961 "virtual machine has multiple block devices, you must supply all of them with "
962 "separate I<-a> options."
966 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:92
967 msgid "B<--echo-keys>"
971 #: ../cat/virt-cat.pod:100
973 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
974 "so you cannot see what you are typing. If you are not worried about Tempest "
975 "attacks and there is no one else in the room you can specify this flag to "
976 "see what you are typing."
980 #: ../cat/virt-cat.pod:116
983 " virt-cat --format=raw -a disk.img file\n"
988 #: ../cat/virt-cat.pod:120
991 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
996 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:172 ../inspector/virt-inspector.pod:114
997 msgid "B<--keys-from-stdin>"
1001 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:174 ../inspector/virt-inspector.pod:116
1003 "Read key or passphrase parameters from stdin. The default is to try to read "
1004 "passphrases from the user by opening C</dev/tty>."
1008 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:209
1009 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
1013 #: ../cat/virt-cat.pod:154
1014 msgid "Previous versions of virt-cat allowed you to write either:"
1018 #: ../cat/virt-cat.pod:156
1021 " virt-cat disk.img [disk.img ...] file\n"
1026 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:215
1031 #: ../cat/virt-cat.pod:160
1034 " virt-cat guestname file\n"
1039 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:219
1041 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
1042 "the confusing case where a disk image might have the same name as a guest."
1046 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:223
1047 msgid "For compatibility the old style is still supported."
1051 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
1052 msgid "WINDOWS PATHS"
1056 #: ../cat/virt-cat.pod:170
1058 "C<virt-cat> has a limited ability to understand Windows drive letters and "
1059 "paths (eg. C<E:\\foo\\bar.txt>)."
1063 #: ../cat/virt-cat.pod:173 ../edit/virt-edit.pod:262
1064 msgid "If and only if the guest is running Windows then:"
1068 #: ../cat/virt-cat.pod:179 ../edit/virt-edit.pod:268
1070 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
1071 "to the correct filesystem."
1075 #: ../cat/virt-cat.pod:184 ../edit/virt-edit.pod:273
1077 "Any backslash (C<\\>) characters in the path are replaced with forward "
1078 "slashes so that libguestfs can process it."
1082 #: ../cat/virt-cat.pod:189
1084 "The path is resolved case insensitively to locate the file that should be "
1089 #: ../cat/virt-cat.pod:194 ../edit/virt-edit.pod:283
1090 msgid "There are some known shortcomings:"
1094 #: ../cat/virt-cat.pod:200 ../edit/virt-edit.pod:289
1095 msgid "Some NTFS symbolic links may not be followed correctly."
1099 #: ../cat/virt-cat.pod:204 ../edit/virt-edit.pod:293
1100 msgid "NTFS junction points that cross filesystems are not followed."
1104 #: ../cat/virt-cat.pod:208 ../edit/virt-edit.pod:297
1105 msgid "USING GUESTFISH"
1109 #: ../cat/virt-cat.pod:210
1111 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
1112 "C<virt-cat> doesn't work."
1116 #: ../cat/virt-cat.pod:213
1117 msgid "Using C<virt-cat> is approximately equivalent to doing:"
1121 #: ../cat/virt-cat.pod:215
1124 " guestfish --ro -i -d domname download file -\n"
1129 #: ../cat/virt-cat.pod:217
1131 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
1132 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
1136 #: ../cat/virt-cat.pod:221
1138 "The command above uses libguestfs's guest inspection feature and so does not "
1139 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
1140 "disk images that don't contain guests. To display a file from a disk image "
1145 #: ../cat/virt-cat.pod:226
1148 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
1153 #: ../cat/virt-cat.pod:228
1155 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
1156 "the disk image, and C<file> is the full path to the file."
1160 #: ../cat/virt-cat.pod:240 ../cat/virt-filesystems.pod:382 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:377 ../resize/virt-resize.pod:685 ../sparsify/virt-sparsify.pod:229
1161 msgid "This program returns 0 if successful, or non-zero if there was an error."
1165 #: ../cat/virt-cat.pod:245
1167 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
1168 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
1172 #: ../cat/virt-cat.pod:258 ../inspector/virt-inspector.pod:405 ../resize/virt-resize.pod:717 ../tools/virt-make-fs.pl:588
1173 msgid "Copyright (C) 2010-2011 Red Hat Inc."
1177 #: ../cat/virt-filesystems.pod:5
1179 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
1180 "virtual machine or disk image"
1184 #: ../cat/virt-filesystems.pod:9
1187 " virt-filesystems [--options] -d domname\n"
1192 #: ../cat/virt-filesystems.pod:11
1195 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
1200 #: ../cat/virt-filesystems.pod:15
1202 "This tool allows you to discover filesystems, partitions, logical volumes, "
1203 "and their sizes in a disk image or virtual machine. It is a replacement for "
1204 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
1208 #: ../cat/virt-filesystems.pod:20
1210 "One use for this tool is from shell scripts to iterate over all filesystems "
1211 "from a disk image:"
1215 #: ../cat/virt-filesystems.pod:23
1218 " for fs in $(virt-filesystems -a disk.img); do\n"
1225 #: ../cat/virt-filesystems.pod:27
1227 "Another use is to list partitions before using another tool to modify those "
1228 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
1229 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
1233 #: ../cat/virt-filesystems.pod:32
1235 "Various command line options control what this program displays. You need "
1236 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
1237 "guest respectively. If you just specify that then the program shows "
1238 "filesystems found, one per line, like this:"
1242 #: ../cat/virt-filesystems.pod:37
1245 " $ virt-filesystems -a disk.img\n"
1247 " /dev/vg_guest/lv_root\n"
1252 #: ../cat/virt-filesystems.pod:41
1253 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
1257 #: ../cat/virt-filesystems.pod:44
1260 " $ virt-filesystems -a disk.img -l\n"
1261 " Name Type VFS Label Size\n"
1262 " /dev/sda1 filesystem ext4 boot 524288000\n"
1263 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
1268 #: ../cat/virt-filesystems.pod:49
1270 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
1275 #: ../cat/virt-filesystems.pod:52
1278 " $ virt-filesystems -a disk.img --extra\n"
1280 " /dev/vg_guest/lv_root\n"
1281 " /dev/vg_guest/lv_swap\n"
1282 " /dev/vg_guest/lv_data\n"
1287 #: ../cat/virt-filesystems.pod:58
1288 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
1292 #: ../cat/virt-filesystems.pod:60
1295 " $ virt-filesystems -a disk.img --partitions\n"
1302 #: ../cat/virt-filesystems.pod:64
1304 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
1305 "I<--physical-volumes>, I<--block-devices> to list those items."
1309 #: ../cat/virt-filesystems.pod:67
1311 "You can use these options in combination as well (if you want a combination "
1312 "including filesystems, you have to add I<--filesystems>). Notice that some "
1313 "items fall into several categories (eg. C</dev/sda1> might be both a "
1314 "partition and a filesystem). These items are listed several times. To get "
1315 "a list which includes absolutely everything that virt-filesystems knows "
1316 "about, use the I<--all> option."
1320 #: ../cat/virt-filesystems.pod:74
1322 "UUIDs (because they are quite long) are not shown by default. Add the "
1323 "I<--uuid> option to display device and filesystem UUIDs in the long output."
1327 #: ../cat/virt-filesystems.pod:78
1329 "I<--all --long --uuid> is a useful combination to display all possible "
1330 "information about everything."
1334 #: ../cat/virt-filesystems.pod:81
1337 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
1338 " Name Type VFS Label Size Parent UUID\n"
1339 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
1340 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
1341 " /dev/sda1 partition - - 100M /dev/sda -\n"
1342 " /dev/sda2 partition - - 20G /dev/sda -\n"
1343 " /dev/sda device - - 20G - -\n"
1348 #: ../cat/virt-filesystems.pod:89
1349 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
1353 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
1358 #: ../cat/virt-filesystems.pod:112
1360 "Display everything. This is currently the same as specifying these options: "
1361 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
1362 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may "
1363 "be added to this list in future)."
1367 #: ../cat/virt-filesystems.pod:117
1368 msgid "See also I<--long>."
1372 #: ../cat/virt-filesystems.pod:119
1373 msgid "B<--blkdevs>"
1377 #: ../cat/virt-filesystems.pod:121
1378 msgid "B<--block-devices>"
1382 #: ../cat/virt-filesystems.pod:123
1383 msgid "Display block devices."
1387 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1392 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1394 "Write out the results in CSV format (comma-separated values). This format "
1395 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1396 "ABOUT CSV FORMAT> below."
1400 #: ../cat/virt-filesystems.pod:150
1402 "When prompting for keys and passphrases, virt-filesystems normally turns "
1403 "echoing off so you cannot see what you are typing. If you are not worried "
1404 "about Tempest attacks and there is no one else in the room you can specify "
1405 "this flag to see what you are typing."
1409 #: ../cat/virt-filesystems.pod:155
1414 #: ../cat/virt-filesystems.pod:157
1416 "This causes filesystems that are not ordinary, mountable filesystems to be "
1417 "displayed. This category includes swapspace, and filesystems that are empty "
1418 "or contain unknown data."
1422 #: ../cat/virt-filesystems.pod:161
1423 msgid "This option implies I<--filesystems>."
1427 #: ../cat/virt-filesystems.pod:163
1428 msgid "B<--filesystems>"
1432 #: ../cat/virt-filesystems.pod:165
1434 "Display mountable filesystems. If no display option was selected then this "
1435 "option is implied."
1439 #: ../cat/virt-filesystems.pod:168
1440 msgid "With I<--extra>, non-mountable filesystems are shown too."
1444 #: ../cat/virt-filesystems.pod:181
1447 " virt-filesystems --format=raw -a disk.img\n"
1452 #: ../cat/virt-filesystems.pod:185
1455 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1460 #: ../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
1465 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1466 msgid "B<--human-readable>"
1470 #: ../cat/virt-filesystems.pod:198
1471 msgid "In I<--long> mode, display sizes in human-readable format."
1475 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1480 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1485 #: ../cat/virt-filesystems.pod:209
1486 msgid "Display extra columns of data (\"long format\")."
1490 #: ../cat/virt-filesystems.pod:211
1491 msgid "A title row is added unless you also specify I<--no-title>."
1495 #: ../cat/virt-filesystems.pod:213
1497 "The extra columns displayed depend on what output you select, and the "
1498 "ordering of columns may change in future versions. Use the title row, "
1499 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
1504 #: ../cat/virt-filesystems.pod:218
1506 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1507 "default is to show raw numbers of I<bytes>."
1511 #: ../cat/virt-filesystems.pod:221
1512 msgid "Use I<--uuid> to display UUIDs too."
1516 #: ../cat/virt-filesystems.pod:223
1521 #: ../cat/virt-filesystems.pod:225
1522 msgid "B<--logvols>"
1526 #: ../cat/virt-filesystems.pod:227
1527 msgid "B<--logical-volumes>"
1531 #: ../cat/virt-filesystems.pod:229
1533 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1534 "of whether the LVs contain filesystems."
1538 #: ../cat/virt-filesystems.pod:232
1539 msgid "B<--no-title>"
1543 #: ../cat/virt-filesystems.pod:234
1544 msgid "In I<--long> mode, don't add a title row."
1548 #: ../cat/virt-filesystems.pod:236
1550 "Note that the order of the columns is not fixed, and may change in future "
1551 "versions of virt-filesystems, so using this option may give you unexpected "
1556 #: ../cat/virt-filesystems.pod:240
1561 #: ../cat/virt-filesystems.pod:242
1562 msgid "B<--partitions>"
1566 #: ../cat/virt-filesystems.pod:244
1568 "Display partitions. In this mode, these are displayed irrespective of "
1569 "whether the partitions contain filesystems."
1573 #: ../cat/virt-filesystems.pod:247
1578 #: ../cat/virt-filesystems.pod:249
1579 msgid "B<--physvols>"
1583 #: ../cat/virt-filesystems.pod:251
1584 msgid "B<--physical-volumes>"
1588 #: ../cat/virt-filesystems.pod:253
1589 msgid "Display LVM physical volumes."
1593 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1598 #: ../cat/virt-filesystems.pod:257
1603 #: ../cat/virt-filesystems.pod:259
1604 msgid "In I<--long> mode, display UUIDs as well."
1608 #: ../cat/virt-filesystems.pod:273
1613 #: ../cat/virt-filesystems.pod:275
1614 msgid "B<--volgroups>"
1618 #: ../cat/virt-filesystems.pod:277
1619 msgid "B<--volume-groups>"
1623 #: ../cat/virt-filesystems.pod:279
1624 msgid "Display LVM volume groups."
1628 #: ../cat/virt-filesystems.pod:287
1633 #: ../cat/virt-filesystems.pod:289
1635 "Note that columns in the output are subject to reordering and change in "
1636 "future versions of this tool."
1640 #: ../cat/virt-filesystems.pod:294
1645 #: ../cat/virt-filesystems.pod:296
1646 msgid "The filesystem, partition, block device or LVM name."
1650 #: ../cat/virt-filesystems.pod:298
1652 "For device and partition names these are displayed as canonical libguestfs "
1653 "names, so that for example C</dev/sda2> is the second partition on the first "
1658 #: ../cat/virt-filesystems.pod:302
1660 "If the I<--long> option is B<not> specified, then only the name column is "
1661 "shown in the output."
1665 #: ../cat/virt-filesystems.pod:305
1670 #: ../cat/virt-filesystems.pod:307
1671 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1675 #: ../cat/virt-filesystems.pod:309
1680 #: ../cat/virt-filesystems.pod:311
1682 "If there is a filesystem, then this column displays the filesystem type if "
1683 "one could be detected, eg. C<ext4>."
1687 #: ../cat/virt-filesystems.pod:314
1692 #: ../cat/virt-filesystems.pod:316
1694 "If the object has a label (used for identifying and mounting filesystems) "
1695 "then this column contains the label."
1699 #: ../cat/virt-filesystems.pod:319
1704 #: ../cat/virt-filesystems.pod:321
1706 "The partition type byte, displayed as a two digit hexadecimal number. A "
1707 "comprehensive list of partition types can be found here: "
1708 "L<http://www.win.tue.nl/~aeb/partitions/partition_types-1.html>"
1712 #: ../cat/virt-filesystems.pod:325
1713 msgid "This is only applicable for DOS (MBR) partitions."
1717 #: ../cat/virt-filesystems.pod:327
1722 #: ../cat/virt-filesystems.pod:329
1724 "The size of the object in bytes. If the I<--human> option is used then the "
1725 "size is displayed in a human-readable form."
1729 #: ../cat/virt-filesystems.pod:332
1734 #: ../cat/virt-filesystems.pod:334
1736 "The parent column records the parent relationship between objects. For "
1737 "example, if the object is a partition, then this column contains the name of "
1738 "the containing device. If the object is a logical volume, then this column "
1739 "is the name of the volume group."
1743 #: ../cat/virt-filesystems.pod:339
1748 #: ../cat/virt-filesystems.pod:341
1750 "If the object has a UUID (used for identifying and mounting filesystems and "
1751 "block devices) then this column contains the UUID as a string."
1755 #: ../cat/virt-filesystems.pod:345
1756 msgid "The UUID is only displayed if the I<--uuid> option is given."
1760 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1761 msgid "NOTE ABOUT CSV FORMAT"
1765 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1767 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1768 "should be easy to parse, but it is definitely not easy to parse."
1772 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1774 "Myth: Just split fields at commas. Reality: This does I<not> work "
1775 "reliably. This example has two columns:"
1779 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1782 " \"foo,bar\",baz\n"
1787 #: ../cat/virt-filesystems.pod:359 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1789 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1790 "reliably. This example has one row:"
1794 #: ../cat/virt-filesystems.pod:362 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1803 #: ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1805 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1806 "packaged in major Linux distributions)."
1810 #: ../cat/virt-filesystems.pod:368 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1812 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1813 "or Python's built-in csv library)."
1817 #: ../cat/virt-filesystems.pod:371 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1818 msgid "Most spreadsheets and databases can import CSV directly."
1822 #: ../cat/virt-filesystems.pod:387
1824 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1825 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1826 "L<http://libguestfs.org/>."
1830 #: ../cat/virt-filesystems.pod:402 ../tools/virt-win-reg.pl:789
1831 msgid "Copyright (C) 2010 Red Hat Inc."
1835 #: ../cat/virt-ls.pod:5
1836 msgid "virt-ls - List files in a virtual machine"
1840 #: ../cat/virt-ls.pod:9
1843 " virt-ls [--options] -d domname directory [directory ...]\n"
1848 #: ../cat/virt-ls.pod:11
1851 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1857 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1862 #: ../cat/virt-ls.pod:15
1865 " virt-ls [--options] domname directory\n"
1870 #: ../cat/virt-ls.pod:17
1873 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1878 #: ../cat/virt-ls.pod:21
1880 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1881 "more from a virtual machine or disk image."
1885 #: ../cat/virt-ls.pod:24
1887 "Multiple directory names can be given, in which case the output from each is "
1892 #: ../cat/virt-ls.pod:27
1894 "To list directories from a libvirt guest use the I<-d> option to specify the "
1895 "name of the guest. For a disk image, use the I<-a> option."
1899 #: ../cat/virt-ls.pod:31
1901 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1902 "may need to use L<guestfish(1)>, or write a program directly to the "
1903 "L<guestfs(3)> API."
1907 #: ../cat/virt-ls.pod:37
1908 msgid "Get a list of all files and directories in a virtual machine:"
1912 #: ../cat/virt-ls.pod:39
1915 " virt-ls -R -d guest /\n"
1920 #: ../cat/virt-ls.pod:41
1921 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1925 #: ../cat/virt-ls.pod:43
1928 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1933 #: ../cat/virt-ls.pod:45
1934 msgid "List all public-writable directories in a Linux virtual machine:"
1938 #: ../cat/virt-ls.pod:47
1941 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1946 #: ../cat/virt-ls.pod:49
1947 msgid "List all Unix domain sockets in a Linux virtual machine:"
1951 #: ../cat/virt-ls.pod:51
1954 " virt-ls -lR -d guest / | grep '^s'\n"
1959 #: ../cat/virt-ls.pod:53
1960 msgid "List all regular files with filenames ending in '.png':"
1964 #: ../cat/virt-ls.pod:55
1967 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1972 #: ../cat/virt-ls.pod:57
1973 msgid "To display files larger than 10MB in home directories:"
1977 #: ../cat/virt-ls.pod:59
1980 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1985 #: ../cat/virt-ls.pod:61
1986 msgid "Find everything modified in the last 7 days:"
1990 #: ../cat/virt-ls.pod:63
1993 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1998 #: ../cat/virt-ls.pod:65
1999 msgid "Find regular files modified in the last 24 hours:"
2003 #: ../cat/virt-ls.pod:67
2006 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
2011 #: ../cat/virt-ls.pod:69
2012 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
2016 #: ../cat/virt-ls.pod:71
2018 "Find the differences between files in a guest and an earlier snapshot of the "
2023 #: ../cat/virt-ls.pod:74
2026 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
2027 " virt-ls -lR -a current.img / --uids --time-t > new\n"
2028 " diff -u old new | less\n"
2033 #: ../cat/virt-ls.pod:78
2035 "The commands above won't find files where the content has changed but the "
2036 "metadata (eg. file size and modification date) is the same. To do that, you "
2037 "need to add the I<--checksum> parameter to both C<virt-ls> commands. "
2038 "I<--checksum> can be quite slow since it has to read and compute a checksum "
2039 "of every regular file in the virtual machine."
2043 #: ../cat/virt-ls.pod:84
2044 msgid "OUTPUT MODES"
2048 #: ../cat/virt-ls.pod:86
2050 "C<virt-ls> has four output modes, controlled by different combinations of "
2051 "the I<-l> and I<-R> options."
2055 #: ../cat/virt-ls.pod:89
2056 msgid "SIMPLE LISTING"
2060 #: ../cat/virt-ls.pod:91
2061 msgid "A simple listing is like the ordinary L<ls(1)> command:"
2065 #: ../cat/virt-ls.pod:93
2068 " $ virt-ls -d guest /\n"
2076 #: ../cat/virt-ls.pod:98
2077 msgid "LONG LISTING"
2081 #: ../cat/virt-ls.pod:100
2083 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
2084 "(more specifically, like the C<guestfs_ll> function)."
2088 #: ../cat/virt-ls.pod:103
2091 " $ virt-ls -l -d guest /\n"
2093 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
2094 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
2100 #: ../cat/virt-ls.pod:109
2102 "Note that while this is useful for displaying a directory, do not try "
2103 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
2108 #: ../cat/virt-ls.pod:113
2109 msgid "RECURSIVE LISTING"
2113 #: ../cat/virt-ls.pod:115
2115 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
2116 "and directories recursively:"
2120 #: ../cat/virt-ls.pod:118
2123 " $ virt-ls -R -d guest /tmp\n"
2131 #: ../cat/virt-ls.pod:123
2133 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
2134 "converts C<\\0> characters to C<\\n>."
2138 #: ../cat/virt-ls.pod:126
2139 msgid "RECURSIVE LONG LISTING"
2143 #: ../cat/virt-ls.pod:128
2145 "Using I<-lR> options together changes the output to display directories "
2146 "recursively, with file stats, and optionally other features such as "
2147 "checksums and extended attributes."
2151 #: ../cat/virt-ls.pod:132
2153 "Most of the interesting features of C<virt-ls> are only available when using "
2158 #: ../cat/virt-ls.pod:135
2160 "The fields are normally space-separated. Filenames are B<not> quoted, so "
2161 "you cannot use the output in another program (because filenames can contain "
2162 "spaces and other unsafe characters). If the guest was untrusted and someone "
2163 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
2164 "on you by creating filenames with embedded newline characters. To B<safely> "
2165 "parse the output in another program, use the I<--csv> (Comma-Separated "
2170 #: ../cat/virt-ls.pod:143
2172 "Note that this output format is completely unrelated to the C<ls -lR> "
2177 #: ../cat/virt-ls.pod:146
2180 " $ virt-ls -lR -d guest /bin\n"
2181 " d 0555 4096 /bin\n"
2182 " - 0755 123 /bin/alsaunmute\n"
2183 " - 0755 28328 /bin/arch\n"
2184 " l 0777 4 /bin/awk -> gawk\n"
2185 " - 0755 27216 /bin/basename\n"
2186 " - 0755 943360 /bin/bash\n"
2192 #: ../cat/virt-ls.pod:155
2193 msgid "These basic fields are always shown:"
2197 #: ../cat/virt-ls.pod:159
2202 #: ../cat/virt-ls.pod:161
2204 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
2205 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
2206 "link), C<s> (socket) or C<u> (unknown)."
2210 #: ../cat/virt-ls.pod:171
2215 #: ../cat/virt-ls.pod:173
2216 msgid "The Unix permissions, displayed as a 4 digit octal number."
2220 #: ../cat/virt-ls.pod:175
2225 #: ../cat/virt-ls.pod:177
2227 "The size of the file. This is shown in bytes unless I<-h> or "
2228 "I<--human-readable> option is given, in which case this is shown as a "
2229 "human-readable number."
2233 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4380
2238 #: ../cat/virt-ls.pod:183
2239 msgid "The full path of the file or directory."
2243 #: ../cat/virt-ls.pod:185
2248 #: ../cat/virt-ls.pod:187
2249 msgid "For symbolic links only, the link target."
2253 #: ../cat/virt-ls.pod:191
2255 "In I<-lR> mode, additional command line options enable the display of more "
2260 #: ../cat/virt-ls.pod:194
2262 "With the I<--uids> flag, these additional fields are displayed before the "
2267 #: ../cat/virt-ls.pod:199
2272 #: ../cat/virt-ls.pod:201
2277 #: ../cat/virt-ls.pod:203
2279 "The UID and GID of the owner of the file (displayed numerically). Note "
2280 "these only make sense in the context of a Unix-like guest."
2284 #: ../cat/virt-ls.pod:208
2285 msgid "With the I<--times> flag, these additional fields are displayed:"
2289 #: ../cat/virt-ls.pod:212
2294 #: ../cat/virt-ls.pod:214
2295 msgid "The time of last access."
2299 #: ../cat/virt-ls.pod:216
2304 #: ../cat/virt-ls.pod:218
2305 msgid "The time of last modification."
2309 #: ../cat/virt-ls.pod:220
2314 #: ../cat/virt-ls.pod:222
2315 msgid "The time of last status change."
2319 #: ../cat/virt-ls.pod:226
2321 "The time fields are displayed as string dates and times, unless one of the "
2322 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
2326 #: ../cat/virt-ls.pod:229
2327 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
2331 #: ../cat/virt-ls.pod:233
2336 #: ../cat/virt-ls.pod:235
2338 "The device containing the file (displayed as major:minor). This may not "
2339 "match devices as known to the guest."
2343 #: ../cat/virt-ls.pod:238
2348 #: ../cat/virt-ls.pod:240
2349 msgid "The inode number."
2353 #: ../cat/virt-ls.pod:242
2358 #: ../cat/virt-ls.pod:244
2359 msgid "The number of hard links."
2363 #: ../cat/virt-ls.pod:246
2368 #: ../cat/virt-ls.pod:248
2369 msgid "For block and char special files, the device (displayed as major:minor)."
2373 #: ../cat/virt-ls.pod:251
2378 #: ../cat/virt-ls.pod:253
2379 msgid "The number of 512 byte blocks allocated to the file."
2383 #: ../cat/virt-ls.pod:257
2385 "With the I<--checksum> flag, the checksum of the file contents is shown "
2386 "(only for regular files). Computing file checksums can take a considerable "
2391 #: ../cat/virt-ls.pod:280
2392 msgid "B<--checksum>"
2396 #: ../cat/virt-ls.pod:282
2397 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2401 #: ../cat/virt-ls.pod:284
2403 "Display checksum over file contents for regular files. With no argument, "
2404 "this defaults to using I<md5>. Using an argument, you can select the "
2405 "checksum type to use."
2409 #: ../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
2411 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2416 #: ../cat/virt-ls.pod:316
2418 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2419 "so you cannot see what you are typing. If you are not worried about Tempest "
2420 "attacks and there is no one else in the room you can specify this flag to "
2421 "see what you are typing."
2425 #: ../cat/virt-ls.pod:321
2426 msgid "B<--extra-stats>"
2430 #: ../cat/virt-ls.pod:323
2431 msgid "Display extra stats."
2435 #: ../cat/virt-ls.pod:339
2438 " virt-ls --format=raw -a disk.img /dir\n"
2443 #: ../cat/virt-ls.pod:343
2446 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2451 #: ../cat/virt-ls.pod:356
2452 msgid "Display file sizes in human-readable format."
2456 #: ../cat/virt-ls.pod:370
2461 #: ../cat/virt-ls.pod:372
2462 msgid "B<--recursive>"
2466 #: ../cat/virt-ls.pod:374
2468 "Select the mode. With neither of these options, C<virt-ls> produces a "
2469 "simple, flat list of the files in the named directory. See L</SIMPLE "
2474 #: ../cat/virt-ls.pod:378
2476 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See "
2481 #: ../cat/virt-ls.pod:381
2483 "C<virt-ls -R> produces a recursive list of files starting at the named "
2484 "directory. See L</RECURSIVE LISTING>."
2488 #: ../cat/virt-ls.pod:384
2490 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2491 "parsed. See L</RECURSIVE LONG LISTING>."
2495 #: ../cat/virt-ls.pod:387
2500 #: ../cat/virt-ls.pod:389
2501 msgid "Display time fields."
2505 #: ../cat/virt-ls.pod:394
2506 msgid "B<--time-days>"
2510 #: ../cat/virt-ls.pod:396
2511 msgid "Display time fields as days before now (negative if in the future)."
2515 #: ../cat/virt-ls.pod:398
2517 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2518 "of the file is between 0 and 86399 seconds."
2522 #: ../cat/virt-ls.pod:404
2523 msgid "B<--time-relative>"
2527 #: ../cat/virt-ls.pod:406
2528 msgid "Display time fields as seconds before now (negative if in the future)."
2532 #: ../cat/virt-ls.pod:411
2537 #: ../cat/virt-ls.pod:413
2538 msgid "Display time fields as seconds since the Unix epoch."
2542 #: ../cat/virt-ls.pod:418
2547 #: ../cat/virt-ls.pod:420
2548 msgid "Display UID and GID fields."
2552 #: ../cat/virt-ls.pod:445
2553 msgid "Previous versions of virt-ls allowed you to write either:"
2557 #: ../cat/virt-ls.pod:447
2560 " virt-ls disk.img [disk.img ...] /dir\n"
2565 #: ../cat/virt-ls.pod:451
2568 " virt-ls guestname /dir\n"
2573 #: ../cat/virt-ls.pod:497
2575 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
2576 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2577 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
2581 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:302
2582 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2586 #: ../clone/virt-sysprep.pod:5
2587 msgid "virt-sysprep - Reset or unconfigure a virtual machine so clones can be made"
2591 #: ../clone/virt-sysprep.pod:9
2594 " virt-sysprep [--options] -d domname\n"
2599 #: ../clone/virt-sysprep.pod:11
2602 " virt-sysprep [--options] -a disk.img [-a disk.img ...]\n"
2607 #: ../clone/virt-sysprep.pod:15
2609 "Virt-sysprep \"resets\" or \"unconfigures\" a virtual machine so that clones "
2610 "can be made from it. Steps in this process include removing SSH host keys, "
2611 "removing persistent network MAC configuration, and removing user accounts. "
2612 "Each step can be enabled or disabled as required."
2616 #: ../clone/virt-sysprep.pod:21
2618 "Virt-sysprep is a simple shell script, allowing easy inspection or "
2619 "customization by the system administrator."
2623 #: ../clone/virt-sysprep.pod:24
2625 "Virt-sysprep modifies the guest or disk image I<in place>. The guest must "
2626 "be shut down. If you want to preserve the existing contents of the guest, "
2627 "you I<must copy or clone the disk first>. See L</COPYING AND CLONING> "
2632 #: ../clone/virt-sysprep.pod:29
2634 "You do I<not> need to run virt-sysprep as root. In fact we'd generally "
2635 "recommend that you don't. The time you might want to run it as root is when "
2636 "you need root in order to access the disk image, but even in this case it "
2637 "would be better to change the permissions on the disk image to be writable "
2638 "as the non-root user running virt-sysprep."
2642 #: ../clone/virt-sysprep.pod:35
2644 "\"Sysprep\" stands for \"system preparation\" tool. The name comes from the "
2645 "Microsoft program C<sysprep.exe> which is used to unconfigure Windows "
2646 "machines in preparation for cloning them. Having said that, virt-sysprep "
2647 "does I<not> currently work on Microsoft Windows guests. We plan to support "
2648 "Windows sysprepping in a future version, and we already have code to do it."
2652 #: ../clone/virt-sysprep.pod:76
2653 msgid "B<--enable=...>"
2657 #: ../clone/virt-sysprep.pod:78
2659 "Choose which sysprep operations to perform. Give a comma-separated list of "
2660 "operations, for example:"
2664 #: ../clone/virt-sysprep.pod:81
2667 " --enable=ssh-hostkeys,udev-persistent-net\n"
2672 #: ../clone/virt-sysprep.pod:83
2673 msgid "would enable ONLY C<ssh-hostkeys> and C<udev-persistent-net> operations."
2677 #: ../clone/virt-sysprep.pod:85
2679 "If the I<--enable> option is not given, then we default to trying all "
2680 "possible sysprep operations. But some sysprep operations are skipped for "
2685 #: ../clone/virt-sysprep.pod:89
2687 "Use I<--list-operations> to list operations supported by a particular "
2688 "version of virt-sysprep."
2692 #: ../clone/virt-sysprep.pod:92
2693 msgid "See L</OPERATIONS> below for a list and an explanation of each operation."
2697 #: ../clone/virt-sysprep.pod:106
2700 " virt-sysprep --format=raw -a disk.img\n"
2705 #: ../clone/virt-sysprep.pod:110
2708 " virt-sysprep --format=raw -a disk.img --format -a another.img\n"
2713 #: ../clone/virt-sysprep.pod:119
2714 msgid "B<--hostname> newhostname"
2718 #: ../clone/virt-sysprep.pod:121
2720 "Change the hostname. See the L</hostname> operation below. If not given, "
2721 "defaults to C<localhost.localdomain>."
2725 #: ../clone/virt-sysprep.pod:124
2726 msgid "B<--list-operations>"
2730 #: ../clone/virt-sysprep.pod:126
2731 msgid "List the operations supported by the virt-sysprep program."
2735 #: ../clone/virt-sysprep.pod:128
2736 msgid "B<--selinux-relabel>"
2740 #: ../clone/virt-sysprep.pod:130
2741 msgid "B<--no-selinux-relabel>"
2745 #: ../clone/virt-sysprep.pod:132
2747 "I<--selinux-relabel> forces SELinux relabelling next time the guest boots. "
2748 "I<--no-selinux-relabel> disables relabelling."
2752 #: ../clone/virt-sysprep.pod:135
2754 "The default is to try to detect if SELinux relabelling is required. See "
2755 "L</SELINUX RELABELLING> below for more details."
2759 #: ../clone/virt-sysprep.pod:156
2764 #: ../clone/virt-sysprep.pod:158
2766 "If the I<--enable> option is I<not> given, then I<all sysprep operations are "
2767 "enabled>, although some are skipped depending on the type of guest."
2771 #: ../clone/virt-sysprep.pod:162
2773 "Operations can be individually enabled using the I<--enable> option. Use a "
2774 "comma-separated list, for example:"
2778 #: ../clone/virt-sysprep.pod:165
2781 " virt-sysprep --enable=ssh-hostkeys,udev-persistent-net [etc..]\n"
2786 #: ../clone/virt-sysprep.pod:167
2788 "To list the operations supported by the current version of virt-sysprep, use "
2789 "I<--list-operations>."
2793 #: ../clone/virt-sysprep.pod:170
2795 "Future versions of virt-sysprep may add more operations. If you are using "
2796 "virt-sysprep and want predictable behaviour, specify only the operations "
2797 "that you want to have enabled."
2801 #: ../clone/virt-sysprep.pod:174
2806 #: ../clone/virt-sysprep.pod:176
2807 msgid "Remove user at-jobs and cron-jobs."
2811 #: ../clone/virt-sysprep.pod:178
2812 msgid "dhcp-client-state"
2816 #: ../clone/virt-sysprep.pod:180
2817 msgid "Remove DHCP client leases."
2821 #: ../clone/virt-sysprep.pod:182
2822 msgid "dhcp-server-state"
2826 #: ../clone/virt-sysprep.pod:184
2827 msgid "Remove DHCP server leases."
2831 #: ../clone/virt-sysprep.pod:186
2836 #: ../clone/virt-sysprep.pod:188
2838 "Changes the hostname of the guest to the value given in the I<--hostname> "
2843 #: ../clone/virt-sysprep.pod:191
2845 "If the I<--hostname> parameter is not given, then the hostname is changed to "
2846 "C<localhost.localdomain>."
2850 #: ../clone/virt-sysprep.pod:194
2855 #: ../clone/virt-sysprep.pod:196
2856 msgid "Remove many log files."
2860 #: ../clone/virt-sysprep.pod:198
2865 #: ../clone/virt-sysprep.pod:200
2866 msgid "Remove email from the local mail spool directory."
2870 #: ../clone/virt-sysprep.pod:202
2875 #: ../clone/virt-sysprep.pod:204
2877 "Remove HWADDR (hard-coded MAC address) configuration. For Fedora and Red "
2878 "Hat Enterprise Linux, this is removed from C<ifcfg-*> files."
2882 #: ../clone/virt-sysprep.pod:207
2887 #: ../clone/virt-sysprep.pod:209
2889 "Write some random bytes from the host into the random seed file of the "
2894 #: ../clone/virt-sysprep.pod:212
2895 msgid "See L</RANDOM SEED> below."
2899 #: ../clone/virt-sysprep.pod:214
2900 msgid "rhn-systemid"
2904 #: ../clone/virt-sysprep.pod:216
2905 msgid "Remove the RHN system ID."
2909 #: ../clone/virt-sysprep.pod:218
2914 #: ../clone/virt-sysprep.pod:220
2915 msgid "Remove the Smolt hardware UUID."
2919 #: ../clone/virt-sysprep.pod:222
2920 msgid "ssh-hostkeys"
2924 #: ../clone/virt-sysprep.pod:224
2925 msgid "Remove the SSH host keys in the guest."
2929 #: ../clone/virt-sysprep.pod:226
2931 "The SSH host keys are regenerated (differently) next time the guest is "
2936 #: ../clone/virt-sysprep.pod:229
2938 "If, after cloning, the guest gets the same IP address, ssh will give you a "
2939 "stark warning about the host key changing:"
2943 #: ../clone/virt-sysprep.pod:232
2946 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
2947 " @ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @\n"
2948 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
2949 " IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!\n"
2954 #: ../clone/virt-sysprep.pod:237
2955 msgid "udev-persistent-net"
2959 #: ../clone/virt-sysprep.pod:239
2961 "Remove udev persistent net rules which map the guest's existing MAC address "
2962 "to a fixed ethernet device (eg. eth0)."
2966 #: ../clone/virt-sysprep.pod:242
2968 "After a guest is cloned, the MAC address usually changes. Since the old MAC "
2969 "address occupies the old name (eg. eth0), this means the fresh MAC address "
2970 "is assigned to a new name (eg. eth1) and this is usually undesirable. "
2971 "Erasing the udev persistent net rules avoids this."
2975 #: ../clone/virt-sysprep.pod:247
2980 #: ../clone/virt-sysprep.pod:249
2981 msgid "Remove the utmp file."
2985 #: ../clone/virt-sysprep.pod:251
2987 "This records who is currently logged in on a machine. In modern Linux "
2988 "distros it is stored in a ramdisk and hence not part of the virtual "
2989 "machine's disk, but it was stored on disk in older distros."
2993 #: ../clone/virt-sysprep.pod:255
2998 #: ../clone/virt-sysprep.pod:257
2999 msgid "Remove the yum UUID."
3003 #: ../clone/virt-sysprep.pod:259
3005 "Yum creates a fresh UUID the next time it runs when it notices that the "
3006 "original UUID has been erased."
3010 #: ../clone/virt-sysprep.pod:262
3011 msgid "COPYING AND CLONING"
3015 #: ../clone/virt-sysprep.pod:264
3017 "Virt-sysprep can be used as part of a process of cloning guests, or to "
3018 "prepare a template from which guests can be cloned. There are many "
3019 "different ways to achieve this using the virt tools, and this section is "
3020 "just an introduction."
3024 #: ../clone/virt-sysprep.pod:269
3025 msgid "A virtual machine (when switched off) consists of two parts:"
3029 #: ../clone/virt-sysprep.pod:273
3030 msgid "I<configuration>"
3034 #: ../clone/virt-sysprep.pod:275
3036 "The configuration or description of the guest. eg. The libvirt XML (see "
3037 "C<virsh dumpxml>), the running configuration of the guest, or another "
3038 "external format like OVF."
3042 #: ../clone/virt-sysprep.pod:279
3043 msgid "Some configuration items that might need to be changed:"
3047 #: ../clone/virt-sysprep.pod:285
3052 #: ../clone/virt-sysprep.pod:289 ../clone/virt-sysprep.pod:316
3057 #: ../clone/virt-sysprep.pod:293
3058 msgid "path to block device(s)"
3062 #: ../clone/virt-sysprep.pod:297
3063 msgid "network card MAC address"
3067 #: ../clone/virt-sysprep.pod:301
3068 msgid "I<block device(s)>"
3072 #: ../clone/virt-sysprep.pod:303
3074 "One or more hard disk images, themselves containing files, directories, "
3075 "applications, kernels, configuration, etc."
3079 #: ../clone/virt-sysprep.pod:306
3080 msgid "Some things inside the block devices that might need to be changed:"
3084 #: ../clone/virt-sysprep.pod:312
3085 msgid "hostname and other net configuration"
3089 #: ../clone/virt-sysprep.pod:320
3090 msgid "SSH host keys"
3094 #: ../clone/virt-sysprep.pod:324
3095 msgid "Windows unique security ID (SID)"
3099 #: ../clone/virt-sysprep.pod:328
3100 msgid "Puppet registration"
3104 #: ../clone/virt-sysprep.pod:334
3105 msgid "COPYING THE BLOCK DEVICE"
3109 #: ../clone/virt-sysprep.pod:336
3111 "Starting with an original guest, you probably wish to copy the guest block "
3112 "device and its configuration to make a template. Then once you are happy "
3113 "with the template, you will want to make many clones from it."
3117 #: ../clone/virt-sysprep.pod:341
3123 " original guest --------> template ---------->\n"
3124 " \\------> cloned\n"
3125 " \\-----> guests\n"
3131 #: ../clone/virt-sysprep.pod:349
3133 "You can, of course, just copy the block device on the host using L<cp(1)> or "
3138 #: ../clone/virt-sysprep.pod:352
3142 " original guest --------> template ---------->\n"
3143 " \\------> cloned\n"
3144 " \\-----> guests\n"
3150 #: ../clone/virt-sysprep.pod:358
3151 msgid "There are some smarter (and faster) ways too:"
3155 #: ../clone/virt-sysprep.pod:364
3159 " template ---------->\n"
3160 " \\------> cloned\n"
3161 " \\-----> guests\n"
3167 #: ../clone/virt-sysprep.pod:370
3169 "Use the block device as a backing file and create a snapshot on top for each "
3170 "guest. The advantage is that you don't need to copy the block device (very "
3171 "fast) and only changes are stored (less storage required)."
3175 #: ../clone/virt-sysprep.pod:375
3177 "Note that writing to the backing file once you have created guests on top of "
3178 "it is not possible: you will corrupt the guests."
3182 #: ../clone/virt-sysprep.pod:378
3184 "Tools that can do this include: L<qemu-img(1)> (with the I<create -f qcow2 "
3185 "-o backing_file> option), L<lvcreate(8)> (I<--snapshot> option). Some "
3186 "filesystems (such as btrfs) and most Network Attached Storage devices can "
3187 "also create cheap snapshots from files or LUNs."
3191 #: ../clone/virt-sysprep.pod:386
3192 msgid "Get your NAS to snapshot and/or duplicate the LUN."
3196 #: ../clone/virt-sysprep.pod:390
3197 msgid "Prepare your template using L<virt-sparsify(1)>. See below."
3201 #: ../clone/virt-sysprep.pod:394
3206 #: ../clone/virt-sysprep.pod:396
3208 "A separate tool, L<virt-clone(1)>, can be used to duplicate the block device "
3209 "and/or modify the external libvirt configuration of a guest. It will reset "
3210 "the name, UUID and MAC address of the guest in the libvirt XML."
3214 #: ../clone/virt-sysprep.pod:401
3216 "L<virt-clone(1)> does not use libguestfs and cannot look inside the disk "
3217 "image. This was the original motivation to write virt-sysprep."
3221 #: ../clone/virt-sysprep.pod:404
3226 #: ../clone/virt-sysprep.pod:406
3230 " original guest --------> template\n"
3235 #: ../clone/virt-sysprep.pod:409
3237 "L<virt-sparsify(1)> can be used to make the cloning template smaller, making "
3238 "it easier to compress and/or faster to copy."
3242 #: ../clone/virt-sysprep.pod:412
3244 "Notice that since virt-sparsify also copies the image, you can use it to "
3245 "make the initial copy (instead of C<dd>)."
3249 #: ../clone/virt-sysprep.pod:415
3254 #: ../clone/virt-sysprep.pod:417
3258 " template ---------->\n"
3259 " \\------> cloned\n"
3260 " \\-----> guests\n"
3266 #: ../clone/virt-sysprep.pod:423
3268 "If you want to give people cloned guests, but let them pick the size of the "
3269 "guest themselves (eg. depending on how much they are prepared to pay for "
3270 "disk space), then instead of copying the template, you can run "
3271 "L<virt-resize(1)>. Virt-resize performs a copy and resize, and thus is "
3272 "ideal for cloning guests from a template."
3276 #: ../clone/virt-sysprep.pod:429 ../src/guestfs.pod:1164
3281 #: ../clone/virt-sysprep.pod:431
3283 "Although virt-sysprep removes some sensitive information from the guest, it "
3284 "does not pretend to remove all of it. You should examine the L</OPERATIONS> "
3285 "above, and the implementation of the operations in the shell script. You "
3286 "should also examine the guest afterwards."
3290 #: ../clone/virt-sysprep.pod:436
3292 "Sensitive files are simply removed. The data they contained may still exist "
3293 "on the disk, easily recovered with a hex editor or undelete tool. Use "
3294 "L<virt-sparsify(1)> as one way to remove this content. See also the "
3295 "L<scrub(1)> command to get rid of deleted content in directory entries and "
3300 #: ../clone/virt-sysprep.pod:442
3305 #: ../clone/virt-sysprep.pod:444
3306 msgid "I<(This section applies to Linux guests only)>"
3310 #: ../clone/virt-sysprep.pod:446
3312 "The virt-sysprep C<random-seed> operation writes a few bytes of randomness "
3313 "from the host into the guest's random seed file."
3317 #: ../clone/virt-sysprep.pod:449
3319 "If this is just done once and the guest is cloned from the same template, "
3320 "then each guest will start with the same entropy, and things like SSH host "
3321 "keys and TCP sequence numbers may be predictable."
3325 #: ../clone/virt-sysprep.pod:453
3327 "Therefore you should arrange to add more randomness I<after> cloning from a "
3328 "template too, which can be done by just enabling the C<random-seed> "
3333 #: ../clone/virt-sysprep.pod:457
3336 " cp template.img newguest.img\n"
3337 " virt-sysprep --enable=random-seed -a newguest.img\n"
3342 #: ../clone/virt-sysprep.pod:460
3343 msgid "SELINUX RELABELLING"
3347 #: ../clone/virt-sysprep.pod:462
3348 msgid "I<(This section applies to Linux guests using SELinux only)>"
3352 #: ../clone/virt-sysprep.pod:464
3354 "If any new files are created by virt-sysprep, then virt-sysprep touches "
3355 "C</.autorelabel> so that these will be correctly labelled by SELinux the "
3356 "next time the guest is booted. This process interrupts boot and can take "
3361 #: ../clone/virt-sysprep.pod:469
3363 "You can force relabelling for all guests by supplying the "
3364 "I<--selinux-relabel> option."
3368 #: ../clone/virt-sysprep.pod:472
3370 "You can disable relabelling entirely by supplying the "
3371 "I<--no-selinux-relabel> option."
3375 #: ../clone/virt-sysprep.pod:484
3376 msgid "This program returns 0 on success, or 1 if there was an error."
3380 #: ../clone/virt-sysprep.pod:488
3382 "L<guestfs(3)>, L<guestfish(1)>, L<virt-clone(1)>, L<virt-rescue(1)>, "
3383 "L<virt-resize(1)>, L<virt-sparsify(1)>, L<virsh(1)>, L<lvcreate(8)>, "
3384 "L<qemu-img(1)>, L<scrub(1)>, L<http://libguestfs.org/>, "
3385 "L<http://libvirt.org/>."
3389 #: ../df/virt-df.pod:5
3390 msgid "virt-df - Display free space on virtual filesystems"
3394 #: ../df/virt-df.pod:9
3397 " virt-df [--options]\n"
3402 #: ../df/virt-df.pod:11
3405 " virt-df [--options] -d domname\n"
3410 #: ../df/virt-df.pod:13
3413 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
3418 #: ../df/virt-df.pod:17
3421 " virt-df [--options] domname\n"
3426 #: ../df/virt-df.pod:19
3429 " virt-df [--options] disk.img [disk.img ...]\n"
3434 #: ../df/virt-df.pod:23
3436 "C<virt-df> is a command line tool to display free space on virtual machine "
3437 "filesystems. Unlike other tools, it doesn't just display the size of disk "
3438 "allocated to a virtual machine, but can look inside disk images to see how "
3439 "much space is really being used."
3443 #: ../df/virt-df.pod:28
3445 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
3446 "to get a list of all active and inactive guests, and performs a C<df>-type "
3447 "operation on each one in turn, printing out the results."
3451 #: ../df/virt-df.pod:32
3453 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
3454 "C<df>-type operation on either the single named libvirt domain, or on the "
3455 "disk image(s) listed on the command line (which must all belong to a single "
3456 "VM). In this mode (with arguments), C<virt-df> will I<only work for a "
3457 "single guest>. If you want to run on multiple guests, then you have to "
3458 "invoke C<virt-df> multiple times."
3462 #: ../df/virt-df.pod:39
3464 "Use the I<--csv> option to get a format which can be easily parsed by other "
3465 "programs. Other options are similar to the standard L<df(1)> command."
3469 #: ../df/virt-df.pod:45
3471 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
3472 "output human-readable:"
3476 #: ../df/virt-df.pod:48
3479 " # virt-df -d F14x64 -h\n"
3480 " Filesystem Size Used Available Use%\n"
3481 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
3482 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
3487 #: ../df/virt-df.pod:53
3488 msgid "Show disk usage for a disk image file called C<test.img>:"
3492 #: ../df/virt-df.pod:55
3495 " $ virt-df -a test1.img\n"
3496 " Filesystem 1K-blocks Used Available Use%\n"
3497 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
3502 #: ../df/virt-df.pod:112
3505 " virt-df --format=raw -a disk.img\n"
3510 #: ../df/virt-df.pod:116
3513 " virt-df --format=raw -a disk.img --format -a another.img\n"
3518 #: ../df/virt-df.pod:129
3519 msgid "Print sizes in human-readable format."
3523 #: ../df/virt-df.pod:131
3524 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
3528 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:164
3533 #: ../df/virt-df.pod:135
3538 #: ../df/virt-df.pod:137
3539 msgid "Print inodes instead of blocks."
3543 #: ../df/virt-df.pod:139
3544 msgid "B<--one-per-guest>"
3548 #: ../df/virt-df.pod:141
3550 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
3551 "disks from several guests to a single libguestfs appliance."
3555 #: ../df/virt-df.pod:144
3556 msgid "You might use this option in the following circumstances:"
3560 #: ../df/virt-df.pod:150
3562 "If you think an untrusted guest might actively try to exploit the libguestfs "
3563 "appliance kernel, then this prevents one guest from interfering with the "
3564 "stats printed for another guest."
3568 #: ../df/virt-df.pod:156
3570 "If the kernel has a bug which stops it from accessing a filesystem in one "
3571 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
3572 "and report stats for further guests."
3576 #: ../df/virt-df.pod:165
3578 "Print UUIDs instead of names. This is useful for following a guest even "
3579 "when the guest is migrated or renamed, or when two guests happen to have the "
3584 #: ../df/virt-df.pod:169
3586 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
3587 "images, we still print the disk image name even when this option is "
3592 #: ../df/virt-df.pod:229
3594 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
3595 "L<http://libguestfs.org/>."
3599 #: ../edit/virt-edit.pod:5
3600 msgid "virt-edit - Edit a file in a virtual machine"
3604 #: ../edit/virt-edit.pod:9
3607 " virt-edit [--options] -d domname file [file ...]\n"
3612 #: ../edit/virt-edit.pod:11
3615 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
3620 #: ../edit/virt-edit.pod:13
3623 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
3628 #: ../edit/virt-edit.pod:17
3631 " virt-edit domname file\n"
3636 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
3639 " virt-edit disk.img [disk.img ...] file\n"
3644 #: ../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
3649 #: ../edit/virt-edit.pod:23
3651 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
3652 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
3653 "doing this, but doesn't catch all cases."
3657 #: ../edit/virt-edit.pod:29
3659 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
3660 "exists in the named virtual machine (or disk image)."
3664 #: ../edit/virt-edit.pod:32
3666 "Multiple filenames can be given, in which case they are each edited in "
3667 "turn. Each filename must be a full path, starting at the root directory "
3668 "(starting with '/')."
3672 #: ../edit/virt-edit.pod:36
3673 msgid "If you want to just view a file, use L<virt-cat(1)>."
3677 #: ../edit/virt-edit.pod:38
3679 "For more complex cases you should look at the L<guestfish(1)> tool (see "
3680 "L</USING GUESTFISH> below)."
3684 #: ../edit/virt-edit.pod:41
3686 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
3687 "that and much more."
3691 #: ../edit/virt-edit.pod:46
3692 msgid "Edit the named files interactively:"
3696 #: ../edit/virt-edit.pod:48
3699 " virt-edit -d mydomain /boot/grub/grub.conf\n"
3704 #: ../edit/virt-edit.pod:50
3707 " virt-edit -d mydomain /etc/passwd\n"
3712 #: ../edit/virt-edit.pod:52
3713 msgid "For Windows guests, some Windows paths are understood:"
3717 #: ../edit/virt-edit.pod:54
3720 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
3725 #: ../edit/virt-edit.pod:56
3727 "If Perl is installed, you can also edit files non-interactively (see "
3728 "L</NON-INTERACTIVE EDITING> below). To change the init default level to 5:"
3732 #: ../edit/virt-edit.pod:60
3735 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
3740 #: ../edit/virt-edit.pod:81
3741 msgid "B<-b> extension"
3745 #: ../edit/virt-edit.pod:83
3746 msgid "B<--backup> extension"
3750 #: ../edit/virt-edit.pod:85
3752 "Create a backup of the original file I<in the guest disk image>. The backup "
3753 "has the original filename with C<extension> added."
3757 #: ../edit/virt-edit.pod:88
3759 "Usually the first character of C<extension> would be a dot C<.> so you would "
3764 #: ../edit/virt-edit.pod:91
3767 " virt-edit -b .orig [etc]\n"
3772 #: ../edit/virt-edit.pod:93
3773 msgid "By default, no backup file is made."
3777 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:105 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
3782 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:107 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
3783 msgid "B<--connect URI>"
3787 #: ../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
3789 "If you specify guest block devices directly, then libvirt is not used at "
3794 #: ../edit/virt-edit.pod:114
3796 "When prompting for keys and passphrases, virt-edit normally turns echoing "
3797 "off so you cannot see what you are typing. If you are not worried about "
3798 "Tempest attacks and there is no one else in the room you can specify this "
3799 "flag to see what you are typing."
3803 #: ../edit/virt-edit.pod:119
3808 #: ../edit/virt-edit.pod:121
3809 msgid "B<--expr> EXPR"
3813 #: ../edit/virt-edit.pod:123
3815 "Instead of launching the external editor, non-interactively apply the Perl "
3816 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
3821 #: ../edit/virt-edit.pod:127
3823 "Be careful to properly quote the expression to prevent it from being altered "
3828 #: ../edit/virt-edit.pod:130
3829 msgid "Note that this option is only available when Perl 5 is installed."
3833 #: ../edit/virt-edit.pod:132
3834 msgid "B<--format> raw|qcow2|..."
3838 #: ../edit/virt-edit.pod:143
3841 " virt-edit --format=raw -a disk.img file\n"
3846 #: ../edit/virt-edit.pod:147
3849 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
3854 #: ../edit/virt-edit.pod:181
3855 msgid "Previous versions of virt-edit allowed you to write either:"
3859 #: ../edit/virt-edit.pod:187
3862 " virt-edit guestname file\n"
3867 #: ../edit/virt-edit.pod:195
3868 msgid "NON-INTERACTIVE EDITING"
3872 #: ../edit/virt-edit.pod:197
3874 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
3875 "administrator can interactively edit the file."
3879 #: ../edit/virt-edit.pod:200
3881 "There are two ways also to use C<virt-edit> from scripts in order to make "
3882 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
3883 "like this, it's less error-prone to write scripts directly using the "
3884 "libguestfs API and Augeas for configuration file editing.)"
3888 #: ../edit/virt-edit.pod:206
3890 "The first method is to temporarily set C<$EDITOR> to any script or program "
3891 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
3892 "update C<tmpfile> in place however it likes."
3896 #: ../edit/virt-edit.pod:210
3898 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
3899 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
3900 "instances of C<foo> with C<bar> in a file:"
3904 #: ../edit/virt-edit.pod:214
3907 " virt-edit -d domname filename -e 's/foo/bar/'\n"
3912 #: ../edit/virt-edit.pod:216
3914 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
3915 "For example to delete root's password you could do:"
3919 #: ../edit/virt-edit.pod:219
3922 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3927 #: ../edit/virt-edit.pod:221
3929 "What really happens is that the snippet is evaluated as a Perl expression "
3930 "for each line of the file. The line, including the final C<\\n>, is passed "
3931 "in C<$_> and the expression should update C<$_> or leave it unchanged."
3935 #: ../edit/virt-edit.pod:226
3937 "To delete a line, set C<$_> to the empty string. For example, to delete the "
3938 "C<apache> user account from the password file you can do:"
3942 #: ../edit/virt-edit.pod:229
3945 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
3950 #: ../edit/virt-edit.pod:231
3952 "To insert a line, prepend or append it to C<$_>. However appending lines to "
3953 "the end of the file is rather difficult this way since there is no concept "
3954 "of \"last line of the file\" - your expression just doesn't get called "
3955 "again. You might want to use the first method (setting C<$EDITOR>) if you "
3960 #: ../edit/virt-edit.pod:237
3962 "The variable C<$lineno> contains the current line number. As is "
3963 "traditional, the first line in the file is number C<1>."
3967 #: ../edit/virt-edit.pod:240
3969 "The return value from the expression is ignored, but the expression may call "
3970 "C<die> in order to abort the whole program, leaving the original file "
3975 #: ../edit/virt-edit.pod:244
3977 "Remember when matching the end of a line that C<$_> may contain the final "
3978 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
3979 "newline then neither of these. Thus to match or substitute some text at the "
3980 "end of a line, use this regular expression:"
3984 #: ../edit/virt-edit.pod:249
3987 " /some text(\\r?\\n)?$/\n"
3992 #: ../edit/virt-edit.pod:251
3994 "Alternately, use the perl C<chomp> function, being careful not to chomp "
3995 "C<$_> itself (since that would remove all newlines from the file):"
3999 #: ../edit/virt-edit.pod:255
4002 " my $m = $_; chomp $m; $m =~ /some text$/\n"
4007 #: ../edit/virt-edit.pod:259
4009 "C<virt-edit> has a limited ability to understand Windows drive letters and "
4010 "paths (eg. C<E:\\foo\\bar.txt>)."
4014 #: ../edit/virt-edit.pod:278
4016 "The path is resolved case insensitively to locate the file that should be "
4021 #: ../edit/virt-edit.pod:299
4023 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
4024 "C<virt-edit> doesn't work."
4028 #: ../edit/virt-edit.pod:302
4029 msgid "Using C<virt-edit> is approximately equivalent to doing:"
4033 #: ../edit/virt-edit.pod:304
4036 " guestfish --rw -i -d domname edit /file\n"
4041 #: ../edit/virt-edit.pod:306
4043 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
4048 #: ../edit/virt-edit.pod:309
4050 "The command above uses libguestfs's guest inspection feature and so does not "
4051 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
4052 "disk images that don't contain guests. To edit a file on a disk image "
4057 #: ../edit/virt-edit.pod:314
4060 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
4065 #: ../edit/virt-edit.pod:316
4067 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
4068 "the disk image to edit, and C</file> is the full path to the file."
4072 #: ../edit/virt-edit.pod:320
4074 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
4075 "C<write> or C<upload> instead:"
4079 #: ../edit/virt-edit.pod:323
4082 " guestfish --rw -i -d domname touch /newfile\n"
4087 #: ../edit/virt-edit.pod:325
4090 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
4095 #: ../edit/virt-edit.pod:327
4098 " guestfish --rw -i -d domname upload localfile /newfile\n"
4103 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1119 ../rescue/virt-rescue.pod:261 ../sparsify/virt-sparsify.pod:232 ../src/guestfs.pod:3209 ../test-tool/libguestfs-test-tool.pod:95
4104 msgid "ENVIRONMENT VARIABLES"
4108 #: ../edit/virt-edit.pod:333
4113 #: ../edit/virt-edit.pod:335
4115 "If set, this string is used as the editor. It may contain arguments, "
4116 "eg. C<\"emacs -nw\">"
4120 #: ../edit/virt-edit.pod:338
4121 msgid "If not set, C<vi> is used."
4125 #: ../edit/virt-edit.pod:356
4127 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
4128 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
4129 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
4133 #: ../erlang/examples/guestfs-erlang.pod:5
4134 msgid "guestfs-erlang - How to use libguestfs from Erlang"
4138 #: ../erlang/examples/guestfs-erlang.pod:9
4141 " {ok, G} = guestfs:create(),\n"
4142 " ok = guestfs:add_drive_opts(G, Disk,\n"
4143 " [{format, \"raw\"}, {readonly, true}]),\n"
4144 " ok = guestfs:launch(G),\n"
4145 " [Device] = guestfs:list_devices(G),\n"
4146 " ok = guestfs:close(G).\n"
4151 #: ../erlang/examples/guestfs-erlang.pod:18
4153 "This manual page documents how to call libguestfs from the Erlang "
4154 "programming language. This page just documents the differences from the C "
4155 "API and gives some examples. If you are not familiar with using libguestfs, "
4156 "you also need to read L<guestfs(3)>."
4160 #: ../erlang/examples/guestfs-erlang.pod:23
4161 msgid "OPENING AND CLOSING THE HANDLE"
4165 #: ../erlang/examples/guestfs-erlang.pod:25
4167 "The Erlang bindings are implemented using an external program called "
4168 "C<erl-guestfs>. This program must be on the current PATH, or else you "
4169 "should specify the full path to the program:"
4173 #: ../erlang/examples/guestfs-erlang.pod:29
4176 " {ok, G} = guestfs:create().\n"
4181 #: ../erlang/examples/guestfs-erlang.pod:31
4184 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
4189 #: ../erlang/examples/guestfs-erlang.pod:33
4190 msgid "C<G> is the libguestfs handle which you should pass to other functions."
4194 #: ../erlang/examples/guestfs-erlang.pod:36
4195 msgid "To close the handle:"
4199 #: ../erlang/examples/guestfs-erlang.pod:38
4202 " ok = guestfs:close(G).\n"
4207 #: ../erlang/examples/guestfs-erlang.pod:40
4208 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
4212 #: ../erlang/examples/guestfs-erlang.pod:42
4214 "For functions that take optional arguments, the first arguments are the "
4215 "non-optional ones. The last argument is a list of tuples supplying the "
4216 "remaining optional arguments."
4220 #: ../erlang/examples/guestfs-erlang.pod:46
4223 " ok = guestfs:add_drive_opts(G, Disk,\n"
4224 " [{format, \"raw\"}, {readonly, true}]).\n"
4229 #: ../erlang/examples/guestfs-erlang.pod:49
4230 msgid "If the last argument would be an empty list, you can also omit it:"
4234 #: ../erlang/examples/guestfs-erlang.pod:51
4237 " ok = guestfs:add_drive_opts(G, Disk).\n"
4242 #: ../erlang/examples/guestfs-erlang.pod:53
4243 msgid "RETURN VALUES AND ERRORS"
4247 #: ../erlang/examples/guestfs-erlang.pod:55
4249 "On success, most functions return a C<Result> term (which could be a list, "
4250 "string, tuple etc.). If there is nothing for the function to return, then "
4251 "the atom C<ok> is returned."
4255 #: ../erlang/examples/guestfs-erlang.pod:59
4256 msgid "On error, you would see one of the following tuples:"
4260 #: ../erlang/examples/guestfs-erlang.pod:63
4261 msgid "C<{error, Msg, Errno}>"
4265 #: ../erlang/examples/guestfs-erlang.pod:65
4266 msgid "This indicates an ordinary error from the function."
4270 #: ../erlang/examples/guestfs-erlang.pod:67
4272 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
4277 #: ../erlang/examples/guestfs-erlang.pod:70
4278 msgid "C<Errno> can be zero. See L<guestfs(3)/guestfs_last_errno>."
4282 #: ../erlang/examples/guestfs-erlang.pod:72
4283 msgid "C<{unknown, Function}>"
4287 #: ../erlang/examples/guestfs-erlang.pod:74
4289 "This indicates that the function you called is not known. Generally this "
4290 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
4291 "which you should not do."
4295 #: ../erlang/examples/guestfs-erlang.pod:78
4296 msgid "C<Function> is the name of the unknown function."
4300 #: ../erlang/examples/guestfs-erlang.pod:80
4301 msgid "C<{unknownarg, Arg}>"
4305 #: ../erlang/examples/guestfs-erlang.pod:82
4307 "This indicates that you called a function with optional arguments, with an "
4308 "unknown argument name."
4312 #: ../erlang/examples/guestfs-erlang.pod:85
4313 msgid "C<Arg> is the name of the unknown argument."
4317 #: ../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
4318 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
4322 #: ../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
4327 #: ../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
4328 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
4332 #: ../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
4337 #: ../erlang/examples/guestfs-erlang.pod:99
4339 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
4340 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
4341 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>. "
4342 "L<http://libguestfs.org/>."
4346 #: ../erlang/examples/guestfs-erlang.pod:110 ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 ../fish/guestfish.pod:1296 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod: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:3348 ../test-tool/libguestfs-test-tool.pod:106
4351 #: ../erlang/examples/guestfs-erlang.pod:112 ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 ../fish/guestfish.pod:1298 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:330 ../java/examples/guestfs-java.pod: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:3350 ../test-tool/libguestfs-test-tool.pod:108
4352 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4356 #: ../erlang/examples/guestfs-erlang.pod:116 ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
4357 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
4361 #: ../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
4363 "The examples in this manual page may be freely copied, modified and "
4364 "distributed without any restrictions."
4368 #: ../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:3357
4370 "This library is free software; you can redistribute it and/or modify it "
4371 "under the terms of the GNU Lesser General Public License as published by the "
4372 "Free Software Foundation; either version 2 of the License, or (at your "
4373 "option) any later version."
4377 #: ../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:3362
4379 "This library is distributed in the hope that it will be useful, but WITHOUT "
4380 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4381 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4386 #: ../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:3367
4388 "You should have received a copy of the GNU Lesser General Public License "
4389 "along with this library; if not, write to the Free Software Foundation, "
4390 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4394 #: ../examples/guestfs-examples.pod:5
4395 msgid "guestfs-examples - Examples of using libguestfs from C"
4399 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
4402 " #include <guestfs.h>\n"
4407 #: ../examples/guestfs-examples.pod:11
4410 " guestfs_h *g = guestfs_create ();\n"
4411 " guestfs_add_drive_ro (g, \"disk.img\");\n"
4412 " guestfs_launch (g);\n"
4417 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
4420 " cc prog.c -o prog -lguestfs\n"
4422 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
4427 #: ../examples/guestfs-examples.pod:21
4429 "This manual page contains examples of calling libguestfs from the C "
4430 "programming language. If you are not familiar with using libguestfs, you "
4431 "also need to read L<guestfs(3)>."
4435 #: ../examples/guestfs-examples.pod:35
4437 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
4438 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
4439 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
4443 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 ../python/examples/guestfs-python.pod:60 ../ruby/examples/guestfs-ruby.pod:54
4444 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
4448 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
4453 #: ../examples/guestfs-recipes.pod:5
4455 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
4456 "here. The only way which works for both sorts of output is to just write "
4457 "the URL directly. Do NOT use L<...> for URLs."
4461 #: ../examples/guestfs-recipes.pod:9
4463 "We break with tradition here and don't use ALL CAPS for the section "
4464 "headings, as this makes them much easier to read."
4468 #: ../examples/guestfs-recipes.pod:16
4469 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
4473 #: ../examples/guestfs-recipes.pod:20
4475 "This page contains recipes for and links to things you can do using "
4476 "libguestfs, L<guestfish(1)> and the virt tools."
4480 #: ../examples/guestfs-recipes.pod:23
4481 msgid "Audit a virtual machine for setuid files"
4485 #: ../examples/guestfs-recipes.pod:25
4487 "The link below contains a small program which can be used to audit a Linux "
4488 "virtual machine to see what setuid and setgid files it contains."
4492 #: ../examples/guestfs-recipes.pod:28
4493 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
4497 #: ../examples/guestfs-recipes.pod:30
4498 msgid "Change the background image in a Windows XP VM"
4502 #: ../examples/guestfs-recipes.pod:32
4504 "The links below explain how to use L<guestfish(1)> to change the background "
4505 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
4506 "be substantially different for each version of Windows."
4510 #: ../examples/guestfs-recipes.pod:37
4512 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
4513 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
4517 #: ../examples/guestfs-recipes.pod:40
4518 msgid "Cloning a virtual machine (Linux)"
4522 #: ../examples/guestfs-recipes.pod:42
4524 "The guestfish technique described in the link below works well for most "
4525 "Linux VMs. Depending on the Linux distro you may need to change the paths "
4530 #: ../examples/guestfs-recipes.pod:46
4531 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
4535 #: ../examples/guestfs-recipes.pod:48
4537 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
4542 #: ../examples/guestfs-recipes.pod:51
4543 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4547 #: ../examples/guestfs-recipes.pod:53
4548 msgid "Cloning a virtual machine (Windows)"
4552 #: ../examples/guestfs-recipes.pod:55
4554 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
4555 "straightforward. Currently there is code in the Aeolus Oz project which "
4556 "does this (using libguestfs). As part of our review of the virt-clone tool, "
4557 "we may add sysprepping ability."
4561 #: ../examples/guestfs-recipes.pod:60
4563 "https://github.com/clalancette/oz "
4564 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4568 #: ../examples/guestfs-recipes.pod:63
4569 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
4573 #: ../examples/guestfs-recipes.pod:65
4574 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
4578 #: ../examples/guestfs-recipes.pod:67
4581 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
4586 #: ../examples/guestfs-recipes.pod:69
4587 msgid "To export just a subdirectory, eg. C</files>, do:"
4591 #: ../examples/guestfs-recipes.pod:71
4594 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
4599 #: ../examples/guestfs-recipes.pod:73
4600 msgid "Create empty disk images"
4604 #: ../examples/guestfs-recipes.pod:75
4606 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
4607 "The useful guide below explains the options available."
4611 #: ../examples/guestfs-recipes.pod:78
4612 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
4616 #: ../examples/guestfs-recipes.pod:80
4617 msgid "Dump raw filesystem content from inside a disk image or VM"
4621 #: ../examples/guestfs-recipes.pod:82
4623 "You can use the L<guestfish(1)> C<download> command to extract the raw "
4624 "filesystem content from any filesystem in a disk image or a VM (even one "
4625 "which is encrypted or buried inside an LV):"
4629 #: ../examples/guestfs-recipes.pod:86
4632 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
4637 #: ../examples/guestfs-recipes.pod:88
4640 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
4645 #: ../examples/guestfs-recipes.pod:90
4646 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
4650 #: ../examples/guestfs-recipes.pod:92
4651 msgid "Edit grub configuration in a VM"
4655 #: ../examples/guestfs-recipes.pod:94
4656 msgid "You can use this to:"
4660 #: ../examples/guestfs-recipes.pod:100
4661 msgid "Fix a virtual machine that does not boot."
4665 #: ../examples/guestfs-recipes.pod:104
4666 msgid "Change which kernel is used to boot the VM."
4670 #: ../examples/guestfs-recipes.pod:108
4671 msgid "Change kernel command line options."
4675 #: ../examples/guestfs-recipes.pod:112
4676 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
4680 #: ../examples/guestfs-recipes.pod:114
4683 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
4688 #: ../examples/guestfs-recipes.pod:116
4690 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
4695 #: ../examples/guestfs-recipes.pod:119
4698 " virt-rescue -d BrokenGuest\n"
4703 #: ../examples/guestfs-recipes.pod:121
4704 msgid "Export any directory from a VM"
4708 #: ../examples/guestfs-recipes.pod:123
4709 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
4713 #: ../examples/guestfs-recipes.pod:126
4716 " virt-copy-out -d Guest /home .\n"
4721 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1450 ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:2132 ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:2334 ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:3317 ../src/guestfs.pod:1685 ../tools/virt-win-reg.pl:717
4726 #: ../examples/guestfs-recipes.pod:134
4728 "The final dot of the command is not a printing error. It means we want to "
4729 "copy out to the current directory."
4733 #: ../examples/guestfs-recipes.pod:139
4734 msgid "This creates a directory called C<home> under the current directory."
4738 #: ../examples/guestfs-recipes.pod:143
4740 "If the guest is a Windows guest then you can use drive letters and "
4741 "backslashes, but you must prefix the path with C<win:> and quote it to "
4742 "protect it from the shell, like this:"
4746 #: ../examples/guestfs-recipes.pod:147
4749 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
4754 #: ../examples/guestfs-recipes.pod:149
4755 msgid "To get the output as a compressed tarball, do:"
4759 #: ../examples/guestfs-recipes.pod:151
4762 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
4767 #: ../examples/guestfs-recipes.pod:153
4769 "Although it sounds tempting, this is usually not a reliable way to get a "
4770 "backup from a running guest. See the entry in the FAQ: "
4771 "http://libguestfs.org/FAQ.html#backup"
4775 #: ../examples/guestfs-recipes.pod:157
4776 msgid "Find out which user is using the most space"
4780 #: ../examples/guestfs-recipes.pod:159
4782 "This simple script examines a Linux guest to find out which user is using "
4783 "the most space in their home directory:"
4787 #: ../examples/guestfs-recipes.pod:162
4795 #: ../examples/guestfs-recipes.pod:164 ../fish/guestfish.pod:984
4803 #: ../examples/guestfs-recipes.pod:166
4812 #: ../examples/guestfs-recipes.pod:169
4815 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
4820 #: ../examples/guestfs-recipes.pod:171
4823 " for d in $(guestfish --remote ls \"$dir\"); do\n"
4824 " echo -n \"$dir/$d\"\n"
4826 " guestfish --remote du \"$dir/$d\";\n"
4827 " done | sort -nr -k 2\n"
4832 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
4835 " guestfish --remote exit\n"
4840 #: ../examples/guestfs-recipes.pod:179
4841 msgid "Get DHCP address from a VM"
4845 #: ../examples/guestfs-recipes.pod:181
4847 "The link below explains the many different possible techniques for getting "
4848 "the last assigned DHCP address of a virtual machine."
4852 #: ../examples/guestfs-recipes.pod:184
4853 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
4857 #: ../examples/guestfs-recipes.pod:186
4859 "In the libguestfs source examples directory you will find the latest version "
4860 "of the C<virt-dhcp-address.c> program."
4864 #: ../examples/guestfs-recipes.pod:189
4865 msgid "Get the operating system product name string"
4869 #: ../examples/guestfs-recipes.pod:191
4870 msgid "Save the following script into a file called C<product-name.sh>:"
4874 #: ../examples/guestfs-recipes.pod:193
4879 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4880 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4881 " guestfish --remote inspect-get-product-name \"$root\"\n"
4882 " guestfish --remote exit\n"
4887 #: ../examples/guestfs-recipes.pod:200
4888 msgid "Make the script executable and run it on a named guest:"
4892 #: ../examples/guestfs-recipes.pod:202
4895 " # product-name.sh RHEL60x64\n"
4896 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
4901 #: ../examples/guestfs-recipes.pod:205
4903 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
4904 "C<xpath> command line tool or from your favourite programming language:"
4908 #: ../examples/guestfs-recipes.pod:209
4911 " # virt-inspector RHEL60x64 > xml\n"
4912 " # xpath '//product_name' < xml\n"
4915 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
4916 "(Santiago)</product_name>\n"
4921 #: ../examples/guestfs-recipes.pod:215
4922 msgid "Get the default boot kernel for a Linux VM"
4926 #: ../examples/guestfs-recipes.pod:217
4928 "The link below contains a program to print the default boot kernel for a "
4933 #: ../examples/guestfs-recipes.pod:220
4934 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
4938 #: ../examples/guestfs-recipes.pod:222
4940 "It uses Augeas, and the technique is generally applicable for many different "
4945 #: ../examples/guestfs-recipes.pod:229
4946 msgid "listing the user accounts in the guest"
4950 #: ../examples/guestfs-recipes.pod:233
4951 msgid "what repositories is it configured to use"
4955 #: ../examples/guestfs-recipes.pod:237
4956 msgid "what NTP servers does it connect to"
4960 #: ../examples/guestfs-recipes.pod:241
4961 msgid "what were the boot messages last time it booted"
4965 #: ../examples/guestfs-recipes.pod:245
4966 msgid "listing who was logged in recently"
4970 #: ../examples/guestfs-recipes.pod:249
4971 msgid "http://augeas.net/"
4975 #: ../examples/guestfs-recipes.pod:251
4976 msgid "Install RPMs in a guest"
4980 #: ../examples/guestfs-recipes.pod:253
4982 "The link below contains a method to install RPMs in a guest. In fact the "
4983 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
4984 "installs them next time the guest is booted. You could use this technique "
4985 "to install vital security updates in an offline guest."
4989 #: ../examples/guestfs-recipes.pod:259
4990 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
4994 #: ../examples/guestfs-recipes.pod:261
4995 msgid "List applications installed in a VM"
4999 #: ../examples/guestfs-recipes.pod:263
5000 msgid "Save the following to a file C<list-apps.sh>:"
5004 #: ../examples/guestfs-recipes.pod:265
5009 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
5010 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
5011 " guestfish --remote inspect-list-applications \"$root\"\n"
5012 " guestfish --remote exit\n"
5017 #: ../examples/guestfs-recipes.pod:272
5019 "Make the file executable and then you can run it on any named virtual "
5024 #: ../examples/guestfs-recipes.pod:275
5027 " # list-apps.sh WinGuest\n"
5029 " app_name: Mozilla Firefox (3.6.12)\n"
5030 " app_display_name: Mozilla Firefox (3.6.12)\n"
5032 " app_version: 3.6.12 (en-GB)\n"
5034 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
5035 " app_trans_path:\n"
5036 " app_publisher: Mozilla\n"
5037 " app_url: http://www.mozilla.com/en-GB/\n"
5038 " app_source_package:\n"
5040 " app_description: Mozilla Firefox\n"
5043 " app_name: VLC media player\n"
5044 " app_display_name: VLC media player 1.1.5\n"
5046 " app_version: 1.1.5\n"
5048 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
5049 " app_trans_path:\n"
5050 " app_publisher: VideoLAN\n"
5051 " app_url: http://www.videolan.org/\n"
5052 " app_source_package:\n"
5054 " app_description:\n"
5060 #: ../examples/guestfs-recipes.pod:305
5062 "If you want to run the script on disk images (instead of libvirt virtual "
5063 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
5064 "L<virt-inspector(1)>."
5068 #: ../examples/guestfs-recipes.pod:309
5069 msgid "List files and directories in a VM"
5073 #: ../examples/guestfs-recipes.pod:311
5074 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
5078 #: ../examples/guestfs-recipes.pod:313
5081 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
5086 #: ../examples/guestfs-recipes.pod:315
5087 msgid "List services in a Windows VM"
5091 #: ../examples/guestfs-recipes.pod:317
5093 "The link below contains a script that can be used to list out the services "
5094 "from a Windows VM, and whether those services run at boot time or are loaded "
5099 #: ../examples/guestfs-recipes.pod:321
5100 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
5104 #: ../examples/guestfs-recipes.pod:323
5105 msgid "Make a disk image sparse"
5109 #: ../examples/guestfs-recipes.pod:325
5111 "The link below contains some guides for making a disk image sparse (or "
5112 "reintroducing sparseness)."
5116 #: ../examples/guestfs-recipes.pod:328
5117 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
5121 #: ../examples/guestfs-recipes.pod:330
5122 msgid "Monitor disk usage over time"
5126 #: ../examples/guestfs-recipes.pod:332
5128 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
5129 "The link below contains a guide."
5133 #: ../examples/guestfs-recipes.pod:335
5134 msgid "http://virt-tools.org/learning/advanced-virt-df/"
5138 #: ../examples/guestfs-recipes.pod:337
5139 msgid "Reading the Windows Event Log from Windows Vista (or later)"
5143 #: ../examples/guestfs-recipes.pod:339
5145 "L<guestfish(1)> plus the tools described in the link below can be used to "
5146 "read out the Windows Event Log from any virtual machine running Windows "
5147 "Vista or a later version."
5151 #: ../examples/guestfs-recipes.pod:343
5152 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
5156 #: ../examples/guestfs-recipes.pod:345
5157 msgid "Remove root password (Linux)"
5161 #: ../examples/guestfs-recipes.pod:347
5163 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
5164 "files. One use is to remove the root password from a Linux guest:"
5168 #: ../examples/guestfs-recipes.pod:350
5171 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
5176 #: ../examples/guestfs-recipes.pod:352
5177 msgid "Remove Administrator password (Windows)"
5181 #: ../examples/guestfs-recipes.pod:354
5183 "The link below contains one technique for removing the Administrator "
5184 "password from a Windows VM, or to be more precise, it gives you a command "
5185 "prompt the next time you log in which you can use to bypass any security:"
5189 #: ../examples/guestfs-recipes.pod:359
5190 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
5194 #: ../examples/guestfs-recipes.pod:361
5195 msgid "Unpack a live CD"
5199 #: ../examples/guestfs-recipes.pod:363
5201 "Linux live CDs often contain multiple layers of disk images wrapped like a "
5202 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
5203 "layers, as outlined in the guide below."
5207 #: ../examples/guestfs-recipes.pod:367
5208 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
5212 #: ../examples/guestfs-recipes.pod:369
5213 msgid "Uploading and downloading files"
5217 #: ../examples/guestfs-recipes.pod:371
5219 "The link below contains general tips on uploading (copying in) and "
5220 "downloading (copying out) files from VMs."
5224 #: ../examples/guestfs-recipes.pod:374
5225 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
5229 #: ../examples/guestfs-recipes.pod:376
5230 msgid "Use libguestfs tools on VMware ESX guests"
5234 #: ../examples/guestfs-recipes.pod:378
5236 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
5237 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
5241 #: ../examples/guestfs-recipes.pod:382
5242 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
5246 #: ../examples/guestfs-recipes.pod:386
5248 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, "
5249 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
5250 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
5251 "L<http://libguestfs.org/>."
5255 #: ../examples/guestfs-recipes.pod:403
5256 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5260 #: ../fish/guestfish-actions.pod:1
5265 #: ../fish/guestfish-actions.pod:3
5268 " add-cdrom filename\n"
5273 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
5274 msgid "This function adds a virtual CD-ROM disk image to the guest."
5278 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
5279 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5283 #: ../fish/guestfish-actions.pod:15
5285 "This call checks for the existence of C<filename>. This stops you from "
5286 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5287 "and C<http:> URLs. To specify those, use the general L</config> call "
5292 #: ../fish/guestfish-actions.pod:22
5294 "If you just want to add an ISO file (often you use this as an efficient way "
5295 "to transfer large files into the guest), then you should probably use "
5296 "L</add-drive-ro> instead."
5300 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:214 ../fish/guestfish-actions.pod:228
5302 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
5307 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:217 ../fish/guestfish-actions.pod:231 ../fish/guestfish-actions.pod:941 ../fish/guestfish-actions.pod:976 ../fish/guestfish-actions.pod:1149 ../fish/guestfish-actions.pod:1509 ../fish/guestfish-actions.pod:1523 ../fish/guestfish-actions.pod:3284 ../fish/guestfish-actions.pod:3595 ../fish/guestfish-actions.pod:3643 ../fish/guestfish-actions.pod:4561 ../fish/guestfish-actions.pod:4581 ../fish/guestfish-actions.pod:4600 ../fish/guestfish-actions.pod:4638 ../fish/guestfish-actions.pod:5287 ../fish/guestfish-actions.pod:5390 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:305 ../src/guestfs-actions.pod:326 ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:1637 ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:2419 ../src/guestfs-actions.pod:2440 ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:6994 ../src/guestfs-actions.pod:7035 ../src/guestfs-actions.pod:7066 ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:8058 ../src/guestfs-actions.pod:8167 ../src/guestfs-actions.pod:8347
5309 "Deprecated functions will not be removed from the API, but the fact that "
5310 "they are deprecated indicates that there are problems with correct use of "
5315 #: ../fish/guestfish-actions.pod:35
5320 #: ../fish/guestfish-actions.pod:37
5325 #: ../fish/guestfish-actions.pod:39
5328 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
5329 "[allowuuid:..] [readonlydisk:..]\n"
5334 #: ../fish/guestfish-actions.pod:41
5336 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5337 "It works by connecting to libvirt, requesting the domain and domain XML from "
5338 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
5342 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:65
5344 "The number of disks added is returned. This operation is atomic: if an "
5345 "error is returned, then no disks are added."
5349 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:68
5351 "This function does some minimal checks to make sure the libvirt domain is "
5352 "not running (unless C<readonly> is true). In a future version we will try "
5353 "to acquire the libvirt lock on each disk."
5357 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:72
5359 "Disks must be accessible locally. This often means that adding disks from a "
5360 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5361 "unless those disks are accessible via the same device path locally too."
5365 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:77
5367 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5368 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5369 "default libvirt URI (or one set through an environment variable, see the "
5370 "libvirt documentation for full details)."
5374 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:83
5376 "The optional C<live> flag controls whether this call will try to connect to "
5377 "a running virtual machine C<guestfsd> process if it sees a suitable "
5378 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5379 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5380 "DAEMONS> for more information."
5384 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:90
5386 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5387 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5388 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5393 #: ../fish/guestfish-actions.pod:76 ../src/guestfs-actions.pod:95
5395 "The optional C<readonlydisk> parameter controls what we do for disks which "
5396 "are marked E<lt>readonly/E<gt> in the libvirt XML. Possible values are:"
5400 #: ../fish/guestfish-actions.pod:82 ../src/guestfs-actions.pod:101
5401 msgid "readonlydisk = \"error\""
5405 #: ../fish/guestfish-actions.pod:84 ../fish/guestfish-actions.pod:95 ../fish/guestfish-actions.pod:106 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:125
5406 msgid "If C<readonly> is false:"
5410 #: ../fish/guestfish-actions.pod:86 ../src/guestfs-actions.pod:105
5412 "The whole call is aborted with an error if any disk with the "
5413 "E<lt>readonly/E<gt> flag is found."
5417 #: ../fish/guestfish-actions.pod:89 ../fish/guestfish-actions.pod:100 ../fish/guestfish-actions.pod:110 ../src/guestfs-actions.pod:108 ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:129
5418 msgid "If C<readonly> is true:"
5422 #: ../fish/guestfish-actions.pod:91 ../fish/guestfish-actions.pod:102 ../fish/guestfish-actions.pod:112 ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:131
5423 msgid "Disks with the E<lt>readonly/E<gt> flag are added read-only."
5427 #: ../fish/guestfish-actions.pod:93 ../src/guestfs-actions.pod:112
5428 msgid "readonlydisk = \"read\""
5432 #: ../fish/guestfish-actions.pod:97 ../src/guestfs-actions.pod:116
5434 "Disks with the E<lt>readonly/E<gt> flag are added read-only. Other disks "
5435 "are added read/write."
5439 #: ../fish/guestfish-actions.pod:104 ../src/guestfs-actions.pod:123
5440 msgid "readonlydisk = \"write\" (default)"
5444 #: ../fish/guestfish-actions.pod:108 ../src/guestfs-actions.pod:127
5445 msgid "Disks with the E<lt>readonly/E<gt> flag are added read/write."
5449 #: ../fish/guestfish-actions.pod:114 ../src/guestfs-actions.pod:133
5450 msgid "readonlydisk = \"ignore\""
5454 #: ../fish/guestfish-actions.pod:116 ../src/guestfs-actions.pod:135
5455 msgid "If C<readonly> is true or false:"
5459 #: ../fish/guestfish-actions.pod:118 ../src/guestfs-actions.pod:137
5460 msgid "Disks with the E<lt>readonly/E<gt> flag are skipped."
5464 #: ../fish/guestfish-actions.pod:122
5466 "The other optional parameters are passed directly through to "
5467 "L</add-drive-opts>."
5471 #: ../fish/guestfish-actions.pod:125 ../fish/guestfish-actions.pod:194 ../fish/guestfish-actions.pod:624 ../fish/guestfish-actions.pod:835 ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:894 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:912 ../fish/guestfish-actions.pod:926 ../fish/guestfish-actions.pod:2171 ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3496 ../fish/guestfish-actions.pod:3631
5473 "This command has one or more optional arguments. See L</OPTIONAL "
5478 #: ../fish/guestfish-actions.pod:127
5483 #: ../fish/guestfish-actions.pod:129
5486 " add-drive filename\n"
5491 #: ../fish/guestfish-actions.pod:131
5493 "This function is the equivalent of calling L</add-drive-opts> with no "
5494 "optional parameters, so the disk is added writable, with the format being "
5495 "detected automatically."
5499 #: ../fish/guestfish-actions.pod:135
5501 "Automatic detection of the format opens you up to a potential security hole "
5502 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5503 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5504 "you should think about replacing calls to this function with calls to "
5505 "L</add-drive-opts>, and specifying the format."
5509 #: ../fish/guestfish-actions.pod:142
5510 msgid "add-drive-opts"
5514 #: ../fish/guestfish-actions.pod:144
5519 #: ../fish/guestfish-actions.pod:146
5522 " add-drive-opts filename [readonly:..] [format:..] [iface:..] [name:..]\n"
5527 #: ../fish/guestfish-actions.pod:148 ../src/guestfs-actions.pod:208
5529 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5530 "The first time you call this function, the disk appears as C</dev/sda>, the "
5531 "second time as C</dev/sdb>, and so on."
5535 #: ../fish/guestfish-actions.pod:153 ../src/guestfs-actions.pod:213
5537 "You don't necessarily need to be root when using libguestfs. However you "
5538 "obviously do need sufficient permissions to access the filename for whatever "
5539 "operations you want to perform (ie. read access if you just want to read the "
5540 "image or write access if you want to modify the image)."
5544 #: ../fish/guestfish-actions.pod:159 ../src/guestfs-actions.pod:219
5545 msgid "This call checks that C<filename> exists."
5549 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:3295 ../src/guestfs-actions.pod:221 ../src/guestfs-actions.pod:5113
5550 msgid "The optional arguments are:"
5554 #: ../fish/guestfish-actions.pod:165 ../src/guestfs-actions.pod:225
5559 #: ../fish/guestfish-actions.pod:167 ../src/guestfs-actions.pod:227
5561 "If true then the image is treated as read-only. Writes are still allowed, "
5562 "but they are stored in a temporary snapshot overlay which is discarded at "
5563 "the end. The disk that you add is not modified."
5567 #: ../fish/guestfish-actions.pod:171 ../src/guestfs-actions.pod:231
5572 #: ../fish/guestfish-actions.pod:173
5574 "This forces the image format. If you omit this (or use L</add-drive> or "
5575 "L</add-drive-ro>) then the format is automatically detected. Possible "
5576 "formats include C<raw> and C<qcow2>."
5580 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:237
5582 "Automatic detection of the format opens you up to a potential security hole "
5583 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5584 "RHBZ#642934. Specifying the format closes this security hole."
5588 #: ../fish/guestfish-actions.pod:182 ../src/guestfs-actions.pod:242
5593 #: ../fish/guestfish-actions.pod:184
5595 "This rarely-used option lets you emulate the behaviour of the deprecated "
5596 "L</add-drive-with-if> call (q.v.)"
5600 #: ../fish/guestfish-actions.pod:187 ../src/guestfs-actions.pod:247
5605 #: ../fish/guestfish-actions.pod:189 ../src/guestfs-actions.pod:249
5607 "The name the drive had in the original guest, e.g. /dev/sdb. This is used as "
5608 "a hint to the guest inspection process if it is available."
5612 #: ../fish/guestfish-actions.pod:196
5613 msgid "add-drive-ro"
5617 #: ../fish/guestfish-actions.pod:198
5622 #: ../fish/guestfish-actions.pod:200
5625 " add-drive-ro filename\n"
5630 #: ../fish/guestfish-actions.pod:202
5632 "This function is the equivalent of calling L</add-drive-opts> with the "
5633 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
5634 "is added read-only, with the format being detected automatically."
5638 #: ../fish/guestfish-actions.pod:207
5639 msgid "add-drive-ro-with-if"
5643 #: ../fish/guestfish-actions.pod:209
5646 " add-drive-ro-with-if filename iface\n"
5651 #: ../fish/guestfish-actions.pod:211
5653 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
5654 "interface emulation to use at run time."
5658 #: ../fish/guestfish-actions.pod:221
5659 msgid "add-drive-with-if"
5663 #: ../fish/guestfish-actions.pod:223
5666 " add-drive-with-if filename iface\n"
5671 #: ../fish/guestfish-actions.pod:225
5673 "This is the same as L</add-drive> but it allows you to specify the QEMU "
5674 "interface emulation to use at run time."
5678 #: ../fish/guestfish-actions.pod:235
5683 #: ../fish/guestfish-actions.pod:237
5686 " aug-clear augpath\n"
5691 #: ../fish/guestfish-actions.pod:239 ../src/guestfs-actions.pod:343
5693 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5694 "L<augtool(1)> C<clear> command."
5698 #: ../fish/guestfish-actions.pod:242
5703 #: ../fish/guestfish-actions.pod:244
5711 #: ../fish/guestfish-actions.pod:246
5713 "Close the current Augeas handle and free up any resources used by it. After "
5714 "calling this, you have to call L</aug-init> again before you can use any "
5715 "other Augeas functions."
5719 #: ../fish/guestfish-actions.pod:251
5724 #: ../fish/guestfish-actions.pod:253
5727 " aug-defnode name expr val\n"
5732 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:372
5733 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5737 #: ../fish/guestfish-actions.pod:258
5739 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5740 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
5741 "containing that single node."
5745 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:379
5747 "On success this returns a pair containing the number of nodes in the "
5748 "nodeset, and a boolean flag if a node was created."
5752 #: ../fish/guestfish-actions.pod:266
5757 #: ../fish/guestfish-actions.pod:268
5760 " aug-defvar name expr\n"
5765 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:396
5767 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5768 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5772 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:400
5774 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5775 "evaluates to something which is not a nodeset."
5779 #: ../fish/guestfish-actions.pod:277
5784 #: ../fish/guestfish-actions.pod:279
5787 " aug-get augpath\n"
5792 #: ../fish/guestfish-actions.pod:281 ../src/guestfs-actions.pod:413
5794 "Look up the value associated with C<path>. If C<path> matches exactly one "
5795 "node, the C<value> is returned."
5799 #: ../fish/guestfish-actions.pod:284
5804 #: ../fish/guestfish-actions.pod:286
5807 " aug-init root flags\n"
5812 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:428
5814 "Create a new Augeas handle for editing configuration files. If there was "
5815 "any previous Augeas handle associated with this guestfs session, then it is "
5820 #: ../fish/guestfish-actions.pod:292
5821 msgid "You must call this before using any other L</aug-*> commands."
5825 #: ../fish/guestfish-actions.pod:295 ../src/guestfs-actions.pod:435
5826 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5830 #: ../fish/guestfish-actions.pod:298 ../src/guestfs-actions.pod:438
5832 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5833 "logical I<or> of the following integers:"
5837 #: ../fish/guestfish-actions.pod:304 ../src/guestfs-actions.pod:444
5838 msgid "C<AUG_SAVE_BACKUP> = 1"
5842 #: ../fish/guestfish-actions.pod:306 ../src/guestfs-actions.pod:446
5843 msgid "Keep the original file with a C<.augsave> extension."
5847 #: ../fish/guestfish-actions.pod:308 ../src/guestfs-actions.pod:448
5848 msgid "C<AUG_SAVE_NEWFILE> = 2"
5852 #: ../fish/guestfish-actions.pod:310 ../src/guestfs-actions.pod:450
5854 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5855 "original. Overrides C<AUG_SAVE_BACKUP>."
5859 #: ../fish/guestfish-actions.pod:313 ../src/guestfs-actions.pod:453
5860 msgid "C<AUG_TYPE_CHECK> = 4"
5864 #: ../fish/guestfish-actions.pod:315 ../src/guestfs-actions.pod:455
5865 msgid "Typecheck lenses."
5869 #: ../fish/guestfish-actions.pod:317
5871 "This option is only useful when debugging Augeas lenses. Use of this option "
5872 "may require additional memory for the libguestfs appliance. You may need to "
5873 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
5877 #: ../fish/guestfish-actions.pod:322 ../src/guestfs-actions.pod:462
5878 msgid "C<AUG_NO_STDINC> = 8"
5882 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:464
5883 msgid "Do not use standard load path for modules."
5887 #: ../fish/guestfish-actions.pod:326 ../src/guestfs-actions.pod:466
5888 msgid "C<AUG_SAVE_NOOP> = 16"
5892 #: ../fish/guestfish-actions.pod:328 ../src/guestfs-actions.pod:468
5893 msgid "Make save a no-op, just record what would have been changed."
5897 #: ../fish/guestfish-actions.pod:330 ../src/guestfs-actions.pod:470
5898 msgid "C<AUG_NO_LOAD> = 32"
5902 #: ../fish/guestfish-actions.pod:332
5903 msgid "Do not load the tree in L</aug-init>."
5907 #: ../fish/guestfish-actions.pod:336
5908 msgid "To close the handle, you can call L</aug-close>."
5912 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:478
5913 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5917 #: ../fish/guestfish-actions.pod:340
5922 #: ../fish/guestfish-actions.pod:342
5925 " aug-insert augpath label true|false\n"
5930 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:492
5932 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5933 "or after C<path> (depending on the boolean flag C<before>)."
5937 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:496
5939 "C<path> must match exactly one existing node in the tree, and C<label> must "
5940 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5944 #: ../fish/guestfish-actions.pod:352
5949 #: ../fish/guestfish-actions.pod:354
5957 #: ../fish/guestfish-actions.pod:356 ../src/guestfs-actions.pod:509
5958 msgid "Load files into the tree."
5962 #: ../fish/guestfish-actions.pod:358 ../src/guestfs-actions.pod:511
5963 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5967 #: ../fish/guestfish-actions.pod:361
5972 #: ../fish/guestfish-actions.pod:363
5980 #: ../fish/guestfish-actions.pod:365
5982 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
5983 "resulting nodes into alphabetical order."
5987 #: ../fish/guestfish-actions.pod:368
5992 #: ../fish/guestfish-actions.pod:370
5995 " aug-match augpath\n"
6000 #: ../fish/guestfish-actions.pod:372 ../src/guestfs-actions.pod:539
6002 "Returns a list of paths which match the path expression C<path>. The "
6003 "returned paths are sufficiently qualified so that they match exactly one "
6004 "node in the current tree."
6008 #: ../fish/guestfish-actions.pod:376
6013 #: ../fish/guestfish-actions.pod:378
6016 " aug-mv src dest\n"
6021 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:556
6023 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6024 "C<dest> is overwritten if it exists."
6028 #: ../fish/guestfish-actions.pod:383
6033 #: ../fish/guestfish-actions.pod:385
6041 #: ../fish/guestfish-actions.pod:387 ../src/guestfs-actions.pod:569
6042 msgid "Remove C<path> and all of its children."
6046 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:571
6047 msgid "On success this returns the number of entries which were removed."
6051 #: ../fish/guestfish-actions.pod:391
6056 #: ../fish/guestfish-actions.pod:393
6064 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:582
6065 msgid "This writes all pending changes to disk."
6069 #: ../fish/guestfish-actions.pod:397
6071 "The flags which were passed to L</aug-init> affect exactly how files are "
6076 #: ../fish/guestfish-actions.pod:400
6081 #: ../fish/guestfish-actions.pod:402
6084 " aug-set augpath val\n"
6089 #: ../fish/guestfish-actions.pod:404 ../src/guestfs-actions.pod:598
6090 msgid "Set the value associated with C<path> to C<val>."
6094 #: ../fish/guestfish-actions.pod:406
6096 "In the Augeas API, it is possible to clear a node by setting the value to "
6097 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6098 "this call. Instead you must use the L</aug-clear> call."
6102 #: ../fish/guestfish-actions.pod:411
6107 #: ../fish/guestfish-actions.pod:413
6110 " available 'groups ...'\n"
6115 #: ../fish/guestfish-actions.pod:415 ../src/guestfs-actions.pod:615
6117 "This command is used to check the availability of some groups of "
6118 "functionality in the appliance, which not all builds of the libguestfs "
6119 "appliance will be able to provide."
6123 #: ../fish/guestfish-actions.pod:419
6125 "The libguestfs groups, and the functions that those groups correspond to, "
6126 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6127 "runtime by calling L</available-all-groups>."
6131 #: ../fish/guestfish-actions.pod:424 ../src/guestfs-actions.pod:624
6133 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6134 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6135 "and Augeas (configuration file editing) functions."
6139 #: ../fish/guestfish-actions.pod:429 ../src/guestfs-actions.pod:629
6140 msgid "The command returns no error if I<all> requested groups are available."
6144 #: ../fish/guestfish-actions.pod:431 ../src/guestfs-actions.pod:631
6146 "It fails with an error if one or more of the requested groups is unavailable "
6151 #: ../fish/guestfish-actions.pod:434 ../src/guestfs-actions.pod:634
6153 "If an unknown group name is included in the list of groups then an error is "
6158 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:637
6163 #: ../fish/guestfish-actions.pod:443
6164 msgid "You must call L</launch> before calling this function."
6168 #: ../fish/guestfish-actions.pod:445 ../src/guestfs-actions.pod:645
6170 "The reason is because we don't know what groups are supported by the "
6171 "appliance/daemon until it is running and can be queried."
6175 #: ../fish/guestfish-actions.pod:451 ../src/guestfs-actions.pod:651
6177 "If a group of functions is available, this does not necessarily mean that "
6178 "they will work. You still have to check for errors when calling individual "
6179 "API functions even if they are available."
6183 #: ../fish/guestfish-actions.pod:458 ../src/guestfs-actions.pod:658
6185 "It is usually the job of distro packagers to build complete functionality "
6186 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6187 "with all requirements satisfied, will support everything."
6191 #: ../fish/guestfish-actions.pod:465
6193 "This call was added in version C<1.0.80>. In previous versions of "
6194 "libguestfs all you could do would be to speculatively execute a command to "
6195 "find out if the daemon implemented it. See also L</version>."
6199 #: ../fish/guestfish-actions.pod:472
6200 msgid "available-all-groups"
6204 #: ../fish/guestfish-actions.pod:474
6207 " available-all-groups\n"
6212 #: ../fish/guestfish-actions.pod:476
6214 "This command returns a list of all optional groups that this daemon knows "
6215 "about. Note this returns both supported and unsupported groups. To find "
6216 "out which ones the daemon can actually support you have to call "
6217 "L</available> on each member of the returned list."
6221 #: ../fish/guestfish-actions.pod:482
6222 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
6226 #: ../fish/guestfish-actions.pod:484
6231 #: ../fish/guestfish-actions.pod:486
6234 " base64-in (base64file|-) filename\n"
6239 #: ../fish/guestfish-actions.pod:488 ../src/guestfs-actions.pod:702
6240 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6244 #: ../fish/guestfish-actions.pod:491 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:749 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:854 ../fish/guestfish-actions.pod:1025 ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1418 ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4870 ../fish/guestfish-actions.pod:4881 ../fish/guestfish-actions.pod:4892 ../fish/guestfish-actions.pod:4944 ../fish/guestfish-actions.pod:4953 ../fish/guestfish-actions.pod:5007 ../fish/guestfish-actions.pod:5030
6245 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
6249 #: ../fish/guestfish-actions.pod:493
6254 #: ../fish/guestfish-actions.pod:495
6257 " base64-out filename (base64file|-)\n"
6262 #: ../fish/guestfish-actions.pod:497 ../src/guestfs-actions.pod:716
6264 "This command downloads the contents of C<filename>, writing it out to local "
6265 "file C<base64file> encoded as base64."
6269 #: ../fish/guestfish-actions.pod:502
6270 msgid "blockdev-flushbufs"
6274 #: ../fish/guestfish-actions.pod:504
6277 " blockdev-flushbufs device\n"
6282 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:729
6283 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6287 #: ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520 ../fish/guestfish-actions.pod:529 ../fish/guestfish-actions.pod:539 ../fish/guestfish-actions.pod:551 ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:572 ../fish/guestfish-actions.pod:583 ../fish/guestfish-actions.pod:591 ../fish/guestfish-actions.pod:599 ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:817 ../src/guestfs-actions.pod:831 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:877
6288 msgid "This uses the L<blockdev(8)> command."
6292 #: ../fish/guestfish-actions.pod:511
6293 msgid "blockdev-getbsz"
6297 #: ../fish/guestfish-actions.pod:513
6300 " blockdev-getbsz device\n"
6305 #: ../fish/guestfish-actions.pod:515 ../src/guestfs-actions.pod:744
6306 msgid "This returns the block size of a device."
6310 #: ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:580 ../src/guestfs-actions.pod:746 ../src/guestfs-actions.pod:846
6312 "(Note this is different from both I<size in blocks> and I<filesystem block "
6317 #: ../fish/guestfish-actions.pod:522
6318 msgid "blockdev-getro"
6322 #: ../fish/guestfish-actions.pod:524
6325 " blockdev-getro device\n"
6330 #: ../fish/guestfish-actions.pod:526 ../src/guestfs-actions.pod:761
6332 "Returns a boolean indicating if the block device is read-only (true if "
6333 "read-only, false if not)."
6337 #: ../fish/guestfish-actions.pod:531
6338 msgid "blockdev-getsize64"
6342 #: ../fish/guestfish-actions.pod:533
6345 " blockdev-getsize64 device\n"
6350 #: ../fish/guestfish-actions.pod:535 ../src/guestfs-actions.pod:776
6351 msgid "This returns the size of the device in bytes."
6355 #: ../fish/guestfish-actions.pod:537
6356 msgid "See also L</blockdev-getsz>."
6360 #: ../fish/guestfish-actions.pod:541
6361 msgid "blockdev-getss"
6365 #: ../fish/guestfish-actions.pod:543
6368 " blockdev-getss device\n"
6373 #: ../fish/guestfish-actions.pod:545 ../src/guestfs-actions.pod:792
6375 "This returns the size of sectors on a block device. Usually 512, but can be "
6376 "larger for modern devices."
6380 #: ../fish/guestfish-actions.pod:548
6381 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
6385 #: ../fish/guestfish-actions.pod:553
6386 msgid "blockdev-getsz"
6390 #: ../fish/guestfish-actions.pod:555
6393 " blockdev-getsz device\n"
6398 #: ../fish/guestfish-actions.pod:557 ../src/guestfs-actions.pod:810
6400 "This returns the size of the device in units of 512-byte sectors (even if "
6401 "the sectorsize isn't 512 bytes ... weird)."
6405 #: ../fish/guestfish-actions.pod:560
6407 "See also L</blockdev-getss> for the real sector size of the device, and "
6408 "L</blockdev-getsize64> for the more useful I<size in bytes>."
6412 #: ../fish/guestfish-actions.pod:566
6413 msgid "blockdev-rereadpt"
6417 #: ../fish/guestfish-actions.pod:568
6420 " blockdev-rereadpt device\n"
6425 #: ../fish/guestfish-actions.pod:570 ../src/guestfs-actions.pod:829
6426 msgid "Reread the partition table on C<device>."
6430 #: ../fish/guestfish-actions.pod:574
6431 msgid "blockdev-setbsz"
6435 #: ../fish/guestfish-actions.pod:576
6438 " blockdev-setbsz device blocksize\n"
6443 #: ../fish/guestfish-actions.pod:578 ../src/guestfs-actions.pod:844
6444 msgid "This sets the block size of a device."
6448 #: ../fish/guestfish-actions.pod:585
6449 msgid "blockdev-setro"
6453 #: ../fish/guestfish-actions.pod:587
6456 " blockdev-setro device\n"
6461 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:861
6462 msgid "Sets the block device named C<device> to read-only."
6466 #: ../fish/guestfish-actions.pod:593
6467 msgid "blockdev-setrw"
6471 #: ../fish/guestfish-actions.pod:595
6474 " blockdev-setrw device\n"
6479 #: ../fish/guestfish-actions.pod:597 ../src/guestfs-actions.pod:875
6480 msgid "Sets the block device named C<device> to read-write."
6484 #: ../fish/guestfish-actions.pod:601
6485 msgid "btrfs-filesystem-resize"
6489 #: ../fish/guestfish-actions.pod:603
6492 " btrfs-filesystem-resize mountpoint [size:..]\n"
6497 #: ../fish/guestfish-actions.pod:605 ../src/guestfs-actions.pod:897
6498 msgid "This command resizes a btrfs filesystem."
6502 #: ../fish/guestfish-actions.pod:607 ../src/guestfs-actions.pod:899
6504 "Note that unlike other resize calls, the filesystem has to be mounted and "
6505 "the parameter is the mountpoint not the device (this is a requirement of "
6510 #: ../fish/guestfish-actions.pod:611 ../fish/guestfish-actions.pod:3606 ../src/guestfs-actions.pod:903 ../src/guestfs-actions.pod:5637
6511 msgid "The optional parameters are:"
6515 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3610 ../src/guestfs-actions.pod:907 ../src/guestfs-actions.pod:5641
6520 #: ../fish/guestfish-actions.pod:617 ../src/guestfs-actions.pod:909
6522 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
6523 "resized to the maximum size."
6527 #: ../fish/guestfish-actions.pod:622 ../src/guestfs-actions.pod:914
6528 msgid "See also L<btrfs(8)>."
6532 #: ../fish/guestfish-actions.pod:626
6533 msgid "case-sensitive-path"
6537 #: ../fish/guestfish-actions.pod:628
6540 " case-sensitive-path path\n"
6545 #: ../fish/guestfish-actions.pod:630 ../src/guestfs-actions.pod:948
6547 "This can be used to resolve case insensitive paths on a filesystem which is "
6548 "case sensitive. The use case is to resolve paths which you have read from "
6549 "Windows configuration files or the Windows Registry, to the true path."
6553 #: ../fish/guestfish-actions.pod:635 ../src/guestfs-actions.pod:953
6555 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6556 "(and probably others), which is that although the underlying filesystem is "
6557 "case-insensitive, the driver exports the filesystem to Linux as "
6562 #: ../fish/guestfish-actions.pod:640 ../src/guestfs-actions.pod:958
6564 "One consequence of this is that special directories such as C<c:\\windows> "
6565 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6566 "precise details of how they were created. In Windows itself this would not "
6571 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:964
6573 "Bug or feature? You decide: "
6574 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6578 #: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:967
6580 "This function resolves the true case of each element in the path and returns "
6581 "the case-sensitive path."
6585 #: ../fish/guestfish-actions.pod:652
6587 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
6588 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6589 "how the directories were originally created under Windows)."
6593 #: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:975
6594 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6598 #: ../fish/guestfish-actions.pod:660
6599 msgid "See also L</realpath>."
6603 #: ../fish/guestfish-actions.pod:662
6608 #: ../fish/guestfish-actions.pod:664
6616 #: ../fish/guestfish-actions.pod:666 ../fish/guestfish-actions.pod:4037 ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:6297
6617 msgid "Return the contents of the file named C<path>."
6621 #: ../fish/guestfish-actions.pod:668
6623 "Note that this function cannot correctly handle binary files (specifically, "
6624 "files containing C<\\0> character which is treated as end of string). For "
6625 "those you need to use the L</read-file> or L</download> functions which have "
6626 "a more complex interface."
6630 #: ../fish/guestfish-actions.pod:673 ../fish/guestfish-actions.pod:808 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1180 ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1382 ../fish/guestfish-actions.pod:1695 ../fish/guestfish-actions.pod:1705 ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1799 ../fish/guestfish-actions.pod:3907 ../fish/guestfish-actions.pod:3922 ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4699 ../fish/guestfish-actions.pod:4745 ../fish/guestfish-actions.pod:4830 ../fish/guestfish-actions.pod:4845 ../fish/guestfish-actions.pod:5251 ../fish/guestfish-actions.pod:5263 ../fish/guestfish-actions.pod:5281 ../fish/guestfish-actions.pod:5298 ../fish/guestfish-actions.pod:5308 ../fish/guestfish-actions.pod:5362 ../fish/guestfish-actions.pod:5372 ../fish/guestfish-actions.pod:5401 ../fish/guestfish-actions.pod:5411 ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1180 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:1977 ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6262 ../src/guestfs-actions.pod:6286 ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:8131 ../src/guestfs-actions.pod:8151 ../src/guestfs-actions.pod:8184 ../src/guestfs-actions.pod:8203 ../src/guestfs-actions.pod:8222 ../src/guestfs-actions.pod:8313 ../src/guestfs-actions.pod:8332 ../src/guestfs-actions.pod:8378 ../src/guestfs-actions.pod:8397
6632 "Because of the message protocol, there is a transfer limit of somewhere "
6633 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6637 #: ../fish/guestfish-actions.pod:676
6642 #: ../fish/guestfish-actions.pod:678
6645 " checksum csumtype path\n"
6650 #: ../fish/guestfish-actions.pod:680 ../src/guestfs-actions.pod:1013
6651 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6655 #: ../fish/guestfish-actions.pod:683 ../src/guestfs-actions.pod:1016
6657 "The type of checksum to compute is given by the C<csumtype> parameter which "
6658 "must have one of the following values:"
6662 #: ../fish/guestfish-actions.pod:688 ../src/guestfs-actions.pod:1021
6667 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1023
6669 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6674 #: ../fish/guestfish-actions.pod:693 ../src/guestfs-actions.pod:1026
6679 #: ../fish/guestfish-actions.pod:695 ../src/guestfs-actions.pod:1028
6680 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6684 #: ../fish/guestfish-actions.pod:697 ../src/guestfs-actions.pod:1030
6689 #: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1032
6690 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6694 #: ../fish/guestfish-actions.pod:701 ../src/guestfs-actions.pod:1034
6699 #: ../fish/guestfish-actions.pod:703 ../src/guestfs-actions.pod:1036
6700 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6704 #: ../fish/guestfish-actions.pod:705 ../src/guestfs-actions.pod:1038
6709 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1040
6710 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6714 #: ../fish/guestfish-actions.pod:709 ../src/guestfs-actions.pod:1042
6719 #: ../fish/guestfish-actions.pod:711 ../src/guestfs-actions.pod:1044
6720 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6724 #: ../fish/guestfish-actions.pod:713 ../src/guestfs-actions.pod:1046
6729 #: ../fish/guestfish-actions.pod:715 ../src/guestfs-actions.pod:1048
6730 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6734 #: ../fish/guestfish-actions.pod:719 ../src/guestfs-actions.pod:1052
6735 msgid "The checksum is returned as a printable string."
6739 #: ../fish/guestfish-actions.pod:721
6740 msgid "To get the checksum for a device, use L</checksum-device>."
6744 #: ../fish/guestfish-actions.pod:723
6745 msgid "To get the checksums for many files, use L</checksums-out>."
6749 #: ../fish/guestfish-actions.pod:725
6750 msgid "checksum-device"
6754 #: ../fish/guestfish-actions.pod:727
6757 " checksum-device csumtype device\n"
6762 #: ../fish/guestfish-actions.pod:729
6764 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6765 "device named C<device>. For the types of checksums supported see the "
6766 "L</checksum> command."
6770 #: ../fish/guestfish-actions.pod:733
6771 msgid "checksums-out"
6775 #: ../fish/guestfish-actions.pod:735
6778 " checksums-out csumtype directory (sumsfile|-)\n"
6783 #: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1087
6785 "This command computes the checksums of all regular files in C<directory> and "
6786 "then emits a list of those checksums to the local output file C<sumsfile>."
6790 #: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1091
6792 "This can be used for verifying the integrity of a virtual machine. However "
6793 "to be properly secure you should pay attention to the output of the checksum "
6794 "command (it uses the ones from GNU coreutils). In particular when the "
6795 "filename is not printable, coreutils uses a special backslash syntax. For "
6796 "more information, see the GNU coreutils info file."
6800 #: ../fish/guestfish-actions.pod:751
6805 #: ../fish/guestfish-actions.pod:753
6808 " chmod mode path\n"
6813 #: ../fish/guestfish-actions.pod:755 ../src/guestfs-actions.pod:1110
6815 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6820 #: ../fish/guestfish-actions.pod:758 ../src/guestfs-actions.pod:1113
6822 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6823 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6828 #: ../fish/guestfish-actions.pod:762 ../fish/guestfish-actions.pod:3259 ../fish/guestfish-actions.pod:3398 ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3418 ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:5044 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5291
6829 msgid "The mode actually set is affected by the umask."
6833 #: ../fish/guestfish-actions.pod:764
6838 #: ../fish/guestfish-actions.pod:766
6841 " chown owner group path\n"
6846 #: ../fish/guestfish-actions.pod:768 ../src/guestfs-actions.pod:1131
6847 msgid "Change the file owner to C<owner> and group to C<group>."
6851 #: ../fish/guestfish-actions.pod:770 ../fish/guestfish-actions.pod:2703 ../src/guestfs-actions.pod:1133 ../src/guestfs-actions.pod:4124
6853 "Only numeric uid and gid are supported. If you want to use names, you will "
6854 "need to locate and parse the password file yourself (Augeas support makes "
6855 "this relatively easy)."
6859 #: ../fish/guestfish-actions.pod:774
6864 #: ../fish/guestfish-actions.pod:776
6867 " command 'arguments ...'\n"
6872 #: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1147
6874 "This call runs a command from the guest filesystem. The filesystem must be "
6875 "mounted, and must contain a compatible operating system (ie. something "
6876 "Linux, with the same or compatible processor architecture)."
6880 #: ../fish/guestfish-actions.pod:783
6882 "The single parameter is an argv-style list of arguments. The first element "
6883 "is the name of the program to run. Subsequent elements are parameters. The "
6884 "list must be non-empty (ie. must contain a program name). Note that the "
6885 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
6889 #: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1159
6890 msgid "The return value is anything printed to I<stdout> by the command."
6894 #: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1162
6896 "If the command returns a non-zero exit status, then this function returns an "
6897 "error message. The error message string is the content of I<stderr> from "
6902 #: ../fish/guestfish-actions.pod:797 ../src/guestfs-actions.pod:1166
6904 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6905 "C</bin>. If you require a program from another location, you should provide "
6906 "the full path in the first parameter."
6910 #: ../fish/guestfish-actions.pod:802 ../src/guestfs-actions.pod:1171
6912 "Shared libraries and data files required by the program must be available on "
6913 "filesystems which are mounted in the correct places. It is the caller's "
6914 "responsibility to ensure all filesystems that are needed are mounted at the "
6919 #: ../fish/guestfish-actions.pod:811
6920 msgid "command-lines"
6924 #: ../fish/guestfish-actions.pod:813
6927 " command-lines 'arguments ...'\n"
6932 #: ../fish/guestfish-actions.pod:815
6933 msgid "This is the same as L</command>, but splits the result into a list of lines."
6937 #: ../fish/guestfish-actions.pod:818
6938 msgid "See also: L</sh-lines>"
6942 #: ../fish/guestfish-actions.pod:823
6943 msgid "compress-device-out"
6947 #: ../fish/guestfish-actions.pod:825
6950 " compress-device-out ctype device (zdevice|-) [level:..]\n"
6955 #: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1221
6957 "This command compresses C<device> and writes it out to the local file "
6962 #: ../fish/guestfish-actions.pod:830
6964 "The C<ctype> and optional C<level> parameters have the same meaning as in "
6969 #: ../fish/guestfish-actions.pod:837
6970 msgid "compress-out"
6974 #: ../fish/guestfish-actions.pod:839
6977 " compress-out ctype file (zfile|-) [level:..]\n"
6982 #: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1273
6984 "This command compresses C<file> and writes it out to the local file "
6989 #: ../fish/guestfish-actions.pod:844 ../src/guestfs-actions.pod:1276
6991 "The compression program used is controlled by the C<ctype> parameter. "
6992 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>. "
6993 "Some compression types may not be supported by particular builds of "
6994 "libguestfs, in which case you will get an error containing the substring "
6995 "\"not supported\"."
6999 #: ../fish/guestfish-actions.pod:850 ../src/guestfs-actions.pod:1282
7001 "The optional C<level> parameter controls compression level. The meaning and "
7002 "default for this parameter depends on the compression program being used."
7006 #: ../fish/guestfish-actions.pod:858
7011 #: ../fish/guestfish-actions.pod:860
7014 " config qemuparam qemuvalue\n"
7019 #: ../fish/guestfish-actions.pod:862 ../src/guestfs-actions.pod:1323
7021 "This can be used to add arbitrary qemu command line parameters of the form "
7022 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7023 "setting some parameters which would interfere with parameters that we use."
7027 #: ../fish/guestfish-actions.pod:867 ../src/guestfs-actions.pod:1328
7028 msgid "The first character of C<param> string must be a C<-> (dash)."
7032 #: ../fish/guestfish-actions.pod:869 ../src/guestfs-actions.pod:1330
7033 msgid "C<value> can be NULL."
7037 #: ../fish/guestfish-actions.pod:871
7038 msgid "copy-device-to-device"
7042 #: ../fish/guestfish-actions.pod:873
7045 " copy-device-to-device src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7050 #: ../fish/guestfish-actions.pod:875
7052 "The four calls L</copy-device-to-device>, L</copy-device-to-file>, "
7053 "L</copy-file-to-device>, and L</copy-file-to-file> let you copy from a "
7054 "source (device|file) to a destination (device|file)."
7058 #: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1360
7060 "Partial copies can be made since you can specify optionally the source "
7061 "offset, destination offset and size to copy. These values are all specified "
7062 "in bytes. If not given, the offsets both default to zero, and the size "
7063 "defaults to copying as much as possible until we hit the end of the source."
7067 #: ../fish/guestfish-actions.pod:888 ../src/guestfs-actions.pod:1366
7069 "The source and destination may be the same object. However overlapping "
7070 "regions may not be copied correctly."
7074 #: ../fish/guestfish-actions.pod:891 ../src/guestfs-actions.pod:1369
7076 "If the destination is a file, it is created if required. If the destination "
7077 "file is not large enough, it is extended."
7081 #: ../fish/guestfish-actions.pod:896
7082 msgid "copy-device-to-file"
7086 #: ../fish/guestfish-actions.pod:898
7089 " copy-device-to-file src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7094 #: ../fish/guestfish-actions.pod:900 ../fish/guestfish-actions.pod:909 ../fish/guestfish-actions.pod:918
7095 msgid "See L</copy-device-to-device> for a general overview of this call."
7099 #: ../fish/guestfish-actions.pod:905
7100 msgid "copy-file-to-device"
7104 #: ../fish/guestfish-actions.pod:907
7107 " copy-file-to-device src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7112 #: ../fish/guestfish-actions.pod:914
7113 msgid "copy-file-to-file"
7117 #: ../fish/guestfish-actions.pod:916
7120 " copy-file-to-file src dest [srcoffset:..] [destoffset:..] [size:..]\n"
7125 #: ../fish/guestfish-actions.pod:921
7127 "This is B<not> the function you want for copying files. This is for copying "
7128 "blocks within existing files. See L</cp>, L</cp-a> and L</mv> for general "
7129 "file copying and moving functions."
7133 #: ../fish/guestfish-actions.pod:928
7138 #: ../fish/guestfish-actions.pod:930
7141 " copy-size src dest size\n"
7146 #: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1584
7148 "This command copies exactly C<size> bytes from one source device or file "
7149 "C<src> to another destination device or file C<dest>."
7153 #: ../fish/guestfish-actions.pod:935 ../src/guestfs-actions.pod:1587
7155 "Note this will fail if the source is too short or if the destination is not "
7160 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:973
7162 "I<This function is deprecated.> In new code, use the "
7163 "L</copy_device_to_device> call instead."
7167 #: ../fish/guestfish-actions.pod:945
7172 #: ../fish/guestfish-actions.pod:947
7180 #: ../fish/guestfish-actions.pod:949 ../src/guestfs-actions.pod:1606
7182 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7183 "destination filename or destination directory."
7187 #: ../fish/guestfish-actions.pod:952
7192 #: ../fish/guestfish-actions.pod:954
7200 #: ../fish/guestfish-actions.pod:956 ../src/guestfs-actions.pod:1620
7202 "This copies a file or directory from C<src> to C<dest> recursively using the "
7207 #: ../fish/guestfish-actions.pod:959
7212 #: ../fish/guestfish-actions.pod:961
7220 #: ../fish/guestfish-actions.pod:963 ../src/guestfs-actions.pod:1641
7222 "This command copies from one source device or file C<src> to another "
7223 "destination device or file C<dest>. Normally you would use this to copy to "
7224 "or from a device or partition, for example to duplicate a filesystem."
7228 #: ../fish/guestfish-actions.pod:968
7230 "If the destination is a device, it must be as large or larger than the "
7231 "source file or device, otherwise the copy will fail. This command cannot do "
7232 "partial copies (see L</copy-device-to-device>)."
7236 #: ../fish/guestfish-actions.pod:980
7241 #: ../fish/guestfish-actions.pod:982
7249 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1660
7250 msgid "This command runs the C<df> command to report disk space used."
7254 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:997
7256 "This command is mostly useful for interactive sessions. It is I<not> "
7257 "intended that you try to parse the output string. Use L</statvfs> from "
7262 #: ../fish/guestfish-actions.pod:990
7267 #: ../fish/guestfish-actions.pod:992
7275 #: ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1676
7277 "This command runs the C<df -h> command to report disk space used in "
7278 "human-readable format."
7282 #: ../fish/guestfish-actions.pod:1001
7287 #: ../fish/guestfish-actions.pod:1003
7295 #: ../fish/guestfish-actions.pod:1005 ../src/guestfs-actions.pod:1693
7297 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7298 "This is sometimes useful for extended debugging of problems."
7302 #: ../fish/guestfish-actions.pod:1009
7304 "Another way to get the same information is to enable verbose messages with "
7305 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
7306 "before running the program."
7310 #: ../fish/guestfish-actions.pod:1014
7315 #: ../fish/guestfish-actions.pod:1016
7318 " download remotefilename (filename|-)\n"
7323 #: ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1031 ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:1739
7325 "Download file C<remotefilename> and save it as C<filename> on the local "
7330 #: ../fish/guestfish-actions.pod:1021 ../fish/guestfish-actions.pod:5003 ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:7701
7331 msgid "C<filename> can also be a named pipe."
7335 #: ../fish/guestfish-actions.pod:1023
7336 msgid "See also L</upload>, L</cat>."
7340 #: ../fish/guestfish-actions.pod:1027
7341 msgid "download-offset"
7345 #: ../fish/guestfish-actions.pod:1029
7348 " download-offset remotefilename (filename|-) offset size\n"
7353 #: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1742
7355 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7356 "region must be within the file or device)."
7360 #: ../fish/guestfish-actions.pod:1037
7362 "Note that there is no limit on the amount of data that can be downloaded "
7363 "with this call, unlike with L</pread>, and this call always reads the full "
7364 "amount unless an error occurs."
7368 #: ../fish/guestfish-actions.pod:1042
7369 msgid "See also L</download>, L</pread>."
7373 #: ../fish/guestfish-actions.pod:1046
7378 #: ../fish/guestfish-actions.pod:1048
7381 " drop-caches whattodrop\n"
7386 #: ../fish/guestfish-actions.pod:1050 ../src/guestfs-actions.pod:1767
7388 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7389 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7390 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7394 #: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1772
7395 msgid "Setting C<whattodrop> to 3 should drop everything."
7399 #: ../fish/guestfish-actions.pod:1057 ../src/guestfs-actions.pod:1774
7401 "This automatically calls L<sync(2)> before the operation, so that the "
7402 "maximum guest memory is freed."
7406 #: ../fish/guestfish-actions.pod:1060
7411 #: ../fish/guestfish-actions.pod:1062
7419 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1787
7421 "This command runs the C<du -s> command to estimate file space usage for "
7426 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1790
7428 "C<path> can be a file or a directory. If C<path> is a directory then the "
7429 "estimate includes the contents of the directory and all subdirectories "
7434 #: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1794
7435 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7439 #: ../fish/guestfish-actions.pod:1074
7444 #: ../fish/guestfish-actions.pod:1076
7447 " e2fsck-f device\n"
7452 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1812
7454 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7455 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
7460 #: ../fish/guestfish-actions.pod:1082
7462 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
7463 "should use L</fsck>."
7467 #: ../fish/guestfish-actions.pod:1085
7472 #: ../fish/guestfish-actions.pod:1087
7475 " echo-daemon 'words ...'\n"
7480 #: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1829
7482 "This command concatenates the list of C<words> passed with single spaces "
7483 "between them and returns the resulting string."
7487 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1832
7488 msgid "You can use this command to test the connection through to the daemon."
7492 #: ../fish/guestfish-actions.pod:1094
7493 msgid "See also L</ping-daemon>."
7497 #: ../fish/guestfish-actions.pod:1096
7502 #: ../fish/guestfish-actions.pod:1098
7505 " egrep regex path\n"
7510 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1848
7511 msgid "This calls the external C<egrep> program and returns the matching lines."
7515 #: ../fish/guestfish-actions.pod:1106
7520 #: ../fish/guestfish-actions.pod:1108
7523 " egrepi regex path\n"
7528 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1867
7529 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7533 #: ../fish/guestfish-actions.pod:1116
7538 #: ../fish/guestfish-actions.pod:1118
7541 " equal file1 file2\n"
7546 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1886
7548 "This compares the two files C<file1> and C<file2> and returns true if their "
7549 "content is exactly equal, or false otherwise."
7553 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1889
7554 msgid "The external L<cmp(1)> program is used for the comparison."
7558 #: ../fish/guestfish-actions.pod:1125
7563 #: ../fish/guestfish-actions.pod:1127
7571 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1901
7573 "This returns C<true> if and only if there is a file, directory (or anything) "
7574 "with the given C<path> name."
7578 #: ../fish/guestfish-actions.pod:1132
7579 msgid "See also L</is-file>, L</is-dir>, L</stat>."
7583 #: ../fish/guestfish-actions.pod:1134
7588 #: ../fish/guestfish-actions.pod:1136
7591 " fallocate path len\n"
7596 #: ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1157 ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:1943
7598 "This command preallocates a file (containing zero bytes) named C<path> of "
7599 "size C<len> bytes. If the file exists already, it is overwritten."
7603 #: ../fish/guestfish-actions.pod:1142 ../src/guestfs-actions.pod:1928
7605 "Do not confuse this with the guestfish-specific C<alloc> command which "
7606 "allocates a file in the host and attaches it as a device."
7610 #: ../fish/guestfish-actions.pod:1146
7612 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
7617 #: ../fish/guestfish-actions.pod:1153
7622 #: ../fish/guestfish-actions.pod:1155
7625 " fallocate64 path len\n"
7630 #: ../fish/guestfish-actions.pod:1161
7632 "Note that this call allocates disk blocks for the file. To create a sparse "
7633 "file use L</truncate-size> instead."
7637 #: ../fish/guestfish-actions.pod:1164
7639 "The deprecated call L</fallocate> does the same, but owing to an oversight "
7640 "it only allowed 30 bit lengths to be specified, effectively limiting the "
7641 "maximum size of files created through that call to 1GB."
7645 #: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1955
7647 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7648 "commands which create a file in the host and attach it as a device."
7652 #: ../fish/guestfish-actions.pod:1173
7657 #: ../fish/guestfish-actions.pod:1175
7660 " fgrep pattern path\n"
7665 #: ../fish/guestfish-actions.pod:1177 ../src/guestfs-actions.pod:1970
7666 msgid "This calls the external C<fgrep> program and returns the matching lines."
7670 #: ../fish/guestfish-actions.pod:1183
7675 #: ../fish/guestfish-actions.pod:1185
7678 " fgrepi pattern path\n"
7683 #: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1989
7684 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7688 #: ../fish/guestfish-actions.pod:1193
7693 #: ../fish/guestfish-actions.pod:1195
7701 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:2007
7703 "This call uses the standard L<file(1)> command to determine the type or "
7704 "contents of the file."
7708 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:2010
7710 "This call will also transparently look inside various types of compressed "
7715 #: ../fish/guestfish-actions.pod:1203 ../src/guestfs-actions.pod:2013
7717 "The exact command which runs is C<file -zb path>. Note in particular that "
7718 "the filename is not prepended to the output (the I<-b> option)."
7722 #: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:2017
7724 "The output depends on the output of the underlying L<file(1)> command and it "
7725 "can change in future in ways beyond our control. In other words, the output "
7726 "is not guaranteed by the ABI."
7730 #: ../fish/guestfish-actions.pod:1211
7732 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
7733 "(etc), L</is-zero>."
7737 #: ../fish/guestfish-actions.pod:1214
7738 msgid "file-architecture"
7742 #: ../fish/guestfish-actions.pod:1216
7745 " file-architecture filename\n"
7750 #: ../fish/guestfish-actions.pod:1218 ../src/guestfs-actions.pod:2035
7752 "This detects the architecture of the binary C<filename>, and returns it if "
7757 #: ../fish/guestfish-actions.pod:1221 ../src/guestfs-actions.pod:2038
7758 msgid "Currently defined architectures are:"
7762 #: ../fish/guestfish-actions.pod:1225 ../src/guestfs-actions.pod:2042
7767 #: ../fish/guestfish-actions.pod:1227 ../src/guestfs-actions.pod:2044
7769 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7770 "irrespective of the precise processor requirements of the binary."
7774 #: ../fish/guestfish-actions.pod:1230 ../src/guestfs-actions.pod:2047
7779 #: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:2049
7780 msgid "64 bit x86-64."
7784 #: ../fish/guestfish-actions.pod:1234 ../src/guestfs-actions.pod:2051
7789 #: ../fish/guestfish-actions.pod:1236 ../src/guestfs-actions.pod:2053
7790 msgid "32 bit SPARC."
7794 #: ../fish/guestfish-actions.pod:1238 ../src/guestfs-actions.pod:2055
7799 #: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:2057
7800 msgid "64 bit SPARC V9 and above."
7804 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:2059
7809 #: ../fish/guestfish-actions.pod:1244 ../src/guestfs-actions.pod:2061
7810 msgid "Intel Itanium."
7814 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:2063
7819 #: ../fish/guestfish-actions.pod:1248 ../src/guestfs-actions.pod:2065
7820 msgid "32 bit Power PC."
7824 #: ../fish/guestfish-actions.pod:1250 ../src/guestfs-actions.pod:2067
7829 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:2069
7830 msgid "64 bit Power PC."
7834 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:2073
7835 msgid "Libguestfs may return other architecture strings in future."
7839 #: ../fish/guestfish-actions.pod:1258 ../src/guestfs-actions.pod:2075
7840 msgid "The function works on at least the following types of files:"
7844 #: ../fish/guestfish-actions.pod:1264 ../src/guestfs-actions.pod:2081
7845 msgid "many types of Un*x and Linux binary"
7849 #: ../fish/guestfish-actions.pod:1268 ../src/guestfs-actions.pod:2085
7850 msgid "many types of Un*x and Linux shared library"
7854 #: ../fish/guestfish-actions.pod:1272 ../src/guestfs-actions.pod:2089
7855 msgid "Windows Win32 and Win64 binaries"
7859 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:2093
7860 msgid "Windows Win32 and Win64 DLLs"
7864 #: ../fish/guestfish-actions.pod:1278 ../src/guestfs-actions.pod:2095
7865 msgid "Win32 binaries and DLLs return C<i386>."
7869 #: ../fish/guestfish-actions.pod:1280 ../src/guestfs-actions.pod:2097
7870 msgid "Win64 binaries and DLLs return C<x86_64>."
7874 #: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:2101
7875 msgid "Linux kernel modules"
7879 #: ../fish/guestfish-actions.pod:1288 ../src/guestfs-actions.pod:2105
7880 msgid "Linux new-style initrd images"
7884 #: ../fish/guestfish-actions.pod:1292 ../src/guestfs-actions.pod:2109
7885 msgid "some non-x86 Linux vmlinuz kernels"
7889 #: ../fish/guestfish-actions.pod:1296 ../src/guestfs-actions.pod:2113
7890 msgid "What it can't do currently:"
7894 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:2119
7895 msgid "static libraries (libfoo.a)"
7899 #: ../fish/guestfish-actions.pod:1306 ../src/guestfs-actions.pod:2123
7900 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7904 #: ../fish/guestfish-actions.pod:1310 ../src/guestfs-actions.pod:2127
7905 msgid "x86 Linux vmlinuz kernels"
7909 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:2129
7911 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7912 "compressed code, and are horribly hard to unpack. If you want to find the "
7913 "architecture of a kernel, use the architecture of the associated initrd or "
7914 "kernel module(s) instead."
7918 #: ../fish/guestfish-actions.pod:1319
7923 #: ../fish/guestfish-actions.pod:1321
7931 #: ../fish/guestfish-actions.pod:1323 ../src/guestfs-actions.pod:2147
7932 msgid "This command returns the size of C<file> in bytes."
7936 #: ../fish/guestfish-actions.pod:1325
7938 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
7939 "L</is-file> etc. To get the size of block devices, use "
7940 "L</blockdev-getsize64>."
7944 #: ../fish/guestfish-actions.pod:1329
7949 #: ../fish/guestfish-actions.pod:1331
7952 " fill c len path\n"
7957 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2165
7959 "This command creates a new file called C<path>. The initial content of the "
7960 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7965 #: ../fish/guestfish-actions.pod:1337
7967 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7968 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
7973 #: ../fish/guestfish-actions.pod:1342
7974 msgid "fill-pattern"
7978 #: ../fish/guestfish-actions.pod:1344
7981 " fill-pattern pattern len path\n"
7986 #: ../fish/guestfish-actions.pod:1346
7988 "This function is like L</fill> except that it creates a new file of length "
7989 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
7990 "is truncated if necessary to ensure the length of the file is exactly C<len> "
7995 #: ../fish/guestfish-actions.pod:1351
8000 #: ../fish/guestfish-actions.pod:1353
8008 #: ../fish/guestfish-actions.pod:1355 ../src/guestfs-actions.pod:2211
8010 "This command lists out all files and directories, recursively, starting at "
8011 "C<directory>. It is essentially equivalent to running the shell command "
8012 "C<find directory -print> but some post-processing happens on the output, "
8017 #: ../fish/guestfish-actions.pod:1360 ../src/guestfs-actions.pod:2216
8019 "This returns a list of strings I<without any prefix>. Thus if the directory "
8024 #: ../fish/guestfish-actions.pod:1363 ../src/guestfs-actions.pod:2219
8034 #: ../fish/guestfish-actions.pod:1367
8035 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
8039 #: ../fish/guestfish-actions.pod:1370 ../src/guestfs-actions.pod:2226
8050 #: ../fish/guestfish-actions.pod:1375 ../src/guestfs-actions.pod:2231
8051 msgid "If C<directory> is not a directory, then this command returns an error."
8055 #: ../fish/guestfish-actions.pod:1378 ../src/guestfs-actions.pod:2234
8056 msgid "The returned list is sorted."
8060 #: ../fish/guestfish-actions.pod:1380
8061 msgid "See also L</find0>."
8065 #: ../fish/guestfish-actions.pod:1385
8070 #: ../fish/guestfish-actions.pod:1387
8073 " find0 directory (files|-)\n"
8078 #: ../fish/guestfish-actions.pod:1389 ../src/guestfs-actions.pod:2254
8080 "This command lists out all files and directories, recursively, starting at "
8081 "C<directory>, placing the resulting list in the external file called "
8086 #: ../fish/guestfish-actions.pod:1393
8087 msgid "This command works the same way as L</find> with the following exceptions:"
8091 #: ../fish/guestfish-actions.pod:1400 ../src/guestfs-actions.pod:2265
8092 msgid "The resulting list is written to an external file."
8096 #: ../fish/guestfish-actions.pod:1404 ../src/guestfs-actions.pod:2269
8098 "Items (filenames) in the result are separated by C<\\0> characters. See "
8099 "L<find(1)> option I<-print0>."
8103 #: ../fish/guestfish-actions.pod:1409 ../src/guestfs-actions.pod:2274
8104 msgid "This command is not limited in the number of names that it can return."
8108 #: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2279
8109 msgid "The result list is not sorted."
8113 #: ../fish/guestfish-actions.pod:1420
8114 msgid "findfs-label"
8118 #: ../fish/guestfish-actions.pod:1422
8121 " findfs-label label\n"
8126 #: ../fish/guestfish-actions.pod:1424 ../src/guestfs-actions.pod:2293
8128 "This command searches the filesystems and returns the one which has the "
8129 "given label. An error is returned if no such filesystem can be found."
8133 #: ../fish/guestfish-actions.pod:1428
8134 msgid "To find the label of a filesystem, use L</vfs-label>."
8138 #: ../fish/guestfish-actions.pod:1430
8143 #: ../fish/guestfish-actions.pod:1432
8146 " findfs-uuid uuid\n"
8151 #: ../fish/guestfish-actions.pod:1434 ../src/guestfs-actions.pod:2310
8153 "This command searches the filesystems and returns the one which has the "
8154 "given UUID. An error is returned if no such filesystem can be found."
8158 #: ../fish/guestfish-actions.pod:1438
8159 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
8163 #: ../fish/guestfish-actions.pod:1440
8168 #: ../fish/guestfish-actions.pod:1442
8171 " fsck fstype device\n"
8176 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2328
8178 "This runs the filesystem checker (fsck) on C<device> which should have "
8179 "filesystem type C<fstype>."
8183 #: ../fish/guestfish-actions.pod:1447 ../src/guestfs-actions.pod:2331
8185 "The returned integer is the status. See L<fsck(8)> for the list of status "
8186 "codes from C<fsck>."
8190 #: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2340
8191 msgid "Multiple status codes can be summed together."
8195 #: ../fish/guestfish-actions.pod:1460 ../src/guestfs-actions.pod:2344
8197 "A non-zero return code can mean \"success\", for example if errors have been "
8198 "corrected on the filesystem."
8202 #: ../fish/guestfish-actions.pod:1465 ../src/guestfs-actions.pod:2349
8203 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8207 #: ../fish/guestfish-actions.pod:1470 ../src/guestfs-actions.pod:2354
8208 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8212 #: ../fish/guestfish-actions.pod:1472
8217 #: ../fish/guestfish-actions.pod:1474
8225 #: ../fish/guestfish-actions.pod:1476 ../src/guestfs-actions.pod:2365
8227 "Return the additional kernel options which are added to the guest kernel "
8232 #: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2368
8233 msgid "If C<NULL> then no options are added."
8237 #: ../fish/guestfish-actions.pod:1481
8238 msgid "get-attach-method"
8242 #: ../fish/guestfish-actions.pod:1483
8245 " get-attach-method\n"
8250 #: ../fish/guestfish-actions.pod:1485
8251 msgid "Return the current attach method. See L</set-attach-method>."
8255 #: ../fish/guestfish-actions.pod:1487
8256 msgid "get-autosync"
8260 #: ../fish/guestfish-actions.pod:1489
8268 #: ../fish/guestfish-actions.pod:1491 ../src/guestfs-actions.pod:2393
8269 msgid "Get the autosync flag."
8273 #: ../fish/guestfish-actions.pod:1493
8278 #: ../fish/guestfish-actions.pod:1495
8286 #: ../fish/guestfish-actions.pod:1497 ../src/guestfs-actions.pod:2404
8287 msgid "Return the direct appliance mode flag."
8291 #: ../fish/guestfish-actions.pod:1499
8296 #: ../fish/guestfish-actions.pod:1501
8299 " get-e2label device\n"
8304 #: ../fish/guestfish-actions.pod:1503 ../src/guestfs-actions.pod:2423
8305 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8309 #: ../fish/guestfish-actions.pod:1506
8311 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
8316 #: ../fish/guestfish-actions.pod:1513
8321 #: ../fish/guestfish-actions.pod:1515
8324 " get-e2uuid device\n"
8329 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2444
8330 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8334 #: ../fish/guestfish-actions.pod:1520
8336 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
8341 #: ../fish/guestfish-actions.pod:1527
8346 #: ../fish/guestfish-actions.pod:1529
8354 #: ../fish/guestfish-actions.pod:1531 ../src/guestfs-actions.pod:2457
8355 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8359 #: ../fish/guestfish-actions.pod:1534
8361 "If L</set-memsize> was not called on this handle, and if "
8362 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8363 "value for memsize."
8367 #: ../fish/guestfish-actions.pod:1538 ../fish/guestfish-actions.pod:1595 ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4462 ../src/guestfs-actions.pod:2464 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6881
8368 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8372 #: ../fish/guestfish-actions.pod:1541
8377 #: ../fish/guestfish-actions.pod:1543
8385 #: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2476
8386 msgid "This returns the enable network flag."
8390 #: ../fish/guestfish-actions.pod:1547
8395 #: ../fish/guestfish-actions.pod:1549
8403 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2487
8404 msgid "Return the current search path."
8408 #: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2489
8410 "This is always non-NULL. If it wasn't set already, then this will return "
8415 #: ../fish/guestfish-actions.pod:1556
8420 #: ../fish/guestfish-actions.pod:1558
8428 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2502
8429 msgid "This returns the process group flag."
8433 #: ../fish/guestfish-actions.pod:1562
8438 #: ../fish/guestfish-actions.pod:1564
8443 #: ../fish/guestfish-actions.pod:1566
8451 #: ../fish/guestfish-actions.pod:1568 ../src/guestfs-actions.pod:2513
8453 "Return the process ID of the qemu subprocess. If there is no qemu "
8454 "subprocess, then this will return an error."
8458 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2516
8459 msgid "This is an internal call used for debugging and testing."
8463 #: ../fish/guestfish-actions.pod:1573
8468 #: ../fish/guestfish-actions.pod:1575
8476 #: ../fish/guestfish-actions.pod:1577 ../src/guestfs-actions.pod:2527
8477 msgid "Return the current qemu binary."
8481 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2529
8483 "This is always non-NULL. If it wasn't set already, then this will return "
8484 "the default qemu binary name."
8488 #: ../fish/guestfish-actions.pod:1582
8489 msgid "get-recovery-proc"
8493 #: ../fish/guestfish-actions.pod:1584
8496 " get-recovery-proc\n"
8501 #: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2542
8502 msgid "Return the recovery process enabled flag."
8506 #: ../fish/guestfish-actions.pod:1588
8511 #: ../fish/guestfish-actions.pod:1590
8519 #: ../fish/guestfish-actions.pod:1592
8521 "This returns the current setting of the selinux flag which is passed to the "
8522 "appliance at boot time. See L</set-selinux>."
8526 #: ../fish/guestfish-actions.pod:1598
8531 #: ../fish/guestfish-actions.pod:1600
8539 #: ../fish/guestfish-actions.pod:1602 ../src/guestfs-actions.pod:2568
8540 msgid "This returns the number of virtual CPUs assigned to the appliance."
8544 #: ../fish/guestfish-actions.pod:1604
8549 #: ../fish/guestfish-actions.pod:1606
8557 #: ../fish/guestfish-actions.pod:1608 ../src/guestfs-actions.pod:2579
8559 "This returns the current state as an opaque integer. This is only useful "
8560 "for printing debug and internal error messages."
8564 #: ../fish/guestfish-actions.pod:1611 ../fish/guestfish-actions.pod:2570 ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:2642 ../src/guestfs-actions.pod:2582 ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:4018
8565 msgid "For more information on states, see L<guestfs(3)>."
8569 #: ../fish/guestfish-actions.pod:1613
8574 #: ../fish/guestfish-actions.pod:1615
8582 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2593
8583 msgid "Return the command trace flag."
8587 #: ../fish/guestfish-actions.pod:1619
8592 #: ../fish/guestfish-actions.pod:1621
8600 #: ../fish/guestfish-actions.pod:1623
8602 "Return the current umask. By default the umask is C<022> unless it has been "
8603 "set by calling L</umask>."
8607 #: ../fish/guestfish-actions.pod:1626
8612 #: ../fish/guestfish-actions.pod:1628
8620 #: ../fish/guestfish-actions.pod:1630 ../src/guestfs-actions.pod:2616
8621 msgid "This returns the verbose messages flag."
8625 #: ../fish/guestfish-actions.pod:1632
8630 #: ../fish/guestfish-actions.pod:1634
8638 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2627
8639 msgid "This gets the SELinux security context of the daemon."
8643 #: ../fish/guestfish-actions.pod:1638
8644 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
8648 #: ../fish/guestfish-actions.pod:1641
8653 #: ../fish/guestfish-actions.pod:1643
8656 " getxattr path name\n"
8661 #: ../fish/guestfish-actions.pod:1645
8663 "Get a single extended attribute from file C<path> named C<name>. This call "
8664 "follows symlinks. If you want to lookup an extended attribute for the "
8665 "symlink itself, use L</lgetxattr>."
8669 #: ../fish/guestfish-actions.pod:1649 ../fish/guestfish-actions.pod:2715
8671 "Normally it is better to get all extended attributes from a file in one go "
8672 "by calling L</getxattrs>. However some Linux filesystem implementations are "
8673 "buggy and do not provide a way to list out attributes. For these "
8674 "filesystems (notably ntfs-3g) you have to know the names of the extended "
8675 "attributes you want in advance and call this function."
8679 #: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:2722 ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:4151
8681 "Extended attribute values are blobs of binary data. If there is no extended "
8682 "attribute named C<name>, this returns an error."
8686 #: ../fish/guestfish-actions.pod:1659
8687 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
8691 #: ../fish/guestfish-actions.pod:1661
8696 #: ../fish/guestfish-actions.pod:1663
8704 #: ../fish/guestfish-actions.pod:1665 ../src/guestfs-actions.pod:2673
8705 msgid "This call lists the extended attributes of the file or directory C<path>."
8709 #: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2676
8711 "At the system call level, this is a combination of the L<listxattr(2)> and "
8712 "L<getxattr(2)> calls."
8716 #: ../fish/guestfish-actions.pod:1671
8717 msgid "See also: L</lgetxattrs>, L<attr(5)>."
8721 #: ../fish/guestfish-actions.pod:1673
8726 #: ../fish/guestfish-actions.pod:1675
8729 " glob-expand pattern\n"
8734 #: ../fish/guestfish-actions.pod:1677 ../src/guestfs-actions.pod:2693
8736 "This command searches for all the pathnames matching C<pattern> according to "
8737 "the wildcard expansion rules used by the shell."
8741 #: ../fish/guestfish-actions.pod:1681 ../src/guestfs-actions.pod:2697
8742 msgid "If no paths match, then this returns an empty list (note: not an error)."
8746 #: ../fish/guestfish-actions.pod:1684 ../src/guestfs-actions.pod:2700
8748 "It is just a wrapper around the C L<glob(3)> function with flags "
8749 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8753 #: ../fish/guestfish-actions.pod:1688
8758 #: ../fish/guestfish-actions.pod:1690
8761 " grep regex path\n"
8766 #: ../fish/guestfish-actions.pod:1692 ../src/guestfs-actions.pod:2717
8767 msgid "This calls the external C<grep> program and returns the matching lines."
8771 #: ../fish/guestfish-actions.pod:1698
8776 #: ../fish/guestfish-actions.pod:1700
8779 " grepi regex path\n"
8784 #: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2736
8785 msgid "This calls the external C<grep -i> program and returns the matching lines."
8789 #: ../fish/guestfish-actions.pod:1708
8790 msgid "grub-install"
8794 #: ../fish/guestfish-actions.pod:1710
8797 " grub-install root device\n"
8802 #: ../fish/guestfish-actions.pod:1712 ../src/guestfs-actions.pod:2755
8804 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
8805 "with the root directory being C<root>."
8809 #: ../fish/guestfish-actions.pod:1721 ../src/guestfs-actions.pod:2764
8811 "There is currently no way in the API to install grub2, which is used by most "
8812 "modern Linux guests. It is possible to run the grub2 command from the "
8813 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
8817 #: ../fish/guestfish-actions.pod:1728 ../src/guestfs-actions.pod:2771
8819 "This uses C<grub-install> from the host. Unfortunately grub is not always "
8820 "compatible with itself, so this only works in rather narrow circumstances. "
8821 "Careful testing with each guest version is advisable."
8825 #: ../fish/guestfish-actions.pod:1735 ../src/guestfs-actions.pod:2778
8827 "If grub-install reports the error \"No suitable drive was found in the "
8828 "generated device map.\" it may be that you need to create a "
8829 "C</boot/grub/device.map> file first that contains the mapping between grub "
8830 "device names and Linux device names. It is usually sufficient to create a "
8835 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2785
8843 #: ../fish/guestfish-actions.pod:1744 ../src/guestfs-actions.pod:2787
8844 msgid "replacing C</dev/vda> with the name of the installation device."
8848 #: ../fish/guestfish-actions.pod:1748
8853 #: ../fish/guestfish-actions.pod:1750
8861 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2801
8863 "This command returns up to the first 10 lines of a file as a list of "
8868 #: ../fish/guestfish-actions.pod:1758
8873 #: ../fish/guestfish-actions.pod:1760
8876 " head-n nrlines path\n"
8881 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2820
8883 "If the parameter C<nrlines> is a positive number, this returns the first "
8884 "C<nrlines> lines of the file C<path>."
8888 #: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2823
8890 "If the parameter C<nrlines> is a negative number, this returns lines from "
8891 "the file C<path>, excluding the last C<nrlines> lines."
8895 #: ../fish/guestfish-actions.pod:1768 ../fish/guestfish-actions.pod:4843 ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:7460
8896 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8900 #: ../fish/guestfish-actions.pod:1773
8905 #: ../fish/guestfish-actions.pod:1775
8913 #: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2843
8915 "This runs C<hexdump -C> on the given C<path>. The result is the "
8916 "human-readable, canonical hex dump of the file."
8920 #: ../fish/guestfish-actions.pod:1783
8925 #: ../fish/guestfish-actions.pod:1785
8928 " initrd-cat initrdpath filename\n"
8933 #: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2862
8935 "This command unpacks the file C<filename> from the initrd file called "
8936 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8941 #: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2866
8943 "For example, in guestfish you could use the following command to examine the "
8944 "boot script (usually called C</init>) contained in a Linux initrd or "
8949 #: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2870
8952 " initrd-cat /boot/initrd-<version>.img init\n"
8957 #: ../fish/guestfish-actions.pod:1797
8958 msgid "See also L</initrd-list>."
8962 #: ../fish/guestfish-actions.pod:1802
8967 #: ../fish/guestfish-actions.pod:1804
8970 " initrd-list path\n"
8975 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2889
8976 msgid "This command lists out files contained in an initrd."
8980 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2891
8982 "The files are listed without any initial C</> character. The files are "
8983 "listed in the order they appear (not necessarily alphabetical). Directory "
8984 "names are listed as separate items."
8988 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2895
8990 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8991 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8996 #: ../fish/guestfish-actions.pod:1816
8997 msgid "inotify-add-watch"
9001 #: ../fish/guestfish-actions.pod:1818
9004 " inotify-add-watch path mask\n"
9009 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2912
9010 msgid "Watch C<path> for the events listed in C<mask>."
9014 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2914
9016 "Note that if C<path> is a directory then events within that directory are "
9017 "watched, but this does I<not> happen recursively (in subdirectories)."
9021 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2918
9023 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9024 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9028 #: ../fish/guestfish-actions.pod:1830
9029 msgid "inotify-close"
9033 #: ../fish/guestfish-actions.pod:1832
9041 #: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2931
9043 "This closes the inotify handle which was previously opened by inotify_init. "
9044 "It removes all watches, throws away any pending events, and deallocates all "
9049 #: ../fish/guestfish-actions.pod:1838
9050 msgid "inotify-files"
9054 #: ../fish/guestfish-actions.pod:1840
9062 #: ../fish/guestfish-actions.pod:1842
9064 "This function is a helpful wrapper around L</inotify-read> which just "
9065 "returns a list of pathnames of objects that were touched. The returned "
9066 "pathnames are sorted and deduplicated."
9070 #: ../fish/guestfish-actions.pod:1846
9071 msgid "inotify-init"
9075 #: ../fish/guestfish-actions.pod:1848
9078 " inotify-init maxevents\n"
9083 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2960
9085 "This command creates a new inotify handle. The inotify subsystem can be "
9086 "used to notify events which happen to objects in the guest filesystem."
9090 #: ../fish/guestfish-actions.pod:1854
9092 "C<maxevents> is the maximum number of events which will be queued up between "
9093 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
9094 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
9095 "default was 16384 events. Beyond this limit, the kernel throws away events, "
9096 "but records the fact that it threw them away by setting a flag "
9097 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
9101 #: ../fish/guestfish-actions.pod:1864
9103 "Before any events are generated, you have to add some watches to the "
9104 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
9105 "L</inotify-watch-all>."
9109 #: ../fish/guestfish-actions.pod:1870
9111 "Queued up events should be read periodically by calling L</inotify-read> (or "
9112 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
9113 "If you don't read the events out often enough then you risk the internal "
9114 "queue overflowing."
9118 #: ../fish/guestfish-actions.pod:1877
9120 "The handle should be closed after use by calling L</inotify-close>. This "
9121 "also removes any watches automatically."
9125 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2991
9127 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9128 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9129 "that there is one global inotify handle per libguestfs instance."
9133 #: ../fish/guestfish-actions.pod:1886
9134 msgid "inotify-read"
9138 #: ../fish/guestfish-actions.pod:1888
9146 #: ../fish/guestfish-actions.pod:1890 ../src/guestfs-actions.pod:3005
9148 "Return the complete queue of events that have happened since the previous "
9153 #: ../fish/guestfish-actions.pod:1893 ../src/guestfs-actions.pod:3008
9154 msgid "If no events have happened, this returns an empty list."
9158 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:3010
9160 "I<Note>: In order to make sure that all events have been read, you must call "
9161 "this function repeatedly until it returns an empty list. The reason is that "
9162 "the call will read events up to the maximum appliance-to-host message size "
9163 "and leave remaining events in the queue."
9167 #: ../fish/guestfish-actions.pod:1901
9168 msgid "inotify-rm-watch"
9172 #: ../fish/guestfish-actions.pod:1903
9175 " inotify-rm-watch wd\n"
9180 #: ../fish/guestfish-actions.pod:1905
9181 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
9185 #: ../fish/guestfish-actions.pod:1908
9186 msgid "inspect-get-arch"
9190 #: ../fish/guestfish-actions.pod:1910
9193 " inspect-get-arch root\n"
9198 #: ../fish/guestfish-actions.pod:1912
9200 "This returns the architecture of the inspected operating system. The "
9201 "possible return values are listed under L</file-architecture>."
9205 #: ../fish/guestfish-actions.pod:1916 ../src/guestfs-actions.pod:3045
9207 "If the architecture could not be determined, then the string C<unknown> is "
9212 #: ../fish/guestfish-actions.pod:1919 ../fish/guestfish-actions.pod:2014 ../fish/guestfish-actions.pod:2093 ../fish/guestfish-actions.pod:2105 ../fish/guestfish-actions.pod:2189 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2286 ../fish/guestfish-actions.pod:2326 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2388 ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2420 ../fish/guestfish-actions.pod:2516 ../fish/guestfish-actions.pod:2550 ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3150 ../src/guestfs-actions.pod:3254 ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3516 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3590 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3868
9213 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9217 #: ../fish/guestfish-actions.pod:1921
9218 msgid "inspect-get-distro"
9222 #: ../fish/guestfish-actions.pod:1923
9225 " inspect-get-distro root\n"
9230 #: ../fish/guestfish-actions.pod:1925 ../src/guestfs-actions.pod:3061
9231 msgid "This returns the distro (distribution) of the inspected operating system."
9235 #: ../fish/guestfish-actions.pod:1928 ../src/guestfs-actions.pod:3064
9236 msgid "Currently defined distros are:"
9240 #: ../fish/guestfish-actions.pod:1932 ../src/guestfs-actions.pod:3068
9241 msgid "\"archlinux\""
9245 #: ../fish/guestfish-actions.pod:1934 ../src/guestfs-actions.pod:3070
9250 #: ../fish/guestfish-actions.pod:1936 ../src/guestfs-actions.pod:3072
9255 #: ../fish/guestfish-actions.pod:1938 ../src/guestfs-actions.pod:3074
9260 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:3076
9265 #: ../fish/guestfish-actions.pod:1942 ../src/guestfs-actions.pod:3078
9270 #: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:3080
9275 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:3082
9280 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:3084
9285 #: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:3086
9290 #: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:3088
9291 msgid "\"linuxmint\""
9295 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:3090
9300 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:3092
9305 #: ../fish/guestfish-actions.pod:1958 ../src/guestfs-actions.pod:3094
9310 #: ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:3096
9311 msgid "\"mandriva\""
9315 #: ../fish/guestfish-actions.pod:1962 ../src/guestfs-actions.pod:3098
9320 #: ../fish/guestfish-actions.pod:1964 ../src/guestfs-actions.pod:3100
9325 #: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:3102
9330 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:3104
9331 msgid "\"opensuse\""
9335 #: ../fish/guestfish-actions.pod:1970 ../src/guestfs-actions.pod:3106
9340 #: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:3108
9345 #: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:3110
9350 #: ../fish/guestfish-actions.pod:1976 ../src/guestfs-actions.pod:3112
9351 msgid "\"redhat-based\""
9355 #: ../fish/guestfish-actions.pod:1978 ../src/guestfs-actions.pod:3114
9356 msgid "Some Red Hat-derived distro."
9360 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:3116
9365 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:3118
9366 msgid "Red Hat Enterprise Linux."
9370 #: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:3120
9371 msgid "\"scientificlinux\""
9375 #: ../fish/guestfish-actions.pod:1986 ../src/guestfs-actions.pod:3122
9376 msgid "Scientific Linux."
9380 #: ../fish/guestfish-actions.pod:1988 ../src/guestfs-actions.pod:3124
9381 msgid "\"slackware\""
9385 #: ../fish/guestfish-actions.pod:1990 ../src/guestfs-actions.pod:3126
9390 #: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:3128
9391 msgid "\"ttylinux\""
9395 #: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:3130
9400 #: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3132
9405 #: ../fish/guestfish-actions.pod:1998 ../src/guestfs-actions.pod:3134
9410 #: ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2084 ../fish/guestfish-actions.pod:2353 ../src/guestfs-actions.pod:3136 ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3625
9415 #: ../fish/guestfish-actions.pod:2002 ../src/guestfs-actions.pod:3138
9416 msgid "The distro could not be determined."
9420 #: ../fish/guestfish-actions.pod:2004 ../fish/guestfish-actions.pod:2341 ../src/guestfs-actions.pod:3140 ../src/guestfs-actions.pod:3613
9425 #: ../fish/guestfish-actions.pod:2006 ../src/guestfs-actions.pod:3142
9427 "Windows does not have distributions. This string is returned if the OS type "
9432 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2090 ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3147 ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3631
9434 "Future versions of libguestfs may return other strings here. The caller "
9435 "should be prepared to handle any string."
9439 #: ../fish/guestfish-actions.pod:2016
9440 msgid "inspect-get-drive-mappings"
9444 #: ../fish/guestfish-actions.pod:2018
9447 " inspect-get-drive-mappings root\n"
9452 #: ../fish/guestfish-actions.pod:2020 ../src/guestfs-actions.pod:3163
9454 "This call is useful for Windows which uses a primitive system of assigning "
9455 "drive letters (like \"C:\") to partitions. This inspection API examines the "
9456 "Windows Registry to find out how disks/partitions are mapped to drive "
9457 "letters, and returns a hash table as in the example below:"
9461 #: ../fish/guestfish-actions.pod:2026 ../src/guestfs-actions.pod:3169
9471 #: ../fish/guestfish-actions.pod:2030 ../src/guestfs-actions.pod:3173
9473 "Note that keys are drive letters. For Windows, the key is case insensitive "
9474 "and just contains the drive letter, without the customary colon separator "
9479 #: ../fish/guestfish-actions.pod:2034 ../src/guestfs-actions.pod:3177
9481 "In future we may support other operating systems that also used drive "
9482 "letters, but the keys for those might not be case insensitive and might be "
9483 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
9488 #: ../fish/guestfish-actions.pod:2039 ../src/guestfs-actions.pod:3182
9490 "For Windows guests, currently only hard drive mappings are returned. "
9491 "Removable disks (eg. DVD-ROMs) are ignored."
9495 #: ../fish/guestfish-actions.pod:2042 ../src/guestfs-actions.pod:3185
9497 "For guests that do not use drive mappings, or if the drive mappings could "
9498 "not be determined, this returns an empty hash table."
9502 #: ../fish/guestfish-actions.pod:2045
9504 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9505 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
9509 #: ../fish/guestfish-actions.pod:2049
9510 msgid "inspect-get-filesystems"
9514 #: ../fish/guestfish-actions.pod:2051
9517 " inspect-get-filesystems root\n"
9522 #: ../fish/guestfish-actions.pod:2053 ../src/guestfs-actions.pod:3206
9524 "This returns a list of all the filesystems that we think are associated with "
9525 "this operating system. This includes the root filesystem, other ordinary "
9526 "filesystems, and non-mounted devices like swap partitions."
9530 #: ../fish/guestfish-actions.pod:2058 ../src/guestfs-actions.pod:3211
9532 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9533 "to be shared between operating systems."
9537 #: ../fish/guestfish-actions.pod:2061
9539 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9540 "L</inspect-get-mountpoints>."
9544 #: ../fish/guestfish-actions.pod:2064
9545 msgid "inspect-get-format"
9549 #: ../fish/guestfish-actions.pod:2066
9552 " inspect-get-format root\n"
9557 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3229
9559 "This returns the format of the inspected operating system. You can use it "
9560 "to detect install images, live CDs and similar."
9564 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3232
9565 msgid "Currently defined formats are:"
9569 #: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3236
9570 msgid "\"installed\""
9574 #: ../fish/guestfish-actions.pod:2077 ../src/guestfs-actions.pod:3238
9575 msgid "This is an installed operating system."
9579 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3240
9580 msgid "\"installer\""
9584 #: ../fish/guestfish-actions.pod:2081 ../src/guestfs-actions.pod:3242
9586 "The disk image being inspected is not an installed operating system, but a "
9587 "I<bootable> install disk, live CD, or similar."
9591 #: ../fish/guestfish-actions.pod:2086 ../src/guestfs-actions.pod:3247
9592 msgid "The format of this disk image is not known."
9596 #: ../fish/guestfish-actions.pod:2095
9597 msgid "inspect-get-hostname"
9601 #: ../fish/guestfish-actions.pod:2097
9604 " inspect-get-hostname root\n"
9609 #: ../fish/guestfish-actions.pod:2099 ../src/guestfs-actions.pod:3267
9611 "This function returns the hostname of the operating system as found by "
9612 "inspection of the guest's configuration files."
9616 #: ../fish/guestfish-actions.pod:2102 ../src/guestfs-actions.pod:3270
9618 "If the hostname could not be determined, then the string C<unknown> is "
9623 #: ../fish/guestfish-actions.pod:2107
9624 msgid "inspect-get-icon"
9628 #: ../fish/guestfish-actions.pod:2109
9631 " inspect-get-icon root [favicon:..] [highquality:..]\n"
9636 #: ../fish/guestfish-actions.pod:2111 ../src/guestfs-actions.pod:3296
9638 "This function returns an icon corresponding to the inspected operating "
9639 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
9640 "to PNG if necessary)."
9644 #: ../fish/guestfish-actions.pod:2115 ../src/guestfs-actions.pod:3300
9646 "If it was not possible to get an icon this function returns a zero-length "
9647 "(non-NULL) buffer. I<Callers must check for this case>."
9651 #: ../fish/guestfish-actions.pod:2118 ../src/guestfs-actions.pod:3303
9653 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
9654 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
9655 "this file will be returned. You can disable favicons by passing the "
9656 "optional C<favicon> boolean as false (default is true)."
9660 #: ../fish/guestfish-actions.pod:2124 ../src/guestfs-actions.pod:3309
9662 "If finding the favicon fails, then we look in other places in the guest for "
9667 #: ../fish/guestfish-actions.pod:2127 ../src/guestfs-actions.pod:3312
9669 "If the optional C<highquality> boolean is true then only high quality icons "
9670 "are returned, which means only icons of high resolution with an alpha "
9671 "channel. The default (false) is to return any icon we can, even if it is of "
9672 "substandard quality."
9676 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3323
9678 "Unlike most other inspection API calls, the guest's disks must be mounted up "
9679 "before you call this, since it needs to read information from the guest "
9680 "filesystem during the call."
9684 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3329
9686 "B<Security:> The icon data comes from the untrusted guest, and should be "
9687 "treated with caution. PNG files have been known to contain exploits. "
9688 "Ensure that libpng (or other relevant libraries) are fully up to date before "
9689 "trying to process or display the icon."
9693 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3337
9695 "The PNG image returned can be any size. It might not be square. Libguestfs "
9696 "tries to return the largest, highest quality icon available. The "
9697 "application must scale the icon to the required size."
9701 #: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3344
9703 "Extracting icons from Windows guests requires the external C<wrestool> "
9704 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
9705 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
9706 "installed separately."
9710 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3351
9712 "Operating system icons are usually trademarks. Seek legal advice before "
9713 "using trademarks in applications."
9717 #: ../fish/guestfish-actions.pod:2173
9718 msgid "inspect-get-major-version"
9722 #: ../fish/guestfish-actions.pod:2175
9725 " inspect-get-major-version root\n"
9730 #: ../fish/guestfish-actions.pod:2177 ../src/guestfs-actions.pod:3392
9731 msgid "This returns the major version number of the inspected operating system."
9735 #: ../fish/guestfish-actions.pod:2180 ../src/guestfs-actions.pod:3395
9737 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9738 "popular public names used by the operating system. Notably the operating "
9739 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9740 "1). You can find out the real versions corresponding to releases of Windows "
9741 "by consulting Wikipedia or MSDN."
9745 #: ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2198 ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3419
9746 msgid "If the version could not be determined, then C<0> is returned."
9750 #: ../fish/guestfish-actions.pod:2191
9751 msgid "inspect-get-minor-version"
9755 #: ../fish/guestfish-actions.pod:2193
9758 " inspect-get-minor-version root\n"
9763 #: ../fish/guestfish-actions.pod:2195 ../src/guestfs-actions.pod:3416
9764 msgid "This returns the minor version number of the inspected operating system."
9768 #: ../fish/guestfish-actions.pod:2200
9770 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9771 "L</inspect-get-major-version>."
9775 #: ../fish/guestfish-actions.pod:2203
9776 msgid "inspect-get-mountpoints"
9780 #: ../fish/guestfish-actions.pod:2205
9783 " inspect-get-mountpoints root\n"
9788 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3434
9790 "This returns a hash of where we think the filesystems associated with this "
9791 "operating system should be mounted. Callers should note that this is at "
9792 "best an educated guess made by reading configuration files such as "
9793 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9794 "are non-existent or not mountable and callers should be prepared to handle "
9795 "or ignore failures if they try to mount them."
9799 #: ../fish/guestfish-actions.pod:2216 ../src/guestfs-actions.pod:3443
9801 "Each element in the returned hashtable has a key which is the path of the "
9802 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9803 "mounted there (eg. C</dev/sda1>)."
9807 #: ../fish/guestfish-actions.pod:2221 ../src/guestfs-actions.pod:3448
9808 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9812 #: ../fish/guestfish-actions.pod:2224
9814 "For operating systems like Windows which still use drive letters, this call "
9815 "will only return an entry for the first drive \"mounted on\" C</>. For "
9816 "information about the mapping of drive letters to partitions, see "
9817 "L</inspect-get-drive-mappings>."
9821 #: ../fish/guestfish-actions.pod:2230
9823 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9824 "L</inspect-get-filesystems>."
9828 #: ../fish/guestfish-actions.pod:2233
9829 msgid "inspect-get-package-format"
9833 #: ../fish/guestfish-actions.pod:2235
9836 " inspect-get-package-format root\n"
9841 #: ../fish/guestfish-actions.pod:2237
9843 "This function and L</inspect-get-package-management> return the package "
9844 "format and package management tool used by the inspected operating system. "
9845 "For example for Fedora these functions would return C<rpm> (package format) "
9846 "and C<yum> (package management)."
9850 #: ../fish/guestfish-actions.pod:2243 ../src/guestfs-actions.pod:3480
9852 "This returns the string C<unknown> if we could not determine the package "
9853 "format I<or> if the operating system does not have a real packaging system "
9858 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3484
9860 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, "
9861 "C<pkgsrc>. Future versions of libguestfs may return other strings."
9865 #: ../fish/guestfish-actions.pod:2253
9866 msgid "inspect-get-package-management"
9870 #: ../fish/guestfish-actions.pod:2255
9873 " inspect-get-package-management root\n"
9878 #: ../fish/guestfish-actions.pod:2257
9880 "L</inspect-get-package-format> and this function return the package format "
9881 "and package management tool used by the inspected operating system. For "
9882 "example for Fedora these functions would return C<rpm> (package format) and "
9883 "C<yum> (package management)."
9887 #: ../fish/guestfish-actions.pod:2263 ../src/guestfs-actions.pod:3507
9889 "This returns the string C<unknown> if we could not determine the package "
9890 "management tool I<or> if the operating system does not have a real packaging "
9891 "system (eg. Windows)."
9895 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3511
9897 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9898 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>. Future "
9899 "versions of libguestfs may return other strings."
9903 #: ../fish/guestfish-actions.pod:2274
9904 msgid "inspect-get-product-name"
9908 #: ../fish/guestfish-actions.pod:2276
9911 " inspect-get-product-name root\n"
9916 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3529
9918 "This returns the product name of the inspected operating system. The "
9919 "product name is generally some freeform string which can be displayed to the "
9920 "user, but should not be parsed by programs."
9924 #: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3534
9926 "If the product name could not be determined, then the string C<unknown> is "
9931 #: ../fish/guestfish-actions.pod:2288
9932 msgid "inspect-get-product-variant"
9936 #: ../fish/guestfish-actions.pod:2290
9939 " inspect-get-product-variant root\n"
9944 #: ../fish/guestfish-actions.pod:2292 ../src/guestfs-actions.pod:3550
9945 msgid "This returns the product variant of the inspected operating system."
9949 #: ../fish/guestfish-actions.pod:2295 ../src/guestfs-actions.pod:3553
9951 "For Windows guests, this returns the contents of the Registry key "
9952 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
9953 "which is usually a string such as C<Client> or C<Server> (other values are "
9954 "possible). This can be used to distinguish consumer and enterprise versions "
9955 "of Windows that have the same version number (for example, Windows 7 and "
9956 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
9957 "the latter is C<Server>)."
9961 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3562
9963 "For enterprise Linux guests, in future we intend this to return the product "
9964 "variant such as C<Desktop>, C<Server> and so on. But this is not "
9965 "implemented at present."
9969 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3566
9971 "If the product variant could not be determined, then the string C<unknown> "
9976 #: ../fish/guestfish-actions.pod:2311
9978 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9979 "L</inspect-get-product-name>, L</inspect-get-major-version>."
9983 #: ../fish/guestfish-actions.pod:2315
9984 msgid "inspect-get-roots"
9988 #: ../fish/guestfish-actions.pod:2317
9991 " inspect-get-roots\n"
9996 #: ../fish/guestfish-actions.pod:2319
9998 "This function is a convenient way to get the list of root devices, as "
9999 "returned from a previous call to L</inspect-os>, but without redoing the "
10000 "whole inspection process."
10004 #: ../fish/guestfish-actions.pod:2323
10006 "This returns an empty list if either no root devices were found or the "
10007 "caller has not called L</inspect-os>."
10011 #: ../fish/guestfish-actions.pod:2328
10012 msgid "inspect-get-type"
10016 #: ../fish/guestfish-actions.pod:2330
10019 " inspect-get-type root\n"
10024 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3604
10026 "This returns the type of the inspected operating system. Currently defined "
10031 #: ../fish/guestfish-actions.pod:2337 ../src/guestfs-actions.pod:3609
10036 #: ../fish/guestfish-actions.pod:2339 ../src/guestfs-actions.pod:3611
10037 msgid "Any Linux-based operating system."
10041 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3615
10042 msgid "Any Microsoft Windows operating system."
10046 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3617
10047 msgid "\"freebsd\""
10051 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3619
10056 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3621
10061 #: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3623
10066 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3627
10067 msgid "The operating system type could not be determined."
10071 #: ../fish/guestfish-actions.pod:2364
10072 msgid "inspect-get-windows-current-control-set"
10076 #: ../fish/guestfish-actions.pod:2366
10079 " inspect-get-windows-current-control-set root\n"
10084 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3647
10086 "This returns the Windows CurrentControlSet of the inspected guest. The "
10087 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10091 #: ../fish/guestfish-actions.pod:2371 ../src/guestfs-actions.pod:3650
10093 "This call assumes that the guest is Windows and that the Registry could be "
10094 "examined by inspection. If this is not the case then an error is returned."
10098 #: ../fish/guestfish-actions.pod:2377
10099 msgid "inspect-get-windows-systemroot"
10103 #: ../fish/guestfish-actions.pod:2379
10106 " inspect-get-windows-systemroot root\n"
10111 #: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3667
10113 "This returns the Windows systemroot of the inspected guest. The systemroot "
10114 "is a directory path such as C</WINDOWS>."
10118 #: ../fish/guestfish-actions.pod:2384 ../src/guestfs-actions.pod:3670
10120 "This call assumes that the guest is Windows and that the systemroot could be "
10121 "determined by inspection. If this is not the case then an error is "
10126 #: ../fish/guestfish-actions.pod:2390
10127 msgid "inspect-is-live"
10131 #: ../fish/guestfish-actions.pod:2392
10134 " inspect-is-live root\n"
10139 #: ../fish/guestfish-actions.pod:2394
10141 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10142 "then this returns true if a live image was detected on the disk."
10146 #: ../fish/guestfish-actions.pod:2400
10147 msgid "inspect-is-multipart"
10151 #: ../fish/guestfish-actions.pod:2402
10154 " inspect-is-multipart root\n"
10159 #: ../fish/guestfish-actions.pod:2404
10161 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10162 "then this returns true if the disk is part of a set."
10166 #: ../fish/guestfish-actions.pod:2410
10167 msgid "inspect-is-netinst"
10171 #: ../fish/guestfish-actions.pod:2412
10174 " inspect-is-netinst root\n"
10179 #: ../fish/guestfish-actions.pod:2414
10181 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
10182 "then this returns true if the disk is a network installer, ie. not a "
10183 "self-contained install CD but one which is likely to require network access "
10184 "to complete the install."
10188 #: ../fish/guestfish-actions.pod:2422
10189 msgid "inspect-list-applications"
10193 #: ../fish/guestfish-actions.pod:2424
10196 " inspect-list-applications root\n"
10201 #: ../fish/guestfish-actions.pod:2426 ../src/guestfs-actions.pod:3737
10202 msgid "Return the list of applications installed in the operating system."
10206 #: ../fish/guestfish-actions.pod:2428
10208 "I<Note:> This call works differently from other parts of the inspection "
10209 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
10210 "then mount up the disks, before calling this. Listing applications is a "
10211 "significantly more difficult operation which requires access to the full "
10212 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
10213 "are just returning data cached in the libguestfs handle, this call actually "
10214 "reads parts of the mounted filesystems during the call."
10218 #: ../fish/guestfish-actions.pod:2438 ../src/guestfs-actions.pod:3749
10220 "This returns an empty list if the inspection code was not able to determine "
10221 "the list of applications."
10225 #: ../fish/guestfish-actions.pod:2441 ../src/guestfs-actions.pod:3752
10226 msgid "The application structure contains the following fields:"
10230 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3756
10231 msgid "C<app_name>"
10235 #: ../fish/guestfish-actions.pod:2447 ../src/guestfs-actions.pod:3758
10237 "The name of the application. For Red Hat-derived and Debian-derived Linux "
10238 "guests, this is the package name."
10242 #: ../fish/guestfish-actions.pod:2450 ../src/guestfs-actions.pod:3761
10243 msgid "C<app_display_name>"
10247 #: ../fish/guestfish-actions.pod:2452 ../src/guestfs-actions.pod:3763
10249 "The display name of the application, sometimes localized to the install "
10250 "language of the guest operating system."
10254 #: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3766
10256 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
10257 "to display something can use C<app_name> instead."
10261 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3769
10262 msgid "C<app_epoch>"
10266 #: ../fish/guestfish-actions.pod:2460 ../src/guestfs-actions.pod:3771
10268 "For package managers which use epochs, this contains the epoch of the "
10269 "package (an integer). If unavailable, this is returned as C<0>."
10273 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3774
10274 msgid "C<app_version>"
10278 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3776
10280 "The version string of the application or package. If unavailable this is "
10281 "returned as an empty string C<\"\">."
10285 #: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3779
10286 msgid "C<app_release>"
10290 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3781
10292 "The release string of the application or package, for package managers that "
10293 "use this. If unavailable this is returned as an empty string C<\"\">."
10297 #: ../fish/guestfish-actions.pod:2474 ../src/guestfs-actions.pod:3785
10298 msgid "C<app_install_path>"
10302 #: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3787
10304 "The installation path of the application (on operating systems such as "
10305 "Windows which use installation paths). This path is in the format used by "
10306 "the guest operating system, it is not a libguestfs path."
10310 #: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3792
10311 msgid "If unavailable this is returned as an empty string C<\"\">."
10315 #: ../fish/guestfish-actions.pod:2483 ../src/guestfs-actions.pod:3794
10316 msgid "C<app_trans_path>"
10320 #: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3796
10322 "The install path translated into a libguestfs path. If unavailable this is "
10323 "returned as an empty string C<\"\">."
10327 #: ../fish/guestfish-actions.pod:2488 ../src/guestfs-actions.pod:3799
10328 msgid "C<app_publisher>"
10332 #: ../fish/guestfish-actions.pod:2490 ../src/guestfs-actions.pod:3801
10334 "The name of the publisher of the application, for package managers that use "
10335 "this. If unavailable this is returned as an empty string C<\"\">."
10339 #: ../fish/guestfish-actions.pod:2494 ../src/guestfs-actions.pod:3805
10344 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3807
10346 "The URL (eg. upstream URL) of the application. If unavailable this is "
10347 "returned as an empty string C<\"\">."
10351 #: ../fish/guestfish-actions.pod:2499 ../src/guestfs-actions.pod:3810
10352 msgid "C<app_source_package>"
10356 #: ../fish/guestfish-actions.pod:2501 ../src/guestfs-actions.pod:3812
10358 "For packaging systems which support this, the name of the source package. "
10359 "If unavailable this is returned as an empty string C<\"\">."
10363 #: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3815
10364 msgid "C<app_summary>"
10368 #: ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:3817
10370 "A short (usually one line) description of the application or package. If "
10371 "unavailable this is returned as an empty string C<\"\">."
10375 #: ../fish/guestfish-actions.pod:2509 ../src/guestfs-actions.pod:3820
10376 msgid "C<app_description>"
10380 #: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3822
10382 "A longer description of the application or package. If unavailable this is "
10383 "returned as an empty string C<\"\">."
10387 #: ../fish/guestfish-actions.pod:2518
10392 #: ../fish/guestfish-actions.pod:2520
10400 #: ../fish/guestfish-actions.pod:2522 ../src/guestfs-actions.pod:3840
10402 "This function uses other libguestfs functions and certain heuristics to "
10403 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10404 "for operating systems."
10408 #: ../fish/guestfish-actions.pod:2526 ../src/guestfs-actions.pod:3844
10409 msgid "The list returned is empty if no operating systems were found."
10413 #: ../fish/guestfish-actions.pod:2528 ../src/guestfs-actions.pod:3846
10415 "If one operating system was found, then this returns a list with a single "
10416 "element, which is the name of the root filesystem of this operating system. "
10417 "It is also possible for this function to return a list containing more than "
10418 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10419 "element being the root filesystem of one of the operating systems."
10423 #: ../fish/guestfish-actions.pod:2535
10425 "You can pass the root string(s) returned to other L</inspect-get-*> "
10426 "functions in order to query further information about each operating system, "
10427 "such as the name and version."
10431 #: ../fish/guestfish-actions.pod:2540
10433 "This function uses other libguestfs features such as L</mount-ro> and "
10434 "L</umount-all> in order to mount and unmount filesystems and look at the "
10435 "contents. This should be called with no disks currently mounted. The "
10436 "function may also use Augeas, so any existing Augeas handle will be closed."
10440 #: ../fish/guestfish-actions.pod:2546 ../src/guestfs-actions.pod:3864
10442 "This function cannot decrypt encrypted disks. The caller must do that first "
10443 "(supplying the necessary keys) if the disk is encrypted."
10447 #: ../fish/guestfish-actions.pod:2552 ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2809
10448 msgid "See also L</list-filesystems>."
10452 #: ../fish/guestfish-actions.pod:2554
10453 msgid "is-blockdev"
10457 #: ../fish/guestfish-actions.pod:2556
10460 " is-blockdev path\n"
10465 #: ../fish/guestfish-actions.pod:2558 ../src/guestfs-actions.pod:3884
10467 "This returns C<true> if and only if there is a block device with the given "
10472 #: ../fish/guestfish-actions.pod:2561 ../fish/guestfish-actions.pod:2579 ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:2607 ../fish/guestfish-actions.pod:2617 ../fish/guestfish-actions.pod:2651 ../fish/guestfish-actions.pod:2660
10473 msgid "See also L</stat>."
10477 #: ../fish/guestfish-actions.pod:2563
10482 #: ../fish/guestfish-actions.pod:2565
10490 #: ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:3898
10492 "This returns true iff this handle is busy processing a command (in the "
10497 #: ../fish/guestfish-actions.pod:2572
10502 #: ../fish/guestfish-actions.pod:2574
10505 " is-chardev path\n"
10510 #: ../fish/guestfish-actions.pod:2576 ../src/guestfs-actions.pod:3913
10512 "This returns C<true> if and only if there is a character device with the "
10513 "given C<path> name."
10517 #: ../fish/guestfish-actions.pod:2581
10522 #: ../fish/guestfish-actions.pod:2583
10530 #: ../fish/guestfish-actions.pod:2585 ../src/guestfs-actions.pod:3927
10532 "This returns true iff this handle is being configured (in the C<CONFIG> "
10537 #: ../fish/guestfish-actions.pod:2590
10542 #: ../fish/guestfish-actions.pod:2592
10550 #: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3942
10552 "This returns C<true> if and only if there is a directory with the given "
10553 "C<path> name. Note that it returns false for other objects like files."
10557 #: ../fish/guestfish-actions.pod:2600
10562 #: ../fish/guestfish-actions.pod:2602
10570 #: ../fish/guestfish-actions.pod:2604 ../src/guestfs-actions.pod:3958
10572 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10573 "given C<path> name."
10577 #: ../fish/guestfish-actions.pod:2609
10582 #: ../fish/guestfish-actions.pod:2611
10590 #: ../fish/guestfish-actions.pod:2613 ../src/guestfs-actions.pod:3973
10592 "This returns C<true> if and only if there is a regular file with the given "
10593 "C<path> name. Note that it returns false for other objects like "
10598 #: ../fish/guestfish-actions.pod:2619
10599 msgid "is-launching"
10603 #: ../fish/guestfish-actions.pod:2621
10611 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3988
10613 "This returns true iff this handle is launching the subprocess (in the "
10614 "C<LAUNCHING> state)."
10618 #: ../fish/guestfish-actions.pod:2628
10623 #: ../fish/guestfish-actions.pod:2630
10631 #: ../fish/guestfish-actions.pod:2632 ../src/guestfs-actions.pod:4003
10633 "This command tests whether C<device> is a logical volume, and returns true "
10634 "iff this is the case."
10638 #: ../fish/guestfish-actions.pod:2635
10643 #: ../fish/guestfish-actions.pod:2637
10651 #: ../fish/guestfish-actions.pod:2639 ../src/guestfs-actions.pod:4015
10653 "This returns true iff this handle is ready to accept commands (in the "
10658 #: ../fish/guestfish-actions.pod:2644
10663 #: ../fish/guestfish-actions.pod:2646
10666 " is-socket path\n"
10671 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:4030
10673 "This returns C<true> if and only if there is a Unix domain socket with the "
10674 "given C<path> name."
10678 #: ../fish/guestfish-actions.pod:2653
10683 #: ../fish/guestfish-actions.pod:2655
10686 " is-symlink path\n"
10691 #: ../fish/guestfish-actions.pod:2657 ../src/guestfs-actions.pod:4045
10693 "This returns C<true> if and only if there is a symbolic link with the given "
10698 #: ../fish/guestfish-actions.pod:2662
10703 #: ../fish/guestfish-actions.pod:2664
10711 #: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:4060
10713 "This returns true iff the file exists and the file is empty or it contains "
10718 #: ../fish/guestfish-actions.pod:2669
10719 msgid "is-zero-device"
10723 #: ../fish/guestfish-actions.pod:2671
10726 " is-zero-device device\n"
10731 #: ../fish/guestfish-actions.pod:2673 ../src/guestfs-actions.pod:4073
10732 msgid "This returns true iff the device exists and contains all zero bytes."
10736 #: ../fish/guestfish-actions.pod:2675 ../src/guestfs-actions.pod:4075
10737 msgid "Note that for large devices this can take a long time to run."
10741 #: ../fish/guestfish-actions.pod:2677
10742 msgid "kill-subprocess"
10746 #: ../fish/guestfish-actions.pod:2679
10749 " kill-subprocess\n"
10754 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:4086
10755 msgid "This kills the qemu subprocess. You should never need to call this."
10759 #: ../fish/guestfish-actions.pod:2683
10764 #: ../fish/guestfish-actions.pod:2685
10769 #: ../fish/guestfish-actions.pod:2687
10777 #: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:4097
10779 "Internally libguestfs is implemented by running a virtual machine using "
10784 #: ../fish/guestfish-actions.pod:2692 ../src/guestfs-actions.pod:4100
10786 "You should call this after configuring the handle (eg. adding drives) but "
10787 "before performing any actions."
10791 #: ../fish/guestfish-actions.pod:2695
10796 #: ../fish/guestfish-actions.pod:2697
10799 " lchown owner group path\n"
10804 #: ../fish/guestfish-actions.pod:2699
10806 "Change the file owner to C<owner> and group to C<group>. This is like "
10807 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
10812 #: ../fish/guestfish-actions.pod:2707
10817 #: ../fish/guestfish-actions.pod:2709
10820 " lgetxattr path name\n"
10825 #: ../fish/guestfish-actions.pod:2711 ../src/guestfs-actions.pod:4140
10827 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10828 "is a symlink, then this call returns an extended attribute from the symlink."
10832 #: ../fish/guestfish-actions.pod:2725
10833 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
10837 #: ../fish/guestfish-actions.pod:2727
10842 #: ../fish/guestfish-actions.pod:2729
10845 " lgetxattrs path\n"
10850 #: ../fish/guestfish-actions.pod:2731
10852 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
10853 "it returns the extended attributes of the link itself."
10857 #: ../fish/guestfish-actions.pod:2735
10862 #: ../fish/guestfish-actions.pod:2737
10870 #: ../fish/guestfish-actions.pod:2739 ../src/guestfs-actions.pod:4183
10872 "List all 9p filesystems attached to the guest. A list of mount tags is "
10877 #: ../fish/guestfish-actions.pod:2742
10878 msgid "list-devices"
10882 #: ../fish/guestfish-actions.pod:2744
10890 #: ../fish/guestfish-actions.pod:2746 ../src/guestfs-actions.pod:4197
10891 msgid "List all the block devices."
10895 #: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4199
10896 msgid "The full block device names are returned, eg. C</dev/sda>."
10900 #: ../fish/guestfish-actions.pod:2752
10901 msgid "list-dm-devices"
10905 #: ../fish/guestfish-actions.pod:2754
10908 " list-dm-devices\n"
10913 #: ../fish/guestfish-actions.pod:2756 ../src/guestfs-actions.pod:4214
10914 msgid "List all device mapper devices."
10918 #: ../fish/guestfish-actions.pod:2758
10920 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
10921 "previous call to L</luks-open>."
10925 #: ../fish/guestfish-actions.pod:2761
10927 "Device mapper devices which correspond to logical volumes are I<not> "
10928 "returned in this list. Call L</lvs> if you want to list logical volumes."
10932 #: ../fish/guestfish-actions.pod:2765
10933 msgid "list-filesystems"
10937 #: ../fish/guestfish-actions.pod:2767
10940 " list-filesystems\n"
10945 #: ../fish/guestfish-actions.pod:2769 ../src/guestfs-actions.pod:4234
10947 "This inspection command looks for filesystems on partitions, block devices "
10948 "and logical volumes, returning a list of devices containing filesystems and "
10953 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4238
10955 "The return value is a hash, where the keys are the devices containing "
10956 "filesystems, and the values are the filesystem types. For example:"
10960 #: ../fish/guestfish-actions.pod:2777 ../src/guestfs-actions.pod:4242
10963 " \"/dev/sda1\" => \"ntfs\"\n"
10964 " \"/dev/sda2\" => \"ext2\"\n"
10965 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10966 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10971 #: ../fish/guestfish-actions.pod:2782 ../src/guestfs-actions.pod:4247
10973 "The value can have the special value \"unknown\", meaning the content of the "
10974 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10978 #: ../fish/guestfish-actions.pod:2786
10980 "This command runs other libguestfs commands, which might include L</mount> "
10981 "and L</umount>, and therefore you should use this soon after launch and only "
10982 "when nothing is mounted."
10986 #: ../fish/guestfish-actions.pod:2790
10988 "Not all of the filesystems returned will be mountable. In particular, swap "
10989 "partitions are returned in the list. Also this command does not check that "
10990 "each filesystem found is valid and mountable, and some filesystems might be "
10991 "mountable but require special options. Filesystems may not all belong to a "
10992 "single logical operating system (use L</inspect-os> to look for OSes)."
10996 #: ../fish/guestfish-actions.pod:2798
10997 msgid "list-partitions"
11001 #: ../fish/guestfish-actions.pod:2800
11004 " list-partitions\n"
11009 #: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4276
11010 msgid "List all the partitions detected on all block devices."
11014 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4278
11015 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11019 #: ../fish/guestfish-actions.pod:2806
11021 "This does not return logical volumes. For that you will need to call "
11026 #: ../fish/guestfish-actions.pod:2811
11031 #: ../fish/guestfish-actions.pod:2813
11039 #: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4297
11041 "List the files in C<directory> (relative to the root directory, there is no "
11042 "cwd) in the format of 'ls -la'."
11046 #: ../fish/guestfish-actions.pod:2818 ../src/guestfs-actions.pod:4300
11048 "This command is mostly useful for interactive sessions. It is I<not> "
11049 "intended that you try to parse the output string."
11053 #: ../fish/guestfish-actions.pod:2821
11058 #: ../fish/guestfish-actions.pod:2823
11061 " ln target linkname\n"
11066 #: ../fish/guestfish-actions.pod:2825 ../src/guestfs-actions.pod:4315
11067 msgid "This command creates a hard link using the C<ln> command."
11071 #: ../fish/guestfish-actions.pod:2827
11076 #: ../fish/guestfish-actions.pod:2829
11079 " ln-f target linkname\n"
11084 #: ../fish/guestfish-actions.pod:2831 ../src/guestfs-actions.pod:4328
11086 "This command creates a hard link using the C<ln -f> command. The I<-f> "
11087 "option removes the link (C<linkname>) if it exists already."
11091 #: ../fish/guestfish-actions.pod:2834
11096 #: ../fish/guestfish-actions.pod:2836
11099 " ln-s target linkname\n"
11104 #: ../fish/guestfish-actions.pod:2838 ../src/guestfs-actions.pod:4342
11105 msgid "This command creates a symbolic link using the C<ln -s> command."
11109 #: ../fish/guestfish-actions.pod:2840
11114 #: ../fish/guestfish-actions.pod:2842
11117 " ln-sf target linkname\n"
11122 #: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4355
11124 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
11125 "option removes the link (C<linkname>) if it exists already."
11129 #: ../fish/guestfish-actions.pod:2847
11130 msgid "lremovexattr"
11134 #: ../fish/guestfish-actions.pod:2849
11137 " lremovexattr xattr path\n"
11142 #: ../fish/guestfish-actions.pod:2851
11144 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
11145 "it removes an extended attribute of the link itself."
11149 #: ../fish/guestfish-actions.pod:2855
11154 #: ../fish/guestfish-actions.pod:2857
11162 #: ../fish/guestfish-actions.pod:2859 ../src/guestfs-actions.pod:4383
11164 "List the files in C<directory> (relative to the root directory, there is no "
11165 "cwd). The '.' and '..' entries are not returned, but hidden files are "
11170 #: ../fish/guestfish-actions.pod:2863
11172 "This command is mostly useful for interactive sessions. Programs should "
11173 "probably use L</readdir> instead."
11177 #: ../fish/guestfish-actions.pod:2866
11182 #: ../fish/guestfish-actions.pod:2868
11185 " lsetxattr xattr val vallen path\n"
11190 #: ../fish/guestfish-actions.pod:2870
11192 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
11193 "sets an extended attribute of the link itself."
11197 #: ../fish/guestfish-actions.pod:2874
11202 #: ../fish/guestfish-actions.pod:2876
11210 #: ../fish/guestfish-actions.pod:2878 ../fish/guestfish-actions.pod:4678 ../src/guestfs-actions.pod:4419 ../src/guestfs-actions.pod:7200
11211 msgid "Returns file information for the given C<path>."
11215 #: ../fish/guestfish-actions.pod:2880
11217 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
11218 "the link is stat-ed, not the file it refers to."
11222 #: ../fish/guestfish-actions.pod:2884 ../src/guestfs-actions.pod:4425
11223 msgid "This is the same as the C<lstat(2)> system call."
11227 #: ../fish/guestfish-actions.pod:2886
11232 #: ../fish/guestfish-actions.pod:2888
11235 " lstatlist path 'names ...'\n"
11240 #: ../fish/guestfish-actions.pod:2890
11242 "This call allows you to perform the L</lstat> operation on multiple files, "
11243 "where all files are in the directory C<path>. C<names> is the list of files "
11244 "from this directory."
11248 #: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4444
11250 "On return you get a list of stat structs, with a one-to-one correspondence "
11251 "to the C<names> list. If any name did not exist or could not be lstat'd, "
11252 "then the C<ino> field of that structure is set to C<-1>."
11256 #: ../fish/guestfish-actions.pod:2899
11258 "This call is intended for programs that want to efficiently list a directory "
11259 "contents without making many round-trips. See also L</lxattrlist> for a "
11260 "similarly efficient call for getting extended attributes. Very long "
11261 "directory listings might cause the protocol message size to be exceeded, "
11262 "causing this call to fail. The caller must split up such requests into "
11263 "smaller groups of names."
11267 #: ../fish/guestfish-actions.pod:2907
11268 msgid "luks-add-key"
11272 #: ../fish/guestfish-actions.pod:2909
11275 " luks-add-key device keyslot\n"
11280 #: ../fish/guestfish-actions.pod:2911 ../src/guestfs-actions.pod:4472
11282 "This command adds a new key on LUKS device C<device>. C<key> is any "
11283 "existing key, and is used to access the device. C<newkey> is the new key to "
11284 "add. C<keyslot> is the key slot that will be replaced."
11288 #: ../fish/guestfish-actions.pod:2916
11290 "Note that if C<keyslot> already contains a key, then this command will "
11291 "fail. You have to use L</luks-kill-slot> first to remove that key."
11295 #: ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2942 ../fish/guestfish-actions.pod:2952 ../fish/guestfish-actions.pod:2963 ../fish/guestfish-actions.pod:2989 ../fish/guestfish-actions.pod:2999
11297 "This command has one or more key or passphrase parameters. Guestfish will "
11298 "prompt for these separately."
11302 #: ../fish/guestfish-actions.pod:2923
11307 #: ../fish/guestfish-actions.pod:2925
11310 " luks-close device\n"
11315 #: ../fish/guestfish-actions.pod:2927
11317 "This closes a LUKS device that was created earlier by L</luks-open> or "
11318 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
11319 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
11320 "underlying block device."
11324 #: ../fish/guestfish-actions.pod:2933
11325 msgid "luks-format"
11329 #: ../fish/guestfish-actions.pod:2935
11332 " luks-format device keyslot\n"
11337 #: ../fish/guestfish-actions.pod:2937 ../src/guestfs-actions.pod:4513
11339 "This command erases existing data on C<device> and formats the device as a "
11340 "LUKS encrypted device. C<key> is the initial key, which is added to key "
11341 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11345 #: ../fish/guestfish-actions.pod:2945
11346 msgid "luks-format-cipher"
11350 #: ../fish/guestfish-actions.pod:2947
11353 " luks-format-cipher device keyslot cipher\n"
11358 #: ../fish/guestfish-actions.pod:2949
11360 "This command is the same as L</luks-format> but it also allows you to set "
11361 "the C<cipher> used."
11365 #: ../fish/guestfish-actions.pod:2955
11366 msgid "luks-kill-slot"
11370 #: ../fish/guestfish-actions.pod:2957
11373 " luks-kill-slot device keyslot\n"
11378 #: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4554
11380 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11381 "device C<device>. C<key> must be one of the I<other> keys."
11385 #: ../fish/guestfish-actions.pod:2966
11390 #: ../fish/guestfish-actions.pod:2968
11393 " luks-open device mapname\n"
11398 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4574
11400 "This command opens a block device which has been encrypted according to the "
11401 "Linux Unified Key Setup (LUKS) standard."
11405 #: ../fish/guestfish-actions.pod:2973 ../src/guestfs-actions.pod:4577
11406 msgid "C<device> is the encrypted block device or partition."
11410 #: ../fish/guestfish-actions.pod:2975 ../src/guestfs-actions.pod:4579
11412 "The caller must supply one of the keys associated with the LUKS block "
11413 "device, in the C<key> parameter."
11417 #: ../fish/guestfish-actions.pod:2978 ../src/guestfs-actions.pod:4582
11419 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11420 "writes to this block device are decrypted from and encrypted to the "
11421 "underlying C<device> respectively."
11425 #: ../fish/guestfish-actions.pod:2982
11427 "If this block device contains LVM volume groups, then calling L</vgscan> "
11428 "followed by L</vg-activate-all> will make them visible."
11432 #: ../fish/guestfish-actions.pod:2986
11433 msgid "Use L</list-dm-devices> to list all device mapper devices."
11437 #: ../fish/guestfish-actions.pod:2992
11438 msgid "luks-open-ro"
11442 #: ../fish/guestfish-actions.pod:2994
11445 " luks-open-ro device mapname\n"
11450 #: ../fish/guestfish-actions.pod:2996
11452 "This is the same as L</luks-open> except that a read-only mapping is "
11457 #: ../fish/guestfish-actions.pod:3002
11462 #: ../fish/guestfish-actions.pod:3004
11465 " lvcreate logvol volgroup mbytes\n"
11470 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4628
11472 "This creates an LVM logical volume called C<logvol> on the volume group "
11473 "C<volgroup>, with C<size> megabytes."
11477 #: ../fish/guestfish-actions.pod:3009
11478 msgid "lvm-canonical-lv-name"
11482 #: ../fish/guestfish-actions.pod:3011
11485 " lvm-canonical-lv-name lvname\n"
11490 #: ../fish/guestfish-actions.pod:3013 ../src/guestfs-actions.pod:4641
11492 "This converts alternative naming schemes for LVs that you might find to the "
11493 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11498 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4645
11500 "This command returns an error if the C<lvname> parameter does not refer to a "
11505 #: ../fish/guestfish-actions.pod:3020
11506 msgid "See also L</is-lv>."
11510 #: ../fish/guestfish-actions.pod:3022
11511 msgid "lvm-clear-filter"
11515 #: ../fish/guestfish-actions.pod:3024
11518 " lvm-clear-filter\n"
11523 #: ../fish/guestfish-actions.pod:3026
11525 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
11530 #: ../fish/guestfish-actions.pod:3029 ../fish/guestfish-actions.pod:3057 ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4702
11531 msgid "This command also clears the LVM cache and performs a volume group scan."
11535 #: ../fish/guestfish-actions.pod:3032
11536 msgid "lvm-remove-all"
11540 #: ../fish/guestfish-actions.pod:3034
11543 " lvm-remove-all\n"
11548 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4675
11550 "This command removes all LVM logical volumes, volume groups and physical "
11555 #: ../fish/guestfish-actions.pod:3039
11556 msgid "lvm-set-filter"
11560 #: ../fish/guestfish-actions.pod:3041
11563 " lvm-set-filter 'devices ...'\n"
11568 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4688
11570 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11571 "block devices in the list C<devices>, and will ignore all other attached "
11576 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4692
11578 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11579 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11580 "there are two types of duplication possible: either cloned PVs/VGs which "
11581 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11582 "same name. In normal operation you cannot create this situation, but you "
11583 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11584 "inside the LVM metadata."
11588 #: ../fish/guestfish-actions.pod:3060 ../src/guestfs-actions.pod:4705
11589 msgid "You can filter whole block devices or individual partitions."
11593 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4707
11595 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11596 "filesystem), even if you are not filtering out that VG."
11600 #: ../fish/guestfish-actions.pod:3066
11605 #: ../fish/guestfish-actions.pod:3068
11608 " lvremove device\n"
11613 #: ../fish/guestfish-actions.pod:3070 ../src/guestfs-actions.pod:4721
11615 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11616 "LV, such as C</dev/VG/LV>."
11620 #: ../fish/guestfish-actions.pod:3073 ../src/guestfs-actions.pod:4724
11622 "You can also remove all LVs in a volume group by specifying the VG name, "
11627 #: ../fish/guestfish-actions.pod:3076
11632 #: ../fish/guestfish-actions.pod:3078
11635 " lvrename logvol newlogvol\n"
11640 #: ../fish/guestfish-actions.pod:3080 ../src/guestfs-actions.pod:4738
11641 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11645 #: ../fish/guestfish-actions.pod:3082
11650 #: ../fish/guestfish-actions.pod:3084
11653 " lvresize device mbytes\n"
11658 #: ../fish/guestfish-actions.pod:3086 ../src/guestfs-actions.pod:4751
11660 "This resizes (expands or shrinks) an existing LVM logical volume to "
11661 "C<mbytes>. When reducing, data in the reduced part is lost."
11665 #: ../fish/guestfish-actions.pod:3090
11666 msgid "lvresize-free"
11670 #: ../fish/guestfish-actions.pod:3092
11673 " lvresize-free lv percent\n"
11678 #: ../fish/guestfish-actions.pod:3094 ../src/guestfs-actions.pod:4766
11680 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11681 "remaining free space in the volume group. Commonly you would call this with "
11682 "pc = 100 which expands the logical volume as much as possible, using all "
11683 "remaining free space in the volume group."
11687 #: ../fish/guestfish-actions.pod:3100
11692 #: ../fish/guestfish-actions.pod:3102
11700 #: ../fish/guestfish-actions.pod:3104 ../src/guestfs-actions.pod:4781
11702 "List all the logical volumes detected. This is the equivalent of the "
11703 "L<lvs(8)> command."
11707 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4784
11709 "This returns a list of the logical volume device names "
11710 "(eg. C</dev/VolGroup00/LogVol00>)."
11714 #: ../fish/guestfish-actions.pod:3110
11715 msgid "See also L</lvs-full>, L</list-filesystems>."
11719 #: ../fish/guestfish-actions.pod:3112
11724 #: ../fish/guestfish-actions.pod:3114
11732 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4800
11734 "List all the logical volumes detected. This is the equivalent of the "
11735 "L<lvs(8)> command. The \"full\" version includes all fields."
11739 #: ../fish/guestfish-actions.pod:3119
11744 #: ../fish/guestfish-actions.pod:3121
11752 #: ../fish/guestfish-actions.pod:3123 ../src/guestfs-actions.pod:4815
11753 msgid "This command returns the UUID of the LVM LV C<device>."
11757 #: ../fish/guestfish-actions.pod:3125
11762 #: ../fish/guestfish-actions.pod:3127
11765 " lxattrlist path 'names ...'\n"
11770 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4829
11772 "This call allows you to get the extended attributes of multiple files, where "
11773 "all files are in the directory C<path>. C<names> is the list of files from "
11778 #: ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4833
11780 "On return you get a flat list of xattr structs which must be interpreted "
11781 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11782 "C<attrval> in this struct is zero-length to indicate there was an error "
11783 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11784 "number (the number of following attributes for this file, which could be "
11785 "C<\"0\">). Then after the first xattr struct are the zero or more "
11786 "attributes for the first named file. This repeats for the second and "
11787 "subsequent files."
11791 #: ../fish/guestfish-actions.pod:3143
11793 "This call is intended for programs that want to efficiently list a directory "
11794 "contents without making many round-trips. See also L</lstatlist> for a "
11795 "similarly efficient call for getting standard stats. Very long directory "
11796 "listings might cause the protocol message size to be exceeded, causing this "
11797 "call to fail. The caller must split up such requests into smaller groups of "
11802 #: ../fish/guestfish-actions.pod:3151
11807 #: ../fish/guestfish-actions.pod:3153
11815 #: ../fish/guestfish-actions.pod:3155 ../src/guestfs-actions.pod:4863
11816 msgid "Create a directory named C<path>."
11820 #: ../fish/guestfish-actions.pod:3157
11825 #: ../fish/guestfish-actions.pod:3159
11828 " mkdir-mode path mode\n"
11833 #: ../fish/guestfish-actions.pod:3161 ../src/guestfs-actions.pod:4876
11835 "This command creates a directory, setting the initial permissions of the "
11836 "directory to C<mode>."
11840 #: ../fish/guestfish-actions.pod:3164 ../src/guestfs-actions.pod:4879
11842 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11843 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11848 #: ../fish/guestfish-actions.pod:3168
11849 msgid "See also L</mkdir>, L</umask>"
11853 #: ../fish/guestfish-actions.pod:3170
11858 #: ../fish/guestfish-actions.pod:3172
11866 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4895
11868 "Create a directory named C<path>, creating any parent directories as "
11869 "necessary. This is like the C<mkdir -p> shell command."
11873 #: ../fish/guestfish-actions.pod:3177
11878 #: ../fish/guestfish-actions.pod:3179
11881 " mkdtemp template\n"
11886 #: ../fish/guestfish-actions.pod:3181 ../src/guestfs-actions.pod:4908
11888 "This command creates a temporary directory. The C<template> parameter "
11889 "should be a full pathname for the temporary directory name with the final "
11890 "six characters being \"XXXXXX\"."
11894 #: ../fish/guestfish-actions.pod:3186 ../src/guestfs-actions.pod:4913
11896 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11897 "being suitable for Windows filesystems."
11901 #: ../fish/guestfish-actions.pod:3189 ../src/guestfs-actions.pod:4916
11902 msgid "The name of the temporary directory that was created is returned."
11906 #: ../fish/guestfish-actions.pod:3192 ../src/guestfs-actions.pod:4919
11907 msgid "The temporary directory is created with mode 0700 and is owned by root."
11911 #: ../fish/guestfish-actions.pod:3195 ../src/guestfs-actions.pod:4922
11913 "The caller is responsible for deleting the temporary directory and its "
11914 "contents after use."
11918 #: ../fish/guestfish-actions.pod:3198 ../src/guestfs-actions.pod:4925
11919 msgid "See also: L<mkdtemp(3)>"
11923 #: ../fish/guestfish-actions.pod:3200
11928 #: ../fish/guestfish-actions.pod:3202
11931 " mke2fs-J fstype blocksize device journal\n"
11936 #: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4941
11938 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11939 "C<journal>. It is equivalent to the command:"
11943 #: ../fish/guestfish-actions.pod:3208 ../src/guestfs-actions.pod:4945
11946 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11951 #: ../fish/guestfish-actions.pod:3210
11952 msgid "See also L</mke2journal>."
11956 #: ../fish/guestfish-actions.pod:3212
11961 #: ../fish/guestfish-actions.pod:3214
11964 " mke2fs-JL fstype blocksize device label\n"
11969 #: ../fish/guestfish-actions.pod:3216 ../src/guestfs-actions.pod:4962
11971 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11972 "the journal labeled C<label>."
11976 #: ../fish/guestfish-actions.pod:3219
11977 msgid "See also L</mke2journal-L>."
11981 #: ../fish/guestfish-actions.pod:3221
11986 #: ../fish/guestfish-actions.pod:3223
11989 " mke2fs-JU fstype blocksize device uuid\n"
11994 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4980
11996 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11997 "the journal with UUID C<uuid>."
12001 #: ../fish/guestfish-actions.pod:3228
12002 msgid "See also L</mke2journal-U>."
12006 #: ../fish/guestfish-actions.pod:3230
12007 msgid "mke2journal"
12011 #: ../fish/guestfish-actions.pod:3232
12014 " mke2journal blocksize device\n"
12019 #: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4996
12021 "This creates an ext2 external journal on C<device>. It is equivalent to the "
12026 #: ../fish/guestfish-actions.pod:3237 ../src/guestfs-actions.pod:4999
12029 " mke2fs -O journal_dev -b blocksize device\n"
12034 #: ../fish/guestfish-actions.pod:3239
12035 msgid "mke2journal-L"
12039 #: ../fish/guestfish-actions.pod:3241
12042 " mke2journal-L blocksize label device\n"
12047 #: ../fish/guestfish-actions.pod:3243 ../src/guestfs-actions.pod:5013
12048 msgid "This creates an ext2 external journal on C<device> with label C<label>."
12052 #: ../fish/guestfish-actions.pod:3245
12053 msgid "mke2journal-U"
12057 #: ../fish/guestfish-actions.pod:3247
12060 " mke2journal-U blocksize uuid device\n"
12065 #: ../fish/guestfish-actions.pod:3249 ../src/guestfs-actions.pod:5027
12066 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
12070 #: ../fish/guestfish-actions.pod:3251
12075 #: ../fish/guestfish-actions.pod:3253
12078 " mkfifo mode path\n"
12083 #: ../fish/guestfish-actions.pod:3255
12085 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
12086 "is just a convenient wrapper around L</mknod>."
12090 #: ../fish/guestfish-actions.pod:3261
12095 #: ../fish/guestfish-actions.pod:3263
12098 " mkfs fstype device\n"
12103 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:5057
12105 "This creates a filesystem on C<device> (usually a partition or LVM logical "
12106 "volume). The filesystem type is C<fstype>, for example C<ext3>."
12110 #: ../fish/guestfish-actions.pod:3269
12115 #: ../fish/guestfish-actions.pod:3271
12118 " mkfs-b fstype blocksize device\n"
12123 #: ../fish/guestfish-actions.pod:3273
12125 "This call is similar to L</mkfs>, but it allows you to control the block "
12126 "size of the resulting filesystem. Supported block sizes depend on the "
12127 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
12131 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5123
12133 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
12138 #: ../fish/guestfish-actions.pod:3281
12140 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
12145 #: ../fish/guestfish-actions.pod:3288
12150 #: ../fish/guestfish-actions.pod:3290
12153 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
12154 "[sectorsize:..]\n"
12159 #: ../fish/guestfish-actions.pod:3292 ../src/guestfs-actions.pod:5110
12161 "This function creates a filesystem on C<device>. The filesystem type is "
12162 "C<fstype>, for example C<ext3>."
12166 #: ../fish/guestfish-actions.pod:3299 ../src/guestfs-actions.pod:5117
12167 msgid "C<blocksize>"
12171 #: ../fish/guestfish-actions.pod:3301 ../src/guestfs-actions.pod:5119
12173 "The filesystem block size. Supported block sizes depend on the filesystem "
12174 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
12179 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:5126
12180 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
12184 #: ../fish/guestfish-actions.pod:3310 ../src/guestfs-actions.pod:5128
12185 msgid "C<features>"
12189 #: ../fish/guestfish-actions.pod:3312 ../src/guestfs-actions.pod:5130
12190 msgid "This passes the I<-O> parameter to the external mkfs program."
12194 #: ../fish/guestfish-actions.pod:3314 ../src/guestfs-actions.pod:5132
12196 "For certain filesystem types, this allows extra filesystem features to be "
12197 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
12201 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5136
12203 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
12208 #: ../fish/guestfish-actions.pod:3321 ../src/guestfs-actions.pod:5139
12213 #: ../fish/guestfish-actions.pod:3323 ../src/guestfs-actions.pod:5141
12215 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
12216 "sets the inode size (only for ext2/3/4 filesystems at present)."
12220 #: ../fish/guestfish-actions.pod:3326 ../src/guestfs-actions.pod:5144
12221 msgid "C<sectorsize>"
12225 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5146
12227 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
12228 "sets sector size for ufs filesystem."
12232 #: ../fish/guestfish-actions.pod:3335
12233 msgid "mkmountpoint"
12237 #: ../fish/guestfish-actions.pod:3337
12240 " mkmountpoint exemptpath\n"
12245 #: ../fish/guestfish-actions.pod:3339
12247 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
12248 "to create extra mountpoints before mounting the first filesystem."
12252 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5189
12254 "These calls are I<only> necessary in some very limited circumstances, mainly "
12255 "the case where you want to mount a mix of unrelated and/or read-only "
12256 "filesystems together."
12260 #: ../fish/guestfish-actions.pod:3347 ../src/guestfs-actions.pod:5193
12262 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12263 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12264 "inside that. You can unpack this as follows in guestfish:"
12268 #: ../fish/guestfish-actions.pod:3352 ../src/guestfs-actions.pod:5198
12271 " add-ro Fedora-11-i686-Live.iso\n"
12273 " mkmountpoint /cd\n"
12274 " mkmountpoint /sqsh\n"
12275 " mkmountpoint /ext3fs\n"
12276 " mount /dev/sda /cd\n"
12277 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12278 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12283 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5207
12284 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12288 #: ../fish/guestfish-actions.pod:3363
12290 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
12291 "unexpected errors if you try to mix these calls. It is safest to manually "
12292 "unmount filesystems and remove mountpoints after use."
12296 #: ../fish/guestfish-actions.pod:3367
12298 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
12299 "for this to work for manual mountpoints, you must ensure that the innermost "
12300 "mountpoints have the longest pathnames, as in the example code above."
12304 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5218
12305 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12309 #: ../fish/guestfish-actions.pod:3374
12311 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
12312 "L</umount-all> to be called when the handle is closed which can also trigger "
12317 #: ../fish/guestfish-actions.pod:3378
12322 #: ../fish/guestfish-actions.pod:3380
12325 " mknod mode devmajor devminor path\n"
12330 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5237
12332 "This call creates block or character special devices, or named pipes "
12337 #: ../fish/guestfish-actions.pod:3385 ../src/guestfs-actions.pod:5240
12339 "The C<mode> parameter should be the mode, using the standard constants. "
12340 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12341 "used when creating block and character special devices."
12345 #: ../fish/guestfish-actions.pod:3390
12347 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12348 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12349 "regular file). These constants are available in the standard Linux header "
12350 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
12351 "wrappers around this command which bitwise OR in the appropriate constant "
12356 #: ../fish/guestfish-actions.pod:3400
12361 #: ../fish/guestfish-actions.pod:3402
12364 " mknod-b mode devmajor devminor path\n"
12369 #: ../fish/guestfish-actions.pod:3404
12371 "This call creates a block device node called C<path> with mode C<mode> and "
12372 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12373 "wrapper around L</mknod>."
12377 #: ../fish/guestfish-actions.pod:3410
12382 #: ../fish/guestfish-actions.pod:3412
12385 " mknod-c mode devmajor devminor path\n"
12390 #: ../fish/guestfish-actions.pod:3414
12392 "This call creates a char device node called C<path> with mode C<mode> and "
12393 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12394 "wrapper around L</mknod>."
12398 #: ../fish/guestfish-actions.pod:3420
12403 #: ../fish/guestfish-actions.pod:3422
12411 #: ../fish/guestfish-actions.pod:3424 ../src/guestfs-actions.pod:5303
12412 msgid "Create a swap partition on C<device>."
12416 #: ../fish/guestfish-actions.pod:3426
12421 #: ../fish/guestfish-actions.pod:3428
12424 " mkswap-L label device\n"
12429 #: ../fish/guestfish-actions.pod:3430 ../src/guestfs-actions.pod:5316
12430 msgid "Create a swap partition on C<device> with label C<label>."
12434 #: ../fish/guestfish-actions.pod:3432 ../src/guestfs-actions.pod:5318
12436 "Note that you cannot attach a swap label to a block device "
12437 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12438 "the kernel or swap tools."
12442 #: ../fish/guestfish-actions.pod:3436
12447 #: ../fish/guestfish-actions.pod:3438
12450 " mkswap-U uuid device\n"
12455 #: ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5333
12456 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12460 #: ../fish/guestfish-actions.pod:3442
12461 msgid "mkswap-file"
12465 #: ../fish/guestfish-actions.pod:3444
12468 " mkswap-file path\n"
12473 #: ../fish/guestfish-actions.pod:3446 ../src/guestfs-actions.pod:5345
12474 msgid "Create a swap file."
12478 #: ../fish/guestfish-actions.pod:3448
12480 "This command just writes a swap file signature to an existing file. To "
12481 "create the file itself, use something like L</fallocate>."
12485 #: ../fish/guestfish-actions.pod:3451
12490 #: ../fish/guestfish-actions.pod:3453
12493 " modprobe modulename\n"
12498 #: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5360
12499 msgid "This loads a kernel module in the appliance."
12503 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5362
12505 "The kernel module must have been whitelisted when libguestfs was built (see "
12506 "C<appliance/kmod.whitelist.in> in the source)."
12510 #: ../fish/guestfish-actions.pod:3460
12515 #: ../fish/guestfish-actions.pod:3462
12518 " mount device mountpoint\n"
12523 #: ../fish/guestfish-actions.pod:3464 ../src/guestfs-actions.pod:5376
12525 "Mount a guest disk at a position in the filesystem. Block devices are named "
12526 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12527 "those block devices contain partitions, they will have the usual names "
12528 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12532 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5382
12534 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12535 "mounted on C</> before others can be mounted. Other filesystems can only be "
12536 "mounted on directories which already exist."
12540 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5387
12542 "The mounted filesystem is writable, if we have sufficient permissions on the "
12543 "underlying device."
12547 #: ../fish/guestfish-actions.pod:3478
12549 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
12550 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
12551 "problems for users. If your program might need to work with older versions "
12552 "of libguestfs, use L</mount-options> instead (using an empty string for the "
12553 "first parameter if you don't want any options)."
12557 #: ../fish/guestfish-actions.pod:3485
12562 #: ../fish/guestfish-actions.pod:3487
12565 " mount-9p mounttag mountpoint [options:..]\n"
12570 #: ../fish/guestfish-actions.pod:3489 ../src/guestfs-actions.pod:5416
12572 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
12577 #: ../fish/guestfish-actions.pod:3492 ../src/guestfs-actions.pod:5419
12579 "If required, C<trans=virtio> will be automatically added to the options. "
12580 "Any other options required can be passed in the optional C<options> "
12585 #: ../fish/guestfish-actions.pod:3498
12590 #: ../fish/guestfish-actions.pod:3500
12593 " mount-loop file mountpoint\n"
12598 #: ../fish/guestfish-actions.pod:3502 ../src/guestfs-actions.pod:5458
12600 "This command lets you mount C<file> (a filesystem image in a file) on a "
12601 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12606 #: ../fish/guestfish-actions.pod:3506
12607 msgid "mount-options"
12611 #: ../fish/guestfish-actions.pod:3508
12614 " mount-options options device mountpoint\n"
12619 #: ../fish/guestfish-actions.pod:3510
12621 "This is the same as the L</mount> command, but it allows you to set the "
12622 "mount options as for the L<mount(8)> I<-o> flag."
12626 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5478
12628 "If the C<options> parameter is an empty string, then no options are passed "
12629 "(all options default to whatever the filesystem uses)."
12633 #: ../fish/guestfish-actions.pod:3518
12638 #: ../fish/guestfish-actions.pod:3520
12641 " mount-ro device mountpoint\n"
12646 #: ../fish/guestfish-actions.pod:3522
12648 "This is the same as the L</mount> command, but it mounts the filesystem with "
12649 "the read-only (I<-o ro>) flag."
12653 #: ../fish/guestfish-actions.pod:3525
12658 #: ../fish/guestfish-actions.pod:3527
12661 " mount-vfs options vfstype device mountpoint\n"
12666 #: ../fish/guestfish-actions.pod:3529
12668 "This is the same as the L</mount> command, but it allows you to set both the "
12669 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
12673 #: ../fish/guestfish-actions.pod:3533
12674 msgid "mountpoints"
12678 #: ../fish/guestfish-actions.pod:3535
12686 #: ../fish/guestfish-actions.pod:3537
12688 "This call is similar to L</mounts>. That call returns a list of devices. "
12689 "This one returns a hash table (map) of device name to directory where the "
12690 "device is mounted."
12694 #: ../fish/guestfish-actions.pod:3541
12699 #: ../fish/guestfish-actions.pod:3543
12707 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5539
12709 "This returns the list of currently mounted filesystems. It returns the list "
12710 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12714 #: ../fish/guestfish-actions.pod:3548 ../src/guestfs-actions.pod:5542
12715 msgid "Some internal mounts are not shown."
12719 #: ../fish/guestfish-actions.pod:3550
12720 msgid "See also: L</mountpoints>"
12724 #: ../fish/guestfish-actions.pod:3552
12729 #: ../fish/guestfish-actions.pod:3554
12737 #: ../fish/guestfish-actions.pod:3556 ../src/guestfs-actions.pod:5559
12739 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12740 "destination filename or destination directory."
12744 #: ../fish/guestfish-actions.pod:3559
12745 msgid "ntfs-3g-probe"
12749 #: ../fish/guestfish-actions.pod:3561
12752 " ntfs-3g-probe true|false device\n"
12757 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5573
12759 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12760 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12761 "read-write, and some cannot be mounted at all)."
12765 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5577
12767 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12768 "can be mounted read-write. Set it to false if you want to test if the "
12769 "volume can be mounted read-only."
12773 #: ../fish/guestfish-actions.pod:3571 ../src/guestfs-actions.pod:5581
12775 "The return value is an integer which C<0> if the operation would succeed, or "
12776 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12780 #: ../fish/guestfish-actions.pod:3575
12785 #: ../fish/guestfish-actions.pod:3577
12788 " ntfsresize device\n"
12793 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5634
12795 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12796 "size of the underlying device."
12800 #: ../fish/guestfish-actions.pod:3582 ../src/guestfs-actions.pod:5605
12802 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
12803 "consistency check (for safety). You have to boot into Windows to perform "
12804 "this check and clear this condition. Furthermore, ntfsresize refuses to "
12805 "resize filesystems which have been marked in this way. So in effect it is "
12806 "not possible to call ntfsresize multiple times on a single filesystem "
12807 "without booting into Windows between each resize."
12811 #: ../fish/guestfish-actions.pod:3590 ../fish/guestfish-actions.pod:3629 ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5660
12812 msgid "See also L<ntfsresize(8)>."
12816 #: ../fish/guestfish-actions.pod:3592 ../fish/guestfish-actions.pod:3640
12818 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
12823 #: ../fish/guestfish-actions.pod:3599
12824 msgid "ntfsresize-opts"
12828 #: ../fish/guestfish-actions.pod:3601
12831 " ntfsresize-opts device [size:..] [force:..]\n"
12836 #: ../fish/guestfish-actions.pod:3612 ../src/guestfs-actions.pod:5643
12838 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
12839 "resized to fit the container (eg. partition)."
12843 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5646
12848 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5648
12850 "If this option is true, then force the resize of the filesystem even if the "
12851 "filesystem is marked as requiring a consistency check."
12855 #: ../fish/guestfish-actions.pod:3620
12857 "After the resize operation, the filesystem is always marked as requiring a "
12858 "consistency check (for safety). You have to boot into Windows to perform "
12859 "this check and clear this condition. If you I<don't> set the C<force> "
12860 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
12861 "a single filesystem without booting into Windows between each resize."
12865 #: ../fish/guestfish-actions.pod:3633
12866 msgid "ntfsresize-size"
12870 #: ../fish/guestfish-actions.pod:3635
12873 " ntfsresize-size device size\n"
12878 #: ../fish/guestfish-actions.pod:3637
12880 "This command is the same as L</ntfsresize> except that it allows you to "
12881 "specify the new size (in bytes) explicitly."
12885 #: ../fish/guestfish-actions.pod:3647
12890 #: ../fish/guestfish-actions.pod:3649
12893 " part-add device prlogex startsect endsect\n"
12898 #: ../fish/guestfish-actions.pod:3651
12900 "This command adds a partition to C<device>. If there is no partition table "
12901 "on the device, call L</part-init> first."
12905 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5721
12907 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12908 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12909 "C<logical>) and C<e> (or C<extended>) partition types."
12913 #: ../fish/guestfish-actions.pod:3659 ../src/guestfs-actions.pod:5726
12915 "C<startsect> and C<endsect> are the start and end of the partition in "
12916 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12917 "from the end of the disk (C<-1> is the last sector)."
12921 #: ../fish/guestfish-actions.pod:3663
12923 "Creating a partition which covers the whole disk is not so easy. Use "
12924 "L</part-disk> to do that."
12928 #: ../fish/guestfish-actions.pod:3666
12933 #: ../fish/guestfish-actions.pod:3668
12936 " part-del device partnum\n"
12941 #: ../fish/guestfish-actions.pod:3670 ../src/guestfs-actions.pod:5744
12942 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12946 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5746
12948 "Note that in the case of MBR partitioning, deleting an extended partition "
12949 "also deletes any logical partitions it contains."
12953 #: ../fish/guestfish-actions.pod:3676
12958 #: ../fish/guestfish-actions.pod:3678
12961 " part-disk device parttype\n"
12966 #: ../fish/guestfish-actions.pod:3680
12968 "This command is simply a combination of L</part-init> followed by "
12969 "L</part-add> to create a single primary partition covering the whole disk."
12973 #: ../fish/guestfish-actions.pod:3684
12975 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12976 "possible values are described in L</part-init>."
12980 #: ../fish/guestfish-actions.pod:3687
12981 msgid "part-get-bootable"
12985 #: ../fish/guestfish-actions.pod:3689
12988 " part-get-bootable device partnum\n"
12993 #: ../fish/guestfish-actions.pod:3691 ../src/guestfs-actions.pod:5779
12995 "This command returns true if the partition C<partnum> on C<device> has the "
12996 "bootable flag set."
13000 #: ../fish/guestfish-actions.pod:3694
13001 msgid "See also L</part-set-bootable>."
13005 #: ../fish/guestfish-actions.pod:3696
13006 msgid "part-get-mbr-id"
13010 #: ../fish/guestfish-actions.pod:3698
13013 " part-get-mbr-id device partnum\n"
13018 #: ../fish/guestfish-actions.pod:3700 ../src/guestfs-actions.pod:5795
13020 "Returns the MBR type byte (also known as the ID byte) from the numbered "
13021 "partition C<partnum>."
13025 #: ../fish/guestfish-actions.pod:3703 ../fish/guestfish-actions.pod:3847
13027 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
13028 "undefined results for other partition table types (see "
13029 "L</part-get-parttype>)."
13033 #: ../fish/guestfish-actions.pod:3707
13034 msgid "part-get-parttype"
13038 #: ../fish/guestfish-actions.pod:3709
13041 " part-get-parttype device\n"
13046 #: ../fish/guestfish-actions.pod:3711 ../src/guestfs-actions.pod:5812
13048 "This command examines the partition table on C<device> and returns the "
13049 "partition table type (format) being used."
13053 #: ../fish/guestfish-actions.pod:3714
13055 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
13056 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
13057 "possible, although unusual. See L</part-init> for a full list."
13061 #: ../fish/guestfish-actions.pod:3719
13066 #: ../fish/guestfish-actions.pod:3721
13069 " part-init device parttype\n"
13074 #: ../fish/guestfish-actions.pod:3723 ../src/guestfs-actions.pod:5832
13076 "This creates an empty partition table on C<device> of one of the partition "
13077 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
13078 "(for large disks)."
13082 #: ../fish/guestfish-actions.pod:3727
13084 "Initially there are no partitions. Following this, you should call "
13085 "L</part-add> for each partition required."
13089 #: ../fish/guestfish-actions.pod:3730 ../src/guestfs-actions.pod:5839
13090 msgid "Possible values for C<parttype> are:"
13094 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5843
13099 #: ../fish/guestfish-actions.pod:3736 ../src/guestfs-actions.pod:5845
13104 #: ../fish/guestfish-actions.pod:3738 ../src/guestfs-actions.pod:5847
13105 msgid "Intel EFI / GPT partition table."
13109 #: ../fish/guestfish-actions.pod:3740 ../src/guestfs-actions.pod:5849
13111 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
13112 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
13113 "the C<mbr> format."
13117 #: ../fish/guestfish-actions.pod:3744 ../src/guestfs-actions.pod:5853
13122 #: ../fish/guestfish-actions.pod:3746 ../src/guestfs-actions.pod:5855
13127 #: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5857
13129 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
13130 "Windows. This partition type will B<only> work for device sizes up to 2 "
13131 "TB. For large disks we recommend using C<gpt>."
13135 #: ../fish/guestfish-actions.pod:3755 ../src/guestfs-actions.pod:5864
13136 msgid "Other partition table types that may work but are not supported include:"
13140 #: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5869
13145 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5871
13146 msgid "AIX disk labels."
13150 #: ../fish/guestfish-actions.pod:3764 ../src/guestfs-actions.pod:5873
13155 #: ../fish/guestfish-actions.pod:3766 ../src/guestfs-actions.pod:5875
13160 #: ../fish/guestfish-actions.pod:3768 ../src/guestfs-actions.pod:5877
13161 msgid "Amiga \"Rigid Disk Block\" format."
13165 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5879
13170 #: ../fish/guestfish-actions.pod:3772 ../src/guestfs-actions.pod:5881
13171 msgid "BSD disk labels."
13175 #: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5883
13180 #: ../fish/guestfish-actions.pod:3776 ../src/guestfs-actions.pod:5885
13181 msgid "DASD, used on IBM mainframes."
13185 #: ../fish/guestfish-actions.pod:3778 ../src/guestfs-actions.pod:5887
13190 #: ../fish/guestfish-actions.pod:3780 ../src/guestfs-actions.pod:5889
13191 msgid "MIPS/SGI volumes."
13195 #: ../fish/guestfish-actions.pod:3782 ../src/guestfs-actions.pod:5891
13200 #: ../fish/guestfish-actions.pod:3784 ../src/guestfs-actions.pod:5893
13201 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13205 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5895
13210 #: ../fish/guestfish-actions.pod:3788 ../src/guestfs-actions.pod:5897
13211 msgid "NEC PC-98 format, common in Japan apparently."
13215 #: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5899
13220 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5901
13221 msgid "Sun disk labels."
13225 #: ../fish/guestfish-actions.pod:3796
13230 #: ../fish/guestfish-actions.pod:3798
13233 " part-list device\n"
13238 #: ../fish/guestfish-actions.pod:3800 ../src/guestfs-actions.pod:5915
13240 "This command parses the partition table on C<device> and returns the list of "
13241 "partitions found."
13245 #: ../fish/guestfish-actions.pod:3803 ../src/guestfs-actions.pod:5918
13246 msgid "The fields in the returned structure are:"
13250 #: ../fish/guestfish-actions.pod:3807 ../src/guestfs-actions.pod:5922
13251 msgid "B<part_num>"
13255 #: ../fish/guestfish-actions.pod:3809 ../src/guestfs-actions.pod:5924
13256 msgid "Partition number, counting from 1."
13260 #: ../fish/guestfish-actions.pod:3811 ../src/guestfs-actions.pod:5926
13261 msgid "B<part_start>"
13265 #: ../fish/guestfish-actions.pod:3813
13267 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13268 "the device's sector size, see L</blockdev-getss>."
13272 #: ../fish/guestfish-actions.pod:3816 ../src/guestfs-actions.pod:5931
13273 msgid "B<part_end>"
13277 #: ../fish/guestfish-actions.pod:3818 ../src/guestfs-actions.pod:5933
13278 msgid "End of the partition in bytes."
13282 #: ../fish/guestfish-actions.pod:3820 ../src/guestfs-actions.pod:5935
13283 msgid "B<part_size>"
13287 #: ../fish/guestfish-actions.pod:3822 ../src/guestfs-actions.pod:5937
13288 msgid "Size of the partition in bytes."
13292 #: ../fish/guestfish-actions.pod:3826
13293 msgid "part-set-bootable"
13297 #: ../fish/guestfish-actions.pod:3828
13300 " part-set-bootable device partnum true|false\n"
13305 #: ../fish/guestfish-actions.pod:3830 ../src/guestfs-actions.pod:5955
13307 "This sets the bootable flag on partition numbered C<partnum> on device "
13308 "C<device>. Note that partitions are numbered from 1."
13312 #: ../fish/guestfish-actions.pod:3833 ../src/guestfs-actions.pod:5958
13314 "The bootable flag is used by some operating systems (notably Windows) to "
13315 "determine which partition to boot from. It is by no means universally "
13320 #: ../fish/guestfish-actions.pod:3837
13321 msgid "part-set-mbr-id"
13325 #: ../fish/guestfish-actions.pod:3839
13328 " part-set-mbr-id device partnum idbyte\n"
13333 #: ../fish/guestfish-actions.pod:3841 ../src/guestfs-actions.pod:5974
13335 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13336 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13337 "documentation are in fact hexadecimal numbers, but usually documented "
13338 "without any leading \"0x\" which might be confusing."
13342 #: ../fish/guestfish-actions.pod:3851
13343 msgid "part-set-name"
13347 #: ../fish/guestfish-actions.pod:3853
13350 " part-set-name device partnum name\n"
13355 #: ../fish/guestfish-actions.pod:3855 ../src/guestfs-actions.pod:5996
13357 "This sets the partition name on partition numbered C<partnum> on device "
13358 "C<device>. Note that partitions are numbered from 1."
13362 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5999
13364 "The partition name can only be set on certain types of partition table. "
13365 "This works on C<gpt> but not on C<mbr> partitions."
13369 #: ../fish/guestfish-actions.pod:3861
13370 msgid "part-to-dev"
13374 #: ../fish/guestfish-actions.pod:3863
13377 " part-to-dev partition\n"
13382 #: ../fish/guestfish-actions.pod:3865 ../src/guestfs-actions.pod:6012
13384 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13385 "partition number, returning the device name (eg. \"/dev/sdb\")."
13389 #: ../fish/guestfish-actions.pod:3869 ../fish/guestfish-actions.pod:3881
13391 "The named partition must exist, for example as a string returned from "
13392 "L</list-partitions>."
13396 #: ../fish/guestfish-actions.pod:3872
13397 msgid "See also L</part-to-partnum>."
13401 #: ../fish/guestfish-actions.pod:3874
13402 msgid "part-to-partnum"
13406 #: ../fish/guestfish-actions.pod:3876
13409 " part-to-partnum partition\n"
13414 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:6032
13416 "This function takes a partition name (eg. \"/dev/sdb1\") and returns the "
13417 "partition number (eg. C<1>)."
13421 #: ../fish/guestfish-actions.pod:3884
13422 msgid "See also L</part-to-dev>."
13426 #: ../fish/guestfish-actions.pod:3886
13427 msgid "ping-daemon"
13431 #: ../fish/guestfish-actions.pod:3888
13439 #: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:6049
13441 "This is a test probe into the guestfs daemon running inside the qemu "
13442 "subprocess. Calling this function checks that the daemon responds to the "
13443 "ping message, without affecting the daemon or attached block device(s) in "
13448 #: ../fish/guestfish-actions.pod:3895
13453 #: ../fish/guestfish-actions.pod:3897
13456 " pread path count offset\n"
13461 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:6067
13463 "This command lets you read part of a file. It reads C<count> bytes of the "
13464 "file, starting at C<offset>, from file C<path>."
13468 #: ../fish/guestfish-actions.pod:3902 ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6096
13470 "This may read fewer bytes than requested. For further details see the "
13471 "L<pread(2)> system call."
13475 #: ../fish/guestfish-actions.pod:3905
13476 msgid "See also L</pwrite>, L</pread-device>."
13480 #: ../fish/guestfish-actions.pod:3910
13481 msgid "pread-device"
13485 #: ../fish/guestfish-actions.pod:3912
13488 " pread-device device count offset\n"
13493 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:6093
13495 "This command lets you read part of a file. It reads C<count> bytes of "
13496 "C<device>, starting at C<offset>."
13500 #: ../fish/guestfish-actions.pod:3920
13501 msgid "See also L</pread>."
13505 #: ../fish/guestfish-actions.pod:3925
13510 #: ../fish/guestfish-actions.pod:3927
13513 " pvcreate device\n"
13518 #: ../fish/guestfish-actions.pod:3929 ../src/guestfs-actions.pod:6116
13520 "This creates an LVM physical volume on the named C<device>, where C<device> "
13521 "should usually be a partition name such as C</dev/sda1>."
13525 #: ../fish/guestfish-actions.pod:3933
13530 #: ../fish/guestfish-actions.pod:3935
13533 " pvremove device\n"
13538 #: ../fish/guestfish-actions.pod:3937 ../src/guestfs-actions.pod:6130
13540 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13545 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:6133
13547 "The implementation uses the C<pvremove> command which refuses to wipe "
13548 "physical volumes that contain any volume groups, so you have to remove those "
13553 #: ../fish/guestfish-actions.pod:3944
13558 #: ../fish/guestfish-actions.pod:3946
13561 " pvresize device\n"
13566 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6147
13568 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13569 "the new size of the underlying device."
13573 #: ../fish/guestfish-actions.pod:3951
13574 msgid "pvresize-size"
13578 #: ../fish/guestfish-actions.pod:3953
13581 " pvresize-size device size\n"
13586 #: ../fish/guestfish-actions.pod:3955
13588 "This command is the same as L</pvresize> except that it allows you to "
13589 "specify the new size (in bytes) explicitly."
13593 #: ../fish/guestfish-actions.pod:3958
13598 #: ../fish/guestfish-actions.pod:3960
13606 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6173
13608 "List all the physical volumes detected. This is the equivalent of the "
13609 "L<pvs(8)> command."
13613 #: ../fish/guestfish-actions.pod:3965 ../src/guestfs-actions.pod:6176
13615 "This returns a list of just the device names that contain PVs "
13616 "(eg. C</dev/sda2>)."
13620 #: ../fish/guestfish-actions.pod:3968
13621 msgid "See also L</pvs-full>."
13625 #: ../fish/guestfish-actions.pod:3970
13630 #: ../fish/guestfish-actions.pod:3972
13638 #: ../fish/guestfish-actions.pod:3974 ../src/guestfs-actions.pod:6192
13640 "List all the physical volumes detected. This is the equivalent of the "
13641 "L<pvs(8)> command. The \"full\" version includes all fields."
13645 #: ../fish/guestfish-actions.pod:3977
13650 #: ../fish/guestfish-actions.pod:3979
13658 #: ../fish/guestfish-actions.pod:3981 ../src/guestfs-actions.pod:6207
13659 msgid "This command returns the UUID of the LVM PV C<device>."
13663 #: ../fish/guestfish-actions.pod:3983
13668 #: ../fish/guestfish-actions.pod:3985
13671 " pwrite path content offset\n"
13676 #: ../fish/guestfish-actions.pod:3987 ../src/guestfs-actions.pod:6223
13678 "This command writes to part of a file. It writes the data buffer C<content> "
13679 "to the file C<path> starting at offset C<offset>."
13683 #: ../fish/guestfish-actions.pod:3990 ../src/guestfs-actions.pod:6226
13685 "This command implements the L<pwrite(2)> system call, and like that system "
13686 "call it may not write the full data requested. The return value is the "
13687 "number of bytes that were actually written to the file. This could even be "
13688 "0, although short writes are unlikely for regular files in ordinary "
13693 #: ../fish/guestfish-actions.pod:3996
13694 msgid "See also L</pread>, L</pwrite-device>."
13698 #: ../fish/guestfish-actions.pod:4001
13699 msgid "pwrite-device"
13703 #: ../fish/guestfish-actions.pod:4003
13706 " pwrite-device device content offset\n"
13711 #: ../fish/guestfish-actions.pod:4005 ../src/guestfs-actions.pod:6250
13713 "This command writes to part of a device. It writes the data buffer "
13714 "C<content> to C<device> starting at offset C<offset>."
13718 #: ../fish/guestfish-actions.pod:4008 ../src/guestfs-actions.pod:6253
13720 "This command implements the L<pwrite(2)> system call, and like that system "
13721 "call it may not write the full data requested (although short writes to disk "
13722 "devices and partitions are probably impossible with standard Linux kernels)."
13726 #: ../fish/guestfish-actions.pod:4013
13727 msgid "See also L</pwrite>."
13731 #: ../fish/guestfish-actions.pod:4018
13736 #: ../fish/guestfish-actions.pod:4020
13739 " read-file path\n"
13744 #: ../fish/guestfish-actions.pod:4022 ../src/guestfs-actions.pod:6274
13745 msgid "This calls returns the contents of the file C<path> as a buffer."
13749 #: ../fish/guestfish-actions.pod:4025
13751 "Unlike L</cat>, this function can correctly handle files that contain "
13752 "embedded ASCII NUL characters. However unlike L</download>, this function "
13753 "is limited in the total size of file that can be handled."
13757 #: ../fish/guestfish-actions.pod:4033
13762 #: ../fish/guestfish-actions.pod:4035
13765 " read-lines path\n"
13770 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6299
13772 "The file contents are returned as a list of lines. Trailing C<LF> and "
13773 "C<CRLF> character sequences are I<not> returned."
13777 #: ../fish/guestfish-actions.pod:4042
13779 "Note that this function cannot correctly handle binary files (specifically, "
13780 "files containing C<\\0> character which is treated as end of line). For "
13781 "those you need to use the L</read-file> function which has a more complex "
13786 #: ../fish/guestfish-actions.pod:4047
13791 #: ../fish/guestfish-actions.pod:4049
13799 #: ../fish/guestfish-actions.pod:4051 ../src/guestfs-actions.pod:6319
13800 msgid "This returns the list of directory entries in directory C<dir>."
13804 #: ../fish/guestfish-actions.pod:4053 ../src/guestfs-actions.pod:6321
13806 "All entries in the directory are returned, including C<.> and C<..>. The "
13807 "entries are I<not> sorted, but returned in the same order as the underlying "
13812 #: ../fish/guestfish-actions.pod:4057 ../src/guestfs-actions.pod:6325
13814 "Also this call returns basic file type information about each file. The "
13815 "C<ftyp> field will contain one of the following characters:"
13819 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6330
13824 #: ../fish/guestfish-actions.pod:4064 ../src/guestfs-actions.pod:6332
13825 msgid "Block special"
13829 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6334
13834 #: ../fish/guestfish-actions.pod:4068 ../src/guestfs-actions.pod:6336
13835 msgid "Char special"
13839 #: ../fish/guestfish-actions.pod:4070 ../src/guestfs-actions.pod:6338
13844 #: ../fish/guestfish-actions.pod:4072 ../src/guestfs-actions.pod:6340
13849 #: ../fish/guestfish-actions.pod:4074 ../src/guestfs-actions.pod:6342
13854 #: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6344
13855 msgid "FIFO (named pipe)"
13859 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6346
13864 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6348
13865 msgid "Symbolic link"
13869 #: ../fish/guestfish-actions.pod:4082 ../src/guestfs-actions.pod:6350
13874 #: ../fish/guestfish-actions.pod:4084 ../src/guestfs-actions.pod:6352
13875 msgid "Regular file"
13879 #: ../fish/guestfish-actions.pod:4086 ../src/guestfs-actions.pod:6354
13884 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6356
13889 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6358
13894 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6360
13895 msgid "Unknown file type"
13899 #: ../fish/guestfish-actions.pod:4094 ../src/guestfs-actions.pod:6362
13904 #: ../fish/guestfish-actions.pod:4096 ../src/guestfs-actions.pod:6364
13905 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13909 #: ../fish/guestfish-actions.pod:4101
13911 "This function is primarily intended for use by programs. To get a simple "
13912 "list of names, use L</ls>. To get a printable directory for human "
13913 "consumption, use L</ll>."
13917 #: ../fish/guestfish-actions.pod:4105
13922 #: ../fish/guestfish-actions.pod:4107
13930 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6385
13931 msgid "This command reads the target of a symbolic link."
13935 #: ../fish/guestfish-actions.pod:4111
13936 msgid "readlinklist"
13940 #: ../fish/guestfish-actions.pod:4113
13943 " readlinklist path 'names ...'\n"
13948 #: ../fish/guestfish-actions.pod:4115 ../src/guestfs-actions.pod:6399
13950 "This call allows you to do a C<readlink> operation on multiple files, where "
13951 "all files are in the directory C<path>. C<names> is the list of files from "
13956 #: ../fish/guestfish-actions.pod:4119 ../src/guestfs-actions.pod:6403
13958 "On return you get a list of strings, with a one-to-one correspondence to the "
13959 "C<names> list. Each string is the value of the symbolic link."
13963 #: ../fish/guestfish-actions.pod:4123 ../src/guestfs-actions.pod:6407
13965 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13966 "result string is the empty string C<\"\">. However the whole operation is "
13967 "completed even if there were C<readlink(2)> errors, and so you can call this "
13968 "function with names where you don't know if they are symbolic links already "
13969 "(albeit slightly less efficient)."
13973 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6414
13975 "This call is intended for programs that want to efficiently list a directory "
13976 "contents without making many round-trips. Very long directory listings "
13977 "might cause the protocol message size to be exceeded, causing this call to "
13978 "fail. The caller must split up such requests into smaller groups of names."
13982 #: ../fish/guestfish-actions.pod:4137
13987 #: ../fish/guestfish-actions.pod:4139
13995 #: ../fish/guestfish-actions.pod:4141 ../src/guestfs-actions.pod:6433
13997 "Return the canonicalized absolute pathname of C<path>. The returned path "
13998 "has no C<.>, C<..> or symbolic link path elements."
14002 #: ../fish/guestfish-actions.pod:4144
14003 msgid "removexattr"
14007 #: ../fish/guestfish-actions.pod:4146
14010 " removexattr xattr path\n"
14015 #: ../fish/guestfish-actions.pod:4148 ../src/guestfs-actions.pod:6448
14016 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
14020 #: ../fish/guestfish-actions.pod:4151
14021 msgid "See also: L</lremovexattr>, L<attr(5)>."
14025 #: ../fish/guestfish-actions.pod:4153
14030 #: ../fish/guestfish-actions.pod:4155
14033 " resize2fs device\n"
14038 #: ../fish/guestfish-actions.pod:4157 ../src/guestfs-actions.pod:6463
14040 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
14041 "underlying device."
14045 #: ../fish/guestfish-actions.pod:4160
14047 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
14048 "before calling this command. For unknown reasons C<resize2fs> sometimes "
14049 "gives an error about this and sometimes not. In any case, it is always safe "
14050 "to call L</e2fsck-f> before calling this function."
14054 #: ../fish/guestfish-actions.pod:4166
14055 msgid "resize2fs-M"
14059 #: ../fish/guestfish-actions.pod:4168
14062 " resize2fs-M device\n"
14067 #: ../fish/guestfish-actions.pod:4170
14069 "This command is the same as L</resize2fs>, but the filesystem is resized to "
14070 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
14075 #: ../fish/guestfish-actions.pod:4174
14077 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
14078 "and read the C<Block size> and C<Block count> values. These two numbers, "
14079 "multiplied together, give the resulting size of the minimal filesystem in "
14084 #: ../fish/guestfish-actions.pod:4179
14085 msgid "resize2fs-size"
14089 #: ../fish/guestfish-actions.pod:4181
14092 " resize2fs-size device size\n"
14097 #: ../fish/guestfish-actions.pod:4183
14099 "This command is the same as L</resize2fs> except that it allows you to "
14100 "specify the new size (in bytes) explicitly."
14104 #: ../fish/guestfish-actions.pod:4186
14109 #: ../fish/guestfish-actions.pod:4188
14117 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6515
14118 msgid "Remove the single file C<path>."
14122 #: ../fish/guestfish-actions.pod:4192
14127 #: ../fish/guestfish-actions.pod:4194
14135 #: ../fish/guestfish-actions.pod:4196 ../src/guestfs-actions.pod:6527
14137 "Remove the file or directory C<path>, recursively removing the contents if "
14138 "its a directory. This is like the C<rm -rf> shell command."
14142 #: ../fish/guestfish-actions.pod:4200
14147 #: ../fish/guestfish-actions.pod:4202
14155 #: ../fish/guestfish-actions.pod:4204 ../src/guestfs-actions.pod:6541
14156 msgid "Remove the single directory C<path>."
14160 #: ../fish/guestfish-actions.pod:4206
14161 msgid "rmmountpoint"
14165 #: ../fish/guestfish-actions.pod:4208
14168 " rmmountpoint exemptpath\n"
14173 #: ../fish/guestfish-actions.pod:4210
14175 "This calls removes a mountpoint that was previously created with "
14176 "L</mkmountpoint>. See L</mkmountpoint> for full details."
14180 #: ../fish/guestfish-actions.pod:4214
14181 msgid "scrub-device"
14185 #: ../fish/guestfish-actions.pod:4216
14188 " scrub-device device\n"
14193 #: ../fish/guestfish-actions.pod:4218 ../src/guestfs-actions.pod:6567
14195 "This command writes patterns over C<device> to make data retrieval more "
14200 #: ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6570 ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6607
14202 "It is an interface to the L<scrub(1)> program. See that manual page for "
14207 #: ../fish/guestfish-actions.pod:4224
14212 #: ../fish/guestfish-actions.pod:4226
14215 " scrub-file file\n"
14220 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6583
14222 "This command writes patterns over a file to make data retrieval more "
14227 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6586
14228 msgid "The file is I<removed> after scrubbing."
14232 #: ../fish/guestfish-actions.pod:4236
14233 msgid "scrub-freespace"
14237 #: ../fish/guestfish-actions.pod:4238
14240 " scrub-freespace dir\n"
14245 #: ../fish/guestfish-actions.pod:4240
14247 "This command creates the directory C<dir> and then fills it with files until "
14248 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
14249 "deletes them. The intention is to scrub any free space on the partition "
14250 "containing C<dir>."
14254 #: ../fish/guestfish-actions.pod:4249
14259 #: ../fish/guestfish-actions.pod:4251
14264 #: ../fish/guestfish-actions.pod:4253
14267 " set-append append\n"
14272 #: ../fish/guestfish-actions.pod:4255 ../src/guestfs-actions.pod:6620
14274 "This function is used to add additional options to the guest kernel command "
14279 #: ../fish/guestfish-actions.pod:4258 ../src/guestfs-actions.pod:6623
14281 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14282 "environment variable."
14286 #: ../fish/guestfish-actions.pod:4261 ../src/guestfs-actions.pod:6626
14288 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14289 "(libguestfs always adds a few of its own)."
14293 #: ../fish/guestfish-actions.pod:4264
14294 msgid "set-attach-method"
14298 #: ../fish/guestfish-actions.pod:4266
14299 msgid "attach-method"
14303 #: ../fish/guestfish-actions.pod:4268
14306 " set-attach-method attachmethod\n"
14311 #: ../fish/guestfish-actions.pod:4270 ../src/guestfs-actions.pod:6639
14313 "Set the method that libguestfs uses to connect to the back end guestfsd "
14314 "daemon. Possible methods are:"
14318 #: ../fish/guestfish-actions.pod:4275 ../src/guestfs-actions.pod:6644 ../src/guestfs.pod:2916
14319 msgid "C<appliance>"
14323 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6646
14325 "Launch an appliance and connect to it. This is the ordinary method and the "
14330 #: ../fish/guestfish-actions.pod:4280 ../src/guestfs-actions.pod:6649
14331 msgid "C<unix:I<path>>"
14335 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6651
14336 msgid "Connect to the Unix domain socket I<path>."
14340 #: ../fish/guestfish-actions.pod:4284 ../src/guestfs-actions.pod:6653
14342 "This method lets you connect to an existing daemon or (using virtio-serial) "
14343 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
14344 "RUNNING DAEMONS>."
14348 #: ../fish/guestfish-actions.pod:4290
14349 msgid "set-autosync"
14353 #: ../fish/guestfish-actions.pod:4292
14358 #: ../fish/guestfish-actions.pod:4294
14361 " set-autosync true|false\n"
14366 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6669
14368 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14369 "effort attempt to make filesystems consistent and synchronized when the "
14370 "handle is closed (also if the program exits without closing handles)."
14374 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6674
14376 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14377 "disabled by default)."
14381 #: ../fish/guestfish-actions.pod:4304
14386 #: ../fish/guestfish-actions.pod:4306
14391 #: ../fish/guestfish-actions.pod:4308
14394 " set-direct true|false\n"
14399 #: ../fish/guestfish-actions.pod:4310 ../src/guestfs-actions.pod:6687
14401 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14402 "passed directly through to the appliance once it is launched."
14406 #: ../fish/guestfish-actions.pod:4314
14408 "One consequence of this is that log messages aren't caught by the library "
14409 "and handled by L</set-log-message-callback>, but go straight to stdout."
14413 #: ../fish/guestfish-actions.pod:4318 ../src/guestfs-actions.pod:6695
14414 msgid "You probably don't want to use this unless you know what you are doing."
14418 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6698
14419 msgid "The default is disabled."
14423 #: ../fish/guestfish-actions.pod:4323
14424 msgid "set-e2label"
14428 #: ../fish/guestfish-actions.pod:4325
14431 " set-e2label device label\n"
14436 #: ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:6711
14438 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14439 "C<label>. Filesystem labels are limited to 16 characters."
14443 #: ../fish/guestfish-actions.pod:4331
14445 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
14446 "label on a filesystem."
14450 #: ../fish/guestfish-actions.pod:4334
14455 #: ../fish/guestfish-actions.pod:4336
14458 " set-e2uuid device uuid\n"
14463 #: ../fish/guestfish-actions.pod:4338 ../src/guestfs-actions.pod:6729
14465 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14466 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14467 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14471 #: ../fish/guestfish-actions.pod:4343
14473 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
14474 "UUID of a filesystem."
14478 #: ../fish/guestfish-actions.pod:4346
14479 msgid "set-memsize"
14483 #: ../fish/guestfish-actions.pod:4348
14488 #: ../fish/guestfish-actions.pod:4350
14491 " set-memsize memsize\n"
14496 #: ../fish/guestfish-actions.pod:4352
14498 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14499 "This only has any effect if called before L</launch>."
14503 #: ../fish/guestfish-actions.pod:4356 ../src/guestfs-actions.pod:6751
14505 "You can also change this by setting the environment variable "
14506 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14510 #: ../fish/guestfish-actions.pod:4363
14511 msgid "set-network"
14515 #: ../fish/guestfish-actions.pod:4365
14520 #: ../fish/guestfish-actions.pod:4367
14523 " set-network true|false\n"
14528 #: ../fish/guestfish-actions.pod:4369 ../src/guestfs-actions.pod:6768
14530 "If C<network> is true, then the network is enabled in the libguestfs "
14531 "appliance. The default is false."
14535 #: ../fish/guestfish-actions.pod:4372 ../src/guestfs-actions.pod:6771
14537 "This affects whether commands are able to access the network (see "
14538 "L<guestfs(3)/RUNNING COMMANDS>)."
14542 #: ../fish/guestfish-actions.pod:4375
14543 msgid "You must call this before calling L</launch>, otherwise it has no effect."
14547 #: ../fish/guestfish-actions.pod:4378
14552 #: ../fish/guestfish-actions.pod:4382
14555 " set-path searchpath\n"
14560 #: ../fish/guestfish-actions.pod:4384 ../src/guestfs-actions.pod:6787
14561 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14565 #: ../fish/guestfish-actions.pod:4386 ../src/guestfs-actions.pod:6789
14567 "The default is C<$libdir/guestfs> unless overridden by setting "
14568 "C<LIBGUESTFS_PATH> environment variable."
14572 #: ../fish/guestfish-actions.pod:4389 ../src/guestfs-actions.pod:6792
14573 msgid "Setting C<path> to C<NULL> restores the default path."
14577 #: ../fish/guestfish-actions.pod:4391
14582 #: ../fish/guestfish-actions.pod:4393
14587 #: ../fish/guestfish-actions.pod:4395
14590 " set-pgroup true|false\n"
14595 #: ../fish/guestfish-actions.pod:4397 ../src/guestfs-actions.pod:6804
14597 "If C<pgroup> is true, child processes are placed into their own process "
14602 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6807
14604 "The practical upshot of this is that signals like C<SIGINT> (from users "
14605 "pressing C<^C>) won't be received by the child process."
14609 #: ../fish/guestfish-actions.pod:4403 ../src/guestfs-actions.pod:6810
14611 "The default for this flag is false, because usually you want C<^C> to kill "
14616 #: ../fish/guestfish-actions.pod:4406
14621 #: ../fish/guestfish-actions.pod:4408
14626 #: ../fish/guestfish-actions.pod:4410
14634 #: ../fish/guestfish-actions.pod:4412 ../src/guestfs-actions.pod:6823
14635 msgid "Set the qemu binary that we will use."
14639 #: ../fish/guestfish-actions.pod:4414 ../src/guestfs-actions.pod:6825
14640 msgid "The default is chosen when the library was compiled by the configure script."
14644 #: ../fish/guestfish-actions.pod:4417 ../src/guestfs-actions.pod:6828
14646 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14651 #: ../fish/guestfish-actions.pod:4420 ../src/guestfs-actions.pod:6831
14652 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14656 #: ../fish/guestfish-actions.pod:4422 ../src/guestfs-actions.pod:6833
14658 "Note that you should call this function as early as possible after creating "
14659 "the handle. This is because some pre-launch operations depend on testing "
14660 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14661 "don't retest features, and so you might see inconsistent results. Using the "
14662 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14663 "the qemu binary at the same time as the handle is created."
14667 #: ../fish/guestfish-actions.pod:4430
14668 msgid "set-recovery-proc"
14672 #: ../fish/guestfish-actions.pod:4432
14673 msgid "recovery-proc"
14677 #: ../fish/guestfish-actions.pod:4434
14680 " set-recovery-proc true|false\n"
14685 #: ../fish/guestfish-actions.pod:4436
14687 "If this is called with the parameter C<false> then L</launch> does not "
14688 "create a recovery process. The purpose of the recovery process is to stop "
14689 "runaway qemu processes in the case where the main program aborts abruptly."
14693 #: ../fish/guestfish-actions.pod:4441
14695 "This only has any effect if called before L</launch>, and the default is "
14700 #: ../fish/guestfish-actions.pod:4444 ../src/guestfs-actions.pod:6859
14702 "About the only time when you would want to disable this is if the main "
14703 "process will fork itself into the background (\"daemonize\" itself). In "
14704 "this case the recovery process thinks that the main program has disappeared "
14705 "and so kills qemu, which is not very helpful."
14709 #: ../fish/guestfish-actions.pod:4450
14710 msgid "set-selinux"
14714 #: ../fish/guestfish-actions.pod:4452
14719 #: ../fish/guestfish-actions.pod:4454
14722 " set-selinux true|false\n"
14727 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6875
14729 "This sets the selinux flag that is passed to the appliance at boot time. "
14730 "The default is C<selinux=0> (disabled)."
14734 #: ../fish/guestfish-actions.pod:4459 ../src/guestfs-actions.pod:6878
14736 "Note that if SELinux is enabled, it is always in Permissive mode "
14737 "(C<enforcing=0>)."
14741 #: ../fish/guestfish-actions.pod:4465
14746 #: ../fish/guestfish-actions.pod:4467
14751 #: ../fish/guestfish-actions.pod:4469
14759 #: ../fish/guestfish-actions.pod:4471 ../src/guestfs-actions.pod:6894
14761 "Change the number of virtual CPUs assigned to the appliance. The default is "
14762 "C<1>. Increasing this may improve performance, though often it has no "
14767 #: ../fish/guestfish-actions.pod:4475
14768 msgid "This function must be called before L</launch>."
14772 #: ../fish/guestfish-actions.pod:4477
14777 #: ../fish/guestfish-actions.pod:4479
14782 #: ../fish/guestfish-actions.pod:4481
14785 " set-trace true|false\n"
14790 #: ../fish/guestfish-actions.pod:4483 ../src/guestfs-actions.pod:6910
14792 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
14793 "return values are traced."
14797 #: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6913
14799 "If you want to trace C API calls into libguestfs (and other libraries) then "
14800 "possibly a better way is to use the external ltrace(1) command."
14804 #: ../fish/guestfish-actions.pod:4490 ../src/guestfs-actions.pod:6917
14806 "Command traces are disabled unless the environment variable "
14807 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14811 #: ../fish/guestfish-actions.pod:4493
14813 "Trace messages are normally sent to C<stderr>, unless you register a "
14814 "callback to send them somewhere else (see L</set-event-callback>)."
14818 #: ../fish/guestfish-actions.pod:4497
14819 msgid "set-verbose"
14823 #: ../fish/guestfish-actions.pod:4499
14828 #: ../fish/guestfish-actions.pod:4501
14831 " set-verbose true|false\n"
14836 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6934
14837 msgid "If C<verbose> is true, this turns on verbose messages."
14841 #: ../fish/guestfish-actions.pod:4505 ../src/guestfs-actions.pod:6936
14843 "Verbose messages are disabled unless the environment variable "
14844 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14848 #: ../fish/guestfish-actions.pod:4508
14850 "Verbose messages are normally sent to C<stderr>, unless you register a "
14851 "callback to send them somewhere else (see L</set-event-callback>)."
14855 #: ../fish/guestfish-actions.pod:4512
14860 #: ../fish/guestfish-actions.pod:4514
14863 " setcon context\n"
14868 #: ../fish/guestfish-actions.pod:4516 ../src/guestfs-actions.pod:6953
14870 "This sets the SELinux security context of the daemon to the string "
14875 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6956
14876 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14880 #: ../fish/guestfish-actions.pod:4521
14885 #: ../fish/guestfish-actions.pod:4523
14888 " setxattr xattr val vallen path\n"
14893 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6971
14895 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14896 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14900 #: ../fish/guestfish-actions.pod:4529
14901 msgid "See also: L</lsetxattr>, L<attr(5)>."
14905 #: ../fish/guestfish-actions.pod:4531
14910 #: ../fish/guestfish-actions.pod:4533
14913 " sfdisk device cyls heads sectors 'lines ...'\n"
14918 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6998
14920 "This is a direct interface to the L<sfdisk(8)> program for creating "
14921 "partitions on block devices."
14925 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:7001
14926 msgid "C<device> should be a block device, for example C</dev/sda>."
14930 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:7003
14932 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14933 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14934 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14935 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14936 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14937 "the kernel) cannot work out the right geometry and you will need to tell it."
14941 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:7011
14943 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14944 "refer to the L<sfdisk(8)> manpage."
14948 #: ../fish/guestfish-actions.pod:4551 ../src/guestfs-actions.pod:7014
14950 "To create a single partition occupying the whole disk, you would pass "
14951 "C<lines> as a single element list, when the single element being the string "
14956 #: ../fish/guestfish-actions.pod:4555
14957 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
14961 #: ../fish/guestfish-actions.pod:4558 ../fish/guestfish-actions.pod:4578 ../fish/guestfish-actions.pod:4597
14963 "I<This function is deprecated.> In new code, use the L</part_add> call "
14968 #: ../fish/guestfish-actions.pod:4565
14973 #: ../fish/guestfish-actions.pod:4567
14976 " sfdiskM device 'lines ...'\n"
14981 #: ../fish/guestfish-actions.pod:4569
14983 "This is a simplified interface to the L</sfdisk> command, where partition "
14984 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
14985 "you don't need to specify the cyls, heads and sectors parameters which were "
14986 "rarely if ever used anyway."
14990 #: ../fish/guestfish-actions.pod:4575
14991 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
14995 #: ../fish/guestfish-actions.pod:4585
15000 #: ../fish/guestfish-actions.pod:4587
15003 " sfdisk-N device partnum cyls heads sectors line\n"
15008 #: ../fish/guestfish-actions.pod:4589 ../src/guestfs-actions.pod:7070
15010 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
15011 "(note: C<n> counts from 1)."
15015 #: ../fish/guestfish-actions.pod:4592
15017 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
15018 "cyls/heads/sectors parameters."
15022 #: ../fish/guestfish-actions.pod:4595
15023 msgid "See also: L</part-add>"
15027 #: ../fish/guestfish-actions.pod:4604
15028 msgid "sfdisk-disk-geometry"
15032 #: ../fish/guestfish-actions.pod:4606
15035 " sfdisk-disk-geometry device\n"
15040 #: ../fish/guestfish-actions.pod:4608
15042 "This displays the disk geometry of C<device> read from the partition table. "
15043 "Especially in the case where the underlying block device has been resized, "
15044 "this can be different from the kernel's idea of the geometry (see "
15045 "L</sfdisk-kernel-geometry>)."
15049 #: ../fish/guestfish-actions.pod:4613 ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7109
15050 msgid "The result is in human-readable format, and not designed to be parsed."
15054 #: ../fish/guestfish-actions.pod:4616
15055 msgid "sfdisk-kernel-geometry"
15059 #: ../fish/guestfish-actions.pod:4618
15062 " sfdisk-kernel-geometry device\n"
15067 #: ../fish/guestfish-actions.pod:4620 ../src/guestfs-actions.pod:7107
15068 msgid "This displays the kernel's idea of the geometry of C<device>."
15072 #: ../fish/guestfish-actions.pod:4625
15077 #: ../fish/guestfish-actions.pod:4627
15080 " sfdisk-l device\n"
15085 #: ../fish/guestfish-actions.pod:4629 ../src/guestfs-actions.pod:7130
15087 "This displays the partition table on C<device>, in the human-readable output "
15088 "of the L<sfdisk(8)> command. It is not intended to be parsed."
15092 #: ../fish/guestfish-actions.pod:4633
15093 msgid "See also: L</part-list>"
15097 #: ../fish/guestfish-actions.pod:4635
15099 "I<This function is deprecated.> In new code, use the L</part_list> call "
15104 #: ../fish/guestfish-actions.pod:4642
15109 #: ../fish/guestfish-actions.pod:4644
15117 #: ../fish/guestfish-actions.pod:4646 ../src/guestfs-actions.pod:7147
15119 "This call runs a command from the guest filesystem via the guest's "
15124 #: ../fish/guestfish-actions.pod:4649
15125 msgid "This is like L</command>, but passes the command to:"
15129 #: ../fish/guestfish-actions.pod:4651 ../src/guestfs-actions.pod:7152
15132 " /bin/sh -c \"command\"\n"
15137 #: ../fish/guestfish-actions.pod:4653 ../src/guestfs-actions.pod:7154
15139 "Depending on the guest's shell, this usually results in wildcards being "
15140 "expanded, shell expressions being interpolated and so on."
15144 #: ../fish/guestfish-actions.pod:4657
15145 msgid "All the provisos about L</command> apply to this call."
15149 #: ../fish/guestfish-actions.pod:4659
15154 #: ../fish/guestfish-actions.pod:4661
15157 " sh-lines command\n"
15162 #: ../fish/guestfish-actions.pod:4663
15163 msgid "This is the same as L</sh>, but splits the result into a list of lines."
15167 #: ../fish/guestfish-actions.pod:4666
15168 msgid "See also: L</command-lines>"
15172 #: ../fish/guestfish-actions.pod:4668
15177 #: ../fish/guestfish-actions.pod:4670
15185 #: ../fish/guestfish-actions.pod:4672 ../src/guestfs-actions.pod:7188
15186 msgid "Sleep for C<secs> seconds."
15190 #: ../fish/guestfish-actions.pod:4674
15195 #: ../fish/guestfish-actions.pod:4676
15203 #: ../fish/guestfish-actions.pod:4680 ../src/guestfs-actions.pod:7202
15204 msgid "This is the same as the C<stat(2)> system call."
15208 #: ../fish/guestfish-actions.pod:4682
15213 #: ../fish/guestfish-actions.pod:4684
15221 #: ../fish/guestfish-actions.pod:4686 ../src/guestfs-actions.pod:7216
15223 "Returns file system statistics for any mounted file system. C<path> should "
15224 "be a file or directory in the mounted file system (typically it is the mount "
15225 "point itself, but it doesn't need to be)."
15229 #: ../fish/guestfish-actions.pod:4690 ../src/guestfs-actions.pod:7220
15230 msgid "This is the same as the C<statvfs(2)> system call."
15234 #: ../fish/guestfish-actions.pod:4692
15239 #: ../fish/guestfish-actions.pod:4694
15247 #: ../fish/guestfish-actions.pod:4696 ../src/guestfs-actions.pod:7234
15249 "This runs the L<strings(1)> command on a file and returns the list of "
15250 "printable strings found."
15254 #: ../fish/guestfish-actions.pod:4702
15259 #: ../fish/guestfish-actions.pod:4704
15262 " strings-e encoding path\n"
15267 #: ../fish/guestfish-actions.pod:4706
15269 "This is like the L</strings> command, but allows you to specify the encoding "
15270 "of strings that are looked for in the source file C<path>."
15274 #: ../fish/guestfish-actions.pod:4710 ../src/guestfs-actions.pod:7257
15275 msgid "Allowed encodings are:"
15279 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7261
15284 #: ../fish/guestfish-actions.pod:4716
15286 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15287 "ISO-8859-X (this is what L</strings> uses)."
15291 #: ../fish/guestfish-actions.pod:4719 ../src/guestfs-actions.pod:7266
15296 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7268
15297 msgid "Single 8-bit-byte characters."
15301 #: ../fish/guestfish-actions.pod:4723 ../src/guestfs-actions.pod:7270
15306 #: ../fish/guestfish-actions.pod:4725 ../src/guestfs-actions.pod:7272
15307 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15311 #: ../fish/guestfish-actions.pod:4728 ../src/guestfs-actions.pod:7275
15312 msgid "l (lower case letter L)"
15316 #: ../fish/guestfish-actions.pod:4730 ../src/guestfs-actions.pod:7277
15318 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15319 "examining binaries in Windows guests."
15323 #: ../fish/guestfish-actions.pod:4733 ../src/guestfs-actions.pod:7280
15328 #: ../fish/guestfish-actions.pod:4735 ../src/guestfs-actions.pod:7282
15329 msgid "32-bit big endian such as UCS-4BE."
15333 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7284
15338 #: ../fish/guestfish-actions.pod:4739 ../src/guestfs-actions.pod:7286
15339 msgid "32-bit little endian such as UCS-4LE."
15343 #: ../fish/guestfish-actions.pod:4743 ../src/guestfs-actions.pod:7290
15344 msgid "The returned strings are transcoded to UTF-8."
15348 #: ../fish/guestfish-actions.pod:4748
15349 msgid "swapoff-device"
15353 #: ../fish/guestfish-actions.pod:4750
15356 " swapoff-device device\n"
15361 #: ../fish/guestfish-actions.pod:4752
15363 "This command disables the libguestfs appliance swap device or partition "
15364 "named C<device>. See L</swapon-device>."
15368 #: ../fish/guestfish-actions.pod:4756
15369 msgid "swapoff-file"
15373 #: ../fish/guestfish-actions.pod:4758
15376 " swapoff-file file\n"
15381 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7321
15382 msgid "This command disables the libguestfs appliance swap on file."
15386 #: ../fish/guestfish-actions.pod:4762
15387 msgid "swapoff-label"
15391 #: ../fish/guestfish-actions.pod:4764
15394 " swapoff-label label\n"
15399 #: ../fish/guestfish-actions.pod:4766 ../src/guestfs-actions.pod:7333
15401 "This command disables the libguestfs appliance swap on labeled swap "
15406 #: ../fish/guestfish-actions.pod:4769
15407 msgid "swapoff-uuid"
15411 #: ../fish/guestfish-actions.pod:4771
15414 " swapoff-uuid uuid\n"
15419 #: ../fish/guestfish-actions.pod:4773 ../src/guestfs-actions.pod:7346
15421 "This command disables the libguestfs appliance swap partition with the given "
15426 #: ../fish/guestfish-actions.pod:4776
15427 msgid "swapon-device"
15431 #: ../fish/guestfish-actions.pod:4778
15434 " swapon-device device\n"
15439 #: ../fish/guestfish-actions.pod:4780
15441 "This command enables the libguestfs appliance to use the swap device or "
15442 "partition named C<device>. The increased memory is made available for all "
15443 "commands, for example those run using L</command> or L</sh>."
15447 #: ../fish/guestfish-actions.pod:4785 ../src/guestfs-actions.pod:7364
15449 "Note that you should not swap to existing guest swap partitions unless you "
15450 "know what you are doing. They may contain hibernation information, or other "
15451 "information that the guest doesn't want you to trash. You also risk leaking "
15452 "information about the host to the guest this way. Instead, attach a new "
15453 "host device to the guest and swap on that."
15457 #: ../fish/guestfish-actions.pod:4792
15458 msgid "swapon-file"
15462 #: ../fish/guestfish-actions.pod:4794
15465 " swapon-file file\n"
15470 #: ../fish/guestfish-actions.pod:4796
15471 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
15475 #: ../fish/guestfish-actions.pod:4799
15476 msgid "swapon-label"
15480 #: ../fish/guestfish-actions.pod:4801
15483 " swapon-label label\n"
15488 #: ../fish/guestfish-actions.pod:4803
15490 "This command enables swap to a labeled swap partition. See "
15491 "L</swapon-device> for other notes."
15495 #: ../fish/guestfish-actions.pod:4806
15496 msgid "swapon-uuid"
15500 #: ../fish/guestfish-actions.pod:4808
15503 " swapon-uuid uuid\n"
15508 #: ../fish/guestfish-actions.pod:4810
15510 "This command enables swap to a swap partition with the given UUID. See "
15511 "L</swapon-device> for other notes."
15515 #: ../fish/guestfish-actions.pod:4813
15520 #: ../fish/guestfish-actions.pod:4815
15528 #: ../fish/guestfish-actions.pod:4817 ../src/guestfs-actions.pod:7419
15530 "This syncs the disk, so that any writes are flushed through to the "
15531 "underlying disk image."
15535 #: ../fish/guestfish-actions.pod:4820 ../src/guestfs-actions.pod:7422
15537 "You should always call this if you have modified a disk image, before "
15538 "closing the handle."
15542 #: ../fish/guestfish-actions.pod:4823
15547 #: ../fish/guestfish-actions.pod:4825
15555 #: ../fish/guestfish-actions.pod:4827 ../src/guestfs-actions.pod:7435
15556 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15560 #: ../fish/guestfish-actions.pod:4833
15565 #: ../fish/guestfish-actions.pod:4835
15568 " tail-n nrlines path\n"
15573 #: ../fish/guestfish-actions.pod:4837 ../src/guestfs-actions.pod:7454
15575 "If the parameter C<nrlines> is a positive number, this returns the last "
15576 "C<nrlines> lines of the file C<path>."
15580 #: ../fish/guestfish-actions.pod:4840 ../src/guestfs-actions.pod:7457
15582 "If the parameter C<nrlines> is a negative number, this returns lines from "
15583 "the file C<path>, starting with the C<-nrlines>th line."
15587 #: ../fish/guestfish-actions.pod:4848
15592 #: ../fish/guestfish-actions.pod:4850
15595 " tar-in (tarfile|-) directory\n"
15600 #: ../fish/guestfish-actions.pod:4852 ../src/guestfs-actions.pod:7478
15602 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15603 "tar file) into C<directory>."
15607 #: ../fish/guestfish-actions.pod:4855
15608 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
15612 #: ../fish/guestfish-actions.pod:4860
15617 #: ../fish/guestfish-actions.pod:4862
15620 " tar-out directory (tarfile|-)\n"
15625 #: ../fish/guestfish-actions.pod:4864 ../src/guestfs-actions.pod:7495
15627 "This command packs the contents of C<directory> and downloads it to local "
15632 #: ../fish/guestfish-actions.pod:4867
15633 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
15637 #: ../fish/guestfish-actions.pod:4872
15642 #: ../fish/guestfish-actions.pod:4874
15645 " tgz-in (tarball|-) directory\n"
15650 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7512
15652 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15653 "tar file) into C<directory>."
15657 #: ../fish/guestfish-actions.pod:4879
15658 msgid "To upload an uncompressed tarball, use L</tar-in>."
15662 #: ../fish/guestfish-actions.pod:4883
15667 #: ../fish/guestfish-actions.pod:4885
15670 " tgz-out directory (tarball|-)\n"
15675 #: ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:7528
15677 "This command packs the contents of C<directory> and downloads it to local "
15682 #: ../fish/guestfish-actions.pod:4890
15683 msgid "To download an uncompressed tarball, use L</tar-out>."
15687 #: ../fish/guestfish-actions.pod:4894
15692 #: ../fish/guestfish-actions.pod:4896
15700 #: ../fish/guestfish-actions.pod:4898 ../src/guestfs-actions.pod:7543
15702 "Touch acts like the L<touch(1)> command. It can be used to update the "
15703 "timestamps on a file, or, if the file does not exist, to create a new "
15704 "zero-length file."
15708 #: ../fish/guestfish-actions.pod:4902 ../src/guestfs-actions.pod:7547
15710 "This command only works on regular files, and will fail on other file types "
15711 "such as directories, symbolic links, block special etc."
15715 #: ../fish/guestfish-actions.pod:4905
15720 #: ../fish/guestfish-actions.pod:4907
15728 #: ../fish/guestfish-actions.pod:4909 ../src/guestfs-actions.pod:7560
15730 "This command truncates C<path> to a zero-length file. The file must exist "
15735 #: ../fish/guestfish-actions.pod:4912
15736 msgid "truncate-size"
15740 #: ../fish/guestfish-actions.pod:4914
15743 " truncate-size path size\n"
15748 #: ../fish/guestfish-actions.pod:4916 ../src/guestfs-actions.pod:7574
15750 "This command truncates C<path> to size C<size> bytes. The file must exist "
15755 #: ../fish/guestfish-actions.pod:4919
15757 "If the current file size is less than C<size> then the file is extended to "
15758 "the required size with zero bytes. This creates a sparse file (ie. disk "
15759 "blocks are not allocated for the file until you write to it). To create a "
15760 "non-sparse file of zeroes, use L</fallocate64> instead."
15764 #: ../fish/guestfish-actions.pod:4925
15769 #: ../fish/guestfish-actions.pod:4927
15772 " tune2fs-l device\n"
15777 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7593
15779 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15784 #: ../fish/guestfish-actions.pod:4932 ../src/guestfs-actions.pod:7596
15786 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15787 "for more details. The list of fields returned isn't clearly defined, and "
15788 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15789 "and the filesystem itself."
15793 #: ../fish/guestfish-actions.pod:4937
15798 #: ../fish/guestfish-actions.pod:4939
15801 " txz-in (tarball|-) directory\n"
15806 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7616
15808 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15809 "tar file) into C<directory>."
15813 #: ../fish/guestfish-actions.pod:4946
15818 #: ../fish/guestfish-actions.pod:4948
15821 " txz-out directory (tarball|-)\n"
15826 #: ../fish/guestfish-actions.pod:4950 ../src/guestfs-actions.pod:7630
15828 "This command packs the contents of C<directory> and downloads it to local "
15829 "file C<tarball> (as an xz compressed tar archive)."
15833 #: ../fish/guestfish-actions.pod:4955
15838 #: ../fish/guestfish-actions.pod:4957
15846 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7643
15848 "This function sets the mask used for creating new files and device nodes to "
15853 #: ../fish/guestfish-actions.pod:4962 ../src/guestfs-actions.pod:7646
15855 "Typical umask values would be C<022> which creates new files with "
15856 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15857 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15861 #: ../fish/guestfish-actions.pod:4967 ../src/guestfs-actions.pod:7651
15863 "The default umask is C<022>. This is important because it means that "
15864 "directories and device nodes will be created with C<0644> or C<0755> mode "
15865 "even if you specify C<0777>."
15869 #: ../fish/guestfish-actions.pod:4971
15870 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
15874 #: ../fish/guestfish-actions.pod:4974 ../src/guestfs-actions.pod:7658
15875 msgid "This call returns the previous umask."
15879 #: ../fish/guestfish-actions.pod:4976
15884 #: ../fish/guestfish-actions.pod:4978
15889 #: ../fish/guestfish-actions.pod:4980
15892 " umount pathordevice\n"
15897 #: ../fish/guestfish-actions.pod:4982 ../src/guestfs-actions.pod:7670
15899 "This unmounts the given filesystem. The filesystem may be specified either "
15900 "by its mountpoint (path) or the device which contains the filesystem."
15904 #: ../fish/guestfish-actions.pod:4986
15909 #: ../fish/guestfish-actions.pod:4988
15910 msgid "unmount-all"
15914 #: ../fish/guestfish-actions.pod:4990
15922 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7683
15923 msgid "This unmounts all mounted filesystems."
15927 #: ../fish/guestfish-actions.pod:4994 ../src/guestfs-actions.pod:7685
15928 msgid "Some internal mounts are not unmounted by this call."
15932 #: ../fish/guestfish-actions.pod:4996
15937 #: ../fish/guestfish-actions.pod:4998
15940 " upload (filename|-) remotefilename\n"
15945 #: ../fish/guestfish-actions.pod:5000 ../fish/guestfish-actions.pod:5013 ../src/guestfs-actions.pod:7698 ../src/guestfs-actions.pod:7722
15946 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15950 #: ../fish/guestfish-actions.pod:5005
15951 msgid "See also L</download>."
15955 #: ../fish/guestfish-actions.pod:5009
15956 msgid "upload-offset"
15960 #: ../fish/guestfish-actions.pod:5011
15963 " upload-offset (filename|-) remotefilename offset\n"
15968 #: ../fish/guestfish-actions.pod:5016 ../src/guestfs-actions.pod:7725
15970 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15971 "The intention is to overwrite parts of existing files or devices, although "
15972 "if a non-existant file is specified then it is created with a \"hole\" "
15973 "before C<offset>. The size of the data written is implicit in the size of "
15974 "the source C<filename>."
15978 #: ../fish/guestfish-actions.pod:5023
15980 "Note that there is no limit on the amount of data that can be uploaded with "
15981 "this call, unlike with L</pwrite>, and this call always writes the full "
15982 "amount unless an error occurs."
15986 #: ../fish/guestfish-actions.pod:5028
15987 msgid "See also L</upload>, L</pwrite>."
15991 #: ../fish/guestfish-actions.pod:5032
15996 #: ../fish/guestfish-actions.pod:5034
15999 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
16004 #: ../fish/guestfish-actions.pod:5036 ../src/guestfs-actions.pod:7758
16005 msgid "This command sets the timestamps of a file with nanosecond precision."
16009 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7761
16011 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
16016 #: ../fish/guestfish-actions.pod:5042 ../src/guestfs-actions.pod:7764
16018 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
16019 "nanoseconds from the epoch."
16023 #: ../fish/guestfish-actions.pod:5045 ../src/guestfs-actions.pod:7767
16025 "If the C<*nsecs> field contains the special value C<-1> then the "
16026 "corresponding timestamp is set to the current time. (The C<*secs> field is "
16027 "ignored in this case)."
16031 #: ../fish/guestfish-actions.pod:5049 ../src/guestfs-actions.pod:7771
16033 "If the C<*nsecs> field contains the special value C<-2> then the "
16034 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
16039 #: ../fish/guestfish-actions.pod:5053
16044 #: ../fish/guestfish-actions.pod:5055
16052 #: ../fish/guestfish-actions.pod:5057 ../src/guestfs-actions.pod:7784
16053 msgid "Return the libguestfs version number that the program is linked against."
16057 #: ../fish/guestfish-actions.pod:5060 ../src/guestfs-actions.pod:7787
16059 "Note that because of dynamic linking this is not necessarily the version of "
16060 "libguestfs that you compiled against. You can compile the program, and then "
16061 "at runtime dynamically link against a completely different C<libguestfs.so> "
16066 #: ../fish/guestfish-actions.pod:5065 ../src/guestfs-actions.pod:7792
16068 "This call was added in version C<1.0.58>. In previous versions of "
16069 "libguestfs there was no way to get the version number. From C code you can "
16070 "use dynamic linker functions to find out if this symbol exists (if it "
16071 "doesn't, then it's an earlier version)."
16075 #: ../fish/guestfish-actions.pod:5071 ../src/guestfs-actions.pod:7798
16077 "The call returns a structure with four elements. The first three (C<major>, "
16078 "C<minor> and C<release>) are numbers and correspond to the usual version "
16079 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
16080 "but may be used for distro-specific information."
16084 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7804
16085 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
16089 #: ../fish/guestfish-actions.pod:5080 ../src/guestfs-actions.pod:7807
16090 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
16094 #: ../fish/guestfish-actions.pod:5082
16096 "I<Note:> Don't use this call to test for availability of features. In "
16097 "enterprise distributions we backport features from later versions into "
16098 "earlier versions, making this an unreliable way to test for features. Use "
16099 "L</available> instead."
16103 #: ../fish/guestfish-actions.pod:5088
16108 #: ../fish/guestfish-actions.pod:5090
16111 " vfs-label device\n"
16116 #: ../fish/guestfish-actions.pod:5092 ../src/guestfs-actions.pod:7827
16117 msgid "This returns the filesystem label of the filesystem on C<device>."
16121 #: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7830
16122 msgid "If the filesystem is unlabeled, this returns the empty string."
16126 #: ../fish/guestfish-actions.pod:5097
16127 msgid "To find a filesystem from the label, use L</findfs-label>."
16131 #: ../fish/guestfish-actions.pod:5099
16136 #: ../fish/guestfish-actions.pod:5101
16139 " vfs-type device\n"
16144 #: ../fish/guestfish-actions.pod:5103 ../src/guestfs-actions.pod:7845
16146 "This command gets the filesystem type corresponding to the filesystem on "
16151 #: ../fish/guestfish-actions.pod:5106 ../src/guestfs-actions.pod:7848
16153 "For most filesystems, the result is the name of the Linux VFS module which "
16154 "would be used to mount this filesystem if you mounted it without specifying "
16155 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16159 #: ../fish/guestfish-actions.pod:5111
16164 #: ../fish/guestfish-actions.pod:5113
16167 " vfs-uuid device\n"
16172 #: ../fish/guestfish-actions.pod:5115 ../src/guestfs-actions.pod:7864
16173 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16177 #: ../fish/guestfish-actions.pod:5118 ../src/guestfs-actions.pod:7867
16178 msgid "If the filesystem does not have a UUID, this returns the empty string."
16182 #: ../fish/guestfish-actions.pod:5120
16183 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
16187 #: ../fish/guestfish-actions.pod:5122
16188 msgid "vg-activate"
16192 #: ../fish/guestfish-actions.pod:5124
16195 " vg-activate true|false 'volgroups ...'\n"
16200 #: ../fish/guestfish-actions.pod:5126 ../src/guestfs-actions.pod:7883
16202 "This command activates or (if C<activate> is false) deactivates all logical "
16203 "volumes in the listed volume groups C<volgroups>."
16207 #: ../fish/guestfish-actions.pod:5129 ../src/guestfs-actions.pod:7886
16208 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16212 #: ../fish/guestfish-actions.pod:5131 ../src/guestfs-actions.pod:7888
16214 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16215 "activated or deactivated."
16219 #: ../fish/guestfish-actions.pod:5134
16220 msgid "vg-activate-all"
16224 #: ../fish/guestfish-actions.pod:5136
16227 " vg-activate-all true|false\n"
16232 #: ../fish/guestfish-actions.pod:5138 ../src/guestfs-actions.pod:7901
16234 "This command activates or (if C<activate> is false) deactivates all logical "
16235 "volumes in all volume groups."
16239 #: ../fish/guestfish-actions.pod:5141 ../src/guestfs-actions.pod:7904
16240 msgid "This command is the same as running C<vgchange -a y|n>"
16244 #: ../fish/guestfish-actions.pod:5143
16249 #: ../fish/guestfish-actions.pod:5145
16252 " vgcreate volgroup 'physvols ...'\n"
16257 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7917
16259 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16260 "of physical volumes C<physvols>."
16264 #: ../fish/guestfish-actions.pod:5150
16269 #: ../fish/guestfish-actions.pod:5152
16272 " vglvuuids vgname\n"
16277 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7930
16279 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16280 "volumes created in this volume group."
16284 #: ../fish/guestfish-actions.pod:5157
16286 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
16287 "logical volumes and volume groups."
16291 #: ../fish/guestfish-actions.pod:5160
16292 msgid "See also L</vgpvuuids>."
16296 #: ../fish/guestfish-actions.pod:5162
16301 #: ../fish/guestfish-actions.pod:5164
16304 " vgpvuuids vgname\n"
16309 #: ../fish/guestfish-actions.pod:5166 ../src/guestfs-actions.pod:7950
16311 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16312 "volumes that this volume group resides on."
16316 #: ../fish/guestfish-actions.pod:5169
16318 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
16319 "physical volumes and volume groups."
16323 #: ../fish/guestfish-actions.pod:5172
16324 msgid "See also L</vglvuuids>."
16328 #: ../fish/guestfish-actions.pod:5174
16333 #: ../fish/guestfish-actions.pod:5176
16336 " vgremove vgname\n"
16341 #: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7970
16342 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16346 #: ../fish/guestfish-actions.pod:5180 ../src/guestfs-actions.pod:7972
16347 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16351 #: ../fish/guestfish-actions.pod:5183
16356 #: ../fish/guestfish-actions.pod:5185
16359 " vgrename volgroup newvolgroup\n"
16364 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7986
16365 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16369 #: ../fish/guestfish-actions.pod:5189
16374 #: ../fish/guestfish-actions.pod:5191
16382 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7997
16384 "List all the volumes groups detected. This is the equivalent of the "
16385 "L<vgs(8)> command."
16389 #: ../fish/guestfish-actions.pod:5196 ../src/guestfs-actions.pod:8000
16391 "This returns a list of just the volume group names that were detected "
16392 "(eg. C<VolGroup00>)."
16396 #: ../fish/guestfish-actions.pod:5199
16397 msgid "See also L</vgs-full>."
16401 #: ../fish/guestfish-actions.pod:5201
16406 #: ../fish/guestfish-actions.pod:5203
16414 #: ../fish/guestfish-actions.pod:5205 ../src/guestfs-actions.pod:8016
16416 "List all the volumes groups detected. This is the equivalent of the "
16417 "L<vgs(8)> command. The \"full\" version includes all fields."
16421 #: ../fish/guestfish-actions.pod:5208
16426 #: ../fish/guestfish-actions.pod:5210
16434 #: ../fish/guestfish-actions.pod:5212 ../src/guestfs-actions.pod:8030
16436 "This rescans all block devices and rebuilds the list of LVM physical "
16437 "volumes, volume groups and logical volumes."
16441 #: ../fish/guestfish-actions.pod:5215
16446 #: ../fish/guestfish-actions.pod:5217
16454 #: ../fish/guestfish-actions.pod:5219 ../src/guestfs-actions.pod:8043
16455 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16459 #: ../fish/guestfish-actions.pod:5221
16464 #: ../fish/guestfish-actions.pod:5223
16472 #: ../fish/guestfish-actions.pod:5225 ../src/guestfs-actions.pod:8083
16474 "This command counts the characters in a file, using the C<wc -c> external "
16479 #: ../fish/guestfish-actions.pod:5228
16484 #: ../fish/guestfish-actions.pod:5230
16492 #: ../fish/guestfish-actions.pod:5232 ../src/guestfs-actions.pod:8096
16494 "This command counts the lines in a file, using the C<wc -l> external "
16499 #: ../fish/guestfish-actions.pod:5235
16504 #: ../fish/guestfish-actions.pod:5237
16512 #: ../fish/guestfish-actions.pod:5239 ../src/guestfs-actions.pod:8109
16514 "This command counts the words in a file, using the C<wc -w> external "
16519 #: ../fish/guestfish-actions.pod:5242
16524 #: ../fish/guestfish-actions.pod:5244
16527 " write path content\n"
16532 #: ../fish/guestfish-actions.pod:5246 ../src/guestfs-actions.pod:8124
16534 "This call creates a file called C<path>. The content of the file is the "
16535 "string C<content> (which can contain any 8 bit data)."
16539 #: ../fish/guestfish-actions.pod:5249
16540 msgid "See also L</write-append>."
16544 #: ../fish/guestfish-actions.pod:5254
16545 msgid "write-append"
16549 #: ../fish/guestfish-actions.pod:5256
16552 " write-append path content\n"
16557 #: ../fish/guestfish-actions.pod:5258 ../src/guestfs-actions.pod:8144
16559 "This call appends C<content> to the end of file C<path>. If C<path> does "
16560 "not exist, then a new file is created."
16564 #: ../fish/guestfish-actions.pod:5261
16565 msgid "See also L</write>."
16569 #: ../fish/guestfish-actions.pod:5266
16574 #: ../fish/guestfish-actions.pod:5268
16577 " write-file path content size\n"
16582 #: ../fish/guestfish-actions.pod:5270 ../src/guestfs-actions.pod:8171
16584 "This call creates a file called C<path>. The contents of the file is the "
16585 "string C<content> (which can contain any 8 bit data), with length C<size>."
16589 #: ../fish/guestfish-actions.pod:5274 ../src/guestfs-actions.pod:8175
16591 "As a special case, if C<size> is C<0> then the length is calculated using "
16592 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16596 #: ../fish/guestfish-actions.pod:5278 ../src/guestfs-actions.pod:8179
16598 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16599 "I<not> work, even if the length is specified."
16603 #: ../fish/guestfish-actions.pod:5284
16604 msgid "I<This function is deprecated.> In new code, use the L</write> call instead."
16608 #: ../fish/guestfish-actions.pod:5291
16613 #: ../fish/guestfish-actions.pod:5293
16616 " zegrep regex path\n"
16621 #: ../fish/guestfish-actions.pod:5295 ../src/guestfs-actions.pod:8196
16622 msgid "This calls the external C<zegrep> program and returns the matching lines."
16626 #: ../fish/guestfish-actions.pod:5301
16631 #: ../fish/guestfish-actions.pod:5303
16634 " zegrepi regex path\n"
16639 #: ../fish/guestfish-actions.pod:5305 ../src/guestfs-actions.pod:8215
16640 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16644 #: ../fish/guestfish-actions.pod:5311
16649 #: ../fish/guestfish-actions.pod:5313
16657 #: ../fish/guestfish-actions.pod:5315 ../src/guestfs-actions.pod:8233
16658 msgid "This command writes zeroes over the first few blocks of C<device>."
16662 #: ../fish/guestfish-actions.pod:5317 ../src/guestfs-actions.pod:8235
16664 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16665 "securely wipe the device). It should be sufficient to remove any partition "
16666 "tables, filesystem superblocks and so on."
16670 #: ../fish/guestfish-actions.pod:5321 ../fish/guestfish-actions.pod:5336 ../src/guestfs-actions.pod:8239 ../src/guestfs-actions.pod:8265
16672 "If blocks are already zero, then this command avoids writing zeroes. This "
16673 "prevents the underlying device from becoming non-sparse or growing "
16678 #: ../fish/guestfish-actions.pod:5325
16679 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
16683 #: ../fish/guestfish-actions.pod:5328
16684 msgid "zero-device"
16688 #: ../fish/guestfish-actions.pod:5330
16691 " zero-device device\n"
16696 #: ../fish/guestfish-actions.pod:5332
16698 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
16699 "which just zeroes the first few blocks of a device."
16703 #: ../fish/guestfish-actions.pod:5340
16708 #: ../fish/guestfish-actions.pod:5342
16711 " zerofree device\n"
16716 #: ../fish/guestfish-actions.pod:5344 ../src/guestfs-actions.pod:8284
16718 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16719 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16720 "possible to compress the filesystem more effectively."
16724 #: ../fish/guestfish-actions.pod:5349 ../src/guestfs-actions.pod:8289
16725 msgid "You should B<not> run this program if the filesystem is mounted."
16729 #: ../fish/guestfish-actions.pod:5352 ../src/guestfs-actions.pod:8292
16731 "It is possible that using this program can damage the filesystem or data on "
16736 #: ../fish/guestfish-actions.pod:5355
16741 #: ../fish/guestfish-actions.pod:5357
16744 " zfgrep pattern path\n"
16749 #: ../fish/guestfish-actions.pod:5359 ../src/guestfs-actions.pod:8306
16750 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16754 #: ../fish/guestfish-actions.pod:5365
16759 #: ../fish/guestfish-actions.pod:5367
16762 " zfgrepi pattern path\n"
16767 #: ../fish/guestfish-actions.pod:5369 ../src/guestfs-actions.pod:8325
16768 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16772 #: ../fish/guestfish-actions.pod:5375
16777 #: ../fish/guestfish-actions.pod:5377
16780 " zfile meth path\n"
16785 #: ../fish/guestfish-actions.pod:5379 ../src/guestfs-actions.pod:8351
16786 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16790 #: ../fish/guestfish-actions.pod:5382 ../src/guestfs-actions.pod:8354
16791 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16795 #: ../fish/guestfish-actions.pod:5384
16796 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
16800 #: ../fish/guestfish-actions.pod:5387
16801 msgid "I<This function is deprecated.> In new code, use the L</file> call instead."
16805 #: ../fish/guestfish-actions.pod:5394
16810 #: ../fish/guestfish-actions.pod:5396
16813 " zgrep regex path\n"
16818 #: ../fish/guestfish-actions.pod:5398 ../src/guestfs-actions.pod:8371
16819 msgid "This calls the external C<zgrep> program and returns the matching lines."
16823 #: ../fish/guestfish-actions.pod:5404
16828 #: ../fish/guestfish-actions.pod:5406
16831 " zgrepi regex path\n"
16836 #: ../fish/guestfish-actions.pod:5408 ../src/guestfs-actions.pod:8390
16837 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16841 #: ../fish/guestfish-commands.pod:1
16846 #: ../fish/guestfish-commands.pod:3
16851 #: ../fish/guestfish-commands.pod:5
16854 " alloc filename size\n"
16859 #: ../fish/guestfish-commands.pod:7
16861 "This creates an empty (zeroed) file of the given size, and then adds so it "
16862 "can be further examined."
16866 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
16867 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
16871 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
16872 msgid "Size can be specified using standard suffixes, eg. C<1M>."
16876 #: ../fish/guestfish-commands.pod:14
16878 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
16879 "image, see L</PREPARED DISK IMAGES>."
16883 #: ../fish/guestfish-commands.pod:17
16888 #: ../fish/guestfish-commands.pod:19
16891 " copy-in local [local ...] /remotedir\n"
16896 #: ../fish/guestfish-commands.pod:21
16898 "C<copy-in> copies local files or directories recursively into the disk "
16899 "image, placing them in the directory called C</remotedir> (which must "
16900 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
16901 "other commands as necessary."
16905 #: ../fish/guestfish-commands.pod:26
16907 "Multiple local files and directories can be specified, but the last "
16908 "parameter must always be a remote directory. Wildcards cannot be used."
16912 #: ../fish/guestfish-commands.pod:30
16917 #: ../fish/guestfish-commands.pod:32
16920 " copy-out remote [remote ...] localdir\n"
16925 #: ../fish/guestfish-commands.pod:34
16927 "C<copy-out> copies remote files or directories recursively out of the disk "
16928 "image, placing them on the host disk in a local directory called C<localdir> "
16929 "(which must exist). This guestfish meta-command turns into a sequence of "
16930 "L</download>, L</tar-out> and other commands as necessary."
16934 #: ../fish/guestfish-commands.pod:40
16936 "Multiple remote files and directories can be specified, but the last "
16937 "parameter must always be a local directory. To download to the current "
16938 "directory, use C<.> as in:"
16942 #: ../fish/guestfish-commands.pod:44
16945 " copy-out /home .\n"
16950 #: ../fish/guestfish-commands.pod:46
16952 "Wildcards cannot be used in the ordinary command, but you can use them with "
16953 "the help of L</glob> like this:"
16957 #: ../fish/guestfish-commands.pod:49
16960 " glob copy-out /home/* .\n"
16965 #: ../fish/guestfish-commands.pod:51
16970 #: ../fish/guestfish-commands.pod:53
16973 " display filename\n"
16978 #: ../fish/guestfish-commands.pod:55
16980 "Use C<display> (a graphical display program) to display an image file. It "
16981 "downloads the file, and runs C<display> on it."
16985 #: ../fish/guestfish-commands.pod:58
16987 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
16988 "environment variable. For example to use the GNOME display program:"
16992 #: ../fish/guestfish-commands.pod:61
16995 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
17000 #: ../fish/guestfish-commands.pod:63
17001 msgid "See also L<display(1)>."
17005 #: ../fish/guestfish-commands.pod:65
17010 #: ../fish/guestfish-commands.pod:67
17013 " echo [params ...]\n"
17018 #: ../fish/guestfish-commands.pod:69
17019 msgid "This echos the parameters to the terminal."
17023 #: ../fish/guestfish-commands.pod:71
17028 #: ../fish/guestfish-commands.pod:73
17033 #: ../fish/guestfish-commands.pod:75
17038 #: ../fish/guestfish-commands.pod:77
17046 #: ../fish/guestfish-commands.pod:79
17048 "This is used to edit a file. It downloads the file, edits it locally using "
17049 "your editor, then uploads the result."
17053 #: ../fish/guestfish-commands.pod:82
17055 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
17056 "or C<emacs> you will get those corresponding editors."
17060 #: ../fish/guestfish-commands.pod:86
17065 #: ../fish/guestfish-commands.pod:88
17068 " glob command args...\n"
17073 #: ../fish/guestfish-commands.pod:90
17075 "Expand wildcards in any paths in the args list, and run C<command> "
17076 "repeatedly on each matching path."
17080 #: ../fish/guestfish-commands.pod:93
17081 msgid "See L</WILDCARDS AND GLOBBING>."
17085 #: ../fish/guestfish-commands.pod:95
17090 #: ../fish/guestfish-commands.pod:97
17093 " hexedit <filename|device>\n"
17094 " hexedit <filename|device> <max>\n"
17095 " hexedit <filename|device> <start> <max>\n"
17100 #: ../fish/guestfish-commands.pod:101
17102 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
17107 #: ../fish/guestfish-commands.pod:104
17109 "This command works by downloading potentially the whole file or device, "
17110 "editing it locally, then uploading it. If the file or device is large, you "
17111 "have to specify which part you wish to edit by using C<max> and/or C<start> "
17112 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
17113 "usual modifiers allowed such as C<1M> (1 megabyte)."
17117 #: ../fish/guestfish-commands.pod:111
17118 msgid "For example to edit the first few sectors of a disk you might do:"
17122 #: ../fish/guestfish-commands.pod:114
17125 " hexedit /dev/sda 1M\n"
17130 #: ../fish/guestfish-commands.pod:116
17132 "which would allow you to edit anywhere within the first megabyte of the "
17137 #: ../fish/guestfish-commands.pod:119
17138 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
17142 #: ../fish/guestfish-commands.pod:121
17145 " hexedit /dev/sda1 0x400 0x400\n"
17150 #: ../fish/guestfish-commands.pod:123
17151 msgid "(assuming the superblock is in the standard location)."
17155 #: ../fish/guestfish-commands.pod:125
17157 "This command requires the external L<hexedit(1)> program. You can specify "
17158 "another program to use by setting the C<HEXEDITOR> environment variable."
17162 #: ../fish/guestfish-commands.pod:129
17163 msgid "See also L</hexdump>."
17167 #: ../fish/guestfish-commands.pod:131
17172 #: ../fish/guestfish-commands.pod:133
17180 #: ../fish/guestfish-commands.pod:135
17181 msgid "Change the local directory, ie. the current directory of guestfish itself."
17185 #: ../fish/guestfish-commands.pod:138
17186 msgid "Note that C<!cd> won't do what you might expect."
17190 #: ../fish/guestfish-commands.pod:140
17195 #: ../fish/guestfish-commands.pod:142
17200 #: ../fish/guestfish-commands.pod:144
17208 #: ../fish/guestfish-commands.pod:146
17209 msgid "Opens the manual page for guestfish."
17213 #: ../fish/guestfish-commands.pod:148
17218 #: ../fish/guestfish-commands.pod:150
17223 #: ../fish/guestfish-commands.pod:152
17231 #: ../fish/guestfish-commands.pod:154
17239 #: ../fish/guestfish-commands.pod:156
17240 msgid "This is used to view a file."
17244 #: ../fish/guestfish-commands.pod:158
17246 "The default viewer is C<$PAGER>. However if you use the alternate command "
17247 "C<less> you will get the C<less> command specifically."
17251 #: ../fish/guestfish-commands.pod:161
17256 #: ../fish/guestfish-commands.pod:163
17264 #: ../fish/guestfish-commands.pod:165
17266 "Close and reopen the libguestfs handle. It is not necessary to use this "
17267 "normally, because the handle is closed properly when guestfish exits. "
17268 "However this is occasionally useful for testing."
17272 #: ../fish/guestfish-commands.pod:169
17277 #: ../fish/guestfish-commands.pod:171
17280 " setenv VAR value\n"
17285 #: ../fish/guestfish-commands.pod:173
17286 msgid "Set the environment variable C<VAR> to the string C<value>."
17290 #: ../fish/guestfish-commands.pod:175
17291 msgid "To print the value of an environment variable use a shell command such as:"
17295 #: ../fish/guestfish-commands.pod:178
17303 #: ../fish/guestfish-commands.pod:180
17308 #: ../fish/guestfish-commands.pod:182
17311 " sparse filename size\n"
17316 #: ../fish/guestfish-commands.pod:184
17318 "This creates an empty sparse file of the given size, and then adds so it can "
17319 "be further examined."
17323 #: ../fish/guestfish-commands.pod:187
17325 "In all respects it works the same as the L</alloc> command, except that the "
17326 "image file is allocated sparsely, which means that disk blocks are not "
17327 "assigned to the file until they are needed. Sparse disk files only use "
17328 "space when written to, but they are slower and there is a danger you could "
17329 "run out of real disk space during a write operation."
17333 #: ../fish/guestfish-commands.pod:197
17338 #: ../fish/guestfish-commands.pod:199
17346 #: ../fish/guestfish-commands.pod:201
17348 "This command returns a list of the optional groups known to the daemon, and "
17349 "indicates which ones are supported by this build of the libguestfs "
17354 #: ../fish/guestfish-commands.pod:205
17355 msgid "See also L<guestfs(3)/AVAILABILITY>."
17359 #: ../fish/guestfish-commands.pod:207
17364 #: ../fish/guestfish-commands.pod:209
17367 " time command args...\n"
17372 #: ../fish/guestfish-commands.pod:211
17374 "Run the command as usual, but print the elapsed time afterwards. This can "
17375 "be useful for benchmarking operations."
17379 #: ../fish/guestfish-commands.pod:214
17384 #: ../fish/guestfish-commands.pod:216
17392 #: ../fish/guestfish-commands.pod:218
17393 msgid "Remove C<VAR> from the environment."
17397 #: ../fish/guestfish.pod:5
17398 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17402 #: ../fish/guestfish.pod:9
17405 " guestfish [--options] [commands]\n"
17410 #: ../fish/guestfish.pod:11
17418 #: ../fish/guestfish.pod:13
17421 " guestfish [--ro|--rw] -a disk.img\n"
17426 #: ../fish/guestfish.pod:15
17429 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17434 #: ../fish/guestfish.pod:17
17437 " guestfish -d libvirt-domain\n"
17442 #: ../fish/guestfish.pod:19
17445 " guestfish [--ro|--rw] -a disk.img -i\n"
17450 #: ../fish/guestfish.pod:21
17453 " guestfish -d libvirt-domain -i\n"
17458 #: ../fish/guestfish.pod:25
17460 "Using guestfish in read/write mode on live virtual machines can be "
17461 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17462 "option to use guestfish safely if the disk image or virtual machine might be "
17467 #: ../fish/guestfish.pod:32
17469 "Guestfish is a shell and command-line tool for examining and modifying "
17470 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17471 "functionality of the guestfs API, see L<guestfs(3)>."
17475 #: ../fish/guestfish.pod:36
17477 "Guestfish gives you structured access to the libguestfs API, from shell "
17478 "scripts or the command line or interactively. If you want to rescue a "
17479 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17484 #: ../fish/guestfish.pod:43
17485 msgid "As an interactive shell"
17489 #: ../fish/guestfish.pod:45
17497 #: ../fish/guestfish.pod:47
17500 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17501 " editing virtual machine filesystems.\n"
17506 #: ../fish/guestfish.pod:50
17509 " Type: 'help' for a list of commands\n"
17510 " 'man' to read the manual\n"
17511 " 'quit' to quit the shell\n"
17516 #: ../fish/guestfish.pod:54
17519 " ><fs> add-ro disk.img\n"
17521 " ><fs> list-filesystems\n"
17522 " /dev/sda1: ext4\n"
17523 " /dev/vg_guest/lv_root: ext4\n"
17524 " /dev/vg_guest/lv_swap: swap\n"
17525 " ><fs> mount /dev/vg_guest/lv_root /\n"
17526 " ><fs> cat /etc/fstab\n"
17528 " # Created by anaconda\n"
17535 #: ../fish/guestfish.pod:67
17536 msgid "From shell scripts"
17540 #: ../fish/guestfish.pod:69
17541 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17545 #: ../fish/guestfish.pod:71
17548 " guestfish <<_EOF_\n"
17551 " mount /dev/vg_guest/lv_root /\n"
17552 " write /etc/motd \"Welcome, new users\"\n"
17558 #: ../fish/guestfish.pod:78
17559 msgid "List the LVM logical volumes in a disk image:"
17563 #: ../fish/guestfish.pod:80
17566 " guestfish -a disk.img --ro <<_EOF_\n"
17574 #: ../fish/guestfish.pod:85
17575 msgid "List all the filesystems in a disk image:"
17579 #: ../fish/guestfish.pod:87
17582 " guestfish -a disk.img --ro <<_EOF_\n"
17584 " list-filesystems\n"
17590 #: ../fish/guestfish.pod:92
17591 msgid "On one command line"
17595 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
17596 msgid "Update C</etc/resolv.conf> in a guest:"
17600 #: ../fish/guestfish.pod:96
17604 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17605 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17610 #: ../fish/guestfish.pod:100
17611 msgid "Edit C</boot/grub/grub.conf> interactively:"
17615 #: ../fish/guestfish.pod:102
17618 " guestfish --rw --add disk.img \\\n"
17619 " --mount /dev/vg_guest/lv_root \\\n"
17620 " --mount /dev/sda1:/boot \\\n"
17621 " edit /boot/grub/grub.conf\n"
17626 #: ../fish/guestfish.pod:107
17627 msgid "Mount disks automatically"
17631 #: ../fish/guestfish.pod:109
17633 "Use the I<-i> option to automatically mount the disks from a virtual "
17638 #: ../fish/guestfish.pod:112
17641 " guestfish --ro -a disk.img -i cat /etc/group\n"
17646 #: ../fish/guestfish.pod:114
17649 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17654 #: ../fish/guestfish.pod:116
17655 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17659 #: ../fish/guestfish.pod:118
17662 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17667 #: ../fish/guestfish.pod:120
17668 msgid "As a script interpreter"
17672 #: ../fish/guestfish.pod:122
17673 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17677 #: ../fish/guestfish.pod:124
17680 " #!/usr/bin/guestfish -f\n"
17681 " sparse test1.img 100M\n"
17683 " part-disk /dev/sda mbr\n"
17684 " mkfs ext2 /dev/sda1\n"
17689 #: ../fish/guestfish.pod:130
17690 msgid "Start with a prepared disk"
17694 #: ../fish/guestfish.pod:132
17696 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17697 "single ext2-formatted partition:"
17701 #: ../fish/guestfish.pod:135 ../src/guestfs.pod:2243
17704 " guestfish -N fs\n"
17709 #: ../fish/guestfish.pod:137
17710 msgid "To list what is available do:"
17714 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1042
17717 " guestfish -N help | less\n"
17722 #: ../fish/guestfish.pod:141
17723 msgid "Remote control"
17727 #: ../fish/guestfish.pod:143
17730 " eval \"`guestfish --listen`\"\n"
17731 " guestfish --remote add-ro disk.img\n"
17732 " guestfish --remote run\n"
17733 " guestfish --remote lvs\n"
17738 #: ../fish/guestfish.pod:154
17739 msgid "Displays general help on options."
17743 #: ../fish/guestfish.pod:158
17744 msgid "B<--cmd-help>"
17748 #: ../fish/guestfish.pod:160
17749 msgid "Lists all available guestfish commands."
17753 #: ../fish/guestfish.pod:162
17758 #: ../fish/guestfish.pod:164
17759 msgid "B<--cmd-help cmd>"
17763 #: ../fish/guestfish.pod:166
17764 msgid "Displays detailed help on a single command C<cmd>."
17768 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
17769 msgid "B<-a image>"
17773 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
17774 msgid "B<--add image>"
17778 #: ../fish/guestfish.pod:172
17779 msgid "Add a block device or virtual machine image to the shell."
17783 #: ../fish/guestfish.pod:177
17785 "Using this flag is mostly equivalent to using the C<add> command, with "
17786 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17787 "the I<--format=...> flag was given."
17791 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
17793 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17794 "URI to use. The default is to use the default libvirt connection."
17798 #: ../fish/guestfish.pod:189
17803 #: ../fish/guestfish.pod:191
17805 "If using the I<--listen> option and a csh-like shell, use this option. See "
17806 "section L</REMOTE CONTROL AND CSH> below."
17810 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
17811 msgid "B<-d libvirt-domain>"
17815 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
17816 msgid "B<--domain libvirt-domain>"
17820 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
17822 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17823 "used, then any libvirt domain can be used. However in write mode, only "
17824 "libvirt domains which are shut down can be named here."
17828 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
17829 msgid "Domain UUIDs can be used instead of names."
17833 #: ../fish/guestfish.pod:204
17835 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17836 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17837 "if the I<--format:...> flag was given."
17841 #: ../fish/guestfish.pod:208
17846 #: ../fish/guestfish.pod:210
17847 msgid "B<--no-dest-paths>"
17851 #: ../fish/guestfish.pod:212
17853 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17854 "to hit the tab key to complete paths on the guest filesystem, but this "
17855 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17856 "allow this feature to be disabled."
17860 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
17862 "When prompting for keys and passphrases, guestfish normally turns echoing "
17863 "off so you cannot see what you are typing. If you are not worried about "
17864 "Tempest attacks and there is no one else in the room you can specify this "
17865 "flag to see what you are typing."
17869 #: ../fish/guestfish.pod:224
17874 #: ../fish/guestfish.pod:226
17875 msgid "B<--file file>"
17879 #: ../fish/guestfish.pod:228
17880 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17884 #: ../fish/guestfish.pod:231
17887 " #!/usr/bin/guestfish -f\n"
17892 #: ../fish/guestfish.pod:244
17895 " guestfish --format=raw -a disk.img\n"
17900 #: ../fish/guestfish.pod:248
17903 " guestfish --format=raw -a disk.img --format -a another.img\n"
17908 #: ../fish/guestfish.pod:253
17910 "If you have untrusted raw-format guest disk images, you should use this "
17911 "option to specify the disk format. This avoids a possible security problem "
17912 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17916 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
17917 msgid "B<--inspector>"
17921 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
17923 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17924 "system and mount filesystems as they would be mounted on the real virtual "
17929 #: ../fish/guestfish.pod:266
17930 msgid "Typical usage is either:"
17934 #: ../fish/guestfish.pod:268
17937 " guestfish -d myguest -i\n"
17942 #: ../fish/guestfish.pod:270
17943 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17947 #: ../fish/guestfish.pod:272
17950 " guestfish --ro -d myguest -i\n"
17955 #: ../fish/guestfish.pod:274
17956 msgid "(for active domains, readonly), or specify the block device directly:"
17960 #: ../fish/guestfish.pod:276
17963 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17968 #: ../fish/guestfish.pod:278
17970 "Note that the command line syntax changed slightly over older versions of "
17971 "guestfish. You can still use the old syntax:"
17975 #: ../fish/guestfish.pod:281
17978 " guestfish [--ro] -i disk.img\n"
17983 #: ../fish/guestfish.pod:283
17986 " guestfish [--ro] -i libvirt-domain\n"
17991 #: ../fish/guestfish.pod:285
17993 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
17994 "then using other commands to mount the filesystems that were found."
17998 #: ../fish/guestfish.pod:294
17999 msgid "B<--listen>"
18003 #: ../fish/guestfish.pod:296
18005 "Fork into the background and listen for remote commands. See section "
18006 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18010 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
18015 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
18017 "Connect to a live virtual machine. (Experimental, see "
18018 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
18022 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
18023 msgid "B<-m dev[:mountpoint[:options]]>"
18027 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
18028 msgid "B<--mount dev[:mountpoint[:options]]>"
18032 #: ../fish/guestfish.pod:308
18033 msgid "Mount the named partition or logical volume on the given mountpoint."
18037 #: ../fish/guestfish.pod:310
18038 msgid "If the mountpoint is omitted, it defaults to C</>."
18042 #: ../fish/guestfish.pod:312
18043 msgid "You have to mount something on C</> before most commands will work."
18047 #: ../fish/guestfish.pod:314
18049 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18054 #: ../fish/guestfish.pod:317
18056 "If you don't know what filesystems a disk image contains, you can either run "
18057 "guestfish without this option, then list the partitions, filesystems and LVs "
18058 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18059 "commands), or you can use the L<virt-filesystems(1)> program."
18063 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
18065 "The third (and rarely used) part of the mount parameter is the list of mount "
18066 "options used to mount the underlying filesystem. If this is not given, then "
18067 "the mount options are either the empty string or C<ro> (the latter if the "
18068 "I<--ro> flag is used). By specifying the mount options, you override this "
18069 "default choice. Probably the only time you would use this is to enable ACLs "
18070 "and/or extended attributes if the filesystem can support them:"
18074 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
18077 " -m /dev/sda1:/:acl,user_xattr\n"
18082 #: ../fish/guestfish.pod:333
18083 msgid "Using this flag is equivalent to using the C<mount-options> command."
18087 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202 ../resize/virt-resize.pod:435
18092 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
18093 msgid "B<--no-sync>"
18097 #: ../fish/guestfish.pod:339
18099 "Disable autosync. This is enabled by default. See the discussion of "
18100 "autosync in the L<guestfs(3)> manpage."
18104 #: ../fish/guestfish.pod:342
18109 #: ../fish/guestfish.pod:344
18110 msgid "B<--new type>"
18114 #: ../fish/guestfish.pod:346
18119 #: ../fish/guestfish.pod:348
18121 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18122 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18123 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18128 #: ../fish/guestfish.pod:353
18129 msgid "B<--progress-bars>"
18133 #: ../fish/guestfish.pod:355
18134 msgid "Enable progress bars, even when guestfish is used non-interactively."
18138 #: ../fish/guestfish.pod:357
18140 "Progress bars are enabled by default when guestfish is used as an "
18141 "interactive shell."
18145 #: ../fish/guestfish.pod:360
18146 msgid "B<--no-progress-bars>"
18150 #: ../fish/guestfish.pod:362
18151 msgid "Disable progress bars."
18155 #: ../fish/guestfish.pod:364
18156 msgid "B<--remote[=pid]>"
18160 #: ../fish/guestfish.pod:366
18162 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18163 "CONTROL GUESTFISH OVER A SOCKET> below."
18167 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248 ../rescue/virt-rescue.pod:161
18172 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250 ../rescue/virt-rescue.pod:163
18177 #: ../fish/guestfish.pod:373
18179 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18180 "mounts are done read-only."
18184 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
18186 "The option must always be used if the disk image or virtual machine might be "
18187 "running, and is generally recommended in cases where you don't need write "
18188 "access to the disk."
18192 #: ../fish/guestfish.pod:380
18194 "Note that prepared disk images created with I<-N> are not affected by this "
18195 "option. Also commands like C<add> are not affected - you have to specify "
18196 "the C<readonly:true> option explicitly if you need it."
18200 #: ../fish/guestfish.pod:384
18201 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18205 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262 ../rescue/virt-rescue.pod:173
18206 msgid "B<--selinux>"
18210 #: ../fish/guestfish.pod:388
18211 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18215 #: ../fish/guestfish.pod:394
18217 "Enable very verbose messages. This is particularly useful if you find a "
18222 #: ../fish/guestfish.pod:401
18223 msgid "Display the guestfish / libguestfs version number and exit."
18227 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278 ../rescue/virt-rescue.pod:194
18232 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280 ../rescue/virt-rescue.pod:196
18237 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
18239 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18240 "mounts are done read-write."
18244 #: ../fish/guestfish.pod:410
18245 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
18249 #: ../fish/guestfish.pod:414
18250 msgid "Echo each command before executing it."
18254 #: ../fish/guestfish.pod:418
18255 msgid "COMMANDS ON COMMAND LINE"
18259 #: ../fish/guestfish.pod:420
18260 msgid "Any additional (non-option) arguments are treated as commands to execute."
18264 #: ../fish/guestfish.pod:423
18266 "Commands to execute should be separated by a colon (C<:>), where the colon "
18267 "is a separate parameter. Thus:"
18271 #: ../fish/guestfish.pod:426
18274 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18279 #: ../fish/guestfish.pod:428
18281 "If there are no additional arguments, then we enter a shell, either an "
18282 "interactive shell with a prompt (if the input is a terminal) or a "
18283 "non-interactive shell."
18287 #: ../fish/guestfish.pod:432
18289 "In either command line mode or non-interactive shell, the first command that "
18290 "gives an error causes the whole shell to exit. In interactive mode (with a "
18291 "prompt) if a command fails, you can continue to enter commands."
18295 #: ../fish/guestfish.pod:437
18296 msgid "USING launch (OR run)"
18300 #: ../fish/guestfish.pod:439
18302 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18303 "then launch it, then mount any disks you need, and finally issue "
18304 "actions/commands. So the general order of the day is:"
18308 #: ../fish/guestfish.pod:447
18309 msgid "add or -a/--add"
18313 #: ../fish/guestfish.pod:451
18314 msgid "launch (aka run)"
18318 #: ../fish/guestfish.pod:455
18319 msgid "mount or -m/--mount"
18323 #: ../fish/guestfish.pod:459
18324 msgid "any other commands"
18328 #: ../fish/guestfish.pod:463
18330 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18331 "guest before mounting or performing any other commands."
18335 #: ../fish/guestfish.pod:466
18337 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18338 "I<--new> options were given then C<run> is done automatically, simply "
18339 "because guestfish can't perform the action you asked for without doing this."
18343 #: ../fish/guestfish.pod:471
18344 msgid "OPENING DISKS FOR READ AND WRITE"
18348 #: ../fish/guestfish.pod:473
18350 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
18351 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
18352 "I<-i> and I<-m> open disk images read-only or for writing."
18356 #: ../fish/guestfish.pod:478
18358 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
18359 "opening disk images supplied on the command line for write. To open a disk "
18360 "image read-only you have to do I<-a image --ro>."
18364 #: ../fish/guestfish.pod:482
18366 "This matters: If you accidentally open a live VM disk image writable then "
18367 "you will cause irreversible disk corruption."
18371 #: ../fish/guestfish.pod:485
18373 "In a future libguestfs we intend to change the default the other way. Disk "
18374 "images will be opened read-only. You will have to either specify "
18375 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
18376 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
18377 "access for disk images specified by those other command line options."
18381 #: ../fish/guestfish.pod:492
18383 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
18384 "which does nothing (it is already the default). However it is highly "
18385 "recommended that you use this option to indicate that you need write access, "
18386 "and prepare your scripts for the day when this option will be required for "
18391 #: ../fish/guestfish.pod:498
18393 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18394 "other libguestfs program apart from guestfish and guestmount."
18398 #: ../fish/guestfish.pod:501
18403 #: ../fish/guestfish.pod:503
18405 "You can quote ordinary parameters using either single or double quotes. For "
18410 #: ../fish/guestfish.pod:506
18413 " add \"file with a space.img\"\n"
18418 #: ../fish/guestfish.pod:508
18421 " rm '/file name'\n"
18426 #: ../fish/guestfish.pod:510
18434 #: ../fish/guestfish.pod:512
18436 "A few commands require a list of strings to be passed. For these, use a "
18437 "whitespace-separated list, enclosed in quotes. Strings containing "
18438 "whitespace to be passed through must be enclosed in single quotes. A "
18439 "literal single quote must be escaped with a backslash."
18443 #: ../fish/guestfish.pod:517
18446 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18447 " command \"/bin/echo 'foo bar'\"\n"
18448 " command \"/bin/echo \\'foo\\'\"\n"
18453 #: ../fish/guestfish.pod:521
18454 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
18458 #: ../fish/guestfish.pod:523
18460 "In double-quoted arguments (only) use backslash to insert special "
18465 #: ../fish/guestfish.pod:528
18470 #: ../fish/guestfish.pod:530
18471 msgid "Alert (bell) character."
18475 #: ../fish/guestfish.pod:532
18480 #: ../fish/guestfish.pod:534
18481 msgid "Backspace character."
18485 #: ../fish/guestfish.pod:536
18490 #: ../fish/guestfish.pod:538
18491 msgid "Form feed character."
18495 #: ../fish/guestfish.pod:540
18500 #: ../fish/guestfish.pod:542
18501 msgid "Newline character."
18505 #: ../fish/guestfish.pod:544
18510 #: ../fish/guestfish.pod:546
18511 msgid "Carriage return character."
18515 #: ../fish/guestfish.pod:548
18520 #: ../fish/guestfish.pod:550
18521 msgid "Horizontal tab character."
18525 #: ../fish/guestfish.pod:552
18530 #: ../fish/guestfish.pod:554
18531 msgid "Vertical tab character."
18535 #: ../fish/guestfish.pod:556
18540 #: ../fish/guestfish.pod:558
18541 msgid "A literal double quote character."
18545 #: ../fish/guestfish.pod:560
18550 #: ../fish/guestfish.pod:562
18552 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
18557 #: ../fish/guestfish.pod:565
18562 #: ../fish/guestfish.pod:567
18563 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
18567 #: ../fish/guestfish.pod:570
18569 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
18574 #: ../fish/guestfish.pod:573
18579 #: ../fish/guestfish.pod:575
18580 msgid "A literal backslash character."
18584 #: ../fish/guestfish.pod:579
18585 msgid "OPTIONAL ARGUMENTS"
18589 #: ../fish/guestfish.pod:581
18591 "Some commands take optional arguments. These arguments appear in this "
18592 "documentation as C<[argname:..]>. You can use them as in these examples:"
18596 #: ../fish/guestfish.pod:585
18599 " add-drive-opts filename\n"
18604 #: ../fish/guestfish.pod:587
18607 " add-drive-opts filename readonly:true\n"
18612 #: ../fish/guestfish.pod:589
18615 " add-drive-opts filename format:qcow2 readonly:false\n"
18620 #: ../fish/guestfish.pod:591
18622 "Each optional argument can appear at most once. All optional arguments must "
18623 "appear after the required ones."
18627 #: ../fish/guestfish.pod:594
18632 #: ../fish/guestfish.pod:596
18633 msgid "This section applies to all commands which can take integers as parameters."
18637 #: ../fish/guestfish.pod:599
18638 msgid "SIZE SUFFIX"
18642 #: ../fish/guestfish.pod:601
18644 "When the command takes a parameter measured in bytes, you can use one of the "
18645 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18649 #: ../fish/guestfish.pod:607
18650 msgid "B<k> or B<K> or B<KiB>"
18654 #: ../fish/guestfish.pod:609
18655 msgid "The size in kilobytes (multiplied by 1024)."
18659 #: ../fish/guestfish.pod:611
18664 #: ../fish/guestfish.pod:613
18665 msgid "The size in SI 1000 byte units."
18669 #: ../fish/guestfish.pod:615
18670 msgid "B<M> or B<MiB>"
18674 #: ../fish/guestfish.pod:617
18675 msgid "The size in megabytes (multiplied by 1048576)."
18679 #: ../fish/guestfish.pod:619
18684 #: ../fish/guestfish.pod:621
18685 msgid "The size in SI 1000000 byte units."
18689 #: ../fish/guestfish.pod:623
18690 msgid "B<G> or B<GiB>"
18694 #: ../fish/guestfish.pod:625
18695 msgid "The size in gigabytes (multiplied by 2**30)."
18699 #: ../fish/guestfish.pod:627
18704 #: ../fish/guestfish.pod:629
18705 msgid "The size in SI 10**9 byte units."
18709 #: ../fish/guestfish.pod:631
18710 msgid "B<T> or B<TiB>"
18714 #: ../fish/guestfish.pod:633
18715 msgid "The size in terabytes (multiplied by 2**40)."
18719 #: ../fish/guestfish.pod:635
18724 #: ../fish/guestfish.pod:637
18725 msgid "The size in SI 10**12 byte units."
18729 #: ../fish/guestfish.pod:639
18730 msgid "B<P> or B<PiB>"
18734 #: ../fish/guestfish.pod:641
18735 msgid "The size in petabytes (multiplied by 2**50)."
18739 #: ../fish/guestfish.pod:643
18744 #: ../fish/guestfish.pod:645
18745 msgid "The size in SI 10**15 byte units."
18749 #: ../fish/guestfish.pod:647
18750 msgid "B<E> or B<EiB>"
18754 #: ../fish/guestfish.pod:649
18755 msgid "The size in exabytes (multiplied by 2**60)."
18759 #: ../fish/guestfish.pod:651
18764 #: ../fish/guestfish.pod:653
18765 msgid "The size in SI 10**18 byte units."
18769 #: ../fish/guestfish.pod:655
18770 msgid "B<Z> or B<ZiB>"
18774 #: ../fish/guestfish.pod:657
18775 msgid "The size in zettabytes (multiplied by 2**70)."
18779 #: ../fish/guestfish.pod:659
18784 #: ../fish/guestfish.pod:661
18785 msgid "The size in SI 10**21 byte units."
18789 #: ../fish/guestfish.pod:663
18790 msgid "B<Y> or B<YiB>"
18794 #: ../fish/guestfish.pod:665
18795 msgid "The size in yottabytes (multiplied by 2**80)."
18799 #: ../fish/guestfish.pod:667
18804 #: ../fish/guestfish.pod:669
18805 msgid "The size in SI 10**24 byte units."
18809 #: ../fish/guestfish.pod:675
18812 " truncate-size /file 1G\n"
18817 #: ../fish/guestfish.pod:677
18818 msgid "would truncate the file to 1 gigabyte."
18822 #: ../fish/guestfish.pod:679
18824 "Be careful because a few commands take sizes in kilobytes or megabytes "
18825 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18826 "Adding a suffix will probably not do what you expect."
18830 #: ../fish/guestfish.pod:683
18831 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18835 #: ../fish/guestfish.pod:685
18837 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18838 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18842 #: ../fish/guestfish.pod:688
18845 " 1234 decimal number 1234\n"
18846 " 02322 octal number, equivalent to decimal 1234\n"
18847 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18852 #: ../fish/guestfish.pod:692
18854 "When using the C<chmod> command, you almost always want to specify an octal "
18855 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18856 "L<chmod(1)> program):"
18860 #: ../fish/guestfish.pod:696
18863 " chmod 0777 /public # OK\n"
18864 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18869 #: ../fish/guestfish.pod:699
18871 "Commands that return numbers usually print them in decimal, but some "
18872 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18873 "octal, preceeded by C<0>)."
18877 #: ../fish/guestfish.pod:703
18878 msgid "WILDCARDS AND GLOBBING"
18882 #: ../fish/guestfish.pod:705
18884 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18885 "(globbing) by default. So for example the following will not do what you "
18890 #: ../fish/guestfish.pod:709
18898 #: ../fish/guestfish.pod:711
18900 "Assuming you don't have a directory called literally C</home/*> then the "
18901 "above command will return an error."
18905 #: ../fish/guestfish.pod:714
18906 msgid "To perform wildcard expansion, use the C<glob> command."
18910 #: ../fish/guestfish.pod:716
18913 " glob rm-rf /home/*\n"
18918 #: ../fish/guestfish.pod:718
18920 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18921 "many times), equivalent to:"
18925 #: ../fish/guestfish.pod:721
18928 " rm-rf /home/jim\n"
18929 " rm-rf /home/joe\n"
18930 " rm-rf /home/mary\n"
18935 #: ../fish/guestfish.pod:725
18936 msgid "C<glob> only works on simple guest paths and not on device names."
18940 #: ../fish/guestfish.pod:727
18942 "If you have several parameters, each containing a wildcard, then glob will "
18943 "perform a Cartesian product."
18947 #: ../fish/guestfish.pod:730
18952 #: ../fish/guestfish.pod:732
18954 "Any line which starts with a I<#> character is treated as a comment and "
18955 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18956 "a command. For example:"
18960 #: ../fish/guestfish.pod:736
18963 " # this is a comment\n"
18964 " # this is a comment\n"
18965 " foo # NOT a comment\n"
18970 #: ../fish/guestfish.pod:740
18971 msgid "Blank lines are also ignored."
18975 #: ../fish/guestfish.pod:742
18976 msgid "RUNNING COMMANDS LOCALLY"
18980 #: ../fish/guestfish.pod:744
18982 "Any line which starts with a I<!> character is treated as a command sent to "
18983 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18987 #: ../fish/guestfish.pod:748
18991 " tgz-out /remote local/remote-data.tar.gz\n"
18996 #: ../fish/guestfish.pod:751
18998 "will create a directory C<local> on the host, and then export the contents "
18999 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19000 "(See C<tgz-out>)."
19004 #: ../fish/guestfish.pod:755
19006 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19007 "effect, due to the way that subprocesses work in Unix."
19011 #: ../fish/guestfish.pod:758
19012 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
19016 #: ../fish/guestfish.pod:760
19018 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
19019 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
19020 "and executed as guestfish commands."
19024 #: ../fish/guestfish.pod:764
19026 "Thus you can use shell script to construct arbitrary guestfish commands "
19027 "which are then parsed by guestfish."
19031 #: ../fish/guestfish.pod:767
19033 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
19034 "through C</foo.100>) using guestfish commands alone. However this is simple "
19035 "if we use a shell script to create the guestfish commands for us:"
19039 #: ../fish/guestfish.pod:772
19042 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
19047 #: ../fish/guestfish.pod:774
19048 msgid "or with names like C</foo.001>:"
19052 #: ../fish/guestfish.pod:776
19055 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
19060 #: ../fish/guestfish.pod:778
19062 "When using guestfish interactively it can be helpful to just run the shell "
19063 "script first (ie. remove the initial C<E<lt>> character so it is just an "
19064 "ordinary I<!> local command), see what guestfish commands it would run, and "
19065 "when you are happy with those prepend the C<E<lt>> character to run the "
19066 "guestfish commands for real."
19070 #: ../fish/guestfish.pod:784
19075 #: ../fish/guestfish.pod:786
19077 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19078 "command (a guestfish command) to the second command (any host command). For "
19083 #: ../fish/guestfish.pod:790
19086 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19091 #: ../fish/guestfish.pod:792
19093 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19094 "program). The above command would list all accounts in the guest filesystem "
19095 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19099 #: ../fish/guestfish.pod:797
19102 " hexdump /bin/ls | head\n"
19103 " list-devices | tail -1\n"
19104 " tgz-out / - | tar ztf -\n"
19109 #: ../fish/guestfish.pod:801
19111 "The space before the pipe symbol is required, any space after the pipe "
19112 "symbol is optional. Everything after the pipe symbol is just passed "
19113 "straight to the host shell, so it can contain redirections, globs and "
19114 "anything else that makes sense on the host side."
19118 #: ../fish/guestfish.pod:806
19120 "To use a literal argument which begins with a pipe symbol, you have to quote "
19125 #: ../fish/guestfish.pod:809
19133 #: ../fish/guestfish.pod:811
19134 msgid "HOME DIRECTORIES"
19138 #: ../fish/guestfish.pod:813
19140 "If a parameter starts with the character C<~> then the tilde may be expanded "
19141 "as a home directory path (either C<~> for the current user's home directory, "
19142 "or C<~user> for another user)."
19146 #: ../fish/guestfish.pod:817
19148 "Note that home directory expansion happens for users known I<on the host>, "
19149 "not in the guest filesystem."
19153 #: ../fish/guestfish.pod:820
19155 "To use a literal argument which begins with a tilde, you have to quote it, "
19160 #: ../fish/guestfish.pod:823
19168 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:534
19169 msgid "ENCRYPTED DISKS"
19173 #: ../fish/guestfish.pod:827
19175 "Libguestfs has some support for Linux guests encrypted according to the "
19176 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19177 "disk encryption systems used by modern Linux guests. Currently only "
19178 "LVM-on-LUKS is supported."
19182 #: ../fish/guestfish.pod:832
19183 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19187 #: ../fish/guestfish.pod:834
19190 " ><fs> vfs-type /dev/sda2\n"
19196 #: ../fish/guestfish.pod:837
19198 "Then open those devices using L</luks-open>. This creates a device-mapper "
19199 "device called C</dev/mapper/luksdev>."
19203 #: ../fish/guestfish.pod:840
19206 " ><fs> luks-open /dev/sda2 luksdev\n"
19207 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19212 #: ../fish/guestfish.pod:843
19214 "Finally you have to tell LVM to scan for volume groups on the newly created "
19219 #: ../fish/guestfish.pod:846
19223 " vg-activate-all true\n"
19228 #: ../fish/guestfish.pod:849
19229 msgid "The logical volume(s) can now be mounted in the usual way."
19233 #: ../fish/guestfish.pod:851
19235 "Before closing a LUKS device you must unmount any logical volumes on it and "
19236 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19237 "one. Then you can close the mapper device:"
19241 #: ../fish/guestfish.pod:855
19244 " vg-activate false /dev/VG\n"
19245 " luks-close /dev/mapper/luksdev\n"
19250 #: ../fish/guestfish.pod:860
19252 "If a path is prefixed with C<win:> then you can use Windows-style drive "
19253 "letters and paths (with some limitations). The following commands are "
19258 #: ../fish/guestfish.pod:864
19261 " file /WINDOWS/system32/config/system.LOG\n"
19266 #: ../fish/guestfish.pod:866
19269 " file win:\\windows\\system32\\config\\system.log\n"
19274 #: ../fish/guestfish.pod:868
19277 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
19282 #: ../fish/guestfish.pod:870
19284 "The parameter is rewritten \"behind the scenes\" by looking up the position "
19285 "where the drive is mounted, prepending that to the path, changing all "
19286 "backslash characters to forward slash, then resolving the result using "
19287 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
19288 "then the parameter might be rewritten like this:"
19292 #: ../fish/guestfish.pod:876
19295 " win:e:\\foo\\bar => /e/FOO/bar\n"
19300 #: ../fish/guestfish.pod:878
19301 msgid "This only works in argument positions that expect a path."
19305 #: ../fish/guestfish.pod:880
19306 msgid "UPLOADING AND DOWNLOADING FILES"
19310 #: ../fish/guestfish.pod:882
19312 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19313 "others which upload from or download to a local file, you can use the "
19314 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19318 #: ../fish/guestfish.pod:886
19326 #: ../fish/guestfish.pod:888
19327 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19331 #: ../fish/guestfish.pod:891
19334 " tar-out /etc - | tar tf -\n"
19339 #: ../fish/guestfish.pod:893
19341 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19342 "command (see L</PIPES>)."
19346 #: ../fish/guestfish.pod:896
19348 "When using C<-> to read from stdin, the input is read up to the end of "
19349 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19350 "some arbitrary end marker:"
19354 #: ../fish/guestfish.pod:900
19357 " upload -<<END /foo\n"
19366 #: ../fish/guestfish.pod:906
19368 "Any string of characters can be used instead of C<END>. The end marker must "
19369 "appear on a line of its own, without any preceeding or following characters "
19370 "(not even spaces)."
19374 #: ../fish/guestfish.pod:910
19376 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19377 "upload local files (so-called \"FileIn\" parameters in the generator)."
19381 #: ../fish/guestfish.pod:913
19382 msgid "EXIT ON ERROR BEHAVIOUR"
19386 #: ../fish/guestfish.pod:915
19388 "By default, guestfish will ignore any errors when in interactive mode "
19389 "(ie. taking commands from a human over a tty), and will exit on the first "
19390 "error in non-interactive mode (scripts, commands given on the command line)."
19394 #: ../fish/guestfish.pod:920
19396 "If you prefix a command with a I<-> character, then that command will not "
19397 "cause guestfish to exit, even if that (one) command returns an error."
19401 #: ../fish/guestfish.pod:924
19402 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19406 #: ../fish/guestfish.pod:926
19408 "Guestfish can be remote-controlled over a socket. This is useful "
19409 "particularly in shell scripts where you want to make several different "
19410 "changes to a filesystem, but you don't want the overhead of starting up a "
19411 "guestfish process each time."
19415 #: ../fish/guestfish.pod:931
19416 msgid "Start a guestfish server process using:"
19420 #: ../fish/guestfish.pod:933
19423 " eval \"`guestfish --listen`\"\n"
19428 #: ../fish/guestfish.pod:935
19429 msgid "and then send it commands by doing:"
19433 #: ../fish/guestfish.pod:937
19436 " guestfish --remote cmd [...]\n"
19441 #: ../fish/guestfish.pod:939
19442 msgid "To cause the server to exit, send it the exit command:"
19446 #: ../fish/guestfish.pod:943
19448 "Note that the server will normally exit if there is an error in a command. "
19449 "You can change this in the usual way. See section L</EXIT ON ERROR "
19454 #: ../fish/guestfish.pod:947
19455 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19459 #: ../fish/guestfish.pod:949
19461 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19462 "is how the I<--remote> option knows where to send the commands. You can "
19463 "have several guestfish listener processes running using:"
19467 #: ../fish/guestfish.pod:953
19470 " eval \"`guestfish --listen`\"\n"
19471 " pid1=$GUESTFISH_PID\n"
19472 " eval \"`guestfish --listen`\"\n"
19473 " pid2=$GUESTFISH_PID\n"
19475 " guestfish --remote=$pid1 cmd\n"
19476 " guestfish --remote=$pid2 cmd\n"
19481 #: ../fish/guestfish.pod:961
19482 msgid "REMOTE CONTROL AND CSH"
19486 #: ../fish/guestfish.pod:963
19488 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19493 #: ../fish/guestfish.pod:966
19496 " eval \"`guestfish --listen --csh`\"\n"
19501 #: ../fish/guestfish.pod:968
19502 msgid "REMOTE CONTROL DETAILS"
19506 #: ../fish/guestfish.pod:970
19508 "Remote control happens over a Unix domain socket called "
19509 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19510 "of the process, and C<$PID> is the process ID of the server."
19514 #: ../fish/guestfish.pod:974
19515 msgid "Guestfish client and server versions must match exactly."
19519 #: ../fish/guestfish.pod:976
19520 msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
19524 #: ../fish/guestfish.pod:978
19526 "From Bash, you can use the following code which creates a guestfish "
19527 "instance, correctly quotes the command line, handles failure to start, and "
19528 "cleans up guestfish when the script exits:"
19532 #: ../fish/guestfish.pod:982 ../src/guestfs.pod:980
19540 #: ../fish/guestfish.pod:986
19543 " guestfish[0]=\"guestfish\"\n"
19544 " guestfish[1]=\"--listen\"\n"
19545 " guestfish[2]=\"--ro\"\n"
19546 " guestfish[3]=\"-a\"\n"
19547 " guestfish[4]=\"disk.img\"\n"
19552 #: ../fish/guestfish.pod:992
19555 " GUESTFISH_PID=\n"
19556 " eval $(\"${guestfish[@]}\")\n"
19557 " if [ -z \"$GUESTFISH_PID\" ]; then\n"
19558 " echo \"error: guestfish didn't start up, see error messages above\"\n"
19565 #: ../fish/guestfish.pod:999
19568 " cleanup_guestfish ()\n"
19570 " guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
19572 " trap cleanup_guestfish EXIT ERR\n"
19577 #: ../fish/guestfish.pod:1005
19580 " guestfish --remote -- run\n"
19585 #: ../fish/guestfish.pod:1007
19593 #: ../fish/guestfish.pod:1009
19594 msgid "REMOTE CONTROL RUN COMMAND HANGING"
19598 #: ../fish/guestfish.pod:1011
19600 "Using the C<run> (or C<launch>) command remotely in a command substitution "
19601 "context hangs, ie. don't do (note the backquotes):"
19605 #: ../fish/guestfish.pod:1014
19608 " a=`guestfish --remote run`\n"
19613 #: ../fish/guestfish.pod:1016
19615 "Since the C<run> command produces no output on stdout, this is not useful "
19616 "anyway. For further information see "
19617 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
19621 #: ../fish/guestfish.pod:1020
19622 msgid "PREPARED DISK IMAGES"
19626 #: ../fish/guestfish.pod:1022
19628 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19629 "preformatted disk images that guestfish can make for you to save typing. "
19630 "This is particularly useful for testing purposes. This option is used "
19631 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19632 "can be mixed with I<-a>)."
19636 #: ../fish/guestfish.pod:1028
19638 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19639 "the second and so on. Existing files in the current directory are "
19644 #: ../fish/guestfish.pod:1032
19646 "The type briefly describes how the disk should be sized, partitioned, how "
19647 "filesystem(s) should be created, and how content should be added. "
19648 "Optionally the type can be followed by extra parameters, separated by C<:> "
19649 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19650 "sparsely-allocated disk, containing a single partition, with the partition "
19651 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19652 "on a 1GB disk instead."
19656 #: ../fish/guestfish.pod:1040
19657 msgid "To list the available types and any extra parameters they take, run:"
19661 #: ../fish/guestfish.pod:1044
19663 "Note that the prepared filesystem is not mounted. You would usually have to "
19664 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19668 #: ../fish/guestfish.pod:1048
19670 "If any I<-N> or I<--new> options are given, the guest is automatically "
19675 #: ../fish/guestfish.pod:1053
19676 msgid "Create a 100MB disk with an ext4-formatted partition:"
19680 #: ../fish/guestfish.pod:1055
19683 " guestfish -N fs:ext4\n"
19688 #: ../fish/guestfish.pod:1057
19689 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19693 #: ../fish/guestfish.pod:1059
19696 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19701 #: ../fish/guestfish.pod:1061
19702 msgid "Create a blank 200MB disk:"
19706 #: ../fish/guestfish.pod:1063
19709 " guestfish -N disk:200M\n"
19714 #: ../fish/guestfish.pod:1065
19715 msgid "PROGRESS BARS"
19719 #: ../fish/guestfish.pod:1067
19721 "Some (not all) long-running commands send progress notification messages as "
19722 "they are running. Guestfish turns these messages into progress bars."
19726 #: ../fish/guestfish.pod:1071
19728 "When a command that supports progress bars takes longer than two seconds to "
19729 "run, and if progress bars are enabled, then you will see one appearing below "
19734 #: ../fish/guestfish.pod:1075
19737 " ><fs> copy-size /large-file /another-file 2048M\n"
19738 " / 10% [#####-----------------------------------------] 00:30\n"
19743 #: ../fish/guestfish.pod:1078
19745 "The spinner on the left hand side moves round once for every progress "
19746 "notification received from the backend. This is a (reasonably) golden "
19747 "assurance that the command is \"doing something\" even if the progress bar "
19748 "is not moving, because the command is able to send the progress "
19749 "notifications. When the bar reaches 100% and the command finishes, the "
19750 "spinner disappears."
19754 #: ../fish/guestfish.pod:1085
19756 "Progress bars are enabled by default when guestfish is used interactively. "
19757 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19758 "and you can disable them completely using I<--no-progress-bars>."
19762 #: ../fish/guestfish.pod:1090
19763 msgid "GUESTFISH COMMANDS"
19767 #: ../fish/guestfish.pod:1092
19769 "The commands in this section are guestfish convenience commands, in other "
19770 "words, they are not part of the L<guestfs(3)> API."
19774 #: ../fish/guestfish.pod:1095
19779 #: ../fish/guestfish.pod:1097
19788 #: ../fish/guestfish.pod:1100
19789 msgid "Without any parameter, this provides general help."
19793 #: ../fish/guestfish.pod:1102
19794 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19798 #: ../fish/guestfish.pod:1104
19799 msgid "quit | exit"
19803 #: ../fish/guestfish.pod:1106
19804 msgid "This exits guestfish. You can also use C<^D> key."
19808 #: ../fish/guestfish.pod:1108
19809 msgid "@FISH_COMMANDS@"
19813 #: ../fish/guestfish.pod:1110
19818 #: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1520
19823 #: ../fish/guestfish.pod:1116
19825 "guestfish returns 0 if the commands completed without error, or 1 if there "
19830 #: ../fish/guestfish.pod:1123
19835 #: ../fish/guestfish.pod:1125
19837 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19842 #: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3213
19843 msgid "FEBOOTSTRAP_KERNEL"
19847 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3215
19848 msgid "FEBOOTSTRAP_MODULES"
19852 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3217
19854 "These two environment variables allow the kernel that libguestfs uses in the "
19855 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
19856 "most recent host kernel is chosen. For more information about kernel "
19857 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
19858 "available in febootstrap E<ge> 3.8."
19862 #: ../fish/guestfish.pod:1138
19863 msgid "GUESTFISH_DISPLAY_IMAGE"
19867 #: ../fish/guestfish.pod:1140
19869 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
19870 "If not set, it uses L<display(1)>."
19874 #: ../fish/guestfish.pod:1143
19875 msgid "GUESTFISH_PID"
19879 #: ../fish/guestfish.pod:1145
19881 "Used with the I<--remote> option to specify the remote guestfish process to "
19882 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19886 #: ../fish/guestfish.pod:1149
19891 #: ../fish/guestfish.pod:1151
19893 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19894 "not specified, the external L<hexedit(1)> program is used."
19898 #: ../fish/guestfish.pod:1155
19903 #: ../fish/guestfish.pod:1157
19905 "If compiled with GNU readline support, various files in the home directory "
19906 "can be used. See L</FILES>."
19910 #: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3223
19911 msgid "LIBGUESTFS_APPEND"
19915 #: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3225
19916 msgid "Pass additional options to the guest kernel."
19920 #: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3227
19921 msgid "LIBGUESTFS_DEBUG"
19925 #: ../fish/guestfish.pod:1166
19927 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19928 "effect as using the B<-v> option."
19932 #: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3232
19933 msgid "LIBGUESTFS_MEMSIZE"
19937 #: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3234
19938 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
19942 #: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3237
19945 " LIBGUESTFS_MEMSIZE=700\n"
19950 #: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3239
19951 msgid "LIBGUESTFS_PATH"
19955 #: ../fish/guestfish.pod:1178
19957 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19958 "the discussion of paths in L<guestfs(3)>."
19962 #: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3244
19963 msgid "LIBGUESTFS_QEMU"
19967 #: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3246
19969 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
19970 "which was found at compile time by the configure script is used."
19974 #: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3252
19975 msgid "LIBGUESTFS_TRACE"
19979 #: ../fish/guestfish.pod:1189
19980 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19984 #: ../fish/guestfish.pod:1191
19989 #: ../fish/guestfish.pod:1193
19991 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19996 #: ../fish/guestfish.pod:1196 ../sparsify/virt-sparsify.pod:236 ../src/guestfs.pod:3257
20001 #: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3259
20003 "Location of temporary directory, defaults to C</tmp> except for the cached "
20004 "supermin appliance which defaults to C</var/tmp>."
20008 #: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3262
20010 "If libguestfs was compiled to use the supermin appliance then the real "
20011 "appliance is cached in this directory, shared between all handles belonging "
20012 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
20013 "use in case C</var/tmp> is not large enough."
20017 #: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297 ../rescue/virt-rescue.pod:273
20022 #: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301 ../rescue/virt-rescue.pod:277
20023 msgid "$HOME/.libguestfs-tools.rc"
20027 #: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303 ../rescue/virt-rescue.pod:279
20028 msgid "/etc/libguestfs-tools.conf"
20032 #: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305 ../rescue/virt-rescue.pod:281
20034 "This configuration file controls the default read-only or read-write mode "
20035 "(I<--ro> or I<--rw>)."
20039 #: ../fish/guestfish.pod:1220
20040 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
20044 #: ../fish/guestfish.pod:1222
20045 msgid "$HOME/.guestfish"
20049 #: ../fish/guestfish.pod:1224
20051 "If compiled with GNU readline support, then the command history is saved in "
20056 #: ../fish/guestfish.pod:1227
20057 msgid "$HOME/.inputrc"
20061 #: ../fish/guestfish.pod:1229
20062 msgid "/etc/inputrc"
20066 #: ../fish/guestfish.pod:1231
20068 "If compiled with GNU readline support, then these files can be used to "
20069 "configure readline. For further information, please see "
20070 "L<readline(3)/INITIALIZATION FILE>."
20074 #: ../fish/guestfish.pod:1235
20075 msgid "To write rules which only apply to guestfish, use:"
20079 #: ../fish/guestfish.pod:1237
20089 #: ../fish/guestfish.pod:1241
20091 "Variables that you can set in inputrc that change the behaviour of guestfish "
20092 "in useful ways include:"
20096 #: ../fish/guestfish.pod:1246
20097 msgid "completion-ignore-case (default: on)"
20101 #: ../fish/guestfish.pod:1248
20103 "By default, guestfish will ignore case when tab-completing paths on the "
20108 #: ../fish/guestfish.pod:1251
20111 " set completion-ignore-case off\n"
20116 #: ../fish/guestfish.pod:1253
20117 msgid "to make guestfish case sensitive."
20121 #: ../fish/guestfish.pod:1257
20126 #: ../fish/guestfish.pod:1259
20127 msgid "test2.img (etc)"
20131 #: ../fish/guestfish.pod:1261
20133 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
20134 "will be created in the file C<test1.img> in the current directory. The "
20135 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
20136 "the same name will be overwritten."
20140 #: ../fish/guestfish.pod:1270
20142 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-alignment-scan(1)>, "
20143 "L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, "
20144 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
20145 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
20146 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
20147 "L<virt-sparsify(1)>, L<virt-sysprep(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
20148 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
20149 "L<febootstrap-supermin-helper(8)>."
20153 #: ../fish/guestfish.pod:1302 ../src/guestfs.pod:3354 ../test-tool/libguestfs-test-tool.pod:112
20154 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
20158 #: ../fish/virt-copy-in.pod:5
20159 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
20163 #: ../fish/virt-copy-in.pod:9
20166 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
20171 #: ../fish/virt-copy-in.pod:11
20174 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
20179 #: ../fish/virt-copy-in.pod:15
20181 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
20182 "causing disk corruption. The virtual machine must be shut down before you "
20183 "use this command."
20187 #: ../fish/virt-copy-in.pod:21
20189 "C<virt-copy-in> copies files and directories from the local disk into a "
20190 "virtual machine disk image or named libvirt domain."
20194 #: ../fish/virt-copy-in.pod:24
20196 "You can give one of more filenames and directories on the command line. "
20197 "Directories are copied in recursively. The final parameter must be the "
20198 "destination directory in the disk image which must be an absolute path "
20199 "starting with a C</> character."
20203 #: ../fish/virt-copy-in.pod:33
20206 " virt-copy-in -d MyGuest resolv.conf /etc\n"
20211 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
20212 msgid "Upload a home directory to a guest:"
20216 #: ../fish/virt-copy-in.pod:37
20219 " virt-copy-in -d MyGuest skel /home\n"
20224 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
20225 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
20229 #: ../fish/virt-copy-in.pod:41
20231 "This command is just a simple shell script wrapper around the "
20232 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
20233 "trivial copy, you are probably better off using guestfish directly."
20237 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
20239 "Since the shell script just passes options straight to guestfish, read "
20240 "L<guestfish(1)> to see the full list of options."
20244 #: ../fish/virt-copy-in.pod:52
20246 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
20247 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
20251 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
20252 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
20256 #: ../fish/virt-copy-out.pod:5
20258 "virt-copy-out - Copy files and directories out of a virtual machine disk "
20263 #: ../fish/virt-copy-out.pod:9
20266 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
20271 #: ../fish/virt-copy-out.pod:11
20274 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
20279 #: ../fish/virt-copy-out.pod:15
20281 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
20282 "image or named libvirt domain."
20286 #: ../fish/virt-copy-out.pod:18
20288 "You can give one of more filenames and directories on the command line. "
20289 "Directories are copied out recursively."
20293 #: ../fish/virt-copy-out.pod:23
20294 msgid "Download the home directories from a virtual machine:"
20298 #: ../fish/virt-copy-out.pod:25
20302 " virt-copy-out -d MyGuest /home homes\n"
20307 #: ../fish/virt-copy-out.pod:30
20309 "This command is just a simple shell script wrapper around the "
20310 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
20311 "trivial copy, you are probably better off using guestfish directly."
20315 #: ../fish/virt-copy-out.pod:41
20317 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
20318 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
20322 #: ../fish/virt-tar-in.pod:5
20323 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
20327 #: ../fish/virt-tar-in.pod:9
20330 " virt-tar-in -a disk.img data.tar /destination\n"
20335 #: ../fish/virt-tar-in.pod:11
20338 " virt-tar-in -d domain data.tar /destination\n"
20343 #: ../fish/virt-tar-in.pod:13
20346 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
20351 #: ../fish/virt-tar-in.pod:17
20353 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
20354 "causing disk corruption. The virtual machine must be shut down before you "
20355 "use this command."
20359 #: ../fish/virt-tar-in.pod:23
20361 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
20362 "image or named libvirt domain."
20366 #: ../fish/virt-tar-in.pod:26
20368 "The first parameter is the tar file. Use C<-> to read the tar file from "
20369 "standard input. The second parameter is the absolute target directory to "
20374 #: ../fish/virt-tar-in.pod:34
20377 " virt-tar-in -d MyGuest homes.tar /home\n"
20382 #: ../fish/virt-tar-in.pod:38
20384 "This command is just a simple shell script wrapper around the "
20385 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
20386 "copy, you are probably better off using guestfish directly."
20390 #: ../fish/virt-tar-in.pod:49
20392 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
20393 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
20394 "L<http://libguestfs.org/>."
20398 #: ../fish/virt-tar-out.pod:5
20399 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
20403 #: ../fish/virt-tar-out.pod:9
20406 " virt-tar-out -a disk.img /dir files.tar\n"
20411 #: ../fish/virt-tar-out.pod:11
20414 " virt-tar-out -d domain /dir files.tar\n"
20419 #: ../fish/virt-tar-out.pod:13
20422 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
20427 #: ../fish/virt-tar-out.pod:17
20428 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
20432 #: ../fish/virt-tar-out.pod:20
20434 "The first parameter is the absolute path of the virtual machine directory. "
20435 "The second parameter is the tar file to write. Use C<-> to write to "
20440 #: ../fish/virt-tar-out.pod:26
20441 msgid "Download the home directories from a guest:"
20445 #: ../fish/virt-tar-out.pod:28
20448 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
20453 #: ../fish/virt-tar-out.pod:32
20455 "This command is just a simple shell script wrapper around the "
20456 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
20457 "trivial copy, you are probably better off using guestfish directly."
20461 #: ../fish/virt-tar-out.pod:43
20463 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
20464 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
20468 #: ../fuse/guestmount.pod:5
20469 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
20473 #: ../fuse/guestmount.pod:9
20476 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
20481 #: ../fuse/guestmount.pod:11
20484 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
20489 #: ../fuse/guestmount.pod:13
20492 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
20497 #: ../fuse/guestmount.pod:17
20499 "You must I<not> use C<guestmount> in read-write mode on live virtual "
20500 "machines. If you do this, you risk disk corruption in the VM."
20504 #: ../fuse/guestmount.pod:22
20506 "The guestmount program can be used to mount virtual machine filesystems and "
20507 "other disk images on the host. It uses libguestfs for access to the guest "
20508 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
20509 "a mountable device."
20513 #: ../fuse/guestmount.pod:27
20515 "Along with other options, you have to give at least one device (I<-a> "
20516 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
20517 "option) or use the I<-i> inspection option or the I<--live> option. How "
20518 "this works is better explained in the L<guestfish(1)> manual page, or by "
20519 "looking at the examples below."
20523 #: ../fuse/guestmount.pod:33
20525 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
20526 "by you, and the filesystem will not be visible to any other users unless you "
20527 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
20528 "the filesystem, use the C<fusermount -u> command."
20532 #: ../fuse/guestmount.pod:41
20534 "For a typical Windows guest which has its main filesystem on the first "
20539 #: ../fuse/guestmount.pod:44
20542 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
20547 #: ../fuse/guestmount.pod:46
20549 "For a typical Linux guest which has a /boot filesystem on the first "
20550 "partition, and the root filesystem on a logical volume:"
20554 #: ../fuse/guestmount.pod:49
20557 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
20562 #: ../fuse/guestmount.pod:51
20563 msgid "To get libguestfs to detect guest mountpoints for you:"
20567 #: ../fuse/guestmount.pod:53
20570 " guestmount -a guest.img -i --ro /mnt\n"
20575 #: ../fuse/guestmount.pod:55
20576 msgid "For a libvirt guest called \"Guest\" you could do:"
20580 #: ../fuse/guestmount.pod:57
20583 " guestmount -d Guest -i --ro /mnt\n"
20588 #: ../fuse/guestmount.pod:59
20590 "If you don't know what filesystems are contained in a guest or disk image, "
20591 "use L<virt-filesystems(1)> first:"
20595 #: ../fuse/guestmount.pod:62
20598 " virt-filesystems MyGuest\n"
20603 #: ../fuse/guestmount.pod:64
20605 "If you want to trace the libguestfs calls but without excessive debugging "
20606 "information, we recommend:"
20610 #: ../fuse/guestmount.pod:67
20613 " guestmount [...] --trace /mnt\n"
20618 #: ../fuse/guestmount.pod:69
20619 msgid "If you want to debug the program, we recommend:"
20623 #: ../fuse/guestmount.pod:71
20626 " guestmount [...] --trace --verbose /mnt\n"
20631 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:621
20636 #: ../fuse/guestmount.pod:75
20637 msgid "Other users cannot see the filesystem by default"
20641 #: ../fuse/guestmount.pod:77
20643 "If you mount a filesystem as one user (eg. root), then other users will not "
20644 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
20645 "option when mounting:"
20649 #: ../fuse/guestmount.pod:81
20652 " sudo guestmount [...] -o allow_other /mnt\n"
20657 #: ../fuse/guestmount.pod:83
20658 msgid "Enabling FUSE"
20662 #: ../fuse/guestmount.pod:85
20664 "On some distros, you may need to add yourself to a special group "
20665 "(eg. C<fuse>) before you can use any FUSE filesystem. This is necessary on "
20666 "Debian and derivatives."
20670 #: ../fuse/guestmount.pod:89
20672 "On other distros, no special group is required. It is not necessary on "
20673 "Fedora or Red Hat Enterprise Linux."
20677 #: ../fuse/guestmount.pod:100
20678 msgid "Add a block device or virtual machine image."
20682 #: ../fuse/guestmount.pod:123
20683 msgid "B<--dir-cache-timeout N>"
20687 #: ../fuse/guestmount.pod:125
20689 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
20690 "seconds. The readdir cache [actually, there are several semi-independent "
20691 "caches] is populated after a readdir(2) call with the stat and extended "
20692 "attributes of the files in the directory, in anticipation that they will be "
20693 "requested soon after."
20697 #: ../fuse/guestmount.pod:131
20699 "There is also a different attribute cache implemented by FUSE (see the FUSE "
20700 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
20701 "requests, only cache existing ones."
20705 #: ../fuse/guestmount.pod:151
20707 "If you have untrusted raw-format guest disk images, you should use this "
20708 "option to specify the disk format. This avoids a possible security problem "
20709 "with malicious guests (CVE-2010-3851). See also "
20710 "L<guestfs(3)/guestfs_add_drive_opts>."
20714 #: ../fuse/guestmount.pod:156
20715 msgid "B<--fuse-help>"
20719 #: ../fuse/guestmount.pod:158
20720 msgid "Display help on special FUSE options (see I<-o> below)."
20724 #: ../fuse/guestmount.pod:162
20725 msgid "Display brief help and exit."
20729 #: ../fuse/guestmount.pod:186
20731 "Mount the named partition or logical volume on the given mountpoint B<in the "
20732 "guest> (this has nothing to do with mountpoints in the host)."
20736 #: ../fuse/guestmount.pod:189
20738 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
20739 "something on C</>."
20743 #: ../fuse/guestmount.pod:206
20745 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
20746 "unmounted. If you specify this option, then we don't attempt to sync the "
20747 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
20751 #: ../fuse/guestmount.pod:211
20752 msgid "B<-o option>"
20756 #: ../fuse/guestmount.pod:213
20757 msgid "B<--option option>"
20761 #: ../fuse/guestmount.pod:215
20762 msgid "Pass extra options to FUSE."
20766 #: ../fuse/guestmount.pod:217
20768 "To get a list of all the extra options supported by FUSE, use the command "
20769 "below. Note that only the FUSE I<-o> options can be passed, and only some "
20770 "of them are a good idea."
20774 #: ../fuse/guestmount.pod:221
20777 " guestmount --fuse-help\n"
20782 #: ../fuse/guestmount.pod:223
20783 msgid "Some potentially useful FUSE options:"
20787 #: ../fuse/guestmount.pod:227
20788 msgid "B<-o allow_other>"
20792 #: ../fuse/guestmount.pod:229
20793 msgid "Allow other users to see the filesystem."
20797 #: ../fuse/guestmount.pod:231
20798 msgid "B<-o attr_timeout=N>"
20802 #: ../fuse/guestmount.pod:233
20803 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
20807 #: ../fuse/guestmount.pod:235
20808 msgid "B<-o kernel_cache>"
20812 #: ../fuse/guestmount.pod:237
20814 "Allow the kernel to cache files (reduces the number of reads that have to go "
20815 "through the L<guestfs(3)> API). This is generally a good idea if you can "
20816 "afford the extra memory usage."
20820 #: ../fuse/guestmount.pod:241
20821 msgid "B<-o uid=N> B<-o gid=N>"
20825 #: ../fuse/guestmount.pod:243
20827 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
20828 "the chosen values."
20832 #: ../fuse/guestmount.pod:252
20834 "Add devices and mount everything read-only. Also disallow writes and make "
20835 "the disk appear read-only to FUSE."
20839 #: ../fuse/guestmount.pod:255
20841 "This is highly recommended if you are not going to edit the guest disk. If "
20842 "the guest is running and this option is I<not> supplied, then there is a "
20843 "strong risk of disk corruption in the guest. We try to prevent this from "
20844 "happening, but it is not always possible."
20848 #: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:171
20849 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
20853 #: ../fuse/guestmount.pod:264
20854 msgid "Enable SELinux support for the guest."
20858 #: ../fuse/guestmount.pod:270
20859 msgid "Enable verbose messages from underlying libguestfs."
20863 #: ../fuse/guestmount.pod:276
20864 msgid "Display the program version and exit."
20868 #: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308 ../rescue/virt-rescue.pod:201 ../rescue/virt-rescue.pod:284
20869 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
20873 #: ../fuse/guestmount.pod:289
20878 #: ../fuse/guestmount.pod:291
20879 msgid "Trace libguestfs calls and entry into each FUSE function."
20883 #: ../fuse/guestmount.pod:293
20884 msgid "This also stops the daemon from forking into the background."
20888 #: ../fuse/guestmount.pod:319
20890 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20891 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
20892 "L<http://fuse.sf.net/>."
20896 #: ../fuse/guestmount.pod:334
20897 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
20901 #: ../inspector/virt-inspector.pod:5
20903 "virt-inspector - Display operating system version and other information "
20904 "about a virtual machine"
20908 #: ../inspector/virt-inspector.pod:9
20911 " virt-inspector [--options] -d domname\n"
20916 #: ../inspector/virt-inspector.pod:11
20919 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
20924 #: ../inspector/virt-inspector.pod:15
20927 " virt-inspector domname\n"
20932 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
20935 " virt-inspector disk.img [disk.img ...]\n"
20940 #: ../inspector/virt-inspector.pod:21
20942 "B<virt-inspector> examines a virtual machine or disk image and tries to "
20943 "determine the version of the operating system and other information about "
20944 "the virtual machine."
20948 #: ../inspector/virt-inspector.pod:25
20949 msgid "Virt-inspector produces XML output for feeding into other programs."
20953 #: ../inspector/virt-inspector.pod:27
20955 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
20956 "the libvirt domain (see: C<virsh list --all>)."
20960 #: ../inspector/virt-inspector.pod:30
20962 "You can also run virt-inspector directly on disk images from a single "
20963 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
20964 "has several block devices, in which case you should list several I<-a> "
20965 "options one after another, with the first corresponding to the guest's "
20966 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
20970 #: ../inspector/virt-inspector.pod:37
20972 "You can also run virt-inspector on install disks, live CDs, bootable USB "
20973 "keys and similar."
20977 #: ../inspector/virt-inspector.pod:40
20979 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
20980 "inspect several virtual machines, you have to run virt-inspector several "
20981 "times (for example, from a shell script for-loop)."
20985 #: ../inspector/virt-inspector.pod:45
20987 "Because virt-inspector needs direct access to guest images, it won't "
20988 "normally work over remote libvirt connections."
20992 #: ../inspector/virt-inspector.pod:48
20994 "All of the information available from virt-inspector is also available "
20995 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
20996 "The same information can also be fetched using guestfish or via libguestfs "
20997 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
20998 "WITH OTHER PROGRAMMING LANGUAGES>)."
21002 #: ../inspector/virt-inspector.pod:81
21004 "Libvirt is only used if you specify a C<domname> on the command line. If "
21005 "you specify guest block devices directly (I<-a>), then libvirt is not used "
21010 #: ../inspector/virt-inspector.pod:94
21012 "When prompting for keys and passphrases, virt-inspector normally turns "
21013 "echoing off so you cannot see what you are typing. If you are not worried "
21014 "about Tempest attacks and there is no one else in the room you can specify "
21015 "this flag to see what you are typing."
21019 #: ../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
21021 "Specify the format of disk images given on the command line. If this is "
21022 "omitted then the format is autodetected from the content of the disk image."
21026 #: ../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
21028 "If disk images are requested from libvirt, then this program asks libvirt "
21029 "for this information. In this case, the value of the format parameter is "
21034 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:391 ../resize/virt-resize.pod:483 ../sparsify/virt-sparsify.pod:132 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
21036 "If working with untrusted raw-format guest disk images, you should ensure "
21037 "the format is always specified."
21041 #: ../inspector/virt-inspector.pod:139
21042 msgid "Previous versions of virt-inspector allowed you to write either:"
21046 #: ../inspector/virt-inspector.pod:145
21049 " virt-inspector guestname\n"
21054 #: ../inspector/virt-inspector.pod:153
21059 #: ../inspector/virt-inspector.pod:155
21061 "The virt-inspector XML is described precisely in a RELAX NG schema file "
21062 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
21063 "just an overview."
21067 #: ../inspector/virt-inspector.pod:159
21069 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
21070 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
21071 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
21072 "which is vanishingly rare in real world VMs."
21076 #: ../inspector/virt-inspector.pod:164
21077 msgid "E<lt>operatingsystemE<gt>"
21081 #: ../inspector/virt-inspector.pod:166
21083 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
21084 "describe the operating system, its architecture, the descriptive \"product "
21085 "name\" string, the type of OS and so on, as in this example:"
21089 #: ../inspector/virt-inspector.pod:170
21092 " <operatingsystems>\n"
21093 " <operatingsystem>\n"
21094 " <root>/dev/sda2</root>\n"
21095 " <name>windows</name>\n"
21096 " <arch>i386</arch>\n"
21097 " <distro>windows</distro>\n"
21098 " <product_name>Windows 7 Enterprise</product_name>\n"
21099 " <product_variant>Client</product_variant>\n"
21100 " <major_version>6</major_version>\n"
21101 " <minor_version>1</minor_version>\n"
21102 " <windows_systemroot>/Windows</windows_systemroot>\n"
21103 " <format>installed</format>\n"
21108 #: ../inspector/virt-inspector.pod:183
21110 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
21111 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
21112 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
21113 "architecture. The other fields are fairly self-explanatory, but because "
21114 "these fields are taken directly from the libguestfs inspection API you can "
21115 "find precise information from L<guestfs(3)/INSPECTION>."
21119 #: ../inspector/virt-inspector.pod:191
21121 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
21122 "of view of libguestfs (block devices may have completely different names "
21123 "inside the VM itself)."
21127 #: ../inspector/virt-inspector.pod:195
21128 msgid "E<lt>mountpointsE<gt>"
21132 #: ../inspector/virt-inspector.pod:197
21134 "Un*x-like guests typically have multiple filesystems which are mounted at "
21135 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
21136 "element which looks like this:"
21140 #: ../inspector/virt-inspector.pod:201
21143 " <operatingsystems>\n"
21144 " <operatingsystem>\n"
21147 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
21148 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
21149 " </mountpoints>\n"
21154 #: ../inspector/virt-inspector.pod:209
21156 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
21157 "and may have completely different names inside the guest. Only mountable "
21158 "filesystems appear in this list, not things like swap devices."
21162 #: ../inspector/virt-inspector.pod:214
21163 msgid "E<lt>filesystemsE<gt>"
21167 #: ../inspector/virt-inspector.pod:216
21169 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
21170 "filesystems belonging to the guest, including swap and empty partitions. "
21171 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
21172 "this OS or shared with this OS and other OSes)."
21176 #: ../inspector/virt-inspector.pod:222
21177 msgid "You might see something like this:"
21181 #: ../inspector/virt-inspector.pod:224
21184 " <operatingsystems>\n"
21185 " <operatingsystem>\n"
21188 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
21189 " <type>ext4</type>\n"
21190 " <label>Fedora-13-x86_64</label>\n"
21191 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
21197 #: ../inspector/virt-inspector.pod:234
21199 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
21200 "the label, and the UUID."
21204 #: ../inspector/virt-inspector.pod:237
21205 msgid "E<lt>applicationsE<gt>"
21209 #: ../inspector/virt-inspector.pod:239
21211 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
21212 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
21217 #: ../inspector/virt-inspector.pod:243
21219 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
21220 "Typical values would be C<rpm> and C<deb>."
21224 #: ../inspector/virt-inspector.pod:246
21226 "E<lt>package_managementE<gt>, if present, describes the package manager. "
21227 "Typical values include C<yum>, C<up2date> and C<apt>"
21231 #: ../inspector/virt-inspector.pod:249
21232 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
21236 #: ../inspector/virt-inspector.pod:252
21239 " <operatingsystems>\n"
21240 " <operatingsystem>\n"
21242 " <applications>\n"
21244 " <name>coreutils</name>\n"
21245 " <version>8.5</version>\n"
21246 " <release>1</release>\n"
21247 " </application>\n"
21252 #: ../inspector/virt-inspector.pod:262
21254 "The version and release fields may not be available for some types guests. "
21255 "Other fields are possible, see "
21256 "L<guestfs(3)/guestfs_inspect_list_applications>."
21260 #: ../inspector/virt-inspector.pod:266
21261 msgid "E<lt>drive_mappingsE<gt>"
21265 #: ../inspector/virt-inspector.pod:268
21267 "For operating systems like Windows which use drive letters, virt-inspector "
21268 "is able to find out how drive letters map to filesystems."
21272 #: ../inspector/virt-inspector.pod:272
21275 " <operatingsystems>\n"
21276 " <operatingsystem>\n"
21278 " <drive_mappings>\n"
21279 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
21280 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
21281 " </drive_mappings>\n"
21286 #: ../inspector/virt-inspector.pod:280
21288 "In the example above, drive C maps to the filesystem on the second partition "
21289 "on the first disk, and drive E maps to the filesystem on the first partition "
21290 "on the second disk."
21294 #: ../inspector/virt-inspector.pod:284
21296 "Note that this only covers permanent local filesystem mappings, not things "
21297 "like network shares. Furthermore NTFS volume mount points may not be listed "
21302 #: ../inspector/virt-inspector.pod:288
21303 msgid "E<lt>iconE<gt>"
21307 #: ../inspector/virt-inspector.pod:290
21309 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
21310 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
21311 "very large and high quality."
21315 #: ../inspector/virt-inspector.pod:294
21318 " <operatingsystems>\n"
21319 " <operatingsystem>\n"
21322 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
21323 " [... many lines of base64 data ...]\n"
21329 #: ../inspector/virt-inspector.pod:302
21331 "To display the icon, you have to extract it and convert the base64 data back "
21332 "to a binary file. Use an XPath query or simply an editor to extract the "
21333 "data, then use the coreutils L<base64(1)> program to do the conversion back "
21338 #: ../inspector/virt-inspector.pod:307
21341 " base64 -i -d < icon.data > icon.png\n"
21346 #: ../inspector/virt-inspector.pod:309
21347 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
21351 #: ../inspector/virt-inspector.pod:311
21353 "Virt-inspector can detect some operating system installers on install disks, "
21354 "live CDs, bootable USB keys and more."
21358 #: ../inspector/virt-inspector.pod:314
21360 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
21361 "fields may be present to indicate a live CD, network installer, or one part "
21362 "of a multipart CD. For example:"
21366 #: ../inspector/virt-inspector.pod:318
21369 " <operatingsystems>\n"
21370 " <operatingsystem>\n"
21371 " <root>/dev/sda</root>\n"
21372 " <name>linux</name>\n"
21373 " <arch>i386</arch>\n"
21374 " <distro>ubuntu</distro>\n"
21375 " <product_name>Ubuntu 10.10 "Maverick "
21376 "Meerkat"</product_name>\n"
21377 " <major_version>10</major_version>\n"
21378 " <minor_version>10</minor_version>\n"
21379 " <format>installer</format>\n"
21385 #: ../inspector/virt-inspector.pod:330
21386 msgid "USING XPATH"
21390 #: ../inspector/virt-inspector.pod:332
21392 "You can use the XPath query language to select parts of the XML. We "
21393 "recommend using C<xmlstarlet> to perform XPath queries from the command "
21398 #: ../inspector/virt-inspector.pod:338
21401 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
21403 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
21404 " <type>ext4</type>\n"
21410 #: ../inspector/virt-inspector.pod:344
21413 " $ virt-inspector -d Guest | \\\n"
21414 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
21420 #: ../inspector/virt-inspector.pod:348
21423 " $ virt-inspector -d Guest | \\\n"
21424 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
21425 " [displays the guest icon, if there is one]\n"
21430 #: ../inspector/virt-inspector.pod:359
21431 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
21435 #: ../inspector/virt-inspector.pod:361
21437 "Early versions of libguestfs shipped with a different virt-inspector program "
21438 "written in Perl (the current version is written in C). The XML output of "
21439 "the Perl virt-inspector was different and it could also output in other "
21440 "formats like text."
21444 #: ../inspector/virt-inspector.pod:366
21445 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
21449 #: ../inspector/virt-inspector.pod:369
21451 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
21452 "versions of virt-inspector with different names:"
21456 #: ../inspector/virt-inspector.pod:372
21459 " virt-inspector Old Perl version.\n"
21460 " virt-inspector2 New C version.\n"
21465 #: ../inspector/virt-inspector.pod:382
21467 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
21468 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
21472 #: ../inspector/virt-inspector.pod:399
21473 msgid "Matthew Booth L<mbooth@redhat.com>"
21477 #: ../java/examples/guestfs-java.pod:5
21478 msgid "guestfs-java - How to use libguestfs from Java"
21482 #: ../java/examples/guestfs-java.pod:9
21485 " import com.redhat.et.libguestfs.*;\n"
21490 #: ../java/examples/guestfs-java.pod:11
21493 " GuestFS g = new GuestFS ();\n"
21494 " g.add_drive_opts (\"disk.img\", null);\n"
21500 #: ../java/examples/guestfs-java.pod:17
21502 "This manual page documents how to call libguestfs from the Java programming "
21503 "language. This page just documents the differences from the C API and gives "
21504 "some examples. If you are not familiar with using libguestfs, you also need "
21505 "to read L<guestfs(3)>."
21509 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
21510 msgid "CLOSING THE HANDLE"
21514 #: ../java/examples/guestfs-java.pod:24
21516 "The handle is closed when it is reaped by the garbage collector. Because "
21517 "libguestfs handles include a lot of state, it is also possible to close (and "
21518 "hence free) them explicitly by calling the C<close> method."
21522 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
21527 #: ../java/examples/guestfs-java.pod:31
21529 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
21530 "exception. This has a single parameter which is the error message (a "
21535 #: ../java/examples/guestfs-java.pod:35
21536 msgid "Calling any method on a closed handle raises the same exception."
21540 #: ../java/examples/guestfs-java.pod:47
21542 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21543 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21544 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
21545 "L<http://caml.inria.fr/>."
21549 #: ../ocaml/examples/guestfs-ocaml.pod:5
21550 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
21554 #: ../ocaml/examples/guestfs-ocaml.pod:9
21555 msgid "Module style:"
21559 #: ../ocaml/examples/guestfs-ocaml.pod:11
21562 " let g = Guestfs.create () in\n"
21563 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
21564 " Guestfs.launch g;\n"
21569 #: ../ocaml/examples/guestfs-ocaml.pod:15
21570 msgid "Object-oriented style:"
21574 #: ../ocaml/examples/guestfs-ocaml.pod:17
21577 " let g = new Guestfs.guestfs () in\n"
21578 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
21584 #: ../ocaml/examples/guestfs-ocaml.pod:21
21587 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
21589 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
21594 #: ../ocaml/examples/guestfs-ocaml.pod:27
21596 "This manual page documents how to call libguestfs from the OCaml programming "
21597 "language. This page just documents the differences from the C API and gives "
21598 "some examples. If you are not familiar with using libguestfs, you also need "
21599 "to read L<guestfs(3)>."
21603 #: ../ocaml/examples/guestfs-ocaml.pod:32
21604 msgid "PROGRAMMING STYLES"
21608 #: ../ocaml/examples/guestfs-ocaml.pod:34
21610 "There are two different programming styles supported by the OCaml bindings. "
21611 "You can use a module style, with each C function mapped to an OCaml "
21616 #: ../ocaml/examples/guestfs-ocaml.pod:38
21619 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
21624 #: ../ocaml/examples/guestfs-ocaml.pod:40
21629 #: ../ocaml/examples/guestfs-ocaml.pod:42
21632 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
21637 #: ../ocaml/examples/guestfs-ocaml.pod:44
21639 "Alternately you can use an object-oriented style, calling methods on the "
21640 "class C<Guestfs.guestfs>:"
21644 #: ../ocaml/examples/guestfs-ocaml.pod:47
21647 " method set_verbose : bool -> unit\n"
21652 #: ../ocaml/examples/guestfs-ocaml.pod:49
21654 "The object-oriented style is usually briefer, and the minor performance "
21655 "penalty isn't noticable in the general overhead of performing libguestfs "
21660 #: ../ocaml/examples/guestfs-ocaml.pod:55
21662 "The handle is closed when it is reaped by the garbage collector. Because "
21663 "libguestfs handles include a lot of state, it is also possible to close (and "
21664 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
21669 #: ../ocaml/examples/guestfs-ocaml.pod:62
21671 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
21672 "exception. This has a single parameter which is the error message (a "
21677 #: ../ocaml/examples/guestfs-ocaml.pod:66
21679 "Calling any function/method on a closed handle raises "
21680 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
21685 #: ../ocaml/examples/guestfs-ocaml.pod:80
21687 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21688 "L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21689 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
21690 "L<http://caml.inria.fr/>."
21694 #: ../perl/examples/guestfs-perl.pod:5
21695 msgid "guestfs-perl - How to use libguestfs from Perl"
21699 #: ../perl/examples/guestfs-perl.pod:9
21702 " use Sys::Guestfs;\n"
21707 #: ../perl/examples/guestfs-perl.pod:11
21710 " my $h = Sys::Guestfs->new ();\n"
21711 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
21712 " $h->launch ();\n"
21713 " $h->mount_options ('', '/dev/sda1', '/');\n"
21714 " $h->touch ('/hello');\n"
21720 #: ../perl/examples/guestfs-perl.pod:20
21722 "This manual page documents how to call libguestfs from the Perl programming "
21723 "language. This page just documents the differences from the C API and gives "
21724 "some examples. If you are not familiar with using libguestfs, you also need "
21725 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
21729 #: ../perl/examples/guestfs-perl.pod:26
21734 #: ../perl/examples/guestfs-perl.pod:28
21736 "Errors from libguestfs functions turn into calls to C<croak> (see "
21741 #: ../perl/examples/guestfs-perl.pod:41
21743 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
21744 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
21745 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
21746 "L<http://libguestfs.org/>."
21750 #: ../python/examples/guestfs-python.pod:5
21751 msgid "guestfs-python - How to use libguestfs from Python"
21755 #: ../python/examples/guestfs-python.pod:9
21758 " import guestfs\n"
21759 " g = guestfs.GuestFS ()\n"
21760 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
21766 #: ../python/examples/guestfs-python.pod:16
21768 "This manual page documents how to call libguestfs from the Python "
21769 "programming language. This page just documents the differences from the C "
21770 "API and gives some examples. If you are not familiar with using libguestfs, "
21771 "you also need to read L<guestfs(3)>."
21775 #: ../python/examples/guestfs-python.pod:23
21777 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
21778 "single string argument which is the error message."
21782 #: ../python/examples/guestfs-python.pod:26
21783 msgid "MORE DOCUMENTATION"
21787 #: ../python/examples/guestfs-python.pod:28
21792 #: ../python/examples/guestfs-python.pod:30
21796 " >>> import guestfs\n"
21797 " >>> help (guestfs)\n"
21802 #: ../python/examples/guestfs-python.pod:44
21804 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21805 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
21806 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
21810 #: ../rescue/virt-rescue.pod:5
21811 msgid "virt-rescue - Run a rescue shell on a virtual machine"
21815 #: ../rescue/virt-rescue.pod:9
21818 " virt-rescue [--options] -d domname\n"
21823 #: ../rescue/virt-rescue.pod:11
21826 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
21831 #: ../rescue/virt-rescue.pod:15
21834 " virt-rescue [--options] domname\n"
21839 #: ../rescue/virt-rescue.pod:17
21842 " virt-rescue [--options] disk.img [disk.img ...]\n"
21847 #: ../rescue/virt-rescue.pod:21
21849 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
21850 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
21851 "you from doing this, but doesn't catch all cases."
21855 #: ../rescue/virt-rescue.pod:25
21857 "However if you use the I<--ro> (read only) option, then you can attach a "
21858 "shell to a live virtual machine. The results might be strange or "
21859 "inconsistent at times but you won't get disk corruption."
21863 #: ../rescue/virt-rescue.pod:31
21865 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
21866 "need for a CD. virt-rescue gives you a rescue shell and some simple "
21867 "recovery tools which you can use to examine or rescue a virtual machine or "
21872 #: ../rescue/virt-rescue.pod:36
21874 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
21875 "on disk image(s):"
21879 #: ../rescue/virt-rescue.pod:39
21882 " virt-rescue -d GuestName\n"
21887 #: ../rescue/virt-rescue.pod:41
21890 " virt-rescue --ro -a /path/to/disk.img\n"
21895 #: ../rescue/virt-rescue.pod:43
21898 " virt-rescue -a /dev/sdc\n"
21903 #: ../rescue/virt-rescue.pod:45
21904 msgid "For live VMs you I<must> use the --ro option."
21908 #: ../rescue/virt-rescue.pod:47
21910 "When you run virt-rescue on a virtual machine or disk image, you are placed "
21911 "in an interactive bash shell where you can use many ordinary Linux "
21912 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
21913 "appliance. You must mount the virtual machine's filesystems by hand. There "
21914 "is an empty directory called C</sysroot> where you can mount filesystems."
21918 #: ../rescue/virt-rescue.pod:54
21920 "In the example below, we list logical volumes, then choose one to mount "
21921 "under C</sysroot>:"
21925 #: ../rescue/virt-rescue.pod:57
21929 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
21930 " lv_root vg_f11x64 -wi-a- 8.83G\n"
21931 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
21932 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
21933 " ><rescue> ls /sysroot\n"
21938 #: ../rescue/virt-rescue.pod:64
21940 "If you don't know what filesystems are available on the virtual machine then "
21941 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
21945 #: ../rescue/virt-rescue.pod:70
21947 "Virt-rescue can be used on I<any> disk image file or device, not just a "
21948 "virtual machine. For example you can use it on a blank file if you want to "
21949 "partition that file (although we would recommend using L<guestfish(1)> "
21950 "instead as it is more suitable for this purpose). You can even use "
21951 "virt-rescue on things like SD cards."
21955 #: ../rescue/virt-rescue.pod:76
21957 "Virt-rescue does not require root. You only need to run it as root if you "
21958 "need root to open the disk image."
21962 #: ../rescue/virt-rescue.pod:79
21964 "This tool is just designed for quick interactive hacking on a virtual "
21965 "machine. For more structured access to a virtual machine disk image, you "
21966 "should use L<guestfs(3)>. To get a structured shell that you can use to "
21967 "make scripted changes to guests, use L<guestfish(1)>."
21971 #: ../rescue/virt-rescue.pod:103
21972 msgid "B<--append kernelopts>"
21976 #: ../rescue/virt-rescue.pod:105
21977 msgid "Pass additional options to the rescue kernel."
21981 #: ../rescue/virt-rescue.pod:135
21984 " virt-rescue --format=raw -a disk.img\n"
21989 #: ../rescue/virt-rescue.pod:139
21992 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
21997 #: ../rescue/virt-rescue.pod:148
22002 #: ../rescue/virt-rescue.pod:150
22003 msgid "B<--memsize MB>"
22007 #: ../rescue/virt-rescue.pod:152
22009 "Change the amount of memory allocated to the rescue system. The default is "
22010 "set by libguestfs and is small but adequate for running system tools. The "
22011 "occasional program might need more memory. The parameter is specified in "
22016 #: ../rescue/virt-rescue.pod:157
22017 msgid "B<--network>"
22021 #: ../rescue/virt-rescue.pod:159
22022 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
22026 #: ../rescue/virt-rescue.pod:165
22027 msgid "Open the image read-only."
22031 #: ../rescue/virt-rescue.pod:175
22033 "Enable SELinux in the rescue appliance. You should read "
22034 "L<guestfs(3)/SELINUX> before using this option."
22038 #: ../rescue/virt-rescue.pod:178
22043 #: ../rescue/virt-rescue.pod:180
22044 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
22048 #: ../rescue/virt-rescue.pod:198
22050 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
22051 "are done read-write."
22055 #: ../rescue/virt-rescue.pod:211
22056 msgid "Previous versions of virt-rescue allowed you to write either:"
22060 #: ../rescue/virt-rescue.pod:213
22063 " virt-rescue disk.img [disk.img ...]\n"
22068 #: ../rescue/virt-rescue.pod:217
22071 " virt-rescue guestname\n"
22076 #: ../rescue/virt-rescue.pod:225
22081 #: ../rescue/virt-rescue.pod:227
22083 "Adding the I<--network> option enables QEMU user networking in the rescue "
22084 "appliance. There are some differences between user networking and ordinary "
22089 #: ../rescue/virt-rescue.pod:233
22090 msgid "ping does not work"
22094 #: ../rescue/virt-rescue.pod:235
22096 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
22097 "send the ping packets, and because virt-rescue must be able to run as "
22098 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
22099 "command. The ping command will appear to resolve addresses but will not be "
22100 "able to send or receive any packets. This does not mean that the network is "
22105 #: ../rescue/virt-rescue.pod:242
22106 msgid "cannot receive connections"
22110 #: ../rescue/virt-rescue.pod:244
22111 msgid "QEMU user networking cannot receive incoming connections."
22115 #: ../rescue/virt-rescue.pod:246
22116 msgid "making TCP connections"
22120 #: ../rescue/virt-rescue.pod:248
22122 "The virt-rescue appliance needs to be small and so does not include many "
22123 "network tools. In particular there is no L<telnet(1)> command. You can "
22124 "make TCP connections from the shell using the magical "
22125 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
22129 #: ../rescue/virt-rescue.pod:253
22132 " exec 3<>/dev/tcp/redhat.com/80\n"
22133 " echo \"GET /\" >&3\n"
22139 #: ../rescue/virt-rescue.pod:257
22140 msgid "See L<bash(1)> for more details."
22144 #: ../rescue/virt-rescue.pod:263
22146 "Several environment variables affect virt-rescue. See "
22147 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
22151 #: ../rescue/virt-rescue.pod:290
22153 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
22154 "L<http://libguestfs.org/>."
22158 #: ../resize/virt-resize.pod:5
22159 msgid "virt-resize - Resize a virtual machine disk"
22163 #: ../resize/virt-resize.pod:9
22166 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
22167 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
22168 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
22173 #: ../resize/virt-resize.pod:15
22175 "Virt-resize is a tool which can resize a virtual machine disk, making it "
22176 "larger or smaller overall, and resizing or deleting any partitions contained "
22181 #: ../resize/virt-resize.pod:19
22183 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
22184 "not> be used on live virtual machines - for consistent results, shut the "
22185 "virtual machine down before resizing it."
22189 #: ../resize/virt-resize.pod:23
22191 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
22192 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
22196 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:597 ../sparsify/virt-sparsify.pod:203 ../src/guestfs.pod:484 ../src/guestfs.pod:1302 ../src/guestfs.pod:1441 ../src/guestfs.pod:2690
22201 #: ../resize/virt-resize.pod:33
22203 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
22204 "fill the extra 5GB of space."
22208 #: ../resize/virt-resize.pod:36
22211 " virt-filesystems --long -h --all -a olddisk\n"
22216 #: ../resize/virt-resize.pod:38
22219 " truncate -r olddisk newdisk\n"
22220 " truncate -s +5G newdisk\n"
22225 #: ../resize/virt-resize.pod:41
22228 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
22229 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
22234 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:604 ../sparsify/virt-sparsify.pod:210 ../src/guestfs.pod:490 ../src/guestfs.pod:1306 ../src/guestfs.pod:1445 ../src/guestfs.pod:2715
22239 #: ../resize/virt-resize.pod:46
22241 "As above, but make the /boot partition 200MB bigger, while giving the "
22242 "remaining space to /dev/sda2:"
22246 #: ../resize/virt-resize.pod:49
22249 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
22250 " olddisk newdisk\n"
22255 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:610 ../sparsify/virt-sparsify.pod:216 ../src/guestfs.pod:501 ../src/guestfs.pod:1451
22260 #: ../resize/virt-resize.pod:54
22262 "As in the first example, but expand a logical volume as the final step. "
22263 "This is what you would typically use for Linux guests that use LVM:"
22267 #: ../resize/virt-resize.pod:58
22270 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
22271 " olddisk newdisk\n"
22276 #: ../resize/virt-resize.pod:61
22281 #: ../resize/virt-resize.pod:63
22283 "As in the first example, but the output format will be qcow2 instead of a "
22288 #: ../resize/virt-resize.pod:66
22291 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
22292 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
22297 #: ../resize/virt-resize.pod:71
22298 msgid "DETAILED USAGE"
22302 #: ../resize/virt-resize.pod:73
22303 msgid "EXPANDING A VIRTUAL MACHINE DISK"
22307 #: ../resize/virt-resize.pod:77
22308 msgid "1. Shut down the virtual machine"
22312 #: ../resize/virt-resize.pod:79
22313 msgid "2. Locate input disk image"
22317 #: ../resize/virt-resize.pod:81
22319 "Locate the input disk image (ie. the file or device on the host containing "
22320 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
22321 "dumpxml> like this to find the disk image name:"
22325 #: ../resize/virt-resize.pod:85
22328 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
22329 " Found 1 nodes:\n"
22331 " <source dev=\"/dev/vg/lv_guest\" />\n"
22336 #: ../resize/virt-resize.pod:90
22337 msgid "3. Look at current sizing"
22341 #: ../resize/virt-resize.pod:92
22342 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
22346 #: ../resize/virt-resize.pod:95
22349 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
22350 " Name Type Size Parent\n"
22351 " /dev/sda1 partition 101M /dev/sda\n"
22352 " /dev/sda2 partition 7.9G /dev/sda\n"
22353 " /dev/sda device 8.0G -\n"
22358 #: ../resize/virt-resize.pod:101
22360 "(This example is a virtual machine with an 8 GB disk which we would like to "
22361 "expand up to 10 GB)."
22365 #: ../resize/virt-resize.pod:104
22366 msgid "4. Create output disk"
22370 #: ../resize/virt-resize.pod:106
22372 "Virt-resize cannot do in-place disk modifications. You have to have space "
22373 "to store the resized output disk."
22377 #: ../resize/virt-resize.pod:109
22378 msgid "To store the resized disk image in a file, create a file of a suitable size:"
22382 #: ../resize/virt-resize.pod:112
22385 " # rm -f outdisk\n"
22386 " # truncate -s 10G outdisk\n"
22391 #: ../resize/virt-resize.pod:115
22392 msgid "Or use L<lvcreate(1)> to create a logical volume:"
22396 #: ../resize/virt-resize.pod:117
22399 " # lvcreate -L 10G -n lv_name vg_name\n"
22404 #: ../resize/virt-resize.pod:119
22405 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
22409 #: ../resize/virt-resize.pod:121
22412 " # virsh pool-list\n"
22413 " # virsh vol-create-as poolname newvol 10G\n"
22418 #: ../resize/virt-resize.pod:124
22423 #: ../resize/virt-resize.pod:126
22425 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
22426 "file) and the output disk. The output disk is the one created in the "
22431 #: ../resize/virt-resize.pod:130
22434 " # virt-resize indisk outdisk\n"
22439 #: ../resize/virt-resize.pod:132
22441 "This command just copies disk image C<indisk> to disk image C<outdisk> "
22442 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
22443 "larger, then an extra, empty partition is created at the end of the disk "
22444 "covering the extra space. If C<outdisk> is smaller, then it will give an "
22449 #: ../resize/virt-resize.pod:138
22451 "More realistically you'd want to expand existing partitions in the disk "
22452 "image by passing extra options (for the full list see the L</OPTIONS> "
22457 #: ../resize/virt-resize.pod:142
22459 "L</--expand> is the most useful option. It expands the named partition "
22460 "within the disk to fill any extra space:"
22464 #: ../resize/virt-resize.pod:145
22467 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
22472 #: ../resize/virt-resize.pod:147
22474 "(In this case, an extra partition is I<not> created at the end of the disk, "
22475 "because there will be no unused space)."
22479 #: ../resize/virt-resize.pod:150
22481 "L</--resize> is the other commonly used option. The following would "
22482 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
22483 "rest of the available space:"
22487 #: ../resize/virt-resize.pod:154
22490 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
22491 " indisk outdisk\n"
22496 #: ../resize/virt-resize.pod:157
22498 "If the expanded partition in the image contains a filesystem or LVM PV, then "
22499 "if virt-resize knows how, it will resize the contents, the equivalent of "
22500 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
22501 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
22502 "filesystems, so you would have to online resize them after booting the "
22507 #: ../resize/virt-resize.pod:164
22508 msgid "Other options are covered below."
22512 #: ../resize/virt-resize.pod:166
22517 #: ../resize/virt-resize.pod:168
22518 msgid "Thoroughly test the new disk image I<before> discarding the old one."
22522 #: ../resize/virt-resize.pod:170
22523 msgid "If you are using libvirt, edit the XML to point at the new disk:"
22527 #: ../resize/virt-resize.pod:172
22530 " # virsh edit guestname\n"
22535 #: ../resize/virt-resize.pod:174
22537 "Change E<lt>source ...E<gt>, see "
22538 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
22542 #: ../resize/virt-resize.pod:177
22543 msgid "Then start up the domain with the new, resized disk:"
22547 #: ../resize/virt-resize.pod:179
22550 " # virsh start guestname\n"
22555 #: ../resize/virt-resize.pod:181
22557 "and check that it still works. See also the L</NOTES> section below for "
22558 "additional information."
22562 #: ../resize/virt-resize.pod:184
22563 msgid "7. Resize LVs etc inside the guest"
22567 #: ../resize/virt-resize.pod:186
22568 msgid "(This can also be done offline using L<guestfish(1)>)"
22572 #: ../resize/virt-resize.pod:188
22574 "Once the guest has booted you should see the new space available, at least "
22575 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
22576 "may need to resize LVs inside PVs, and also resize filesystem types that "
22577 "virt-resize does not know how to expand."
22581 #: ../resize/virt-resize.pod:195
22582 msgid "SHRINKING A VIRTUAL MACHINE DISK"
22586 #: ../resize/virt-resize.pod:197
22588 "Shrinking is somewhat more complex than expanding, and only an overview is "
22593 #: ../resize/virt-resize.pod:200
22595 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
22596 "filesystems). The user has to shrink content before passing the disk image "
22597 "to virt-resize, and virt-resize will check that the content has been shrunk "
22602 #: ../resize/virt-resize.pod:205
22603 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
22607 #: ../resize/virt-resize.pod:207
22609 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
22610 "steps 3 and 4 above to allocate a new disk image."
22614 #: ../resize/virt-resize.pod:210
22615 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
22619 #: ../resize/virt-resize.pod:213
22620 msgid "IGNORING OR DELETING PARTITIONS"
22624 #: ../resize/virt-resize.pod:215
22626 "virt-resize also gives a convenient way to ignore or delete partitions when "
22627 "copying from the input disk to the output disk. Ignoring a partition speeds "
22628 "up the copy where you don't care about the existing contents of a "
22629 "partition. Deleting a partition removes it completely, but note that it "
22630 "also renumbers any partitions after the one which is deleted, which can "
22631 "leave some guests unbootable."
22635 #: ../resize/virt-resize.pod:222
22636 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
22640 #: ../resize/virt-resize.pod:224
22642 "If the input disk is in qcow2 format, then you may prefer that the output is "
22643 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
22644 "the fly. The output format is simply determined by the format of the empty "
22645 "output container that you provide. Thus to create qcow2 output, use:"
22649 #: ../resize/virt-resize.pod:230
22652 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
22657 #: ../resize/virt-resize.pod:232
22658 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
22662 #: ../resize/virt-resize.pod:234
22663 msgid "Similarly, to get non-sparse raw output use:"
22667 #: ../resize/virt-resize.pod:236
22670 " fallocate -l size outdisk\n"
22675 #: ../resize/virt-resize.pod:238
22677 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
22678 "if=/dev/zero of=outdisk bs=1M count=..>)"
22682 #: ../resize/virt-resize.pod:241
22683 msgid "LOGICAL PARTITIONS"
22687 #: ../resize/virt-resize.pod:243
22689 "Logical partitions (a.k.a. C</dev/sda5+> on disks using DOS partition "
22690 "tables) cannot be resized."
22694 #: ../resize/virt-resize.pod:246
22696 "To understand what is going on, firstly one of the four partitions "
22697 "C</dev/sda1-4> will have MBR partition type C<05> or C<0f>. This is called "
22698 "the B<extended partition>. Use L<virt-filesystems(1)> to see the MBR "
22703 #: ../resize/virt-resize.pod:251
22704 msgid "Logical partitions live inside the extended partition."
22708 #: ../resize/virt-resize.pod:253
22710 "The extended partition can be expanded, but not shrunk (unless you force it, "
22711 "which is not advisable). When the extended partition is copied across, all "
22712 "the logical partitions contained inside are copied over implicitly. "
22713 "Virt-resize does not look inside the extended partition, so it copies the "
22714 "logical partitions blindly."
22718 #: ../resize/virt-resize.pod:259
22720 "You cannot specify a logical partition (C</dev/sda5+>) at all on the command "
22721 "line. Doing so will give an error."
22725 #: ../resize/virt-resize.pod:268 ../sparsify/virt-sparsify.pod:105
22726 msgid "Display help."
22730 #: ../resize/virt-resize.pod:270
22731 msgid "B<--align-first auto>"
22735 #: ../resize/virt-resize.pod:272
22736 msgid "B<--align-first never>"
22740 #: ../resize/virt-resize.pod:274
22741 msgid "B<--align-first always>"
22745 #: ../resize/virt-resize.pod:276
22747 "Align the first partition for improved performance (see also the "
22748 "I<--alignment> option)."
22752 #: ../resize/virt-resize.pod:279
22754 "The default is I<--align-first auto> which only aligns the first partition "
22755 "if it is safe to do so. That is, only when we know how to fix the "
22756 "bootloader automatically, and at the moment that can only be done for "
22761 #: ../resize/virt-resize.pod:284
22763 "I<--align-first never> means we never move the first partition. This is the "
22764 "safest option. Try this if the guest does not boot after resizing."
22768 #: ../resize/virt-resize.pod:288
22770 "I<--align-first always> means we always align the first partition (if it "
22771 "needs to be aligned). For some guests this will break the bootloader, "
22772 "making the guest unbootable."
22776 #: ../resize/virt-resize.pod:292
22777 msgid "B<--alignment N>"
22781 #: ../resize/virt-resize.pod:294
22783 "Set the alignment of partitions to C<N> sectors. The default in virt-resize "
22784 "E<lt> 1.13.19 was 64 sectors, and after that is 128 sectors."
22788 #: ../resize/virt-resize.pod:298
22790 "Assuming 512 byte sector size inside the guest, here are some suitable "
22795 #: ../resize/virt-resize.pod:303
22796 msgid "I<--alignment 1> (512 bytes)"
22800 #: ../resize/virt-resize.pod:305
22802 "The partitions would be packed together as closely as possible, but would be "
22803 "completely unaligned. In some cases this can cause very poor performance. "
22804 "See L<virt-alignment-scan(1)> for further details."
22808 #: ../resize/virt-resize.pod:309
22809 msgid "I<--alignment 8> (4K)"
22813 #: ../resize/virt-resize.pod:311
22815 "This would be the minimum acceptable alignment for reasonable performance on "
22820 #: ../resize/virt-resize.pod:314
22821 msgid "I<--alignment 128> (64K)"
22825 #: ../resize/virt-resize.pod:316
22827 "This alignment provides good performance when the host is using high end "
22832 #: ../resize/virt-resize.pod:319
22833 msgid "I<--alignment 2048> (1M)"
22837 #: ../resize/virt-resize.pod:321
22839 "This is the standard alignment used by all newly installed guests since "
22844 #: ../resize/virt-resize.pod:326
22849 #: ../resize/virt-resize.pod:328 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
22854 #: ../resize/virt-resize.pod:330 ../tools/virt-win-reg.pl:122
22855 msgid "Enable debugging messages."
22859 #: ../resize/virt-resize.pod:332
22860 msgid "B<--delete part>"
22864 #: ../resize/virt-resize.pod:334
22866 "Delete the named partition. It would be more accurate to describe this as "
22867 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
22868 "the original disk image is left intact."
22872 #: ../resize/virt-resize.pod:338
22874 "Note that when you delete a partition, then anything contained in the "
22875 "partition is also deleted. Furthermore, this causes any partitions that "
22876 "come after to be I<renumbered>, which can easily make your guest unbootable."
22880 #: ../resize/virt-resize.pod:343 ../resize/virt-resize.pod:404 ../resize/virt-resize.pod:531 ../sparsify/virt-sparsify.pod:145
22881 msgid "You can give this option multiple times."
22885 #: ../resize/virt-resize.pod:345
22886 msgid "B<--expand part>"
22890 #: ../resize/virt-resize.pod:347
22892 "Expand the named partition so it uses up all extra space (space left over "
22893 "after any other resize changes that you request have been done)."
22897 #: ../resize/virt-resize.pod:350
22899 "If virt-resize knows how, it will expand the direct content of the "
22900 "partition. For example, if the partition is an LVM PV, it will expand the "
22901 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
22902 "content it doesn't know about alone."
22906 #: ../resize/virt-resize.pod:355
22907 msgid "Currently virt-resize can resize:"
22911 #: ../resize/virt-resize.pod:361
22912 msgid "ext2, ext3 and ext4 filesystems."
22916 #: ../resize/virt-resize.pod:365
22917 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
22921 #: ../resize/virt-resize.pod:367
22923 "The filesystem must have been shut down consistently last time it was used. "
22924 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
22925 "consistency check, so at the first boot after resizing Windows will check "
22930 #: ../resize/virt-resize.pod:374
22932 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
22933 "inside the PV, but see the I<--LV-expand> option. The user could also "
22934 "resize LVs as desired after boot."
22938 #: ../resize/virt-resize.pod:380
22939 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
22943 #: ../resize/virt-resize.pod:384 ../resize/virt-resize.pod:559
22944 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
22948 #: ../resize/virt-resize.pod:386 ../sparsify/virt-sparsify.pod:125 ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
22949 msgid "B<--format> raw"
22953 #: ../resize/virt-resize.pod:388 ../sparsify/virt-sparsify.pod:129
22955 "Specify the format of the input disk image. If this flag is not given then "
22956 "it is auto-detected from the image itself."
22960 #: ../resize/virt-resize.pod:394
22962 "Note that this option I<does not> affect the output format. See L</QCOW2 "
22963 "AND NON-SPARSE RAW FORMATS>."
22967 #: ../resize/virt-resize.pod:397
22968 msgid "B<--ignore part>"
22972 #: ../resize/virt-resize.pod:399
22974 "Ignore the named partition. Effectively this means the partition is "
22975 "allocated on the destination disk, but the content is not copied across from "
22976 "the source disk. The content of the partition will be blank (all zero "
22981 #: ../resize/virt-resize.pod:406
22982 msgid "B<--LV-expand logvol>"
22986 #: ../resize/virt-resize.pod:408
22988 "This takes the logical volume and, as a final step, expands it to fill all "
22989 "the space available in its volume group. A typical usage, assuming a Linux "
22990 "guest with a single PV C</dev/sda2> and a root device called "
22991 "C</dev/vg_guest/lv_root> would be:"
22995 #: ../resize/virt-resize.pod:413
22998 " virt-resize indisk outdisk \\\n"
22999 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
23004 #: ../resize/virt-resize.pod:416
23006 "This would first expand the partition (and PV), and then expand the root "
23007 "device to fill the extra space in the PV."
23011 #: ../resize/virt-resize.pod:419
23013 "The contents of the LV are also resized if virt-resize knows how to do "
23014 "that. You can stop virt-resize from trying to expand the content by using "
23015 "the option I<--no-expand-content>."
23019 #: ../resize/virt-resize.pod:423
23020 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
23024 #: ../resize/virt-resize.pod:425
23026 "You can give this option multiple times, I<but> it doesn't make sense to do "
23027 "this unless the logical volumes you specify are all in different volume "
23032 #: ../resize/virt-resize.pod:429 ../sparsify/virt-sparsify.pod:147
23033 msgid "B<--machine-readable>"
23037 #: ../resize/virt-resize.pod:431 ../sparsify/virt-sparsify.pod:149
23039 "This option is used to make the output more machine friendly when being "
23040 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
23044 #: ../resize/virt-resize.pod:437
23045 msgid "B<--dryrun>"
23049 #: ../resize/virt-resize.pod:439
23050 msgid "Print a summary of what would be done, but don't do anything."
23054 #: ../resize/virt-resize.pod:441
23055 msgid "B<--no-copy-boot-loader>"
23059 #: ../resize/virt-resize.pod:443
23061 "By default, virt-resize copies over some sectors at the start of the disk "
23062 "(up to the beginning of the first partition). Commonly these sectors "
23063 "contain the Master Boot Record (MBR) and the boot loader, and are required "
23064 "in order for the guest to boot correctly."
23068 #: ../resize/virt-resize.pod:448
23070 "If you specify this flag, then this initial copy is not done. You may need "
23071 "to reinstall the boot loader in this case."
23075 #: ../resize/virt-resize.pod:451
23076 msgid "B<--no-extra-partition>"
23080 #: ../resize/virt-resize.pod:453
23082 "By default, virt-resize creates an extra partition if there is any extra, "
23083 "unused space after all resizing has happened. Use this option to prevent "
23084 "the extra partition from being created. If you do this then the extra space "
23085 "will be inaccessible until you run fdisk, parted, or some other partitioning "
23086 "tool in the guest."
23090 #: ../resize/virt-resize.pod:459
23092 "Note that if the surplus space is smaller than 10 MB, no extra partition "
23097 #: ../resize/virt-resize.pod:462
23098 msgid "B<--no-expand-content>"
23102 #: ../resize/virt-resize.pod:464
23104 "By default, virt-resize will try to expand the direct contents of "
23105 "partitions, if it knows how (see I<--expand> option above)."
23109 #: ../resize/virt-resize.pod:467
23111 "If you give the I<--no-expand-content> option then virt-resize will not "
23116 #: ../resize/virt-resize.pod:470
23117 msgid "B<--ntfsresize-force>"
23121 #: ../resize/virt-resize.pod:472
23123 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
23124 "the NTFS disk is marked as needing a consistency check. You have to use "
23125 "this option if you want to resize a Windows guest multiple times without "
23126 "booting into Windows between each resize."
23130 #: ../resize/virt-resize.pod:478
23131 msgid "B<--output-format> raw"
23135 #: ../resize/virt-resize.pod:480
23137 "Specify the format of the output disk image. If this flag is not given then "
23138 "it is auto-detected from the image itself."
23142 #: ../resize/virt-resize.pod:486
23144 "Note that this option I<does not create> the output format. This option "
23145 "just tells libguestfs what it is so it doesn't try to guess it. You still "
23146 "need to create the output disk with the right format. See L</QCOW2 AND "
23147 "NON-SPARSE RAW FORMATS>."
23151 #: ../resize/virt-resize.pod:495
23152 msgid "Don't print the summary."
23156 #: ../resize/virt-resize.pod:497
23157 msgid "B<--resize part=size>"
23161 #: ../resize/virt-resize.pod:499
23163 "Resize the named partition (expanding or shrinking it) so that it has the "
23168 #: ../resize/virt-resize.pod:502
23170 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
23171 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
23172 "size; or as a relative number or percentage. For example:"
23176 #: ../resize/virt-resize.pod:508
23179 " --resize /dev/sda2=10G\n"
23184 #: ../resize/virt-resize.pod:510
23187 " --resize /dev/sda4=90%\n"
23192 #: ../resize/virt-resize.pod:512
23195 " --resize /dev/sda2=+1G\n"
23200 #: ../resize/virt-resize.pod:514
23203 " --resize /dev/sda2=-200M\n"
23208 #: ../resize/virt-resize.pod:516
23211 " --resize /dev/sda1=+128K\n"
23216 #: ../resize/virt-resize.pod:518
23219 " --resize /dev/sda1=+10%\n"
23224 #: ../resize/virt-resize.pod:520
23227 " --resize /dev/sda1=-10%\n"
23232 #: ../resize/virt-resize.pod:522
23234 "You can increase the size of any partition. Virt-resize will expand the "
23235 "direct content of the partition if it knows how (see I<--expand> below)."
23239 #: ../resize/virt-resize.pod:526
23241 "You can only I<decrease> the size of partitions that contain filesystems or "
23242 "PVs which have already been shrunk. Virt-resize will check this has been "
23243 "done before proceeding, or else will print an error (see also "
23244 "I<--resize-force>)."
23248 #: ../resize/virt-resize.pod:533
23249 msgid "B<--resize-force part=size>"
23253 #: ../resize/virt-resize.pod:535
23255 "This is the same as I<--resize> except that it will let you decrease the "
23256 "size of any partition. Generally this means you will lose any data which "
23257 "was at the end of the partition you shrink, but you may not care about that "
23258 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
23259 "as a swap partition)."
23263 #: ../resize/virt-resize.pod:541
23264 msgid "See also the I<--ignore> option."
23268 #: ../resize/virt-resize.pod:543
23269 msgid "B<--shrink part>"
23273 #: ../resize/virt-resize.pod:545
23275 "Shrink the named partition until the overall disk image fits in the "
23276 "destination. The named partition B<must> contain a filesystem or PV which "
23277 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
23278 "online tools). Virt-resize will check this and give an error if it has not "
23283 #: ../resize/virt-resize.pod:551
23285 "The amount by which the overall disk must be shrunk (after carrying out all "
23286 "other operations requested by the user) is called the \"deficit\". For "
23287 "example, a straight copy (assume no other operations) from a 5GB disk image "
23288 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
23289 "would give an error unless the user specified a partition to shrink and that "
23290 "partition had more than a gigabyte of free space."
23294 #: ../resize/virt-resize.pod:569 ../sparsify/virt-sparsify.pod:177
23295 msgid "MACHINE READABLE OUTPUT"
23299 #: ../resize/virt-resize.pod:571
23301 "The I<--machine-readable> option can be used to make the output more machine "
23302 "friendly, which is useful when calling virt-resize from other programs, GUIs "
23307 #: ../resize/virt-resize.pod:575 ../sparsify/virt-sparsify.pod:183
23308 msgid "There are two ways to use this option."
23312 #: ../resize/virt-resize.pod:577
23314 "Firstly use the option on its own to query the capabilities of the "
23315 "virt-resize binary. Typical output looks like this:"
23319 #: ../resize/virt-resize.pod:580
23322 " $ virt-resize --machine-readable\n"
23324 " ntfsresize-force\n"
23332 #: ../resize/virt-resize.pod:587 ../sparsify/virt-sparsify.pod:193
23334 "A list of features is printed, one per line, and the program exits with "
23339 #: ../resize/virt-resize.pod:590 ../sparsify/virt-sparsify.pod:196
23341 "Secondly use the option in conjunction with other options to make the "
23342 "regular program output more machine friendly."
23346 #: ../resize/virt-resize.pod:593 ../sparsify/virt-sparsify.pod:199
23347 msgid "At the moment this means:"
23351 #: ../resize/virt-resize.pod:599 ../sparsify/virt-sparsify.pod:205
23353 "Progress bar messages can be parsed from stdout by looking for this regular "
23358 #: ../resize/virt-resize.pod:602 ../sparsify/virt-sparsify.pod:208
23361 " ^[0-9]+/[0-9]+$\n"
23366 #: ../resize/virt-resize.pod:606 ../sparsify/virt-sparsify.pod:212
23368 "The calling program should treat messages sent to stdout (except for "
23369 "progress bar messages) as status messages. They can be logged and/or "
23370 "displayed to the user."
23374 #: ../resize/virt-resize.pod:612
23376 "The calling program should treat messages sent to stderr as error messages. "
23377 "In addition, virt-resize exits with a non-zero status code if there was a "
23382 #: ../resize/virt-resize.pod:618
23384 "Versions of the program prior to 1.13.9 did not support the "
23385 "I<--machine-readable> option and will return an error."
23389 #: ../resize/virt-resize.pod:623
23390 msgid "\"Partition 1 does not end on cylinder boundary.\""
23394 #: ../resize/virt-resize.pod:625
23396 "Virt-resize aligns partitions to multiples of 128 sectors (see the "
23397 "I<--alignment> parameter). Usually this means the partitions will not be "
23398 "aligned to the ancient CHS geometry. However CHS geometry is meaningless "
23399 "for disks manufactured since the early 1990s, and doubly so for virtual hard "
23400 "drives. Alignment of partitions to cylinders is not required by any modern "
23401 "operating system."
23405 #: ../resize/virt-resize.pod:632
23406 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
23410 #: ../resize/virt-resize.pod:634
23412 "In Windows Vista and later versions, Microsoft switched to using a separate "
23413 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
23414 "and C</dev/sda2> is the main (C:) drive. Resizing the first (boot) "
23415 "partition causes the bootloader to fail with C<0xC0000225> error. Resizing "
23416 "the second partition (ie. C: drive) should work."
23420 #: ../resize/virt-resize.pod:641
23422 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
23423 "NTFS partitions have been expanded. This is just a safety check and (unless "
23424 "it find errors) is nothing to worry about."
23428 #: ../resize/virt-resize.pod:645
23429 msgid "GUEST BOOT STUCK AT \"GRUB\""
23433 #: ../resize/virt-resize.pod:647
23435 "If a Linux guest does not boot after resizing, and the boot is stuck after "
23436 "printing C<GRUB> on the console, try reinstalling grub."
23440 #: ../resize/virt-resize.pod:650
23443 " guestfish -i -a newdisk\n"
23444 " ><fs> cat /boot/grub/device.map\n"
23445 " # check the contents of this file are sensible or\n"
23446 " # edit the file if necessary\n"
23447 " ><fs> grub-install / /dev/vda\n"
23453 #: ../resize/virt-resize.pod:657
23455 "For more flexible guest reconfiguration, including if you need to specify "
23456 "other parameters to grub-install, use L<virt-rescue(1)>."
23460 #: ../resize/virt-resize.pod:660
23461 msgid "ALTERNATIVE TOOLS"
23465 #: ../resize/virt-resize.pod:662
23467 "There are several proprietary tools for resizing partitions. We won't "
23468 "mention any here."
23472 #: ../resize/virt-resize.pod:665
23474 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
23475 "operations on disk images. They can resize and move partitions, but I don't "
23476 "think they can do anything with the contents, and they certainly don't "
23481 #: ../resize/virt-resize.pod:670
23483 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
23484 "but at a much lower level. You will probably end up hand-calculating sector "
23485 "offsets, which is something that virt-resize was designed to avoid. If you "
23486 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
23491 #: ../resize/virt-resize.pod:690
23493 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
23494 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
23495 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
23496 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
23497 "L<virt-sparsify(1)>, L<virt-alignment-scan(1)>, L<http://libguestfs.org/>."
23501 #: ../ruby/examples/guestfs-ruby.pod:5
23502 msgid "guestfs-ruby - How to use libguestfs from Ruby"
23506 #: ../ruby/examples/guestfs-ruby.pod:9
23509 " require 'guestfs'\n"
23510 " g = Guestfs::Guestfs.new()\n"
23511 " g.add_drive_opts(\"disk.img\",\n"
23512 " :readonly => 1, :format => \"raw\")\n"
23518 #: ../ruby/examples/guestfs-ruby.pod:17
23520 "This manual page documents how to call libguestfs from the Ruby programming "
23521 "language. This page just documents the differences from the C API and gives "
23522 "some examples. If you are not familiar with using libguestfs, you also need "
23523 "to read L<guestfs(3)>."
23527 #: ../ruby/examples/guestfs-ruby.pod:24
23529 "Errors from libguestfs functions are mapped into the C<Error> exception. "
23530 "This has a single parameter which is the error message (a string)."
23534 #: ../ruby/examples/guestfs-ruby.pod:38
23536 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
23537 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
23538 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
23542 #: ../sparsify/virt-sparsify.pod:5
23543 msgid "virt-sparsify - Make a virtual machine disk sparse"
23547 #: ../sparsify/virt-sparsify.pod:9
23550 " virt-sparsify [--options] indisk outdisk\n"
23555 #: ../sparsify/virt-sparsify.pod:13
23557 "Virt-sparsify is a tool which can make a virtual machine disk (or any disk "
23558 "image) sparse a.k.a. thin-provisioned. This means that free space within "
23559 "the disk image can be converted back to free space on the host."
23563 #: ../sparsify/virt-sparsify.pod:18
23565 "Virt-sparsify can locate and sparsify free space in most filesystems "
23566 "(eg. ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes."
23570 #: ../sparsify/virt-sparsify.pod:21
23572 "Virt-sparsify can also convert between some disk formats, for example "
23573 "converting a raw disk image to a thin-provisioned qcow2 image."
23577 #: ../sparsify/virt-sparsify.pod:24
23579 "Virt-sparsify can operate on any disk image, not just ones from virtual "
23580 "machines. If a virtual machine has more than one attached disk, you must "
23581 "sparsify each one separately."
23585 #: ../sparsify/virt-sparsify.pod:28
23586 msgid "IMPORTANT LIMITATIONS"
23590 #: ../sparsify/virt-sparsify.pod:34
23592 "Virt-sparsify does not do in-place modifications. It copies from a source "
23593 "image to a destination image, leaving the source unchanged. I<Check that "
23594 "the sparsification was successful before deleting the source image>."
23598 #: ../sparsify/virt-sparsify.pod:41
23599 msgid "The virtual machine I<must be shut down> before using this tool."
23603 #: ../sparsify/virt-sparsify.pod:45
23605 "Virt-sparsify may require up to 2x the virtual size of the source disk image "
23606 "(1 temporary copy + 1 destination image). This is in the worst case and "
23607 "usually much less space is required."
23611 #: ../sparsify/virt-sparsify.pod:51
23612 msgid "Virt-sparsify cannot resize disk images. To do that, use L<virt-resize(1)>."
23616 #: ../sparsify/virt-sparsify.pod:56
23617 msgid "Virt-sparsify cannot handle encrypted disks."
23621 #: ../sparsify/virt-sparsify.pod:60
23623 "Virt-sparsify cannot yet sparsify the space between partitions. Note that "
23624 "this space is often used for critical items like bootloaders so it's not "
23629 #: ../sparsify/virt-sparsify.pod:66
23631 "Virt-sparsify does not yet know how to sparsify swapspace. It is not safe "
23632 "to do this unless we can be sure there is no hibernation data, so at the "
23633 "moment swap partitions are ignored."
23637 #: ../sparsify/virt-sparsify.pod:72
23639 "You may also want to read the manual pages for the associated tools "
23640 "L<virt-filesystems(1)> and L<virt-df(1)> before starting."
23644 #: ../sparsify/virt-sparsify.pod:77
23645 msgid "Typical usage is:"
23649 #: ../sparsify/virt-sparsify.pod:79
23652 " virt-sparsify indisk outdisk\n"
23657 #: ../sparsify/virt-sparsify.pod:81
23659 "which copies C<indisk> to C<outdisk>, making the output sparse. C<outdisk> "
23660 "is created, or overwritten if it already exists. The format of the input "
23661 "disk is detected (eg. qcow2) and the same format is used for the output "
23666 #: ../sparsify/virt-sparsify.pod:86
23667 msgid "To convert between formats, use the I<--convert> option:"
23671 #: ../sparsify/virt-sparsify.pod:88
23674 " virt-sparsify disk.raw --convert qcow2 disk.qcow2\n"
23679 #: ../sparsify/virt-sparsify.pod:90
23681 "Virt-sparsify tries to zero and sparsify free space on every filesystem it "
23682 "can find within the source disk image. You can get it to ignore (don't zero "
23683 "free space on) certain filesystems by doing:"
23687 #: ../sparsify/virt-sparsify.pod:94
23690 " virt-sparsify --ignore /dev/sda1 indisk outdisk\n"
23695 #: ../sparsify/virt-sparsify.pod:96
23696 msgid "See L<virt-filesystems(1)> to get a list of filesystems within a disk image."
23700 #: ../sparsify/virt-sparsify.pod:107
23701 msgid "B<--convert> raw"
23705 #: ../sparsify/virt-sparsify.pod:109
23706 msgid "B<--convert> qcow2"
23710 #: ../sparsify/virt-sparsify.pod:111
23711 msgid "B<--convert> [other formats]"
23715 #: ../sparsify/virt-sparsify.pod:113
23717 "Use C<output-format> as the format for the destination image. If this is "
23718 "not specified, then the input format is used."
23722 #: ../sparsify/virt-sparsify.pod:116
23723 msgid "Supported and known-working output formats are: C<raw>, C<qcow2>."
23727 #: ../sparsify/virt-sparsify.pod:118
23729 "You can also use any format supported by the L<qemu-img(1)> program, "
23730 "eg. C<vdi> or C<vmdk>, but support for other formats is reliant on qemu."
23734 #: ../sparsify/virt-sparsify.pod:122
23736 "Specifying the I<--convert> option is usually a good idea, because then "
23737 "virt-sparsify doesn't need to try to guess the input format."
23741 #: ../sparsify/virt-sparsify.pod:127
23742 msgid "B<--format> qcow2"
23746 #: ../sparsify/virt-sparsify.pod:135
23747 msgid "B<--ignore> filesystem"
23751 #: ../sparsify/virt-sparsify.pod:137
23752 msgid "B<--ignore> volgroup"
23756 #: ../sparsify/virt-sparsify.pod:139
23758 "Ignore the named filesystem. Free space on the filesystem will not be "
23759 "zeroed, but existing blocks of zeroes will still be sparsified."
23763 #: ../sparsify/virt-sparsify.pod:142
23765 "In the second form, this ignores the named volume group. Use the volume "
23766 "group name without the C</dev/> prefix, eg. I<--ignore vg_foo>"
23770 #: ../sparsify/virt-sparsify.pod:157
23771 msgid "This disables progress bars and other unnecessary output."
23775 #: ../sparsify/virt-sparsify.pod:179
23777 "The I<--machine-readable> option can be used to make the output more machine "
23778 "friendly, which is useful when calling virt-sparsify from other programs, "
23783 #: ../sparsify/virt-sparsify.pod:185
23785 "Firstly use the option on its own to query the capabilities of the "
23786 "virt-sparsify binary. Typical output looks like this:"
23790 #: ../sparsify/virt-sparsify.pod:188
23793 " $ virt-sparsify --machine-readable\n"
23801 #: ../sparsify/virt-sparsify.pod:218
23803 "The calling program should treat messages sent to stderr as error messages. "
23804 "In addition, virt-sparsify exits with a non-zero status code if there was a "
23809 #: ../sparsify/virt-sparsify.pod:224
23811 "All versions of virt-sparsify have supported the I<--machine-readable> "
23816 #: ../sparsify/virt-sparsify.pod:238
23818 "Location of the temporary directory used for the potentially large temporary "
23823 #: ../sparsify/virt-sparsify.pod:241
23825 "You should ensure there is enough free space in the worst case for a full "
23826 "copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point "
23827 "to another directory that has enough space."
23831 #: ../sparsify/virt-sparsify.pod:245
23832 msgid "This defaults to C</tmp>."
23836 #: ../sparsify/virt-sparsify.pod:249
23837 msgid "For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>."
23841 #: ../sparsify/virt-sparsify.pod:253
23843 "L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>, "
23844 "L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>, "
23845 "L<qemu-img(1)>, L<http://libguestfs.org/>."
23849 #: ../src/guestfs-actions.pod:1
23850 msgid "guestfs_add_cdrom"
23854 #: ../src/guestfs-actions.pod:3
23858 " guestfs_add_cdrom (guestfs_h *g,\n"
23859 " const char *filename);\n"
23864 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:323
23866 "I<This function is deprecated.> In new code, use the "
23867 "L</guestfs_add_drive_opts> call instead."
23871 #: ../src/guestfs-actions.pod:24
23873 "This call checks for the existence of C<filename>. This stops you from "
23874 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23875 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
23880 #: ../src/guestfs-actions.pod:31
23882 "If you just want to add an ISO file (often you use this as an efficient way "
23883 "to transfer large files into the guest), then you should probably use "
23884 "C<guestfs_add_drive_ro> instead."
23888 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:291 ../src/guestfs-actions.pod:312 ../src/guestfs-actions.pod:333 ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360 ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:500 ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:559 ../src/guestfs-actions.pod:587 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:705 ../src/guestfs-actions.pod:719 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:833 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:879 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:1099 ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1137 ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:1286 ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1372 ../src/guestfs-actions.pod:1425 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1536 ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1651 ../src/guestfs-actions.pod:1721 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2283 ../src/guestfs-actions.pod:2791 ../src/guestfs-actions.pod:2935 ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4344 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4373 ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4558 ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4612 ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4678 ../src/guestfs-actions.pod:4711 ../src/guestfs-actions.pod:4727 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4772 ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:4885 ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5015 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5224 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5305 ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:5335 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5482 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5513 ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:5705 ../src/guestfs-actions.pod:5733 ../src/guestfs-actions.pod:5750 ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:5905 ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:6610 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6737 ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6841 ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6884 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6924 ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7078 ../src/guestfs-actions.pod:7190 ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7323 ../src/guestfs-actions.pod:7336 ../src/guestfs-actions.pod:7349 ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7397 ../src/guestfs-actions.pod:7410 ../src/guestfs-actions.pod:7425 ../src/guestfs-actions.pod:7484 ../src/guestfs-actions.pod:7501 ../src/guestfs-actions.pod:7517 ../src/guestfs-actions.pod:7533 ../src/guestfs-actions.pod:7550 ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7583 ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7633 ../src/guestfs-actions.pod:7674 ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7705 ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7775 ../src/guestfs-actions.pod:7891 ../src/guestfs-actions.pod:7906 ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7975 ../src/guestfs-actions.pod:7988 ../src/guestfs-actions.pod:8033 ../src/guestfs-actions.pod:8073 ../src/guestfs-actions.pod:8129 ../src/guestfs-actions.pod:8149 ../src/guestfs-actions.pod:8182 ../src/guestfs-actions.pod:8246 ../src/guestfs-actions.pod:8269 ../src/guestfs-actions.pod:8295
23889 msgid "This function returns 0 on success or -1 on error."
23893 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2620 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6945 ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7552 ../src/guestfs-actions.pod:8075
23894 msgid "(Added in 0.3)"
23898 #: ../src/guestfs-actions.pod:41
23899 msgid "guestfs_add_domain"
23903 #: ../src/guestfs-actions.pod:43
23907 " guestfs_add_domain (guestfs_h *g,\n"
23908 " const char *dom,\n"
23914 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:198 ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5626
23916 "You may supply a list of optional arguments to this call. Use zero or more "
23917 "of the following pairs of parameters, and terminate the list with C<-1> on "
23918 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
23922 #: ../src/guestfs-actions.pod:53
23925 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
23926 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
23927 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
23928 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
23929 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
23930 " GUESTFS_ADD_DOMAIN_READONLYDISK, const char *readonlydisk,\n"
23935 #: ../src/guestfs-actions.pod:60
23937 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
23938 "It works by connecting to libvirt, requesting the domain and domain XML from "
23939 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
23944 #: ../src/guestfs-actions.pod:141
23946 "The other optional parameters are passed directly through to "
23947 "C<guestfs_add_drive_opts>."
23951 #: ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:751 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:819 ../src/guestfs-actions.pod:1797 ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2467 ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:5585 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:6040 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:8086 ../src/guestfs-actions.pod:8099 ../src/guestfs-actions.pod:8112
23952 msgid "On error this function returns -1."
23956 #: ../src/guestfs-actions.pod:146
23957 msgid "(Added in 1.7.4)"
23961 #: ../src/guestfs-actions.pod:148
23962 msgid "guestfs_add_domain_va"
23966 #: ../src/guestfs-actions.pod:150
23970 " guestfs_add_domain_va (guestfs_h *g,\n"
23971 " const char *dom,\n"
23972 " va_list args);\n"
23977 #: ../src/guestfs-actions.pod:155
23978 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
23982 #: ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:168 ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1242 ../src/guestfs-actions.pod:1255 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1391 ../src/guestfs-actions.pod:1403 ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1456 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:1555 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5675 ../src/guestfs-actions.pod:5686
23983 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
23987 #: ../src/guestfs-actions.pod:159
23988 msgid "guestfs_add_domain_argv"
23992 #: ../src/guestfs-actions.pod:161
23996 " guestfs_add_domain_argv (guestfs_h *g,\n"
23997 " const char *dom,\n"
23998 " const struct guestfs_add_domain_argv *optargs);\n"
24003 #: ../src/guestfs-actions.pod:166
24004 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
24008 #: ../src/guestfs-actions.pod:170
24009 msgid "guestfs_add_drive"
24013 #: ../src/guestfs-actions.pod:172
24017 " guestfs_add_drive (guestfs_h *g,\n"
24018 " const char *filename);\n"
24023 #: ../src/guestfs-actions.pod:176
24025 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
24026 "optional parameters, so the disk is added writable, with the format being "
24027 "detected automatically."
24031 #: ../src/guestfs-actions.pod:180
24033 "Automatic detection of the format opens you up to a potential security hole "
24034 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
24035 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
24036 "you should think about replacing calls to this function with calls to "
24037 "C<guestfs_add_drive_opts>, and specifying the format."
24041 #: ../src/guestfs-actions.pod:191
24042 msgid "guestfs_add_drive_opts"
24046 #: ../src/guestfs-actions.pod:193
24050 " guestfs_add_drive_opts (guestfs_h *g,\n"
24051 " const char *filename,\n"
24057 #: ../src/guestfs-actions.pod:203
24060 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
24061 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
24062 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
24063 " GUESTFS_ADD_DRIVE_OPTS_NAME, const char *name,\n"
24068 #: ../src/guestfs-actions.pod:233
24070 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
24071 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
24072 "Possible formats include C<raw> and C<qcow2>."
24076 #: ../src/guestfs-actions.pod:244
24078 "This rarely-used option lets you emulate the behaviour of the deprecated "
24079 "C<guestfs_add_drive_with_if> call (q.v.)"
24083 #: ../src/guestfs-actions.pod:256
24084 msgid "(Added in 1.5.23)"
24088 #: ../src/guestfs-actions.pod:258
24089 msgid "guestfs_add_drive_opts_va"
24093 #: ../src/guestfs-actions.pod:260
24097 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
24098 " const char *filename,\n"
24099 " va_list args);\n"
24104 #: ../src/guestfs-actions.pod:265
24105 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
24109 #: ../src/guestfs-actions.pod:269
24110 msgid "guestfs_add_drive_opts_argv"
24114 #: ../src/guestfs-actions.pod:271
24118 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
24119 " const char *filename,\n"
24120 " const struct guestfs_add_drive_opts_argv "
24126 #: ../src/guestfs-actions.pod:276
24127 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
24131 #: ../src/guestfs-actions.pod:280
24132 msgid "guestfs_add_drive_ro"
24136 #: ../src/guestfs-actions.pod:282
24140 " guestfs_add_drive_ro (guestfs_h *g,\n"
24141 " const char *filename);\n"
24146 #: ../src/guestfs-actions.pod:286
24148 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
24149 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
24150 "disk is added read-only, with the format being detected automatically."
24154 #: ../src/guestfs-actions.pod:293
24155 msgid "(Added in 1.0.38)"
24159 #: ../src/guestfs-actions.pod:295
24160 msgid "guestfs_add_drive_ro_with_if"
24164 #: ../src/guestfs-actions.pod:297
24168 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
24169 " const char *filename,\n"
24170 " const char *iface);\n"
24175 #: ../src/guestfs-actions.pod:309
24177 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
24178 "QEMU interface emulation to use at run time."
24182 #: ../src/guestfs-actions.pod:314 ../src/guestfs-actions.pod:335 ../src/guestfs-actions.pod:2881
24183 msgid "(Added in 1.0.84)"
24187 #: ../src/guestfs-actions.pod:316
24188 msgid "guestfs_add_drive_with_if"
24192 #: ../src/guestfs-actions.pod:318
24196 " guestfs_add_drive_with_if (guestfs_h *g,\n"
24197 " const char *filename,\n"
24198 " const char *iface);\n"
24203 #: ../src/guestfs-actions.pod:330
24205 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
24206 "QEMU interface emulation to use at run time."
24210 #: ../src/guestfs-actions.pod:337
24211 msgid "guestfs_aug_clear"
24215 #: ../src/guestfs-actions.pod:339
24219 " guestfs_aug_clear (guestfs_h *g,\n"
24220 " const char *augpath);\n"
24225 #: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:2609
24226 msgid "(Added in 1.3.4)"
24230 #: ../src/guestfs-actions.pod:350
24231 msgid "guestfs_aug_close"
24235 #: ../src/guestfs-actions.pod:352
24239 " guestfs_aug_close (guestfs_h *g);\n"
24244 #: ../src/guestfs-actions.pod:355
24246 "Close the current Augeas handle and free up any resources used by it. After "
24247 "calling this, you have to call C<guestfs_aug_init> again before you can use "
24248 "any other Augeas functions."
24252 #: ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:419 ../src/guestfs-actions.pod:482 ../src/guestfs-actions.pod:502 ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:575 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:607 ../src/guestfs-actions.pod:6311
24253 msgid "(Added in 0.7)"
24257 #: ../src/guestfs-actions.pod:364
24258 msgid "guestfs_aug_defnode"
24262 #: ../src/guestfs-actions.pod:366
24265 " struct guestfs_int_bool *\n"
24266 " guestfs_aug_defnode (guestfs_h *g,\n"
24267 " const char *name,\n"
24268 " const char *expr,\n"
24269 " const char *val);\n"
24274 #: ../src/guestfs-actions.pod:375
24276 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
24277 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
24278 "containing that single node."
24282 #: ../src/guestfs-actions.pod:383
24284 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
24285 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
24289 #: ../src/guestfs-actions.pod:389
24290 msgid "guestfs_aug_defvar"
24294 #: ../src/guestfs-actions.pod:391
24298 " guestfs_aug_defvar (guestfs_h *g,\n"
24299 " const char *name,\n"
24300 " const char *expr);\n"
24305 #: ../src/guestfs-actions.pod:407
24306 msgid "guestfs_aug_get"
24310 #: ../src/guestfs-actions.pod:409
24314 " guestfs_aug_get (guestfs_h *g,\n"
24315 " const char *augpath);\n"
24320 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:980 ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1058 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1683 ../src/guestfs-actions.pod:1702 ../src/guestfs-actions.pod:1836 ../src/guestfs-actions.pod:2024 ../src/guestfs-actions.pod:2136 ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3050 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3676 ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4817 ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:5820 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6387 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7136 ../src/guestfs-actions.pod:7160 ../src/guestfs-actions.pod:7834 ../src/guestfs-actions.pod:7853 ../src/guestfs-actions.pod:7871 ../src/guestfs-actions.pod:8045 ../src/guestfs-actions.pod:8359
24322 "This function returns a string, or NULL on error. I<The caller must free "
24323 "the returned string after use>."
24327 #: ../src/guestfs-actions.pod:421
24328 msgid "guestfs_aug_init"
24332 #: ../src/guestfs-actions.pod:423
24336 " guestfs_aug_init (guestfs_h *g,\n"
24337 " const char *root,\n"
24343 #: ../src/guestfs-actions.pod:432
24344 msgid "You must call this before using any other C<guestfs_aug_*> commands."
24348 #: ../src/guestfs-actions.pod:457
24350 "This option is only useful when debugging Augeas lenses. Use of this option "
24351 "may require additional memory for the libguestfs appliance. You may need to "
24352 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
24353 "C<guestfs_set_memsize>."
24357 #: ../src/guestfs-actions.pod:472
24358 msgid "Do not load the tree in C<guestfs_aug_init>."
24362 #: ../src/guestfs-actions.pod:476
24363 msgid "To close the handle, you can call C<guestfs_aug_close>."
24367 #: ../src/guestfs-actions.pod:484
24368 msgid "guestfs_aug_insert"
24372 #: ../src/guestfs-actions.pod:486
24376 " guestfs_aug_insert (guestfs_h *g,\n"
24377 " const char *augpath,\n"
24378 " const char *label,\n"
24384 #: ../src/guestfs-actions.pod:504
24385 msgid "guestfs_aug_load"
24389 #: ../src/guestfs-actions.pod:506
24393 " guestfs_aug_load (guestfs_h *g);\n"
24398 #: ../src/guestfs-actions.pod:518
24399 msgid "guestfs_aug_ls"
24403 #: ../src/guestfs-actions.pod:520
24407 " guestfs_aug_ls (guestfs_h *g,\n"
24408 " const char *augpath);\n"
24413 #: ../src/guestfs-actions.pod:524
24415 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
24416 "sorting the resulting nodes into alphabetical order."
24420 #: ../src/guestfs-actions.pod:527 ../src/guestfs-actions.pod:543 ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1870 ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:1992 ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:2948 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:4186 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6421 ../src/guestfs-actions.pod:7176 ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7292 ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7462 ../src/guestfs-actions.pod:7938 ../src/guestfs-actions.pod:7958 ../src/guestfs-actions.pod:8005 ../src/guestfs-actions.pod:8199 ../src/guestfs-actions.pod:8218 ../src/guestfs-actions.pod:8309 ../src/guestfs-actions.pod:8328 ../src/guestfs-actions.pod:8374 ../src/guestfs-actions.pod:8393
24422 "This function returns a NULL-terminated array of strings (like "
24423 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
24424 "strings and the array after use>."
24428 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1139 ../src/guestfs-actions.pod:1908 ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4680 ../src/guestfs-actions.pod:4867 ../src/guestfs-actions.pod:4900 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5550 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7676 ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7922 ../src/guestfs-actions.pod:8187
24429 msgid "(Added in 0.8)"
24433 #: ../src/guestfs-actions.pod:533
24434 msgid "guestfs_aug_match"
24438 #: ../src/guestfs-actions.pod:535
24442 " guestfs_aug_match (guestfs_h *g,\n"
24443 " const char *augpath);\n"
24448 #: ../src/guestfs-actions.pod:549
24449 msgid "guestfs_aug_mv"
24453 #: ../src/guestfs-actions.pod:551
24457 " guestfs_aug_mv (guestfs_h *g,\n"
24458 " const char *src,\n"
24459 " const char *dest);\n"
24464 #: ../src/guestfs-actions.pod:563
24465 msgid "guestfs_aug_rm"
24469 #: ../src/guestfs-actions.pod:565
24473 " guestfs_aug_rm (guestfs_h *g,\n"
24474 " const char *augpath);\n"
24479 #: ../src/guestfs-actions.pod:577
24480 msgid "guestfs_aug_save"
24484 #: ../src/guestfs-actions.pod:579
24488 " guestfs_aug_save (guestfs_h *g);\n"
24493 #: ../src/guestfs-actions.pod:584
24495 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
24500 #: ../src/guestfs-actions.pod:591
24501 msgid "guestfs_aug_set"
24505 #: ../src/guestfs-actions.pod:593
24509 " guestfs_aug_set (guestfs_h *g,\n"
24510 " const char *augpath,\n"
24511 " const char *val);\n"
24516 #: ../src/guestfs-actions.pod:600
24518 "In the Augeas API, it is possible to clear a node by setting the value to "
24519 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
24520 "this call. Instead you must use the C<guestfs_aug_clear> call."
24524 #: ../src/guestfs-actions.pod:609
24525 msgid "guestfs_available"
24529 #: ../src/guestfs-actions.pod:611
24533 " guestfs_available (guestfs_h *g,\n"
24534 " char *const *groups);\n"
24539 #: ../src/guestfs-actions.pod:619
24541 "The libguestfs groups, and the functions that those groups correspond to, "
24542 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
24543 "runtime by calling C<guestfs_available_all_groups>."
24547 #: ../src/guestfs-actions.pod:643
24548 msgid "You must call C<guestfs_launch> before calling this function."
24552 #: ../src/guestfs-actions.pod:665
24554 "This call was added in version C<1.0.80>. In previous versions of "
24555 "libguestfs all you could do would be to speculatively execute a command to "
24556 "find out if the daemon implemented it. See also C<guestfs_version>."
24560 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:1653
24561 msgid "(Added in 1.0.80)"
24565 #: ../src/guestfs-actions.pod:676
24566 msgid "guestfs_available_all_groups"
24570 #: ../src/guestfs-actions.pod:678
24574 " guestfs_available_all_groups (guestfs_h *g);\n"
24579 #: ../src/guestfs-actions.pod:681
24581 "This command returns a list of all optional groups that this daemon knows "
24582 "about. Note this returns both supported and unsupported groups. To find "
24583 "out which ones the daemon can actually support you have to call "
24584 "C<guestfs_available> on each member of the returned list."
24588 #: ../src/guestfs-actions.pod:687
24589 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
24593 #: ../src/guestfs-actions.pod:693
24594 msgid "(Added in 1.3.15)"
24598 #: ../src/guestfs-actions.pod:695
24599 msgid "guestfs_base64_in"
24603 #: ../src/guestfs-actions.pod:697
24607 " guestfs_base64_in (guestfs_h *g,\n"
24608 " const char *base64file,\n"
24609 " const char *filename);\n"
24614 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:721
24615 msgid "(Added in 1.3.5)"
24619 #: ../src/guestfs-actions.pod:709
24620 msgid "guestfs_base64_out"
24624 #: ../src/guestfs-actions.pod:711
24628 " guestfs_base64_out (guestfs_h *g,\n"
24629 " const char *filename,\n"
24630 " const char *base64file);\n"
24635 #: ../src/guestfs-actions.pod:723
24636 msgid "guestfs_blockdev_flushbufs"
24640 #: ../src/guestfs-actions.pod:725
24644 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
24645 " const char *device);\n"
24650 #: ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:753 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:835 ../src/guestfs-actions.pod:853 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:881
24651 msgid "(Added in 0.9.3)"
24655 #: ../src/guestfs-actions.pod:738
24656 msgid "guestfs_blockdev_getbsz"
24660 #: ../src/guestfs-actions.pod:740
24664 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
24665 " const char *device);\n"
24670 #: ../src/guestfs-actions.pod:755
24671 msgid "guestfs_blockdev_getro"
24675 #: ../src/guestfs-actions.pod:757
24679 " guestfs_blockdev_getro (guestfs_h *g,\n"
24680 " const char *device);\n"
24685 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:2395 ../src/guestfs-actions.pod:2406 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2504 ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2595 ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:3693 ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3727 ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3948 ../src/guestfs-actions.pod:3963 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4063 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:5784
24686 msgid "This function returns a C truth value on success or -1 on error."
24690 #: ../src/guestfs-actions.pod:770
24691 msgid "guestfs_blockdev_getsize64"
24695 #: ../src/guestfs-actions.pod:772
24699 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
24700 " const char *device);\n"
24705 #: ../src/guestfs-actions.pod:778
24706 msgid "See also C<guestfs_blockdev_getsz>."
24710 #: ../src/guestfs-actions.pod:786
24711 msgid "guestfs_blockdev_getss"
24715 #: ../src/guestfs-actions.pod:788
24719 " guestfs_blockdev_getss (guestfs_h *g,\n"
24720 " const char *device);\n"
24725 #: ../src/guestfs-actions.pod:795
24727 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
24732 #: ../src/guestfs-actions.pod:804
24733 msgid "guestfs_blockdev_getsz"
24737 #: ../src/guestfs-actions.pod:806
24741 " guestfs_blockdev_getsz (guestfs_h *g,\n"
24742 " const char *device);\n"
24747 #: ../src/guestfs-actions.pod:813
24749 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
24750 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
24754 #: ../src/guestfs-actions.pod:823
24755 msgid "guestfs_blockdev_rereadpt"
24759 #: ../src/guestfs-actions.pod:825
24763 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
24764 " const char *device);\n"
24769 #: ../src/guestfs-actions.pod:837
24770 msgid "guestfs_blockdev_setbsz"
24774 #: ../src/guestfs-actions.pod:839
24778 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
24779 " const char *device,\n"
24780 " int blocksize);\n"
24785 #: ../src/guestfs-actions.pod:855
24786 msgid "guestfs_blockdev_setro"
24790 #: ../src/guestfs-actions.pod:857
24794 " guestfs_blockdev_setro (guestfs_h *g,\n"
24795 " const char *device);\n"
24800 #: ../src/guestfs-actions.pod:869
24801 msgid "guestfs_blockdev_setrw"
24805 #: ../src/guestfs-actions.pod:871
24809 " guestfs_blockdev_setrw (guestfs_h *g,\n"
24810 " const char *device);\n"
24815 #: ../src/guestfs-actions.pod:883
24816 msgid "guestfs_btrfs_filesystem_resize"
24820 #: ../src/guestfs-actions.pod:885
24824 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
24825 " const char *mountpoint,\n"
24831 #: ../src/guestfs-actions.pod:895
24834 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
24839 #: ../src/guestfs-actions.pod:918
24840 msgid "(Added in 1.11.17)"
24844 #: ../src/guestfs-actions.pod:920
24845 msgid "guestfs_btrfs_filesystem_resize_va"
24849 #: ../src/guestfs-actions.pod:922
24853 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
24854 " const char *mountpoint,\n"
24855 " va_list args);\n"
24860 #: ../src/guestfs-actions.pod:927
24861 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
24865 #: ../src/guestfs-actions.pod:931
24866 msgid "guestfs_btrfs_filesystem_resize_argv"
24870 #: ../src/guestfs-actions.pod:933
24874 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
24875 " const char *mountpoint,\n"
24877 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
24882 #: ../src/guestfs-actions.pod:938
24883 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
24887 #: ../src/guestfs-actions.pod:942
24888 msgid "guestfs_case_sensitive_path"
24892 #: ../src/guestfs-actions.pod:944
24896 " guestfs_case_sensitive_path (guestfs_h *g,\n"
24897 " const char *path);\n"
24902 #: ../src/guestfs-actions.pod:970
24904 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
24905 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
24906 "how the directories were originally created under Windows)."
24910 #: ../src/guestfs-actions.pod:978
24911 msgid "See also C<guestfs_realpath>."
24915 #: ../src/guestfs-actions.pod:983 ../src/guestfs-actions.pod:7856
24916 msgid "(Added in 1.0.75)"
24920 #: ../src/guestfs-actions.pod:985
24921 msgid "guestfs_cat"
24925 #: ../src/guestfs-actions.pod:987
24929 " guestfs_cat (guestfs_h *g,\n"
24930 " const char *path);\n"
24935 #: ../src/guestfs-actions.pod:993
24937 "Note that this function cannot correctly handle binary files (specifically, "
24938 "files containing C<\\0> character which is treated as end of string). For "
24939 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
24940 "functions which have a more complex interface."
24944 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4306 ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4807 ../src/guestfs-actions.pod:6185 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:8009 ../src/guestfs-actions.pod:8023
24945 msgid "(Added in 0.4)"
24949 #: ../src/guestfs-actions.pod:1006
24950 msgid "guestfs_checksum"
24954 #: ../src/guestfs-actions.pod:1008
24958 " guestfs_checksum (guestfs_h *g,\n"
24959 " const char *csumtype,\n"
24960 " const char *path);\n"
24965 #: ../src/guestfs-actions.pod:1054
24966 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
24970 #: ../src/guestfs-actions.pod:1056
24971 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
24975 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1728 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:3905 ../src/guestfs-actions.pod:3934 ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:7712
24976 msgid "(Added in 1.0.2)"
24980 #: ../src/guestfs-actions.pod:1063
24981 msgid "guestfs_checksum_device"
24985 #: ../src/guestfs-actions.pod:1065
24989 " guestfs_checksum_device (guestfs_h *g,\n"
24990 " const char *csumtype,\n"
24991 " const char *device);\n"
24996 #: ../src/guestfs-actions.pod:1070
24998 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
24999 "device named C<device>. For the types of checksums supported see the "
25000 "C<guestfs_checksum> command."
25004 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:5617 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5786 ../src/guestfs-actions.pod:5804 ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:7621 ../src/guestfs-actions.pod:7635 ../src/guestfs-actions.pod:8035
25005 msgid "(Added in 1.3.2)"
25009 #: ../src/guestfs-actions.pod:1079
25010 msgid "guestfs_checksums_out"
25014 #: ../src/guestfs-actions.pod:1081
25018 " guestfs_checksums_out (guestfs_h *g,\n"
25019 " const char *csumtype,\n"
25020 " const char *directory,\n"
25021 " const char *sumsfile);\n"
25026 #: ../src/guestfs-actions.pod:1101
25027 msgid "(Added in 1.3.7)"
25031 #: ../src/guestfs-actions.pod:1103
25032 msgid "guestfs_chmod"
25036 #: ../src/guestfs-actions.pod:1105
25040 " guestfs_chmod (guestfs_h *g,\n"
25042 " const char *path);\n"
25047 #: ../src/guestfs-actions.pod:1123
25048 msgid "guestfs_chown"
25052 #: ../src/guestfs-actions.pod:1125
25056 " guestfs_chown (guestfs_h *g,\n"
25059 " const char *path);\n"
25064 #: ../src/guestfs-actions.pod:1141
25065 msgid "guestfs_command"
25069 #: ../src/guestfs-actions.pod:1143
25073 " guestfs_command (guestfs_h *g,\n"
25074 " char *const *arguments);\n"
25079 #: ../src/guestfs-actions.pod:1152
25081 "The single parameter is an argv-style list of arguments. The first element "
25082 "is the name of the program to run. Subsequent elements are parameters. The "
25083 "list must be non-empty (ie. must contain a program name). Note that the "
25084 "command runs directly, and is I<not> invoked via the shell (see "
25089 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1203 ../src/guestfs-actions.pod:2027
25090 msgid "(Added in 0.9.1)"
25094 #: ../src/guestfs-actions.pod:1185
25095 msgid "guestfs_command_lines"
25099 #: ../src/guestfs-actions.pod:1187
25103 " guestfs_command_lines (guestfs_h *g,\n"
25104 " char *const *arguments);\n"
25109 #: ../src/guestfs-actions.pod:1191
25111 "This is the same as C<guestfs_command>, but splits the result into a list of "
25116 #: ../src/guestfs-actions.pod:1194
25117 msgid "See also: C<guestfs_sh_lines>"
25121 #: ../src/guestfs-actions.pod:1205
25122 msgid "guestfs_compress_device_out"
25126 #: ../src/guestfs-actions.pod:1207
25130 " guestfs_compress_device_out (guestfs_h *g,\n"
25131 " const char *ctype,\n"
25132 " const char *device,\n"
25133 " const char *zdevice,\n"
25139 #: ../src/guestfs-actions.pod:1219
25142 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
25147 #: ../src/guestfs-actions.pod:1224
25149 "The C<ctype> and optional C<level> parameters have the same meaning as in "
25150 "C<guestfs_compress_out>."
25154 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:2572 ../src/guestfs-actions.pod:6902
25155 msgid "(Added in 1.13.15)"
25159 #: ../src/guestfs-actions.pod:1231
25160 msgid "guestfs_compress_device_out_va"
25164 #: ../src/guestfs-actions.pod:1233
25168 " guestfs_compress_device_out_va (guestfs_h *g,\n"
25169 " const char *ctype,\n"
25170 " const char *device,\n"
25171 " const char *zdevice,\n"
25172 " va_list args);\n"
25177 #: ../src/guestfs-actions.pod:1240
25178 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
25182 #: ../src/guestfs-actions.pod:1244
25183 msgid "guestfs_compress_device_out_argv"
25187 #: ../src/guestfs-actions.pod:1246
25191 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
25192 " const char *ctype,\n"
25193 " const char *device,\n"
25194 " const char *zdevice,\n"
25196 "guestfs_compress_device_out_argv *optargs);\n"
25201 #: ../src/guestfs-actions.pod:1253
25202 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
25206 #: ../src/guestfs-actions.pod:1257
25207 msgid "guestfs_compress_out"
25211 #: ../src/guestfs-actions.pod:1259
25215 " guestfs_compress_out (guestfs_h *g,\n"
25216 " const char *ctype,\n"
25217 " const char *file,\n"
25218 " const char *zfile,\n"
25224 #: ../src/guestfs-actions.pod:1271
25227 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
25232 #: ../src/guestfs-actions.pod:1290
25233 msgid "guestfs_compress_out_va"
25237 #: ../src/guestfs-actions.pod:1292
25241 " guestfs_compress_out_va (guestfs_h *g,\n"
25242 " const char *ctype,\n"
25243 " const char *file,\n"
25244 " const char *zfile,\n"
25245 " va_list args);\n"
25250 #: ../src/guestfs-actions.pod:1299
25251 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
25255 #: ../src/guestfs-actions.pod:1303
25256 msgid "guestfs_compress_out_argv"
25260 #: ../src/guestfs-actions.pod:1305
25264 " guestfs_compress_out_argv (guestfs_h *g,\n"
25265 " const char *ctype,\n"
25266 " const char *file,\n"
25267 " const char *zfile,\n"
25268 " const struct guestfs_compress_out_argv "
25274 #: ../src/guestfs-actions.pod:1312
25275 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
25279 #: ../src/guestfs-actions.pod:1316
25280 msgid "guestfs_config"
25284 #: ../src/guestfs-actions.pod:1318
25288 " guestfs_config (guestfs_h *g,\n"
25289 " const char *qemuparam,\n"
25290 " const char *qemuvalue);\n"
25295 #: ../src/guestfs-actions.pod:1336
25296 msgid "guestfs_copy_device_to_device"
25300 #: ../src/guestfs-actions.pod:1338
25304 " guestfs_copy_device_to_device (guestfs_h *g,\n"
25305 " const char *src,\n"
25306 " const char *dest,\n"
25312 #: ../src/guestfs-actions.pod:1349
25315 " GUESTFS_COPY_DEVICE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
25316 " GUESTFS_COPY_DEVICE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
25317 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, int64_t size,\n"
25322 #: ../src/guestfs-actions.pod:1353
25324 "The four calls C<guestfs_copy_device_to_device>, "
25325 "C<guestfs_copy_device_to_file>, C<guestfs_copy_file_to_device>, and "
25326 "C<guestfs_copy_file_to_file> let you copy from a source (device|file) to a "
25327 "destination (device|file)."
25331 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1538 ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1723 ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:1799 ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:7707 ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:8248 ../src/guestfs-actions.pod:8271
25333 "This long-running command can generate progress notification messages so "
25334 "that the caller can display a progress bar or indicator. To receive these "
25335 "messages, the caller must register a progress event callback. See "
25336 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
25340 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1543 ../src/guestfs-actions.pod:6042
25341 msgid "(Added in 1.13.25)"
25345 #: ../src/guestfs-actions.pod:1381
25346 msgid "guestfs_copy_device_to_device_va"
25350 #: ../src/guestfs-actions.pod:1383
25354 " guestfs_copy_device_to_device_va (guestfs_h *g,\n"
25355 " const char *src,\n"
25356 " const char *dest,\n"
25357 " va_list args);\n"
25362 #: ../src/guestfs-actions.pod:1389
25363 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_device>."
25367 #: ../src/guestfs-actions.pod:1393
25368 msgid "guestfs_copy_device_to_device_argv"
25372 #: ../src/guestfs-actions.pod:1395
25376 " guestfs_copy_device_to_device_argv (guestfs_h *g,\n"
25377 " const char *src,\n"
25378 " const char *dest,\n"
25380 "guestfs_copy_device_to_device_argv *optargs);\n"
25385 #: ../src/guestfs-actions.pod:1401
25386 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_device>."
25390 #: ../src/guestfs-actions.pod:1405
25391 msgid "guestfs_copy_device_to_file"
25395 #: ../src/guestfs-actions.pod:1407
25399 " guestfs_copy_device_to_file (guestfs_h *g,\n"
25400 " const char *src,\n"
25401 " const char *dest,\n"
25407 #: ../src/guestfs-actions.pod:1418
25410 " GUESTFS_COPY_DEVICE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
25411 " GUESTFS_COPY_DEVICE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
25412 " GUESTFS_COPY_DEVICE_TO_FILE_SIZE, int64_t size,\n"
25417 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1475 ../src/guestfs-actions.pod:1528
25418 msgid "See C<guestfs_copy_device_to_device> for a general overview of this call."
25422 #: ../src/guestfs-actions.pod:1434
25423 msgid "guestfs_copy_device_to_file_va"
25427 #: ../src/guestfs-actions.pod:1436
25431 " guestfs_copy_device_to_file_va (guestfs_h *g,\n"
25432 " const char *src,\n"
25433 " const char *dest,\n"
25434 " va_list args);\n"
25439 #: ../src/guestfs-actions.pod:1442
25440 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_file>."
25444 #: ../src/guestfs-actions.pod:1446
25445 msgid "guestfs_copy_device_to_file_argv"
25449 #: ../src/guestfs-actions.pod:1448
25453 " guestfs_copy_device_to_file_argv (guestfs_h *g,\n"
25454 " const char *src,\n"
25455 " const char *dest,\n"
25457 "guestfs_copy_device_to_file_argv *optargs);\n"
25462 #: ../src/guestfs-actions.pod:1454
25463 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_file>."
25467 #: ../src/guestfs-actions.pod:1458
25468 msgid "guestfs_copy_file_to_device"
25472 #: ../src/guestfs-actions.pod:1460
25476 " guestfs_copy_file_to_device (guestfs_h *g,\n"
25477 " const char *src,\n"
25478 " const char *dest,\n"
25484 #: ../src/guestfs-actions.pod:1471
25487 " GUESTFS_COPY_FILE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
25488 " GUESTFS_COPY_FILE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
25489 " GUESTFS_COPY_FILE_TO_DEVICE_SIZE, int64_t size,\n"
25494 #: ../src/guestfs-actions.pod:1487
25495 msgid "guestfs_copy_file_to_device_va"
25499 #: ../src/guestfs-actions.pod:1489
25503 " guestfs_copy_file_to_device_va (guestfs_h *g,\n"
25504 " const char *src,\n"
25505 " const char *dest,\n"
25506 " va_list args);\n"
25511 #: ../src/guestfs-actions.pod:1495
25512 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_device>."
25516 #: ../src/guestfs-actions.pod:1499
25517 msgid "guestfs_copy_file_to_device_argv"
25521 #: ../src/guestfs-actions.pod:1501
25525 " guestfs_copy_file_to_device_argv (guestfs_h *g,\n"
25526 " const char *src,\n"
25527 " const char *dest,\n"
25529 "guestfs_copy_file_to_device_argv *optargs);\n"
25534 #: ../src/guestfs-actions.pod:1507
25535 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_device>."
25539 #: ../src/guestfs-actions.pod:1511
25540 msgid "guestfs_copy_file_to_file"
25544 #: ../src/guestfs-actions.pod:1513
25548 " guestfs_copy_file_to_file (guestfs_h *g,\n"
25549 " const char *src,\n"
25550 " const char *dest,\n"
25556 #: ../src/guestfs-actions.pod:1524
25559 " GUESTFS_COPY_FILE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
25560 " GUESTFS_COPY_FILE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
25561 " GUESTFS_COPY_FILE_TO_FILE_SIZE, int64_t size,\n"
25566 #: ../src/guestfs-actions.pod:1531
25568 "This is B<not> the function you want for copying files. This is for copying "
25569 "blocks within existing files. See C<guestfs_cp>, C<guestfs_cp_a> and "
25570 "C<guestfs_mv> for general file copying and moving functions."
25574 #: ../src/guestfs-actions.pod:1545
25575 msgid "guestfs_copy_file_to_file_va"
25579 #: ../src/guestfs-actions.pod:1547
25583 " guestfs_copy_file_to_file_va (guestfs_h *g,\n"
25584 " const char *src,\n"
25585 " const char *dest,\n"
25586 " va_list args);\n"
25591 #: ../src/guestfs-actions.pod:1553
25592 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_file>."
25596 #: ../src/guestfs-actions.pod:1557
25597 msgid "guestfs_copy_file_to_file_argv"
25601 #: ../src/guestfs-actions.pod:1559
25605 " guestfs_copy_file_to_file_argv (guestfs_h *g,\n"
25606 " const char *src,\n"
25607 " const char *dest,\n"
25608 " const struct guestfs_copy_file_to_file_argv "
25614 #: ../src/guestfs-actions.pod:1565
25615 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_file>."
25619 #: ../src/guestfs-actions.pod:1569
25620 msgid "guestfs_copy_size"
25624 #: ../src/guestfs-actions.pod:1571
25628 " guestfs_copy_size (guestfs_h *g,\n"
25629 " const char *src,\n"
25630 " const char *dest,\n"
25631 " int64_t size);\n"
25636 #: ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1634
25638 "I<This function is deprecated.> In new code, use the "
25639 "L</guestfs_copy_device_to_device> call instead."
25643 #: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:7942 ../src/guestfs-actions.pod:7962 ../src/guestfs-actions.pod:8048
25644 msgid "(Added in 1.0.87)"
25648 #: ../src/guestfs-actions.pod:1599
25653 #: ../src/guestfs-actions.pod:1601
25657 " guestfs_cp (guestfs_h *g,\n"
25658 " const char *src,\n"
25659 " const char *dest);\n"
25664 #: ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:5564 ../src/guestfs-actions.pod:6056
25665 msgid "(Added in 1.0.18)"
25669 #: ../src/guestfs-actions.pod:1613
25670 msgid "guestfs_cp_a"
25674 #: ../src/guestfs-actions.pod:1615
25678 " guestfs_cp_a (guestfs_h *g,\n"
25679 " const char *src,\n"
25680 " const char *dest);\n"
25685 #: ../src/guestfs-actions.pod:1627
25690 #: ../src/guestfs-actions.pod:1629
25694 " guestfs_dd (guestfs_h *g,\n"
25695 " const char *src,\n"
25696 " const char *dest);\n"
25701 #: ../src/guestfs-actions.pod:1646
25703 "If the destination is a device, it must be as large or larger than the "
25704 "source file or device, otherwise the copy will fail. This command cannot do "
25705 "partial copies (see C<guestfs_copy_device_to_device>)."
25709 #: ../src/guestfs-actions.pod:1655
25714 #: ../src/guestfs-actions.pod:1657
25718 " guestfs_df (guestfs_h *g);\n"
25723 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1679
25725 "This command is mostly useful for interactive sessions. It is I<not> "
25726 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
25731 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:4930 ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:7445 ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:8088 ../src/guestfs-actions.pod:8101 ../src/guestfs-actions.pod:8114
25732 msgid "(Added in 1.0.54)"
25736 #: ../src/guestfs-actions.pod:1671
25737 msgid "guestfs_df_h"
25741 #: ../src/guestfs-actions.pod:1673
25745 " guestfs_df_h (guestfs_h *g);\n"
25750 #: ../src/guestfs-actions.pod:1688
25751 msgid "guestfs_dmesg"
25755 #: ../src/guestfs-actions.pod:1690
25759 " guestfs_dmesg (guestfs_h *g);\n"
25764 #: ../src/guestfs-actions.pod:1697
25766 "Another way to get the same information is to enable verbose messages with "
25767 "C<guestfs_set_verbose> or by setting the environment variable "
25768 "C<LIBGUESTFS_DEBUG=1> before running the program."
25772 #: ../src/guestfs-actions.pod:1707
25773 msgid "guestfs_download"
25777 #: ../src/guestfs-actions.pod:1709
25781 " guestfs_download (guestfs_h *g,\n"
25782 " const char *remotefilename,\n"
25783 " const char *filename);\n"
25788 #: ../src/guestfs-actions.pod:1719
25789 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
25793 #: ../src/guestfs-actions.pod:1730
25794 msgid "guestfs_download_offset"
25798 #: ../src/guestfs-actions.pod:1732
25802 " guestfs_download_offset (guestfs_h *g,\n"
25803 " const char *remotefilename,\n"
25804 " const char *filename,\n"
25805 " int64_t offset,\n"
25806 " int64_t size);\n"
25811 #: ../src/guestfs-actions.pod:1745
25813 "Note that there is no limit on the amount of data that can be downloaded "
25814 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
25815 "full amount unless an error occurs."
25819 #: ../src/guestfs-actions.pod:1750
25820 msgid "See also C<guestfs_download>, C<guestfs_pread>."
25824 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:7746
25825 msgid "(Added in 1.5.17)"
25829 #: ../src/guestfs-actions.pod:1761
25830 msgid "guestfs_drop_caches"
25834 #: ../src/guestfs-actions.pod:1763
25838 " guestfs_drop_caches (guestfs_h *g,\n"
25839 " int whattodrop);\n"
25844 #: ../src/guestfs-actions.pod:1781
25849 #: ../src/guestfs-actions.pod:1783
25853 " guestfs_du (guestfs_h *g,\n"
25854 " const char *path);\n"
25859 #: ../src/guestfs-actions.pod:1806
25860 msgid "guestfs_e2fsck_f"
25864 #: ../src/guestfs-actions.pod:1808
25868 " guestfs_e2fsck_f (guestfs_h *g,\n"
25869 " const char *device);\n"
25874 #: ../src/guestfs-actions.pod:1816
25876 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
25877 "Normally you should use C<guestfs_fsck>."
25881 #: ../src/guestfs-actions.pod:1821
25882 msgid "(Added in 1.0.29)"
25886 #: ../src/guestfs-actions.pod:1823
25887 msgid "guestfs_echo_daemon"
25891 #: ../src/guestfs-actions.pod:1825
25895 " guestfs_echo_daemon (guestfs_h *g,\n"
25896 " char *const *words);\n"
25901 #: ../src/guestfs-actions.pod:1834
25902 msgid "See also C<guestfs_ping_daemon>."
25906 #: ../src/guestfs-actions.pod:1839 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:6926
25907 msgid "(Added in 1.0.69)"
25911 #: ../src/guestfs-actions.pod:1841
25912 msgid "guestfs_egrep"
25916 #: ../src/guestfs-actions.pod:1843
25920 " guestfs_egrep (guestfs_h *g,\n"
25921 " const char *regex,\n"
25922 " const char *path);\n"
25927 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1877 ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2924 ../src/guestfs-actions.pod:2937 ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4346 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:6390 ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7325 ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:8206 ../src/guestfs-actions.pod:8225 ../src/guestfs-actions.pod:8316 ../src/guestfs-actions.pod:8335 ../src/guestfs-actions.pod:8381 ../src/guestfs-actions.pod:8400
25928 msgid "(Added in 1.0.66)"
25932 #: ../src/guestfs-actions.pod:1860
25933 msgid "guestfs_egrepi"
25937 #: ../src/guestfs-actions.pod:1862
25941 " guestfs_egrepi (guestfs_h *g,\n"
25942 " const char *regex,\n"
25943 " const char *path);\n"
25948 #: ../src/guestfs-actions.pod:1879
25949 msgid "guestfs_equal"
25953 #: ../src/guestfs-actions.pod:1881
25957 " guestfs_equal (guestfs_h *g,\n"
25958 " const char *file1,\n"
25959 " const char *file2);\n"
25964 #: ../src/guestfs-actions.pod:1895
25965 msgid "guestfs_exists"
25969 #: ../src/guestfs-actions.pod:1897
25973 " guestfs_exists (guestfs_h *g,\n"
25974 " const char *path);\n"
25979 #: ../src/guestfs-actions.pod:1904
25980 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
25984 #: ../src/guestfs-actions.pod:1910
25985 msgid "guestfs_fallocate"
25989 #: ../src/guestfs-actions.pod:1912
25993 " guestfs_fallocate (guestfs_h *g,\n"
25994 " const char *path,\n"
26000 #: ../src/guestfs-actions.pod:1917
26002 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
26007 #: ../src/guestfs-actions.pod:1936
26008 msgid "guestfs_fallocate64"
26012 #: ../src/guestfs-actions.pod:1938
26016 " guestfs_fallocate64 (guestfs_h *g,\n"
26017 " const char *path,\n"
26023 #: ../src/guestfs-actions.pod:1947
26025 "Note that this call allocates disk blocks for the file. To create a sparse "
26026 "file use C<guestfs_truncate_size> instead."
26030 #: ../src/guestfs-actions.pod:1950
26032 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
26033 "oversight it only allowed 30 bit lengths to be specified, effectively "
26034 "limiting the maximum size of files created through that call to 1GB."
26038 #: ../src/guestfs-actions.pod:1961
26039 msgid "(Added in 1.3.17)"
26043 #: ../src/guestfs-actions.pod:1963
26044 msgid "guestfs_fgrep"
26048 #: ../src/guestfs-actions.pod:1965
26052 " guestfs_fgrep (guestfs_h *g,\n"
26053 " const char *pattern,\n"
26054 " const char *path);\n"
26059 #: ../src/guestfs-actions.pod:1982
26060 msgid "guestfs_fgrepi"
26064 #: ../src/guestfs-actions.pod:1984
26068 " guestfs_fgrepi (guestfs_h *g,\n"
26069 " const char *pattern,\n"
26070 " const char *path);\n"
26075 #: ../src/guestfs-actions.pod:2001
26076 msgid "guestfs_file"
26080 #: ../src/guestfs-actions.pod:2003
26084 " guestfs_file (guestfs_h *g,\n"
26085 " const char *path);\n"
26090 #: ../src/guestfs-actions.pod:2021
26092 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
26093 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
26097 #: ../src/guestfs-actions.pod:2029
26098 msgid "guestfs_file_architecture"
26102 #: ../src/guestfs-actions.pod:2031
26106 " guestfs_file_architecture (guestfs_h *g,\n"
26107 " const char *filename);\n"
26112 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3542 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3876 ../src/guestfs-actions.pod:4008
26113 msgid "(Added in 1.5.3)"
26117 #: ../src/guestfs-actions.pod:2141
26118 msgid "guestfs_filesize"
26122 #: ../src/guestfs-actions.pod:2143
26126 " guestfs_filesize (guestfs_h *g,\n"
26127 " const char *file);\n"
26132 #: ../src/guestfs-actions.pod:2149
26134 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
26135 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
26136 "devices, use C<guestfs_blockdev_getsize64>."
26140 #: ../src/guestfs-actions.pod:2155
26141 msgid "(Added in 1.0.82)"
26145 #: ../src/guestfs-actions.pod:2157
26146 msgid "guestfs_fill"
26150 #: ../src/guestfs-actions.pod:2159
26154 " guestfs_fill (guestfs_h *g,\n"
26157 " const char *path);\n"
26162 #: ../src/guestfs-actions.pod:2169
26164 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
26165 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
26166 "bytes use C<guestfs_fill_pattern>."
26170 #: ../src/guestfs-actions.pod:2181
26171 msgid "(Added in 1.0.79)"
26175 #: ../src/guestfs-actions.pod:2183
26176 msgid "guestfs_fill_pattern"
26180 #: ../src/guestfs-actions.pod:2185
26184 " guestfs_fill_pattern (guestfs_h *g,\n"
26185 " const char *pattern,\n"
26187 " const char *path);\n"
26192 #: ../src/guestfs-actions.pod:2191
26194 "This function is like C<guestfs_fill> except that it creates a new file of "
26195 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
26196 "pattern is truncated if necessary to ensure the length of the file is "
26197 "exactly C<len> bytes."
26201 #: ../src/guestfs-actions.pod:2203
26202 msgid "(Added in 1.3.12)"
26206 #: ../src/guestfs-actions.pod:2205
26207 msgid "guestfs_find"
26211 #: ../src/guestfs-actions.pod:2207
26215 " guestfs_find (guestfs_h *g,\n"
26216 " const char *directory);\n"
26221 #: ../src/guestfs-actions.pod:2223
26222 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
26226 #: ../src/guestfs-actions.pod:2236
26227 msgid "See also C<guestfs_find0>."
26231 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:6474
26232 msgid "(Added in 1.0.27)"
26236 #: ../src/guestfs-actions.pod:2247
26237 msgid "guestfs_find0"
26241 #: ../src/guestfs-actions.pod:2249
26245 " guestfs_find0 (guestfs_h *g,\n"
26246 " const char *directory,\n"
26247 " const char *files);\n"
26252 #: ../src/guestfs-actions.pod:2258
26254 "This command works the same way as C<guestfs_find> with the following "
26259 #: ../src/guestfs-actions.pod:2285
26260 msgid "(Added in 1.0.74)"
26264 #: ../src/guestfs-actions.pod:2287
26265 msgid "guestfs_findfs_label"
26269 #: ../src/guestfs-actions.pod:2289
26273 " guestfs_findfs_label (guestfs_h *g,\n"
26274 " const char *label);\n"
26279 #: ../src/guestfs-actions.pod:2297
26280 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
26284 #: ../src/guestfs-actions.pod:2304
26285 msgid "guestfs_findfs_uuid"
26289 #: ../src/guestfs-actions.pod:2306
26293 " guestfs_findfs_uuid (guestfs_h *g,\n"
26294 " const char *uuid);\n"
26299 #: ../src/guestfs-actions.pod:2314
26300 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
26304 #: ../src/guestfs-actions.pod:2321
26305 msgid "guestfs_fsck"
26309 #: ../src/guestfs-actions.pod:2323
26313 " guestfs_fsck (guestfs_h *g,\n"
26314 " const char *fstype,\n"
26315 " const char *device);\n"
26320 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:8253
26321 msgid "(Added in 1.0.16)"
26325 #: ../src/guestfs-actions.pod:2360
26326 msgid "guestfs_get_append"
26330 #: ../src/guestfs-actions.pod:2362
26334 " guestfs_get_append (guestfs_h *g);\n"
26339 #: ../src/guestfs-actions.pod:2370
26341 "This function returns a string which may be NULL. There is no way to return "
26342 "an error from this function. The string is owned by the guest handle and "
26343 "must I<not> be freed."
26347 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6631 ../src/guestfs-actions.pod:7080 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7115 ../src/guestfs-actions.pod:7139 ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7908 ../src/guestfs-actions.pod:8297
26348 msgid "(Added in 1.0.26)"
26352 #: ../src/guestfs-actions.pod:2376
26353 msgid "guestfs_get_attach_method"
26357 #: ../src/guestfs-actions.pod:2378
26361 " guestfs_get_attach_method (guestfs_h *g);\n"
26366 #: ../src/guestfs-actions.pod:2381
26367 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
26371 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:6661
26372 msgid "(Added in 1.9.8)"
26376 #: ../src/guestfs-actions.pod:2388
26377 msgid "guestfs_get_autosync"
26381 #: ../src/guestfs-actions.pod:2390
26385 " guestfs_get_autosync (guestfs_h *g);\n"
26390 #: ../src/guestfs-actions.pod:2399
26391 msgid "guestfs_get_direct"
26395 #: ../src/guestfs-actions.pod:2401
26399 " guestfs_get_direct (guestfs_h *g);\n"
26404 #: ../src/guestfs-actions.pod:2408 ../src/guestfs-actions.pod:6702
26405 msgid "(Added in 1.0.72)"
26409 #: ../src/guestfs-actions.pod:2410
26410 msgid "guestfs_get_e2label"
26414 #: ../src/guestfs-actions.pod:2412
26418 " guestfs_get_e2label (guestfs_h *g,\n"
26419 " const char *device);\n"
26424 #: ../src/guestfs-actions.pod:2416
26426 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
26431 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6739
26432 msgid "(Added in 1.0.15)"
26436 #: ../src/guestfs-actions.pod:2431
26437 msgid "guestfs_get_e2uuid"
26441 #: ../src/guestfs-actions.pod:2433
26445 " guestfs_get_e2uuid (guestfs_h *g,\n"
26446 " const char *device);\n"
26451 #: ../src/guestfs-actions.pod:2437
26453 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
26458 #: ../src/guestfs-actions.pod:2452
26459 msgid "guestfs_get_memsize"
26463 #: ../src/guestfs-actions.pod:2454
26467 " guestfs_get_memsize (guestfs_h *g);\n"
26472 #: ../src/guestfs-actions.pod:2460
26474 "If C<guestfs_set_memsize> was not called on this handle, and if "
26475 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
26476 "value for memsize."
26480 #: ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337 ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7662
26481 msgid "(Added in 1.0.55)"
26485 #: ../src/guestfs-actions.pod:2471
26486 msgid "guestfs_get_network"
26490 #: ../src/guestfs-actions.pod:2473
26494 " guestfs_get_network (guestfs_h *g);\n"
26499 #: ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:6779
26500 msgid "(Added in 1.5.4)"
26504 #: ../src/guestfs-actions.pod:2482
26505 msgid "guestfs_get_path"
26509 #: ../src/guestfs-actions.pod:2484
26513 " guestfs_get_path (guestfs_h *g);\n"
26518 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2532
26520 "This function returns a string, or NULL on error. The string is owned by "
26521 "the guest handle and must I<not> be freed."
26525 #: ../src/guestfs-actions.pod:2497
26526 msgid "guestfs_get_pgroup"
26530 #: ../src/guestfs-actions.pod:2499
26534 " guestfs_get_pgroup (guestfs_h *g);\n"
26539 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:8154
26540 msgid "(Added in 1.11.18)"
26544 #: ../src/guestfs-actions.pod:2508
26545 msgid "guestfs_get_pid"
26549 #: ../src/guestfs-actions.pod:2510
26553 " guestfs_get_pid (guestfs_h *g);\n"
26558 #: ../src/guestfs-actions.pod:2520
26559 msgid "(Added in 1.0.56)"
26563 #: ../src/guestfs-actions.pod:2522
26564 msgid "guestfs_get_qemu"
26568 #: ../src/guestfs-actions.pod:2524
26572 " guestfs_get_qemu (guestfs_h *g);\n"
26577 #: ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:6843
26578 msgid "(Added in 1.0.6)"
26582 #: ../src/guestfs-actions.pod:2537
26583 msgid "guestfs_get_recovery_proc"
26587 #: ../src/guestfs-actions.pod:2539
26591 " guestfs_get_recovery_proc (guestfs_h *g);\n"
26596 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:7565 ../src/guestfs-actions.pod:7585 ../src/guestfs-actions.pod:7777
26597 msgid "(Added in 1.0.77)"
26601 #: ../src/guestfs-actions.pod:2548
26602 msgid "guestfs_get_selinux"
26606 #: ../src/guestfs-actions.pod:2550
26610 " guestfs_get_selinux (guestfs_h *g);\n"
26615 #: ../src/guestfs-actions.pod:2553
26617 "This returns the current setting of the selinux flag which is passed to the "
26618 "appliance at boot time. See C<guestfs_set_selinux>."
26622 #: ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2635 ../src/guestfs-actions.pod:6886 ../src/guestfs-actions.pod:6960
26623 msgid "(Added in 1.0.67)"
26627 #: ../src/guestfs-actions.pod:2563
26628 msgid "guestfs_get_smp"
26632 #: ../src/guestfs-actions.pod:2565
26636 " guestfs_get_smp (guestfs_h *g);\n"
26641 #: ../src/guestfs-actions.pod:2574
26642 msgid "guestfs_get_state"
26646 #: ../src/guestfs-actions.pod:2576
26650 " guestfs_get_state (guestfs_h *g);\n"
26655 #: ../src/guestfs-actions.pod:2588
26656 msgid "guestfs_get_trace"
26660 #: ../src/guestfs-actions.pod:2590
26664 " guestfs_get_trace (guestfs_h *g);\n"
26669 #: ../src/guestfs-actions.pod:2599
26670 msgid "guestfs_get_umask"
26674 #: ../src/guestfs-actions.pod:2601
26678 " guestfs_get_umask (guestfs_h *g);\n"
26683 #: ../src/guestfs-actions.pod:2604
26685 "Return the current umask. By default the umask is C<022> unless it has been "
26686 "set by calling C<guestfs_umask>."
26690 #: ../src/guestfs-actions.pod:2611
26691 msgid "guestfs_get_verbose"
26695 #: ../src/guestfs-actions.pod:2613
26699 " guestfs_get_verbose (guestfs_h *g);\n"
26704 #: ../src/guestfs-actions.pod:2622
26705 msgid "guestfs_getcon"
26709 #: ../src/guestfs-actions.pod:2624
26713 " guestfs_getcon (guestfs_h *g);\n"
26718 #: ../src/guestfs-actions.pod:2629
26719 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
26723 #: ../src/guestfs-actions.pod:2637
26724 msgid "guestfs_getxattr"
26728 #: ../src/guestfs-actions.pod:2639
26732 " guestfs_getxattr (guestfs_h *g,\n"
26733 " const char *path,\n"
26734 " const char *name,\n"
26735 " size_t *size_r);\n"
26740 #: ../src/guestfs-actions.pod:2645
26742 "Get a single extended attribute from file C<path> named C<name>. This call "
26743 "follows symlinks. If you want to lookup an extended attribute for the "
26744 "symlink itself, use C<guestfs_lgetxattr>."
26748 #: ../src/guestfs-actions.pod:2649 ../src/guestfs-actions.pod:4144
26750 "Normally it is better to get all extended attributes from a file in one go "
26751 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
26752 "implementations are buggy and do not provide a way to list out attributes. "
26753 "For these filesystems (notably ntfs-3g) you have to know the names of the "
26754 "extended attributes you want in advance and call this function."
26758 #: ../src/guestfs-actions.pod:2659
26759 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
26763 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6282
26765 "This function returns a buffer, or NULL on error. The size of the returned "
26766 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
26771 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:4160
26772 msgid "(Added in 1.7.24)"
26776 #: ../src/guestfs-actions.pod:2667
26777 msgid "guestfs_getxattrs"
26781 #: ../src/guestfs-actions.pod:2669
26784 " struct guestfs_xattr_list *\n"
26785 " guestfs_getxattrs (guestfs_h *g,\n"
26786 " const char *path);\n"
26791 #: ../src/guestfs-actions.pod:2679
26792 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
26796 #: ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4851
26798 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
26799 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
26803 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:4176 ../src/guestfs-actions.pod:4375 ../src/guestfs-actions.pod:4411 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:8362
26804 msgid "(Added in 1.0.59)"
26808 #: ../src/guestfs-actions.pod:2687
26809 msgid "guestfs_glob_expand"
26813 #: ../src/guestfs-actions.pod:2689
26817 " guestfs_glob_expand (guestfs_h *g,\n"
26818 " const char *pattern);\n"
26823 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:7163 ../src/guestfs-actions.pod:7180
26824 msgid "(Added in 1.0.50)"
26828 #: ../src/guestfs-actions.pod:2710
26829 msgid "guestfs_grep"
26833 #: ../src/guestfs-actions.pod:2712
26837 " guestfs_grep (guestfs_h *g,\n"
26838 " const char *regex,\n"
26839 " const char *path);\n"
26844 #: ../src/guestfs-actions.pod:2729
26845 msgid "guestfs_grepi"
26849 #: ../src/guestfs-actions.pod:2731
26853 " guestfs_grepi (guestfs_h *g,\n"
26854 " const char *regex,\n"
26855 " const char *path);\n"
26860 #: ../src/guestfs-actions.pod:2748
26861 msgid "guestfs_grub_install"
26865 #: ../src/guestfs-actions.pod:2750
26869 " guestfs_grub_install (guestfs_h *g,\n"
26870 " const char *root,\n"
26871 " const char *device);\n"
26876 #: ../src/guestfs-actions.pod:2793
26877 msgid "(Added in 1.0.17)"
26881 #: ../src/guestfs-actions.pod:2795
26882 msgid "guestfs_head"
26886 #: ../src/guestfs-actions.pod:2797
26890 " guestfs_head (guestfs_h *g,\n"
26891 " const char *path);\n"
26896 #: ../src/guestfs-actions.pod:2813
26897 msgid "guestfs_head_n"
26901 #: ../src/guestfs-actions.pod:2815
26905 " guestfs_head_n (guestfs_h *g,\n"
26907 " const char *path);\n"
26912 #: ../src/guestfs-actions.pod:2837
26913 msgid "guestfs_hexdump"
26917 #: ../src/guestfs-actions.pod:2839
26921 " guestfs_hexdump (guestfs_h *g,\n"
26922 " const char *path);\n"
26927 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:7244 ../src/guestfs-actions.pod:7299
26928 msgid "(Added in 1.0.22)"
26932 #: ../src/guestfs-actions.pod:2854
26933 msgid "guestfs_initrd_cat"
26937 #: ../src/guestfs-actions.pod:2856
26941 " guestfs_initrd_cat (guestfs_h *g,\n"
26942 " const char *initrdpath,\n"
26943 " const char *filename,\n"
26944 " size_t *size_r);\n"
26949 #: ../src/guestfs-actions.pod:2872
26950 msgid "See also C<guestfs_initrd_list>."
26954 #: ../src/guestfs-actions.pod:2883
26955 msgid "guestfs_initrd_list"
26959 #: ../src/guestfs-actions.pod:2885
26963 " guestfs_initrd_list (guestfs_h *g,\n"
26964 " const char *path);\n"
26969 #: ../src/guestfs-actions.pod:2905
26970 msgid "guestfs_inotify_add_watch"
26974 #: ../src/guestfs-actions.pod:2907
26978 " guestfs_inotify_add_watch (guestfs_h *g,\n"
26979 " const char *path,\n"
26985 #: ../src/guestfs-actions.pod:2926
26986 msgid "guestfs_inotify_close"
26990 #: ../src/guestfs-actions.pod:2928
26994 " guestfs_inotify_close (guestfs_h *g);\n"
26999 #: ../src/guestfs-actions.pod:2939
27000 msgid "guestfs_inotify_files"
27004 #: ../src/guestfs-actions.pod:2941
27008 " guestfs_inotify_files (guestfs_h *g);\n"
27013 #: ../src/guestfs-actions.pod:2944
27015 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
27016 "returns a list of pathnames of objects that were touched. The returned "
27017 "pathnames are sorted and deduplicated."
27021 #: ../src/guestfs-actions.pod:2954
27022 msgid "guestfs_inotify_init"
27026 #: ../src/guestfs-actions.pod:2956
27030 " guestfs_inotify_init (guestfs_h *g,\n"
27031 " int maxevents);\n"
27036 #: ../src/guestfs-actions.pod:2964
27038 "C<maxevents> is the maximum number of events which will be queued up between "
27039 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
27040 "passed as C<0>, then the kernel (or previously set) default is used. For "
27041 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
27042 "throws away events, but records the fact that it threw them away by setting "
27043 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
27044 "C<guestfs_inotify_read>)."
27048 #: ../src/guestfs-actions.pod:2974
27050 "Before any events are generated, you have to add some watches to the "
27051 "internal watch list. See: C<guestfs_inotify_add_watch>, "
27052 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
27056 #: ../src/guestfs-actions.pod:2980
27058 "Queued up events should be read periodically by calling "
27059 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
27060 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
27061 "often enough then you risk the internal queue overflowing."
27065 #: ../src/guestfs-actions.pod:2987
27067 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
27068 "This also removes any watches automatically."
27072 #: ../src/guestfs-actions.pod:3000
27073 msgid "guestfs_inotify_read"
27077 #: ../src/guestfs-actions.pod:3002
27080 " struct guestfs_inotify_event_list *\n"
27081 " guestfs_inotify_read (guestfs_h *g);\n"
27086 #: ../src/guestfs-actions.pod:3016
27088 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
27089 "there was an error. I<The caller must call "
27090 "C<guestfs_free_inotify_event_list> after use>."
27094 #: ../src/guestfs-actions.pod:3022
27095 msgid "guestfs_inotify_rm_watch"
27099 #: ../src/guestfs-actions.pod:3024
27103 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
27109 #: ../src/guestfs-actions.pod:3028
27111 "Remove a previously defined inotify watch. See "
27112 "C<guestfs_inotify_add_watch>."
27116 #: ../src/guestfs-actions.pod:3035
27117 msgid "guestfs_inspect_get_arch"
27121 #: ../src/guestfs-actions.pod:3037
27125 " guestfs_inspect_get_arch (guestfs_h *g,\n"
27126 " const char *root);\n"
27131 #: ../src/guestfs-actions.pod:3041
27133 "This returns the architecture of the inspected operating system. The "
27134 "possible return values are listed under C<guestfs_file_architecture>."
27138 #: ../src/guestfs-actions.pod:3055
27139 msgid "guestfs_inspect_get_distro"
27143 #: ../src/guestfs-actions.pod:3057
27147 " guestfs_inspect_get_distro (guestfs_h *g,\n"
27148 " const char *root);\n"
27153 #: ../src/guestfs-actions.pod:3157
27154 msgid "guestfs_inspect_get_drive_mappings"
27158 #: ../src/guestfs-actions.pod:3159
27162 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
27163 " const char *root);\n"
27168 #: ../src/guestfs-actions.pod:3188
27170 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
27171 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
27175 #: ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3460 ../src/guestfs-actions.pod:4263 ../src/guestfs-actions.pod:5526 ../src/guestfs-actions.pod:7601
27177 "This function returns a NULL-terminated array of strings, or NULL if there "
27178 "was an error. The array of strings will always have length C<2n+1>, where "
27179 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
27180 "caller must free the strings and the array after use>."
27184 #: ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3659
27185 msgid "(Added in 1.9.17)"
27189 #: ../src/guestfs-actions.pod:3200
27190 msgid "guestfs_inspect_get_filesystems"
27194 #: ../src/guestfs-actions.pod:3202
27198 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
27199 " const char *root);\n"
27204 #: ../src/guestfs-actions.pod:3214
27206 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
27207 "C<guestfs_inspect_get_mountpoints>."
27211 #: ../src/guestfs-actions.pod:3223
27212 msgid "guestfs_inspect_get_format"
27216 #: ../src/guestfs-actions.pod:3225
27220 " guestfs_inspect_get_format (guestfs_h *g,\n"
27221 " const char *root);\n"
27226 #: ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:3695 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:6493
27227 msgid "(Added in 1.9.4)"
27231 #: ../src/guestfs-actions.pod:3261
27232 msgid "guestfs_inspect_get_hostname"
27236 #: ../src/guestfs-actions.pod:3263
27240 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
27241 " const char *root);\n"
27246 #: ../src/guestfs-actions.pod:3278
27247 msgid "(Added in 1.7.9)"
27251 #: ../src/guestfs-actions.pod:3280
27252 msgid "guestfs_inspect_get_icon"
27256 #: ../src/guestfs-actions.pod:3282
27260 " guestfs_inspect_get_icon (guestfs_h *g,\n"
27261 " const char *root,\n"
27262 " size_t *size_r,\n"
27268 #: ../src/guestfs-actions.pod:3293
27271 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
27272 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
27277 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:5425
27278 msgid "(Added in 1.11.12)"
27282 #: ../src/guestfs-actions.pod:3362
27283 msgid "guestfs_inspect_get_icon_va"
27287 #: ../src/guestfs-actions.pod:3364
27291 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
27292 " const char *root,\n"
27293 " size_t *size_r,\n"
27294 " va_list args);\n"
27299 #: ../src/guestfs-actions.pod:3370
27300 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
27304 #: ../src/guestfs-actions.pod:3374
27305 msgid "guestfs_inspect_get_icon_argv"
27309 #: ../src/guestfs-actions.pod:3376
27313 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
27314 " const char *root,\n"
27315 " size_t *size_r,\n"
27316 " const struct guestfs_inspect_get_icon_argv "
27322 #: ../src/guestfs-actions.pod:3382
27323 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
27327 #: ../src/guestfs-actions.pod:3386
27328 msgid "guestfs_inspect_get_major_version"
27332 #: ../src/guestfs-actions.pod:3388
27336 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
27337 " const char *root);\n"
27342 #: ../src/guestfs-actions.pod:3410
27343 msgid "guestfs_inspect_get_minor_version"
27347 #: ../src/guestfs-actions.pod:3412
27351 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
27352 " const char *root);\n"
27357 #: ../src/guestfs-actions.pod:3421
27359 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
27360 "C<guestfs_inspect_get_major_version>."
27364 #: ../src/guestfs-actions.pod:3428
27365 msgid "guestfs_inspect_get_mountpoints"
27369 #: ../src/guestfs-actions.pod:3430
27373 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
27374 " const char *root);\n"
27379 #: ../src/guestfs-actions.pod:3451
27381 "For operating systems like Windows which still use drive letters, this call "
27382 "will only return an entry for the first drive \"mounted on\" C</>. For "
27383 "information about the mapping of drive letters to partitions, see "
27384 "C<guestfs_inspect_get_drive_mappings>."
27388 #: ../src/guestfs-actions.pod:3457
27390 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
27391 "C<guestfs_inspect_get_filesystems>."
27395 #: ../src/guestfs-actions.pod:3468
27396 msgid "guestfs_inspect_get_package_format"
27400 #: ../src/guestfs-actions.pod:3470
27404 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
27405 " const char *root);\n"
27410 #: ../src/guestfs-actions.pod:3474
27412 "This function and C<guestfs_inspect_get_package_management> return the "
27413 "package format and package management tool used by the inspected operating "
27414 "system. For example for Fedora these functions would return C<rpm> (package "
27415 "format) and C<yum> (package management)."
27419 #: ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3521
27420 msgid "(Added in 1.7.5)"
27424 #: ../src/guestfs-actions.pod:3495
27425 msgid "guestfs_inspect_get_package_management"
27429 #: ../src/guestfs-actions.pod:3497
27433 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
27434 " const char *root);\n"
27439 #: ../src/guestfs-actions.pod:3501
27441 "C<guestfs_inspect_get_package_format> and this function return the package "
27442 "format and package management tool used by the inspected operating system. "
27443 "For example for Fedora these functions would return C<rpm> (package format) "
27444 "and C<yum> (package management)."
27448 #: ../src/guestfs-actions.pod:3523
27449 msgid "guestfs_inspect_get_product_name"
27453 #: ../src/guestfs-actions.pod:3525
27457 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
27458 " const char *root);\n"
27463 #: ../src/guestfs-actions.pod:3544
27464 msgid "guestfs_inspect_get_product_variant"
27468 #: ../src/guestfs-actions.pod:3546
27472 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
27473 " const char *root);\n"
27478 #: ../src/guestfs-actions.pod:3569
27480 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
27481 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
27485 #: ../src/guestfs-actions.pod:3576
27486 msgid "(Added in 1.9.13)"
27490 #: ../src/guestfs-actions.pod:3578
27491 msgid "guestfs_inspect_get_roots"
27495 #: ../src/guestfs-actions.pod:3580
27499 " guestfs_inspect_get_roots (guestfs_h *g);\n"
27504 #: ../src/guestfs-actions.pod:3583
27506 "This function is a convenient way to get the list of root devices, as "
27507 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
27508 "the whole inspection process."
27512 #: ../src/guestfs-actions.pod:3587
27514 "This returns an empty list if either no root devices were found or the "
27515 "caller has not called C<guestfs_inspect_os>."
27519 #: ../src/guestfs-actions.pod:3596
27520 msgid "(Added in 1.7.3)"
27524 #: ../src/guestfs-actions.pod:3598
27525 msgid "guestfs_inspect_get_type"
27529 #: ../src/guestfs-actions.pod:3600
27533 " guestfs_inspect_get_type (guestfs_h *g,\n"
27534 " const char *root);\n"
27539 #: ../src/guestfs-actions.pod:3641
27540 msgid "guestfs_inspect_get_windows_current_control_set"
27544 #: ../src/guestfs-actions.pod:3643
27548 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
27549 " const char *root);\n"
27554 #: ../src/guestfs-actions.pod:3661
27555 msgid "guestfs_inspect_get_windows_systemroot"
27559 #: ../src/guestfs-actions.pod:3663
27563 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
27564 " const char *root);\n"
27569 #: ../src/guestfs-actions.pod:3679
27570 msgid "(Added in 1.5.25)"
27574 #: ../src/guestfs-actions.pod:3681
27575 msgid "guestfs_inspect_is_live"
27579 #: ../src/guestfs-actions.pod:3683
27583 " guestfs_inspect_is_live (guestfs_h *g,\n"
27584 " const char *root);\n"
27589 #: ../src/guestfs-actions.pod:3687
27591 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27592 "disk), then this returns true if a live image was detected on the disk."
27596 #: ../src/guestfs-actions.pod:3697
27597 msgid "guestfs_inspect_is_multipart"
27601 #: ../src/guestfs-actions.pod:3699
27605 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
27606 " const char *root);\n"
27611 #: ../src/guestfs-actions.pod:3703
27613 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27614 "disk), then this returns true if the disk is part of a set."
27618 #: ../src/guestfs-actions.pod:3713
27619 msgid "guestfs_inspect_is_netinst"
27623 #: ../src/guestfs-actions.pod:3715
27627 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
27628 " const char *root);\n"
27633 #: ../src/guestfs-actions.pod:3719
27635 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
27636 "disk), then this returns true if the disk is a network installer, ie. not a "
27637 "self-contained install CD but one which is likely to require network access "
27638 "to complete the install."
27642 #: ../src/guestfs-actions.pod:3731
27643 msgid "guestfs_inspect_list_applications"
27647 #: ../src/guestfs-actions.pod:3733
27650 " struct guestfs_application_list *\n"
27651 " guestfs_inspect_list_applications (guestfs_h *g,\n"
27652 " const char *root);\n"
27657 #: ../src/guestfs-actions.pod:3739
27659 "I<Note:> This call works differently from other parts of the inspection "
27660 "API. You have to call C<guestfs_inspect_os>, then "
27661 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
27662 "this. Listing applications is a significantly more difficult operation "
27663 "which requires access to the full filesystem. Also note that unlike the "
27664 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
27665 "the libguestfs handle, this call actually reads parts of the mounted "
27666 "filesystems during the call."
27670 #: ../src/guestfs-actions.pod:3829
27672 "This function returns a C<struct guestfs_application_list *>, or NULL if "
27673 "there was an error. I<The caller must call C<guestfs_free_application_list> "
27678 #: ../src/guestfs-actions.pod:3833
27679 msgid "(Added in 1.7.8)"
27683 #: ../src/guestfs-actions.pod:3835
27684 msgid "guestfs_inspect_os"
27688 #: ../src/guestfs-actions.pod:3837
27692 " guestfs_inspect_os (guestfs_h *g);\n"
27697 #: ../src/guestfs-actions.pod:3853
27699 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
27700 "functions in order to query further information about each operating system, "
27701 "such as the name and version."
27705 #: ../src/guestfs-actions.pod:3858
27707 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
27708 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
27709 "the contents. This should be called with no disks currently mounted. The "
27710 "function may also use Augeas, so any existing Augeas handle will be closed."
27714 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4283
27715 msgid "See also C<guestfs_list_filesystems>."
27719 #: ../src/guestfs-actions.pod:3878
27720 msgid "guestfs_is_blockdev"
27724 #: ../src/guestfs-actions.pod:3880
27728 " guestfs_is_blockdev (guestfs_h *g,\n"
27729 " const char *path);\n"
27734 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4033 ../src/guestfs-actions.pod:4048
27735 msgid "See also C<guestfs_stat>."
27739 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3920 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4037 ../src/guestfs-actions.pod:4052
27740 msgid "(Added in 1.5.10)"
27744 #: ../src/guestfs-actions.pod:3893
27745 msgid "guestfs_is_busy"
27749 #: ../src/guestfs-actions.pod:3895
27753 " guestfs_is_busy (guestfs_h *g);\n"
27758 #: ../src/guestfs-actions.pod:3907
27759 msgid "guestfs_is_chardev"
27763 #: ../src/guestfs-actions.pod:3909
27767 " guestfs_is_chardev (guestfs_h *g,\n"
27768 " const char *path);\n"
27773 #: ../src/guestfs-actions.pod:3922
27774 msgid "guestfs_is_config"
27778 #: ../src/guestfs-actions.pod:3924
27782 " guestfs_is_config (guestfs_h *g);\n"
27787 #: ../src/guestfs-actions.pod:3936
27788 msgid "guestfs_is_dir"
27792 #: ../src/guestfs-actions.pod:3938
27796 " guestfs_is_dir (guestfs_h *g,\n"
27797 " const char *path);\n"
27802 #: ../src/guestfs-actions.pod:3952
27803 msgid "guestfs_is_fifo"
27807 #: ../src/guestfs-actions.pod:3954
27811 " guestfs_is_fifo (guestfs_h *g,\n"
27812 " const char *path);\n"
27817 #: ../src/guestfs-actions.pod:3967
27818 msgid "guestfs_is_file"
27822 #: ../src/guestfs-actions.pod:3969
27826 " guestfs_is_file (guestfs_h *g,\n"
27827 " const char *path);\n"
27832 #: ../src/guestfs-actions.pod:3983
27833 msgid "guestfs_is_launching"
27837 #: ../src/guestfs-actions.pod:3985
27841 " guestfs_is_launching (guestfs_h *g);\n"
27846 #: ../src/guestfs-actions.pod:3997
27847 msgid "guestfs_is_lv"
27851 #: ../src/guestfs-actions.pod:3999
27855 " guestfs_is_lv (guestfs_h *g,\n"
27856 " const char *device);\n"
27861 #: ../src/guestfs-actions.pod:4010
27862 msgid "guestfs_is_ready"
27866 #: ../src/guestfs-actions.pod:4012
27870 " guestfs_is_ready (guestfs_h *g);\n"
27875 #: ../src/guestfs-actions.pod:4024
27876 msgid "guestfs_is_socket"
27880 #: ../src/guestfs-actions.pod:4026
27884 " guestfs_is_socket (guestfs_h *g,\n"
27885 " const char *path);\n"
27890 #: ../src/guestfs-actions.pod:4039
27891 msgid "guestfs_is_symlink"
27895 #: ../src/guestfs-actions.pod:4041
27899 " guestfs_is_symlink (guestfs_h *g,\n"
27900 " const char *path);\n"
27905 #: ../src/guestfs-actions.pod:4054
27906 msgid "guestfs_is_zero"
27910 #: ../src/guestfs-actions.pod:4056
27914 " guestfs_is_zero (guestfs_h *g,\n"
27915 " const char *path);\n"
27920 #: ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4079
27921 msgid "(Added in 1.11.8)"
27925 #: ../src/guestfs-actions.pod:4067
27926 msgid "guestfs_is_zero_device"
27930 #: ../src/guestfs-actions.pod:4069
27934 " guestfs_is_zero_device (guestfs_h *g,\n"
27935 " const char *device);\n"
27940 #: ../src/guestfs-actions.pod:4081
27941 msgid "guestfs_kill_subprocess"
27945 #: ../src/guestfs-actions.pod:4083
27949 " guestfs_kill_subprocess (guestfs_h *g);\n"
27954 #: ../src/guestfs-actions.pod:4092
27955 msgid "guestfs_launch"
27959 #: ../src/guestfs-actions.pod:4094
27963 " guestfs_launch (guestfs_h *g);\n"
27968 #: ../src/guestfs-actions.pod:4112
27969 msgid "guestfs_lchown"
27973 #: ../src/guestfs-actions.pod:4114
27977 " guestfs_lchown (guestfs_h *g,\n"
27980 " const char *path);\n"
27985 #: ../src/guestfs-actions.pod:4120
27987 "Change the file owner to C<owner> and group to C<group>. This is like "
27988 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
27989 "changed, not the target."
27993 #: ../src/guestfs-actions.pod:4132
27994 msgid "guestfs_lgetxattr"
27998 #: ../src/guestfs-actions.pod:4134
28002 " guestfs_lgetxattr (guestfs_h *g,\n"
28003 " const char *path,\n"
28004 " const char *name,\n"
28005 " size_t *size_r);\n"
28010 #: ../src/guestfs-actions.pod:4154
28011 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
28015 #: ../src/guestfs-actions.pod:4162
28016 msgid "guestfs_lgetxattrs"
28020 #: ../src/guestfs-actions.pod:4164
28023 " struct guestfs_xattr_list *\n"
28024 " guestfs_lgetxattrs (guestfs_h *g,\n"
28025 " const char *path);\n"
28030 #: ../src/guestfs-actions.pod:4168
28032 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
28033 "then it returns the extended attributes of the link itself."
28037 #: ../src/guestfs-actions.pod:4178
28038 msgid "guestfs_list_9p"
28042 #: ../src/guestfs-actions.pod:4180
28046 " guestfs_list_9p (guestfs_h *g);\n"
28051 #: ../src/guestfs-actions.pod:4192
28052 msgid "guestfs_list_devices"
28056 #: ../src/guestfs-actions.pod:4194
28060 " guestfs_list_devices (guestfs_h *g);\n"
28065 #: ../src/guestfs-actions.pod:4209
28066 msgid "guestfs_list_dm_devices"
28070 #: ../src/guestfs-actions.pod:4211
28074 " guestfs_list_dm_devices (guestfs_h *g);\n"
28079 #: ../src/guestfs-actions.pod:4216
28081 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
28082 "previous call to C<guestfs_luks_open>."
28086 #: ../src/guestfs-actions.pod:4219
28088 "Device mapper devices which correspond to logical volumes are I<not> "
28089 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
28094 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5664
28095 msgid "(Added in 1.11.15)"
28099 #: ../src/guestfs-actions.pod:4229
28100 msgid "guestfs_list_filesystems"
28104 #: ../src/guestfs-actions.pod:4231
28108 " guestfs_list_filesystems (guestfs_h *g);\n"
28113 #: ../src/guestfs-actions.pod:4251
28115 "This command runs other libguestfs commands, which might include "
28116 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
28117 "soon after launch and only when nothing is mounted."
28121 #: ../src/guestfs-actions.pod:4255
28123 "Not all of the filesystems returned will be mountable. In particular, swap "
28124 "partitions are returned in the list. Also this command does not check that "
28125 "each filesystem found is valid and mountable, and some filesystems might be "
28126 "mountable but require special options. Filesystems may not all belong to a "
28127 "single logical operating system (use C<guestfs_inspect_os> to look for "
28132 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:6024
28133 msgid "(Added in 1.5.15)"
28137 #: ../src/guestfs-actions.pod:4271
28138 msgid "guestfs_list_partitions"
28142 #: ../src/guestfs-actions.pod:4273
28146 " guestfs_list_partitions (guestfs_h *g);\n"
28151 #: ../src/guestfs-actions.pod:4280
28153 "This does not return logical volumes. For that you will need to call "
28158 #: ../src/guestfs-actions.pod:4291
28163 #: ../src/guestfs-actions.pod:4293
28167 " guestfs_ll (guestfs_h *g,\n"
28168 " const char *directory);\n"
28173 #: ../src/guestfs-actions.pod:4308
28178 #: ../src/guestfs-actions.pod:4310
28182 " guestfs_ln (guestfs_h *g,\n"
28183 " const char *target,\n"
28184 " const char *linkname);\n"
28189 #: ../src/guestfs-actions.pod:4321
28190 msgid "guestfs_ln_f"
28194 #: ../src/guestfs-actions.pod:4323
28198 " guestfs_ln_f (guestfs_h *g,\n"
28199 " const char *target,\n"
28200 " const char *linkname);\n"
28205 #: ../src/guestfs-actions.pod:4335
28206 msgid "guestfs_ln_s"
28210 #: ../src/guestfs-actions.pod:4337
28214 " guestfs_ln_s (guestfs_h *g,\n"
28215 " const char *target,\n"
28216 " const char *linkname);\n"
28221 #: ../src/guestfs-actions.pod:4348
28222 msgid "guestfs_ln_sf"
28226 #: ../src/guestfs-actions.pod:4350
28230 " guestfs_ln_sf (guestfs_h *g,\n"
28231 " const char *target,\n"
28232 " const char *linkname);\n"
28237 #: ../src/guestfs-actions.pod:4362
28238 msgid "guestfs_lremovexattr"
28242 #: ../src/guestfs-actions.pod:4364
28246 " guestfs_lremovexattr (guestfs_h *g,\n"
28247 " const char *xattr,\n"
28248 " const char *path);\n"
28253 #: ../src/guestfs-actions.pod:4369
28255 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
28256 "link, then it removes an extended attribute of the link itself."
28260 #: ../src/guestfs-actions.pod:4377
28265 #: ../src/guestfs-actions.pod:4379
28269 " guestfs_ls (guestfs_h *g,\n"
28270 " const char *directory);\n"
28275 #: ../src/guestfs-actions.pod:4387
28277 "This command is mostly useful for interactive sessions. Programs should "
28278 "probably use C<guestfs_readdir> instead."
28282 #: ../src/guestfs-actions.pod:4396
28283 msgid "guestfs_lsetxattr"
28287 #: ../src/guestfs-actions.pod:4398
28291 " guestfs_lsetxattr (guestfs_h *g,\n"
28292 " const char *xattr,\n"
28293 " const char *val,\n"
28295 " const char *path);\n"
28300 #: ../src/guestfs-actions.pod:4405
28302 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
28303 "then it sets an extended attribute of the link itself."
28307 #: ../src/guestfs-actions.pod:4413
28308 msgid "guestfs_lstat"
28312 #: ../src/guestfs-actions.pod:4415
28315 " struct guestfs_stat *\n"
28316 " guestfs_lstat (guestfs_h *g,\n"
28317 " const char *path);\n"
28322 #: ../src/guestfs-actions.pod:4421
28324 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
28325 "link, then the link is stat-ed, not the file it refers to."
28329 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:7204
28331 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
28332 "error. I<The caller must call C<guestfs_free_stat> after use>."
28336 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:7208 ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7607
28337 msgid "(Added in 0.9.2)"
28341 #: ../src/guestfs-actions.pod:4433
28342 msgid "guestfs_lstatlist"
28346 #: ../src/guestfs-actions.pod:4435
28349 " struct guestfs_stat_list *\n"
28350 " guestfs_lstatlist (guestfs_h *g,\n"
28351 " const char *path,\n"
28352 " char *const *names);\n"
28357 #: ../src/guestfs-actions.pod:4440
28359 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
28360 "files, where all files are in the directory C<path>. C<names> is the list "
28361 "of files from this directory."
28365 #: ../src/guestfs-actions.pod:4449
28367 "This call is intended for programs that want to efficiently list a directory "
28368 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
28369 "for a similarly efficient call for getting extended attributes. Very long "
28370 "directory listings might cause the protocol message size to be exceeded, "
28371 "causing this call to fail. The caller must split up such requests into "
28372 "smaller groups of names."
28376 #: ../src/guestfs-actions.pod:4457
28378 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
28379 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
28383 #: ../src/guestfs-actions.pod:4463
28384 msgid "guestfs_luks_add_key"
28388 #: ../src/guestfs-actions.pod:4465
28392 " guestfs_luks_add_key (guestfs_h *g,\n"
28393 " const char *device,\n"
28394 " const char *key,\n"
28395 " const char *newkey,\n"
28401 #: ../src/guestfs-actions.pod:4477
28403 "Note that if C<keyslot> already contains a key, then this command will "
28404 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
28408 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4614
28410 "This function takes a key or passphrase parameter which could contain "
28411 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
28416 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4564
28417 msgid "(Added in 1.5.2)"
28421 #: ../src/guestfs-actions.pod:4489
28422 msgid "guestfs_luks_close"
28426 #: ../src/guestfs-actions.pod:4491
28430 " guestfs_luks_close (guestfs_h *g,\n"
28431 " const char *device);\n"
28436 #: ../src/guestfs-actions.pod:4495
28438 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
28439 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
28440 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
28441 "underlying block device."
28445 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4713
28446 msgid "(Added in 1.5.1)"
28450 #: ../src/guestfs-actions.pod:4505
28451 msgid "guestfs_luks_format"
28455 #: ../src/guestfs-actions.pod:4507
28459 " guestfs_luks_format (guestfs_h *g,\n"
28460 " const char *device,\n"
28461 " const char *key,\n"
28467 #: ../src/guestfs-actions.pod:4526
28468 msgid "guestfs_luks_format_cipher"
28472 #: ../src/guestfs-actions.pod:4528
28476 " guestfs_luks_format_cipher (guestfs_h *g,\n"
28477 " const char *device,\n"
28478 " const char *key,\n"
28480 " const char *cipher);\n"
28485 #: ../src/guestfs-actions.pod:4535
28487 "This command is the same as C<guestfs_luks_format> but it also allows you to "
28488 "set the C<cipher> used."
28492 #: ../src/guestfs-actions.pod:4546
28493 msgid "guestfs_luks_kill_slot"
28497 #: ../src/guestfs-actions.pod:4548
28501 " guestfs_luks_kill_slot (guestfs_h *g,\n"
28502 " const char *device,\n"
28503 " const char *key,\n"
28509 #: ../src/guestfs-actions.pod:4566
28510 msgid "guestfs_luks_open"
28514 #: ../src/guestfs-actions.pod:4568
28518 " guestfs_luks_open (guestfs_h *g,\n"
28519 " const char *device,\n"
28520 " const char *key,\n"
28521 " const char *mapname);\n"
28526 #: ../src/guestfs-actions.pod:4586
28528 "If this block device contains LVM volume groups, then calling "
28529 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
28534 #: ../src/guestfs-actions.pod:4590
28535 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
28539 #: ../src/guestfs-actions.pod:4601
28540 msgid "guestfs_luks_open_ro"
28544 #: ../src/guestfs-actions.pod:4603
28548 " guestfs_luks_open_ro (guestfs_h *g,\n"
28549 " const char *device,\n"
28550 " const char *key,\n"
28551 " const char *mapname);\n"
28556 #: ../src/guestfs-actions.pod:4609
28558 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
28563 #: ../src/guestfs-actions.pod:4620
28564 msgid "guestfs_lvcreate"
28568 #: ../src/guestfs-actions.pod:4622
28572 " guestfs_lvcreate (guestfs_h *g,\n"
28573 " const char *logvol,\n"
28574 " const char *volgroup,\n"
28580 #: ../src/guestfs-actions.pod:4635
28581 msgid "guestfs_lvm_canonical_lv_name"
28585 #: ../src/guestfs-actions.pod:4637
28589 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
28590 " const char *lvname);\n"
28595 #: ../src/guestfs-actions.pod:4648
28596 msgid "See also C<guestfs_is_lv>."
28600 #: ../src/guestfs-actions.pod:4653
28601 msgid "(Added in 1.5.24)"
28605 #: ../src/guestfs-actions.pod:4655
28606 msgid "guestfs_lvm_clear_filter"
28610 #: ../src/guestfs-actions.pod:4657
28614 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
28619 #: ../src/guestfs-actions.pod:4660
28621 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
28622 "see every block device."
28626 #: ../src/guestfs-actions.pod:4670
28627 msgid "guestfs_lvm_remove_all"
28631 #: ../src/guestfs-actions.pod:4672
28635 " guestfs_lvm_remove_all (guestfs_h *g);\n"
28640 #: ../src/guestfs-actions.pod:4682
28641 msgid "guestfs_lvm_set_filter"
28645 #: ../src/guestfs-actions.pod:4684
28649 " guestfs_lvm_set_filter (guestfs_h *g,\n"
28650 " char *const *devices);\n"
28655 #: ../src/guestfs-actions.pod:4715
28656 msgid "guestfs_lvremove"
28660 #: ../src/guestfs-actions.pod:4717
28664 " guestfs_lvremove (guestfs_h *g,\n"
28665 " const char *device);\n"
28670 #: ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:7977
28671 msgid "(Added in 1.0.13)"
28675 #: ../src/guestfs-actions.pod:4731
28676 msgid "guestfs_lvrename"
28680 #: ../src/guestfs-actions.pod:4733
28684 " guestfs_lvrename (guestfs_h *g,\n"
28685 " const char *logvol,\n"
28686 " const char *newlogvol);\n"
28691 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:7990
28692 msgid "(Added in 1.0.83)"
28696 #: ../src/guestfs-actions.pod:4744
28697 msgid "guestfs_lvresize"
28701 #: ../src/guestfs-actions.pod:4746
28705 " guestfs_lvresize (guestfs_h *g,\n"
28706 " const char *device,\n"
28712 #: ../src/guestfs-actions.pod:4759
28713 msgid "guestfs_lvresize_free"
28717 #: ../src/guestfs-actions.pod:4761
28721 " guestfs_lvresize_free (guestfs_h *g,\n"
28722 " const char *lv,\n"
28728 #: ../src/guestfs-actions.pod:4774
28729 msgid "(Added in 1.3.3)"
28733 #: ../src/guestfs-actions.pod:4776
28734 msgid "guestfs_lvs"
28738 #: ../src/guestfs-actions.pod:4778
28742 " guestfs_lvs (guestfs_h *g);\n"
28747 #: ../src/guestfs-actions.pod:4787
28748 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
28752 #: ../src/guestfs-actions.pod:4795
28753 msgid "guestfs_lvs_full"
28757 #: ../src/guestfs-actions.pod:4797
28760 " struct guestfs_lvm_lv_list *\n"
28761 " guestfs_lvs_full (guestfs_h *g);\n"
28766 #: ../src/guestfs-actions.pod:4803
28768 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
28769 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
28774 #: ../src/guestfs-actions.pod:4809
28775 msgid "guestfs_lvuuid"
28779 #: ../src/guestfs-actions.pod:4811
28783 " guestfs_lvuuid (guestfs_h *g,\n"
28784 " const char *device);\n"
28789 #: ../src/guestfs-actions.pod:4822
28790 msgid "guestfs_lxattrlist"
28794 #: ../src/guestfs-actions.pod:4824
28797 " struct guestfs_xattr_list *\n"
28798 " guestfs_lxattrlist (guestfs_h *g,\n"
28799 " const char *path,\n"
28800 " char *const *names);\n"
28805 #: ../src/guestfs-actions.pod:4843
28807 "This call is intended for programs that want to efficiently list a directory "
28808 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
28809 "a similarly efficient call for getting standard stats. Very long directory "
28810 "listings might cause the protocol message size to be exceeded, causing this "
28811 "call to fail. The caller must split up such requests into smaller groups of "
28816 #: ../src/guestfs-actions.pod:4857
28817 msgid "guestfs_mkdir"
28821 #: ../src/guestfs-actions.pod:4859
28825 " guestfs_mkdir (guestfs_h *g,\n"
28826 " const char *path);\n"
28831 #: ../src/guestfs-actions.pod:4869
28832 msgid "guestfs_mkdir_mode"
28836 #: ../src/guestfs-actions.pod:4871
28840 " guestfs_mkdir_mode (guestfs_h *g,\n"
28841 " const char *path,\n"
28847 #: ../src/guestfs-actions.pod:4883
28848 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
28852 #: ../src/guestfs-actions.pod:4889
28853 msgid "guestfs_mkdir_p"
28857 #: ../src/guestfs-actions.pod:4891
28861 " guestfs_mkdir_p (guestfs_h *g,\n"
28862 " const char *path);\n"
28867 #: ../src/guestfs-actions.pod:4902
28868 msgid "guestfs_mkdtemp"
28872 #: ../src/guestfs-actions.pod:4904
28876 " guestfs_mkdtemp (guestfs_h *g,\n"
28877 " const char *template);\n"
28882 #: ../src/guestfs-actions.pod:4932
28883 msgid "guestfs_mke2fs_J"
28887 #: ../src/guestfs-actions.pod:4934
28891 " guestfs_mke2fs_J (guestfs_h *g,\n"
28892 " const char *fstype,\n"
28893 " int blocksize,\n"
28894 " const char *device,\n"
28895 " const char *journal);\n"
28900 #: ../src/guestfs-actions.pod:4947
28901 msgid "See also C<guestfs_mke2journal>."
28905 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5367
28906 msgid "(Added in 1.0.68)"
28910 #: ../src/guestfs-actions.pod:4953
28911 msgid "guestfs_mke2fs_JL"
28915 #: ../src/guestfs-actions.pod:4955
28919 " guestfs_mke2fs_JL (guestfs_h *g,\n"
28920 " const char *fstype,\n"
28921 " int blocksize,\n"
28922 " const char *device,\n"
28923 " const char *label);\n"
28928 #: ../src/guestfs-actions.pod:4965
28929 msgid "See also C<guestfs_mke2journal_L>."
28933 #: ../src/guestfs-actions.pod:4971
28934 msgid "guestfs_mke2fs_JU"
28938 #: ../src/guestfs-actions.pod:4973
28942 " guestfs_mke2fs_JU (guestfs_h *g,\n"
28943 " const char *fstype,\n"
28944 " int blocksize,\n"
28945 " const char *device,\n"
28946 " const char *uuid);\n"
28951 #: ../src/guestfs-actions.pod:4983
28952 msgid "See also C<guestfs_mke2journal_U>."
28956 #: ../src/guestfs-actions.pod:4989
28957 msgid "guestfs_mke2journal"
28961 #: ../src/guestfs-actions.pod:4991
28965 " guestfs_mke2journal (guestfs_h *g,\n"
28966 " int blocksize,\n"
28967 " const char *device);\n"
28972 #: ../src/guestfs-actions.pod:5005
28973 msgid "guestfs_mke2journal_L"
28977 #: ../src/guestfs-actions.pod:5007
28981 " guestfs_mke2journal_L (guestfs_h *g,\n"
28982 " int blocksize,\n"
28983 " const char *label,\n"
28984 " const char *device);\n"
28989 #: ../src/guestfs-actions.pod:5019
28990 msgid "guestfs_mke2journal_U"
28994 #: ../src/guestfs-actions.pod:5021
28998 " guestfs_mke2journal_U (guestfs_h *g,\n"
28999 " int blocksize,\n"
29000 " const char *uuid,\n"
29001 " const char *device);\n"
29006 #: ../src/guestfs-actions.pod:5033
29007 msgid "guestfs_mkfifo"
29011 #: ../src/guestfs-actions.pod:5035
29015 " guestfs_mkfifo (guestfs_h *g,\n"
29017 " const char *path);\n"
29022 #: ../src/guestfs-actions.pod:5040
29024 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
29025 "is just a convenient wrapper around C<guestfs_mknod>."
29029 #: ../src/guestfs-actions.pod:5050
29030 msgid "guestfs_mkfs"
29034 #: ../src/guestfs-actions.pod:5052
29038 " guestfs_mkfs (guestfs_h *g,\n"
29039 " const char *fstype,\n"
29040 " const char *device);\n"
29045 #: ../src/guestfs-actions.pod:5065
29046 msgid "guestfs_mkfs_b"
29050 #: ../src/guestfs-actions.pod:5067
29054 " guestfs_mkfs_b (guestfs_h *g,\n"
29055 " const char *fstype,\n"
29056 " int blocksize,\n"
29057 " const char *device);\n"
29062 #: ../src/guestfs-actions.pod:5073
29064 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
29069 #: ../src/guestfs-actions.pod:5080
29071 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
29072 "block size of the resulting filesystem. Supported block sizes depend on the "
29073 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
29077 #: ../src/guestfs-actions.pod:5092
29078 msgid "guestfs_mkfs_opts"
29082 #: ../src/guestfs-actions.pod:5094
29086 " guestfs_mkfs_opts (guestfs_h *g,\n"
29087 " const char *fstype,\n"
29088 " const char *device,\n"
29094 #: ../src/guestfs-actions.pod:5105
29097 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
29098 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
29099 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
29100 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
29105 #: ../src/guestfs-actions.pod:5153
29106 msgid "(Added in 1.7.19)"
29110 #: ../src/guestfs-actions.pod:5155
29111 msgid "guestfs_mkfs_opts_va"
29115 #: ../src/guestfs-actions.pod:5157
29119 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
29120 " const char *fstype,\n"
29121 " const char *device,\n"
29122 " va_list args);\n"
29127 #: ../src/guestfs-actions.pod:5163
29128 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
29132 #: ../src/guestfs-actions.pod:5167
29133 msgid "guestfs_mkfs_opts_argv"
29137 #: ../src/guestfs-actions.pod:5169
29141 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
29142 " const char *fstype,\n"
29143 " const char *device,\n"
29144 " const struct guestfs_mkfs_opts_argv *optargs);\n"
29149 #: ../src/guestfs-actions.pod:5175
29150 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
29154 #: ../src/guestfs-actions.pod:5179
29155 msgid "guestfs_mkmountpoint"
29159 #: ../src/guestfs-actions.pod:5181
29163 " guestfs_mkmountpoint (guestfs_h *g,\n"
29164 " const char *exemptpath);\n"
29169 #: ../src/guestfs-actions.pod:5185
29171 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
29172 "that can be used to create extra mountpoints before mounting the first "
29177 #: ../src/guestfs-actions.pod:5209
29179 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
29180 "may get unexpected errors if you try to mix these calls. It is safest to "
29181 "manually unmount filesystems and remove mountpoints after use."
29185 #: ../src/guestfs-actions.pod:5213
29187 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
29188 "first, so for this to work for manual mountpoints, you must ensure that the "
29189 "innermost mountpoints have the longest pathnames, as in the example code "
29194 #: ../src/guestfs-actions.pod:5220
29196 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
29197 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
29198 "can also trigger these issues."
29202 #: ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5532 ../src/guestfs-actions.pod:6559
29203 msgid "(Added in 1.0.62)"
29207 #: ../src/guestfs-actions.pod:5228
29208 msgid "guestfs_mknod"
29212 #: ../src/guestfs-actions.pod:5230
29216 " guestfs_mknod (guestfs_h *g,\n"
29220 " const char *path);\n"
29225 #: ../src/guestfs-actions.pod:5245
29227 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
29228 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
29229 "regular file). These constants are available in the standard Linux header "
29230 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
29231 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
29232 "the appropriate constant for you."
29236 #: ../src/guestfs-actions.pod:5259
29237 msgid "guestfs_mknod_b"
29241 #: ../src/guestfs-actions.pod:5261
29245 " guestfs_mknod_b (guestfs_h *g,\n"
29249 " const char *path);\n"
29254 #: ../src/guestfs-actions.pod:5268
29256 "This call creates a block device node called C<path> with mode C<mode> and "
29257 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
29258 "wrapper around C<guestfs_mknod>."
29262 #: ../src/guestfs-actions.pod:5278
29263 msgid "guestfs_mknod_c"
29267 #: ../src/guestfs-actions.pod:5280
29271 " guestfs_mknod_c (guestfs_h *g,\n"
29275 " const char *path);\n"
29280 #: ../src/guestfs-actions.pod:5287
29282 "This call creates a char device node called C<path> with mode C<mode> and "
29283 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
29284 "wrapper around C<guestfs_mknod>."
29288 #: ../src/guestfs-actions.pod:5297
29289 msgid "guestfs_mkswap"
29293 #: ../src/guestfs-actions.pod:5299
29297 " guestfs_mkswap (guestfs_h *g,\n"
29298 " const char *device);\n"
29303 #: ../src/guestfs-actions.pod:5309
29304 msgid "guestfs_mkswap_L"
29308 #: ../src/guestfs-actions.pod:5311
29312 " guestfs_mkswap_L (guestfs_h *g,\n"
29313 " const char *label,\n"
29314 " const char *device);\n"
29319 #: ../src/guestfs-actions.pod:5326
29320 msgid "guestfs_mkswap_U"
29324 #: ../src/guestfs-actions.pod:5328
29328 " guestfs_mkswap_U (guestfs_h *g,\n"
29329 " const char *uuid,\n"
29330 " const char *device);\n"
29335 #: ../src/guestfs-actions.pod:5339
29336 msgid "guestfs_mkswap_file"
29340 #: ../src/guestfs-actions.pod:5341
29344 " guestfs_mkswap_file (guestfs_h *g,\n"
29345 " const char *path);\n"
29350 #: ../src/guestfs-actions.pod:5347
29352 "This command just writes a swap file signature to an existing file. To "
29353 "create the file itself, use something like C<guestfs_fallocate>."
29357 #: ../src/guestfs-actions.pod:5354
29358 msgid "guestfs_modprobe"
29362 #: ../src/guestfs-actions.pod:5356
29366 " guestfs_modprobe (guestfs_h *g,\n"
29367 " const char *modulename);\n"
29372 #: ../src/guestfs-actions.pod:5369
29373 msgid "guestfs_mount"
29377 #: ../src/guestfs-actions.pod:5371
29381 " guestfs_mount (guestfs_h *g,\n"
29382 " const char *device,\n"
29383 " const char *mountpoint);\n"
29388 #: ../src/guestfs-actions.pod:5390
29390 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
29391 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
29392 "problems for users. If your program might need to work with older versions "
29393 "of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
29394 "for the first parameter if you don't want any options)."
29398 #: ../src/guestfs-actions.pod:5401
29399 msgid "guestfs_mount_9p"
29403 #: ../src/guestfs-actions.pod:5403
29407 " guestfs_mount_9p (guestfs_h *g,\n"
29408 " const char *mounttag,\n"
29409 " const char *mountpoint,\n"
29415 #: ../src/guestfs-actions.pod:5414
29418 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
29423 #: ../src/guestfs-actions.pod:5427
29424 msgid "guestfs_mount_9p_va"
29428 #: ../src/guestfs-actions.pod:5429
29432 " guestfs_mount_9p_va (guestfs_h *g,\n"
29433 " const char *mounttag,\n"
29434 " const char *mountpoint,\n"
29435 " va_list args);\n"
29440 #: ../src/guestfs-actions.pod:5435
29441 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
29445 #: ../src/guestfs-actions.pod:5439
29446 msgid "guestfs_mount_9p_argv"
29450 #: ../src/guestfs-actions.pod:5441
29454 " guestfs_mount_9p_argv (guestfs_h *g,\n"
29455 " const char *mounttag,\n"
29456 " const char *mountpoint,\n"
29457 " const struct guestfs_mount_9p_argv *optargs);\n"
29462 #: ../src/guestfs-actions.pod:5447
29463 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
29467 #: ../src/guestfs-actions.pod:5451
29468 msgid "guestfs_mount_loop"
29472 #: ../src/guestfs-actions.pod:5453
29476 " guestfs_mount_loop (guestfs_h *g,\n"
29477 " const char *file,\n"
29478 " const char *mountpoint);\n"
29483 #: ../src/guestfs-actions.pod:5466
29484 msgid "guestfs_mount_options"
29488 #: ../src/guestfs-actions.pod:5468
29492 " guestfs_mount_options (guestfs_h *g,\n"
29493 " const char *options,\n"
29494 " const char *device,\n"
29495 " const char *mountpoint);\n"
29500 #: ../src/guestfs-actions.pod:5474
29502 "This is the same as the C<guestfs_mount> command, but it allows you to set "
29503 "the mount options as for the L<mount(8)> I<-o> flag."
29507 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5515
29508 msgid "(Added in 1.0.10)"
29512 #: ../src/guestfs-actions.pod:5486
29513 msgid "guestfs_mount_ro"
29517 #: ../src/guestfs-actions.pod:5488
29521 " guestfs_mount_ro (guestfs_h *g,\n"
29522 " const char *device,\n"
29523 " const char *mountpoint);\n"
29528 #: ../src/guestfs-actions.pod:5493
29530 "This is the same as the C<guestfs_mount> command, but it mounts the "
29531 "filesystem with the read-only (I<-o ro>) flag."
29535 #: ../src/guestfs-actions.pod:5500
29536 msgid "guestfs_mount_vfs"
29540 #: ../src/guestfs-actions.pod:5502
29544 " guestfs_mount_vfs (guestfs_h *g,\n"
29545 " const char *options,\n"
29546 " const char *vfstype,\n"
29547 " const char *device,\n"
29548 " const char *mountpoint);\n"
29553 #: ../src/guestfs-actions.pod:5509
29555 "This is the same as the C<guestfs_mount> command, but it allows you to set "
29556 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
29561 #: ../src/guestfs-actions.pod:5517
29562 msgid "guestfs_mountpoints"
29566 #: ../src/guestfs-actions.pod:5519
29570 " guestfs_mountpoints (guestfs_h *g);\n"
29575 #: ../src/guestfs-actions.pod:5522
29577 "This call is similar to C<guestfs_mounts>. That call returns a list of "
29578 "devices. This one returns a hash table (map) of device name to directory "
29579 "where the device is mounted."
29583 #: ../src/guestfs-actions.pod:5534
29584 msgid "guestfs_mounts"
29588 #: ../src/guestfs-actions.pod:5536
29592 " guestfs_mounts (guestfs_h *g);\n"
29597 #: ../src/guestfs-actions.pod:5544
29598 msgid "See also: C<guestfs_mountpoints>"
29602 #: ../src/guestfs-actions.pod:5552
29607 #: ../src/guestfs-actions.pod:5554
29611 " guestfs_mv (guestfs_h *g,\n"
29612 " const char *src,\n"
29613 " const char *dest);\n"
29618 #: ../src/guestfs-actions.pod:5566
29619 msgid "guestfs_ntfs_3g_probe"
29623 #: ../src/guestfs-actions.pod:5568
29627 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
29629 " const char *device);\n"
29634 #: ../src/guestfs-actions.pod:5587
29635 msgid "(Added in 1.0.43)"
29639 #: ../src/guestfs-actions.pod:5589
29640 msgid "guestfs_ntfsresize"
29644 #: ../src/guestfs-actions.pod:5591
29648 " guestfs_ntfsresize (guestfs_h *g,\n"
29649 " const char *device);\n"
29654 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5695
29656 "I<This function is deprecated.> In new code, use the "
29657 "L</guestfs_ntfsresize_opts> call instead."
29661 #: ../src/guestfs-actions.pod:5619
29662 msgid "guestfs_ntfsresize_opts"
29666 #: ../src/guestfs-actions.pod:5621
29670 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
29671 " const char *device,\n"
29677 #: ../src/guestfs-actions.pod:5631
29680 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
29681 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
29686 #: ../src/guestfs-actions.pod:5651
29688 "After the resize operation, the filesystem is always marked as requiring a "
29689 "consistency check (for safety). You have to boot into Windows to perform "
29690 "this check and clear this condition. If you I<don't> set the C<force> "
29691 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
29692 "times on a single filesystem without booting into Windows between each "
29697 #: ../src/guestfs-actions.pod:5666
29698 msgid "guestfs_ntfsresize_opts_va"
29702 #: ../src/guestfs-actions.pod:5668
29706 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
29707 " const char *device,\n"
29708 " va_list args);\n"
29713 #: ../src/guestfs-actions.pod:5673
29714 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
29718 #: ../src/guestfs-actions.pod:5677
29719 msgid "guestfs_ntfsresize_opts_argv"
29723 #: ../src/guestfs-actions.pod:5679
29727 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
29728 " const char *device,\n"
29729 " const struct guestfs_ntfsresize_opts_argv "
29735 #: ../src/guestfs-actions.pod:5684
29736 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
29740 #: ../src/guestfs-actions.pod:5688
29741 msgid "guestfs_ntfsresize_size"
29745 #: ../src/guestfs-actions.pod:5690
29749 " guestfs_ntfsresize_size (guestfs_h *g,\n"
29750 " const char *device,\n"
29751 " int64_t size);\n"
29756 #: ../src/guestfs-actions.pod:5702
29758 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
29759 "to specify the new size (in bytes) explicitly."
29763 #: ../src/guestfs-actions.pod:5707 ../src/guestfs-actions.pod:6166 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:8134
29764 msgid "(Added in 1.3.14)"
29768 #: ../src/guestfs-actions.pod:5709
29769 msgid "guestfs_part_add"
29773 #: ../src/guestfs-actions.pod:5711
29777 " guestfs_part_add (guestfs_h *g,\n"
29778 " const char *device,\n"
29779 " const char *prlogex,\n"
29780 " int64_t startsect,\n"
29781 " int64_t endsect);\n"
29786 #: ../src/guestfs-actions.pod:5718
29788 "This command adds a partition to C<device>. If there is no partition table "
29789 "on the device, call C<guestfs_part_init> first."
29793 #: ../src/guestfs-actions.pod:5730
29795 "Creating a partition which covers the whole disk is not so easy. Use "
29796 "C<guestfs_part_disk> to do that."
29800 #: ../src/guestfs-actions.pod:5735 ../src/guestfs-actions.pod:5770 ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5907 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6004
29801 msgid "(Added in 1.0.78)"
29805 #: ../src/guestfs-actions.pod:5737
29806 msgid "guestfs_part_del"
29810 #: ../src/guestfs-actions.pod:5739
29814 " guestfs_part_del (guestfs_h *g,\n"
29815 " const char *device,\n"
29821 #: ../src/guestfs-actions.pod:5754
29822 msgid "guestfs_part_disk"
29826 #: ../src/guestfs-actions.pod:5756
29830 " guestfs_part_disk (guestfs_h *g,\n"
29831 " const char *device,\n"
29832 " const char *parttype);\n"
29837 #: ../src/guestfs-actions.pod:5761
29839 "This command is simply a combination of C<guestfs_part_init> followed by "
29840 "C<guestfs_part_add> to create a single primary partition covering the whole "
29845 #: ../src/guestfs-actions.pod:5765
29847 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
29848 "possible values are described in C<guestfs_part_init>."
29852 #: ../src/guestfs-actions.pod:5772
29853 msgid "guestfs_part_get_bootable"
29857 #: ../src/guestfs-actions.pod:5774
29861 " guestfs_part_get_bootable (guestfs_h *g,\n"
29862 " const char *device,\n"
29868 #: ../src/guestfs-actions.pod:5782
29869 msgid "See also C<guestfs_part_set_bootable>."
29873 #: ../src/guestfs-actions.pod:5788
29874 msgid "guestfs_part_get_mbr_id"
29878 #: ../src/guestfs-actions.pod:5790
29882 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
29883 " const char *device,\n"
29889 #: ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5980
29891 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
29892 "undefined results for other partition table types (see "
29893 "C<guestfs_part_get_parttype>)."
29897 #: ../src/guestfs-actions.pod:5806
29898 msgid "guestfs_part_get_parttype"
29902 #: ../src/guestfs-actions.pod:5808
29906 " guestfs_part_get_parttype (guestfs_h *g,\n"
29907 " const char *device);\n"
29912 #: ../src/guestfs-actions.pod:5815
29914 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
29915 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
29916 "possible, although unusual. See C<guestfs_part_init> for a full list."
29920 #: ../src/guestfs-actions.pod:5825
29921 msgid "guestfs_part_init"
29925 #: ../src/guestfs-actions.pod:5827
29929 " guestfs_part_init (guestfs_h *g,\n"
29930 " const char *device,\n"
29931 " const char *parttype);\n"
29936 #: ../src/guestfs-actions.pod:5836
29938 "Initially there are no partitions. Following this, you should call "
29939 "C<guestfs_part_add> for each partition required."
29943 #: ../src/guestfs-actions.pod:5909
29944 msgid "guestfs_part_list"
29948 #: ../src/guestfs-actions.pod:5911
29951 " struct guestfs_partition_list *\n"
29952 " guestfs_part_list (guestfs_h *g,\n"
29953 " const char *device);\n"
29958 #: ../src/guestfs-actions.pod:5928
29960 "Start of the partition I<in bytes>. To get sectors you have to divide by "
29961 "the device's sector size, see C<guestfs_blockdev_getss>."
29965 #: ../src/guestfs-actions.pod:5941
29967 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
29968 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
29973 #: ../src/guestfs-actions.pod:5947
29974 msgid "guestfs_part_set_bootable"
29978 #: ../src/guestfs-actions.pod:5949
29982 " guestfs_part_set_bootable (guestfs_h *g,\n"
29983 " const char *device,\n"
29985 " int bootable);\n"
29990 #: ../src/guestfs-actions.pod:5966
29991 msgid "guestfs_part_set_mbr_id"
29995 #: ../src/guestfs-actions.pod:5968
29999 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
30000 " const char *device,\n"
30007 #: ../src/guestfs-actions.pod:5988
30008 msgid "guestfs_part_set_name"
30012 #: ../src/guestfs-actions.pod:5990
30016 " guestfs_part_set_name (guestfs_h *g,\n"
30017 " const char *device,\n"
30019 " const char *name);\n"
30024 #: ../src/guestfs-actions.pod:6006
30025 msgid "guestfs_part_to_dev"
30029 #: ../src/guestfs-actions.pod:6008
30033 " guestfs_part_to_dev (guestfs_h *g,\n"
30034 " const char *partition);\n"
30039 #: ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6035
30041 "The named partition must exist, for example as a string returned from "
30042 "C<guestfs_list_partitions>."
30046 #: ../src/guestfs-actions.pod:6019
30047 msgid "See also C<guestfs_part_to_partnum>."
30051 #: ../src/guestfs-actions.pod:6026
30052 msgid "guestfs_part_to_partnum"
30056 #: ../src/guestfs-actions.pod:6028
30060 " guestfs_part_to_partnum (guestfs_h *g,\n"
30061 " const char *partition);\n"
30066 #: ../src/guestfs-actions.pod:6038
30067 msgid "See also C<guestfs_part_to_dev>."
30071 #: ../src/guestfs-actions.pod:6044
30072 msgid "guestfs_ping_daemon"
30076 #: ../src/guestfs-actions.pod:6046
30080 " guestfs_ping_daemon (guestfs_h *g);\n"
30085 #: ../src/guestfs-actions.pod:6058
30086 msgid "guestfs_pread"
30090 #: ../src/guestfs-actions.pod:6060
30094 " guestfs_pread (guestfs_h *g,\n"
30095 " const char *path,\n"
30097 " int64_t offset,\n"
30098 " size_t *size_r);\n"
30103 #: ../src/guestfs-actions.pod:6073
30104 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
30108 #: ../src/guestfs-actions.pod:6084
30109 msgid "guestfs_pread_device"
30113 #: ../src/guestfs-actions.pod:6086
30117 " guestfs_pread_device (guestfs_h *g,\n"
30118 " const char *device,\n"
30120 " int64_t offset,\n"
30121 " size_t *size_r);\n"
30126 #: ../src/guestfs-actions.pod:6099
30127 msgid "See also C<guestfs_pread>."
30131 #: ../src/guestfs-actions.pod:6108
30132 msgid "(Added in 1.5.21)"
30136 #: ../src/guestfs-actions.pod:6110
30137 msgid "guestfs_pvcreate"
30141 #: ../src/guestfs-actions.pod:6112
30145 " guestfs_pvcreate (guestfs_h *g,\n"
30146 " const char *device);\n"
30151 #: ../src/guestfs-actions.pod:6124
30152 msgid "guestfs_pvremove"
30156 #: ../src/guestfs-actions.pod:6126
30160 " guestfs_pvremove (guestfs_h *g,\n"
30161 " const char *device);\n"
30166 #: ../src/guestfs-actions.pod:6141
30167 msgid "guestfs_pvresize"
30171 #: ../src/guestfs-actions.pod:6143
30175 " guestfs_pvresize (guestfs_h *g,\n"
30176 " const char *device);\n"
30181 #: ../src/guestfs-actions.pod:6154
30182 msgid "guestfs_pvresize_size"
30186 #: ../src/guestfs-actions.pod:6156
30190 " guestfs_pvresize_size (guestfs_h *g,\n"
30191 " const char *device,\n"
30192 " int64_t size);\n"
30197 #: ../src/guestfs-actions.pod:6161
30199 "This command is the same as C<guestfs_pvresize> except that it allows you to "
30200 "specify the new size (in bytes) explicitly."
30204 #: ../src/guestfs-actions.pod:6168
30205 msgid "guestfs_pvs"
30209 #: ../src/guestfs-actions.pod:6170
30213 " guestfs_pvs (guestfs_h *g);\n"
30218 #: ../src/guestfs-actions.pod:6179
30219 msgid "See also C<guestfs_pvs_full>."
30223 #: ../src/guestfs-actions.pod:6187
30224 msgid "guestfs_pvs_full"
30228 #: ../src/guestfs-actions.pod:6189
30231 " struct guestfs_lvm_pv_list *\n"
30232 " guestfs_pvs_full (guestfs_h *g);\n"
30237 #: ../src/guestfs-actions.pod:6195
30239 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
30240 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
30245 #: ../src/guestfs-actions.pod:6201
30246 msgid "guestfs_pvuuid"
30250 #: ../src/guestfs-actions.pod:6203
30254 " guestfs_pvuuid (guestfs_h *g,\n"
30255 " const char *device);\n"
30260 #: ../src/guestfs-actions.pod:6214
30261 msgid "guestfs_pwrite"
30265 #: ../src/guestfs-actions.pod:6216
30269 " guestfs_pwrite (guestfs_h *g,\n"
30270 " const char *path,\n"
30271 " const char *content,\n"
30272 " size_t content_size,\n"
30273 " int64_t offset);\n"
30278 #: ../src/guestfs-actions.pod:6232
30279 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
30283 #: ../src/guestfs-actions.pod:6241
30284 msgid "guestfs_pwrite_device"
30288 #: ../src/guestfs-actions.pod:6243
30292 " guestfs_pwrite_device (guestfs_h *g,\n"
30293 " const char *device,\n"
30294 " const char *content,\n"
30295 " size_t content_size,\n"
30296 " int64_t offset);\n"
30301 #: ../src/guestfs-actions.pod:6258
30302 msgid "See also C<guestfs_pwrite>."
30306 #: ../src/guestfs-actions.pod:6265
30307 msgid "(Added in 1.5.20)"
30311 #: ../src/guestfs-actions.pod:6267
30312 msgid "guestfs_read_file"
30316 #: ../src/guestfs-actions.pod:6269
30320 " guestfs_read_file (guestfs_h *g,\n"
30321 " const char *path,\n"
30322 " size_t *size_r);\n"
30327 #: ../src/guestfs-actions.pod:6277
30329 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
30330 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
30331 "function is limited in the total size of file that can be handled."
30335 #: ../src/guestfs-actions.pod:6289
30336 msgid "(Added in 1.0.63)"
30340 #: ../src/guestfs-actions.pod:6291
30341 msgid "guestfs_read_lines"
30345 #: ../src/guestfs-actions.pod:6293
30349 " guestfs_read_lines (guestfs_h *g,\n"
30350 " const char *path);\n"
30355 #: ../src/guestfs-actions.pod:6302
30357 "Note that this function cannot correctly handle binary files (specifically, "
30358 "files containing C<\\0> character which is treated as end of line). For "
30359 "those you need to use the C<guestfs_read_file> function which has a more "
30360 "complex interface."
30364 #: ../src/guestfs-actions.pod:6313
30365 msgid "guestfs_readdir"
30369 #: ../src/guestfs-actions.pod:6315
30372 " struct guestfs_dirent_list *\n"
30373 " guestfs_readdir (guestfs_h *g,\n"
30374 " const char *dir);\n"
30379 #: ../src/guestfs-actions.pod:6369
30381 "This function is primarily intended for use by programs. To get a simple "
30382 "list of names, use C<guestfs_ls>. To get a printable directory for human "
30383 "consumption, use C<guestfs_ll>."
30387 #: ../src/guestfs-actions.pod:6373
30389 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
30390 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
30395 #: ../src/guestfs-actions.pod:6379
30396 msgid "guestfs_readlink"
30400 #: ../src/guestfs-actions.pod:6381
30404 " guestfs_readlink (guestfs_h *g,\n"
30405 " const char *path);\n"
30410 #: ../src/guestfs-actions.pod:6392
30411 msgid "guestfs_readlinklist"
30415 #: ../src/guestfs-actions.pod:6394
30419 " guestfs_readlinklist (guestfs_h *g,\n"
30420 " const char *path,\n"
30421 " char *const *names);\n"
30426 #: ../src/guestfs-actions.pod:6427
30427 msgid "guestfs_realpath"
30431 #: ../src/guestfs-actions.pod:6429
30435 " guestfs_realpath (guestfs_h *g,\n"
30436 " const char *path);\n"
30441 #: ../src/guestfs-actions.pod:6441
30442 msgid "guestfs_removexattr"
30446 #: ../src/guestfs-actions.pod:6443
30450 " guestfs_removexattr (guestfs_h *g,\n"
30451 " const char *xattr,\n"
30452 " const char *path);\n"
30457 #: ../src/guestfs-actions.pod:6451
30458 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
30462 #: ../src/guestfs-actions.pod:6457
30463 msgid "guestfs_resize2fs"
30467 #: ../src/guestfs-actions.pod:6459
30471 " guestfs_resize2fs (guestfs_h *g,\n"
30472 " const char *device);\n"
30477 #: ../src/guestfs-actions.pod:6466
30479 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
30480 "C<device> before calling this command. For unknown reasons C<resize2fs> "
30481 "sometimes gives an error about this and sometimes not. In any case, it is "
30482 "always safe to call C<guestfs_e2fsck_f> before calling this function."
30486 #: ../src/guestfs-actions.pod:6476
30487 msgid "guestfs_resize2fs_M"
30491 #: ../src/guestfs-actions.pod:6478
30495 " guestfs_resize2fs_M (guestfs_h *g,\n"
30496 " const char *device);\n"
30501 #: ../src/guestfs-actions.pod:6482
30503 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
30504 "resized to its minimum size. This works like the I<-M> option to the "
30505 "C<resize2fs> command."
30509 #: ../src/guestfs-actions.pod:6486
30511 "To get the resulting size of the filesystem you should call "
30512 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
30513 "These two numbers, multiplied together, give the resulting size of the "
30514 "minimal filesystem in bytes."
30518 #: ../src/guestfs-actions.pod:6495
30519 msgid "guestfs_resize2fs_size"
30523 #: ../src/guestfs-actions.pod:6497
30527 " guestfs_resize2fs_size (guestfs_h *g,\n"
30528 " const char *device,\n"
30529 " int64_t size);\n"
30534 #: ../src/guestfs-actions.pod:6502
30536 "This command is the same as C<guestfs_resize2fs> except that it allows you "
30537 "to specify the new size (in bytes) explicitly."
30541 #: ../src/guestfs-actions.pod:6509
30546 #: ../src/guestfs-actions.pod:6511
30550 " guestfs_rm (guestfs_h *g,\n"
30551 " const char *path);\n"
30556 #: ../src/guestfs-actions.pod:6521
30557 msgid "guestfs_rm_rf"
30561 #: ../src/guestfs-actions.pod:6523
30565 " guestfs_rm_rf (guestfs_h *g,\n"
30566 " const char *path);\n"
30571 #: ../src/guestfs-actions.pod:6535
30572 msgid "guestfs_rmdir"
30576 #: ../src/guestfs-actions.pod:6537
30580 " guestfs_rmdir (guestfs_h *g,\n"
30581 " const char *path);\n"
30586 #: ../src/guestfs-actions.pod:6547
30587 msgid "guestfs_rmmountpoint"
30591 #: ../src/guestfs-actions.pod:6549
30595 " guestfs_rmmountpoint (guestfs_h *g,\n"
30596 " const char *exemptpath);\n"
30601 #: ../src/guestfs-actions.pod:6553
30603 "This calls removes a mountpoint that was previously created with "
30604 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
30608 #: ../src/guestfs-actions.pod:6561
30609 msgid "guestfs_scrub_device"
30613 #: ../src/guestfs-actions.pod:6563
30617 " guestfs_scrub_device (guestfs_h *g,\n"
30618 " const char *device);\n"
30623 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6612
30624 msgid "(Added in 1.0.52)"
30628 #: ../src/guestfs-actions.pod:6577
30629 msgid "guestfs_scrub_file"
30633 #: ../src/guestfs-actions.pod:6579
30637 " guestfs_scrub_file (guestfs_h *g,\n"
30638 " const char *file);\n"
30643 #: ../src/guestfs-actions.pod:6595
30644 msgid "guestfs_scrub_freespace"
30648 #: ../src/guestfs-actions.pod:6597
30652 " guestfs_scrub_freespace (guestfs_h *g,\n"
30653 " const char *dir);\n"
30658 #: ../src/guestfs-actions.pod:6601
30660 "This command creates the directory C<dir> and then fills it with files until "
30661 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
30662 "and deletes them. The intention is to scrub any free space on the partition "
30663 "containing C<dir>."
30667 #: ../src/guestfs-actions.pod:6614
30668 msgid "guestfs_set_append"
30672 #: ../src/guestfs-actions.pod:6616
30676 " guestfs_set_append (guestfs_h *g,\n"
30677 " const char *append);\n"
30682 #: ../src/guestfs-actions.pod:6633
30683 msgid "guestfs_set_attach_method"
30687 #: ../src/guestfs-actions.pod:6635
30691 " guestfs_set_attach_method (guestfs_h *g,\n"
30692 " const char *attachmethod);\n"
30697 #: ../src/guestfs-actions.pod:6663
30698 msgid "guestfs_set_autosync"
30702 #: ../src/guestfs-actions.pod:6665
30706 " guestfs_set_autosync (guestfs_h *g,\n"
30707 " int autosync);\n"
30712 #: ../src/guestfs-actions.pod:6681
30713 msgid "guestfs_set_direct"
30717 #: ../src/guestfs-actions.pod:6683
30721 " guestfs_set_direct (guestfs_h *g,\n"
30727 #: ../src/guestfs-actions.pod:6691
30729 "One consequence of this is that log messages aren't caught by the library "
30730 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
30735 #: ../src/guestfs-actions.pod:6704
30736 msgid "guestfs_set_e2label"
30740 #: ../src/guestfs-actions.pod:6706
30744 " guestfs_set_e2label (guestfs_h *g,\n"
30745 " const char *device,\n"
30746 " const char *label);\n"
30751 #: ../src/guestfs-actions.pod:6715
30753 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
30754 "the existing label on a filesystem."
30758 #: ../src/guestfs-actions.pod:6722
30759 msgid "guestfs_set_e2uuid"
30763 #: ../src/guestfs-actions.pod:6724
30767 " guestfs_set_e2uuid (guestfs_h *g,\n"
30768 " const char *device,\n"
30769 " const char *uuid);\n"
30774 #: ../src/guestfs-actions.pod:6734
30776 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
30777 "the existing UUID of a filesystem."
30781 #: ../src/guestfs-actions.pod:6741
30782 msgid "guestfs_set_memsize"
30786 #: ../src/guestfs-actions.pod:6743
30790 " guestfs_set_memsize (guestfs_h *g,\n"
30796 #: ../src/guestfs-actions.pod:6747
30798 "This sets the memory size in megabytes allocated to the qemu subprocess. "
30799 "This only has any effect if called before C<guestfs_launch>."
30803 #: ../src/guestfs-actions.pod:6762
30804 msgid "guestfs_set_network"
30808 #: ../src/guestfs-actions.pod:6764
30812 " guestfs_set_network (guestfs_h *g,\n"
30818 #: ../src/guestfs-actions.pod:6774
30820 "You must call this before calling C<guestfs_launch>, otherwise it has no "
30825 #: ../src/guestfs-actions.pod:6781
30826 msgid "guestfs_set_path"
30830 #: ../src/guestfs-actions.pod:6783
30834 " guestfs_set_path (guestfs_h *g,\n"
30835 " const char *searchpath);\n"
30840 #: ../src/guestfs-actions.pod:6798
30841 msgid "guestfs_set_pgroup"
30845 #: ../src/guestfs-actions.pod:6800
30849 " guestfs_set_pgroup (guestfs_h *g,\n"
30855 #: ../src/guestfs-actions.pod:6817
30856 msgid "guestfs_set_qemu"
30860 #: ../src/guestfs-actions.pod:6819
30864 " guestfs_set_qemu (guestfs_h *g,\n"
30865 " const char *qemu);\n"
30870 #: ../src/guestfs-actions.pod:6845
30871 msgid "guestfs_set_recovery_proc"
30875 #: ../src/guestfs-actions.pod:6847
30879 " guestfs_set_recovery_proc (guestfs_h *g,\n"
30880 " int recoveryproc);\n"
30885 #: ../src/guestfs-actions.pod:6851
30887 "If this is called with the parameter C<false> then C<guestfs_launch> does "
30888 "not create a recovery process. The purpose of the recovery process is to "
30889 "stop runaway qemu processes in the case where the main program aborts "
30894 #: ../src/guestfs-actions.pod:6856
30896 "This only has any effect if called before C<guestfs_launch>, and the default "
30901 #: ../src/guestfs-actions.pod:6869
30902 msgid "guestfs_set_selinux"
30906 #: ../src/guestfs-actions.pod:6871
30910 " guestfs_set_selinux (guestfs_h *g,\n"
30916 #: ../src/guestfs-actions.pod:6888
30917 msgid "guestfs_set_smp"
30921 #: ../src/guestfs-actions.pod:6890
30925 " guestfs_set_smp (guestfs_h *g,\n"
30931 #: ../src/guestfs-actions.pod:6898
30932 msgid "This function must be called before C<guestfs_launch>."
30936 #: ../src/guestfs-actions.pod:6904
30937 msgid "guestfs_set_trace"
30941 #: ../src/guestfs-actions.pod:6906
30945 " guestfs_set_trace (guestfs_h *g,\n"
30951 #: ../src/guestfs-actions.pod:6920
30953 "Trace messages are normally sent to C<stderr>, unless you register a "
30954 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
30958 #: ../src/guestfs-actions.pod:6928
30959 msgid "guestfs_set_verbose"
30963 #: ../src/guestfs-actions.pod:6930
30967 " guestfs_set_verbose (guestfs_h *g,\n"
30973 #: ../src/guestfs-actions.pod:6939
30975 "Verbose messages are normally sent to C<stderr>, unless you register a "
30976 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
30980 #: ../src/guestfs-actions.pod:6947
30981 msgid "guestfs_setcon"
30985 #: ../src/guestfs-actions.pod:6949
30989 " guestfs_setcon (guestfs_h *g,\n"
30990 " const char *context);\n"
30995 #: ../src/guestfs-actions.pod:6962
30996 msgid "guestfs_setxattr"
31000 #: ../src/guestfs-actions.pod:6964
31004 " guestfs_setxattr (guestfs_h *g,\n"
31005 " const char *xattr,\n"
31006 " const char *val,\n"
31008 " const char *path);\n"
31013 #: ../src/guestfs-actions.pod:6975
31014 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
31018 #: ../src/guestfs-actions.pod:6981
31019 msgid "guestfs_sfdisk"
31023 #: ../src/guestfs-actions.pod:6983
31027 " guestfs_sfdisk (guestfs_h *g,\n"
31028 " const char *device,\n"
31032 " char *const *lines);\n"
31037 #: ../src/guestfs-actions.pod:6991 ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7063
31039 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
31044 #: ../src/guestfs-actions.pod:7018
31045 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
31049 #: ../src/guestfs-actions.pod:7025
31050 msgid "guestfs_sfdiskM"
31054 #: ../src/guestfs-actions.pod:7027
31058 " guestfs_sfdiskM (guestfs_h *g,\n"
31059 " const char *device,\n"
31060 " char *const *lines);\n"
31065 #: ../src/guestfs-actions.pod:7039
31067 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
31068 "partition sizes are specified in megabytes only (rounded to the nearest "
31069 "cylinder) and you don't need to specify the cyls, heads and sectors "
31070 "parameters which were rarely if ever used anyway."
31074 #: ../src/guestfs-actions.pod:7045
31076 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
31077 "C<guestfs_part_disk>"
31081 #: ../src/guestfs-actions.pod:7052
31082 msgid "guestfs_sfdisk_N"
31086 #: ../src/guestfs-actions.pod:7054
31090 " guestfs_sfdisk_N (guestfs_h *g,\n"
31091 " const char *device,\n"
31096 " const char *line);\n"
31101 #: ../src/guestfs-actions.pod:7073
31103 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
31104 "for the cyls/heads/sectors parameters."
31108 #: ../src/guestfs-actions.pod:7076
31109 msgid "See also: C<guestfs_part_add>"
31113 #: ../src/guestfs-actions.pod:7082
31114 msgid "guestfs_sfdisk_disk_geometry"
31118 #: ../src/guestfs-actions.pod:7084
31122 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
31123 " const char *device);\n"
31128 #: ../src/guestfs-actions.pod:7088
31130 "This displays the disk geometry of C<device> read from the partition table. "
31131 "Especially in the case where the underlying block device has been resized, "
31132 "this can be different from the kernel's idea of the geometry (see "
31133 "C<guestfs_sfdisk_kernel_geometry>)."
31137 #: ../src/guestfs-actions.pod:7101
31138 msgid "guestfs_sfdisk_kernel_geometry"
31142 #: ../src/guestfs-actions.pod:7103
31146 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
31147 " const char *device);\n"
31152 #: ../src/guestfs-actions.pod:7117
31153 msgid "guestfs_sfdisk_l"
31157 #: ../src/guestfs-actions.pod:7119
31161 " guestfs_sfdisk_l (guestfs_h *g,\n"
31162 " const char *device);\n"
31167 #: ../src/guestfs-actions.pod:7123
31169 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
31174 #: ../src/guestfs-actions.pod:7134
31175 msgid "See also: C<guestfs_part_list>"
31179 #: ../src/guestfs-actions.pod:7141
31184 #: ../src/guestfs-actions.pod:7143
31188 " guestfs_sh (guestfs_h *g,\n"
31189 " const char *command);\n"
31194 #: ../src/guestfs-actions.pod:7150
31195 msgid "This is like C<guestfs_command>, but passes the command to:"
31199 #: ../src/guestfs-actions.pod:7158
31200 msgid "All the provisos about C<guestfs_command> apply to this call."
31204 #: ../src/guestfs-actions.pod:7165
31205 msgid "guestfs_sh_lines"
31209 #: ../src/guestfs-actions.pod:7167
31213 " guestfs_sh_lines (guestfs_h *g,\n"
31214 " const char *command);\n"
31219 #: ../src/guestfs-actions.pod:7171
31221 "This is the same as C<guestfs_sh>, but splits the result into a list of "
31226 #: ../src/guestfs-actions.pod:7174
31227 msgid "See also: C<guestfs_command_lines>"
31231 #: ../src/guestfs-actions.pod:7182
31232 msgid "guestfs_sleep"
31236 #: ../src/guestfs-actions.pod:7184
31240 " guestfs_sleep (guestfs_h *g,\n"
31246 #: ../src/guestfs-actions.pod:7192
31247 msgid "(Added in 1.0.41)"
31251 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-structs.pod:109
31252 msgid "guestfs_stat"
31256 #: ../src/guestfs-actions.pod:7196
31259 " struct guestfs_stat *\n"
31260 " guestfs_stat (guestfs_h *g,\n"
31261 " const char *path);\n"
31266 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-structs.pod:135
31267 msgid "guestfs_statvfs"
31271 #: ../src/guestfs-actions.pod:7212
31274 " struct guestfs_statvfs *\n"
31275 " guestfs_statvfs (guestfs_h *g,\n"
31276 " const char *path);\n"
31281 #: ../src/guestfs-actions.pod:7222
31283 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
31284 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
31288 #: ../src/guestfs-actions.pod:7228
31289 msgid "guestfs_strings"
31293 #: ../src/guestfs-actions.pod:7230
31297 " guestfs_strings (guestfs_h *g,\n"
31298 " const char *path);\n"
31303 #: ../src/guestfs-actions.pod:7246
31304 msgid "guestfs_strings_e"
31308 #: ../src/guestfs-actions.pod:7248
31312 " guestfs_strings_e (guestfs_h *g,\n"
31313 " const char *encoding,\n"
31314 " const char *path);\n"
31319 #: ../src/guestfs-actions.pod:7253
31321 "This is like the C<guestfs_strings> command, but allows you to specify the "
31322 "encoding of strings that are looked for in the source file C<path>."
31326 #: ../src/guestfs-actions.pod:7263
31328 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
31329 "ISO-8859-X (this is what C<guestfs_strings> uses)."
31333 #: ../src/guestfs-actions.pod:7301
31334 msgid "guestfs_swapoff_device"
31338 #: ../src/guestfs-actions.pod:7303
31342 " guestfs_swapoff_device (guestfs_h *g,\n"
31343 " const char *device);\n"
31348 #: ../src/guestfs-actions.pod:7307
31350 "This command disables the libguestfs appliance swap device or partition "
31351 "named C<device>. See C<guestfs_swapon_device>."
31355 #: ../src/guestfs-actions.pod:7315
31356 msgid "guestfs_swapoff_file"
31360 #: ../src/guestfs-actions.pod:7317
31364 " guestfs_swapoff_file (guestfs_h *g,\n"
31365 " const char *file);\n"
31370 #: ../src/guestfs-actions.pod:7327
31371 msgid "guestfs_swapoff_label"
31375 #: ../src/guestfs-actions.pod:7329
31379 " guestfs_swapoff_label (guestfs_h *g,\n"
31380 " const char *label);\n"
31385 #: ../src/guestfs-actions.pod:7340
31386 msgid "guestfs_swapoff_uuid"
31390 #: ../src/guestfs-actions.pod:7342
31394 " guestfs_swapoff_uuid (guestfs_h *g,\n"
31395 " const char *uuid);\n"
31400 #: ../src/guestfs-actions.pod:7353
31401 msgid "guestfs_swapon_device"
31405 #: ../src/guestfs-actions.pod:7355
31409 " guestfs_swapon_device (guestfs_h *g,\n"
31410 " const char *device);\n"
31415 #: ../src/guestfs-actions.pod:7359
31417 "This command enables the libguestfs appliance to use the swap device or "
31418 "partition named C<device>. The increased memory is made available for all "
31419 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
31423 #: ../src/guestfs-actions.pod:7375
31424 msgid "guestfs_swapon_file"
31428 #: ../src/guestfs-actions.pod:7377
31432 " guestfs_swapon_file (guestfs_h *g,\n"
31433 " const char *file);\n"
31438 #: ../src/guestfs-actions.pod:7381
31440 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
31445 #: ../src/guestfs-actions.pod:7388
31446 msgid "guestfs_swapon_label"
31450 #: ../src/guestfs-actions.pod:7390
31454 " guestfs_swapon_label (guestfs_h *g,\n"
31455 " const char *label);\n"
31460 #: ../src/guestfs-actions.pod:7394
31462 "This command enables swap to a labeled swap partition. See "
31463 "C<guestfs_swapon_device> for other notes."
31467 #: ../src/guestfs-actions.pod:7401
31468 msgid "guestfs_swapon_uuid"
31472 #: ../src/guestfs-actions.pod:7403
31476 " guestfs_swapon_uuid (guestfs_h *g,\n"
31477 " const char *uuid);\n"
31482 #: ../src/guestfs-actions.pod:7407
31484 "This command enables swap to a swap partition with the given UUID. See "
31485 "C<guestfs_swapon_device> for other notes."
31489 #: ../src/guestfs-actions.pod:7414
31490 msgid "guestfs_sync"
31494 #: ../src/guestfs-actions.pod:7416
31498 " guestfs_sync (guestfs_h *g);\n"
31503 #: ../src/guestfs-actions.pod:7429
31504 msgid "guestfs_tail"
31508 #: ../src/guestfs-actions.pod:7431
31512 " guestfs_tail (guestfs_h *g,\n"
31513 " const char *path);\n"
31518 #: ../src/guestfs-actions.pod:7447
31519 msgid "guestfs_tail_n"
31523 #: ../src/guestfs-actions.pod:7449
31527 " guestfs_tail_n (guestfs_h *g,\n"
31529 " const char *path);\n"
31534 #: ../src/guestfs-actions.pod:7471
31535 msgid "guestfs_tar_in"
31539 #: ../src/guestfs-actions.pod:7473
31543 " guestfs_tar_in (guestfs_h *g,\n"
31544 " const char *tarfile,\n"
31545 " const char *directory);\n"
31550 #: ../src/guestfs-actions.pod:7481
31551 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
31555 #: ../src/guestfs-actions.pod:7486 ../src/guestfs-actions.pod:7503 ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7535
31556 msgid "(Added in 1.0.3)"
31560 #: ../src/guestfs-actions.pod:7488
31561 msgid "guestfs_tar_out"
31565 #: ../src/guestfs-actions.pod:7490
31569 " guestfs_tar_out (guestfs_h *g,\n"
31570 " const char *directory,\n"
31571 " const char *tarfile);\n"
31576 #: ../src/guestfs-actions.pod:7498
31578 "To download a compressed tarball, use C<guestfs_tgz_out> or "
31579 "C<guestfs_txz_out>."
31583 #: ../src/guestfs-actions.pod:7505
31584 msgid "guestfs_tgz_in"
31588 #: ../src/guestfs-actions.pod:7507
31592 " guestfs_tgz_in (guestfs_h *g,\n"
31593 " const char *tarball,\n"
31594 " const char *directory);\n"
31599 #: ../src/guestfs-actions.pod:7515
31600 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
31604 #: ../src/guestfs-actions.pod:7521
31605 msgid "guestfs_tgz_out"
31609 #: ../src/guestfs-actions.pod:7523
31613 " guestfs_tgz_out (guestfs_h *g,\n"
31614 " const char *directory,\n"
31615 " const char *tarball);\n"
31620 #: ../src/guestfs-actions.pod:7531
31621 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
31625 #: ../src/guestfs-actions.pod:7537
31626 msgid "guestfs_touch"
31630 #: ../src/guestfs-actions.pod:7539
31634 " guestfs_touch (guestfs_h *g,\n"
31635 " const char *path);\n"
31640 #: ../src/guestfs-actions.pod:7554
31641 msgid "guestfs_truncate"
31645 #: ../src/guestfs-actions.pod:7556
31649 " guestfs_truncate (guestfs_h *g,\n"
31650 " const char *path);\n"
31655 #: ../src/guestfs-actions.pod:7567
31656 msgid "guestfs_truncate_size"
31660 #: ../src/guestfs-actions.pod:7569
31664 " guestfs_truncate_size (guestfs_h *g,\n"
31665 " const char *path,\n"
31666 " int64_t size);\n"
31671 #: ../src/guestfs-actions.pod:7577
31673 "If the current file size is less than C<size> then the file is extended to "
31674 "the required size with zero bytes. This creates a sparse file (ie. disk "
31675 "blocks are not allocated for the file until you write to it). To create a "
31676 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
31680 #: ../src/guestfs-actions.pod:7587
31681 msgid "guestfs_tune2fs_l"
31685 #: ../src/guestfs-actions.pod:7589
31689 " guestfs_tune2fs_l (guestfs_h *g,\n"
31690 " const char *device);\n"
31695 #: ../src/guestfs-actions.pod:7609
31696 msgid "guestfs_txz_in"
31700 #: ../src/guestfs-actions.pod:7611
31704 " guestfs_txz_in (guestfs_h *g,\n"
31705 " const char *tarball,\n"
31706 " const char *directory);\n"
31711 #: ../src/guestfs-actions.pod:7623
31712 msgid "guestfs_txz_out"
31716 #: ../src/guestfs-actions.pod:7625
31720 " guestfs_txz_out (guestfs_h *g,\n"
31721 " const char *directory,\n"
31722 " const char *tarball);\n"
31727 #: ../src/guestfs-actions.pod:7637
31728 msgid "guestfs_umask"
31732 #: ../src/guestfs-actions.pod:7639
31736 " guestfs_umask (guestfs_h *g,\n"
31742 #: ../src/guestfs-actions.pod:7655
31744 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
31745 "C<guestfs_mkdir>."
31749 #: ../src/guestfs-actions.pod:7664
31750 msgid "guestfs_umount"
31754 #: ../src/guestfs-actions.pod:7666
31758 " guestfs_umount (guestfs_h *g,\n"
31759 " const char *pathordevice);\n"
31764 #: ../src/guestfs-actions.pod:7678
31765 msgid "guestfs_umount_all"
31769 #: ../src/guestfs-actions.pod:7680
31773 " guestfs_umount_all (guestfs_h *g);\n"
31778 #: ../src/guestfs-actions.pod:7691
31779 msgid "guestfs_upload"
31783 #: ../src/guestfs-actions.pod:7693
31787 " guestfs_upload (guestfs_h *g,\n"
31788 " const char *filename,\n"
31789 " const char *remotefilename);\n"
31794 #: ../src/guestfs-actions.pod:7703
31795 msgid "See also C<guestfs_download>."
31799 #: ../src/guestfs-actions.pod:7714
31800 msgid "guestfs_upload_offset"
31804 #: ../src/guestfs-actions.pod:7716
31808 " guestfs_upload_offset (guestfs_h *g,\n"
31809 " const char *filename,\n"
31810 " const char *remotefilename,\n"
31811 " int64_t offset);\n"
31816 #: ../src/guestfs-actions.pod:7732
31818 "Note that there is no limit on the amount of data that can be uploaded with "
31819 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
31820 "full amount unless an error occurs."
31824 #: ../src/guestfs-actions.pod:7737
31825 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
31829 #: ../src/guestfs-actions.pod:7748
31830 msgid "guestfs_utimens"
31834 #: ../src/guestfs-actions.pod:7750
31838 " guestfs_utimens (guestfs_h *g,\n"
31839 " const char *path,\n"
31840 " int64_t atsecs,\n"
31841 " int64_t atnsecs,\n"
31842 " int64_t mtsecs,\n"
31843 " int64_t mtnsecs);\n"
31848 #: ../src/guestfs-actions.pod:7779 ../src/guestfs-structs.pod:175
31849 msgid "guestfs_version"
31853 #: ../src/guestfs-actions.pod:7781
31856 " struct guestfs_version *\n"
31857 " guestfs_version (guestfs_h *g);\n"
31862 #: ../src/guestfs-actions.pod:7809
31864 "I<Note:> Don't use this call to test for availability of features. In "
31865 "enterprise distributions we backport features from later versions into "
31866 "earlier versions, making this an unreliable way to test for features. Use "
31867 "C<guestfs_available> instead."
31871 #: ../src/guestfs-actions.pod:7815
31873 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
31874 "error. I<The caller must call C<guestfs_free_version> after use>."
31878 #: ../src/guestfs-actions.pod:7819
31879 msgid "(Added in 1.0.58)"
31883 #: ../src/guestfs-actions.pod:7821
31884 msgid "guestfs_vfs_label"
31888 #: ../src/guestfs-actions.pod:7823
31892 " guestfs_vfs_label (guestfs_h *g,\n"
31893 " const char *device);\n"
31898 #: ../src/guestfs-actions.pod:7832
31899 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
31903 #: ../src/guestfs-actions.pod:7837 ../src/guestfs-actions.pod:7874
31904 msgid "(Added in 1.3.18)"
31908 #: ../src/guestfs-actions.pod:7839
31909 msgid "guestfs_vfs_type"
31913 #: ../src/guestfs-actions.pod:7841
31917 " guestfs_vfs_type (guestfs_h *g,\n"
31918 " const char *device);\n"
31923 #: ../src/guestfs-actions.pod:7858
31924 msgid "guestfs_vfs_uuid"
31928 #: ../src/guestfs-actions.pod:7860
31932 " guestfs_vfs_uuid (guestfs_h *g,\n"
31933 " const char *device);\n"
31938 #: ../src/guestfs-actions.pod:7869
31939 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
31943 #: ../src/guestfs-actions.pod:7876
31944 msgid "guestfs_vg_activate"
31948 #: ../src/guestfs-actions.pod:7878
31952 " guestfs_vg_activate (guestfs_h *g,\n"
31954 " char *const *volgroups);\n"
31959 #: ../src/guestfs-actions.pod:7895
31960 msgid "guestfs_vg_activate_all"
31964 #: ../src/guestfs-actions.pod:7897
31968 " guestfs_vg_activate_all (guestfs_h *g,\n"
31969 " int activate);\n"
31974 #: ../src/guestfs-actions.pod:7910
31975 msgid "guestfs_vgcreate"
31979 #: ../src/guestfs-actions.pod:7912
31983 " guestfs_vgcreate (guestfs_h *g,\n"
31984 " const char *volgroup,\n"
31985 " char *const *physvols);\n"
31990 #: ../src/guestfs-actions.pod:7924
31991 msgid "guestfs_vglvuuids"
31995 #: ../src/guestfs-actions.pod:7926
31999 " guestfs_vglvuuids (guestfs_h *g,\n"
32000 " const char *vgname);\n"
32005 #: ../src/guestfs-actions.pod:7933
32007 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
32008 "associate logical volumes and volume groups."
32012 #: ../src/guestfs-actions.pod:7936
32013 msgid "See also C<guestfs_vgpvuuids>."
32017 #: ../src/guestfs-actions.pod:7944
32018 msgid "guestfs_vgpvuuids"
32022 #: ../src/guestfs-actions.pod:7946
32026 " guestfs_vgpvuuids (guestfs_h *g,\n"
32027 " const char *vgname);\n"
32032 #: ../src/guestfs-actions.pod:7953
32034 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
32035 "associate physical volumes and volume groups."
32039 #: ../src/guestfs-actions.pod:7956
32040 msgid "See also C<guestfs_vglvuuids>."
32044 #: ../src/guestfs-actions.pod:7964
32045 msgid "guestfs_vgremove"
32049 #: ../src/guestfs-actions.pod:7966
32053 " guestfs_vgremove (guestfs_h *g,\n"
32054 " const char *vgname);\n"
32059 #: ../src/guestfs-actions.pod:7979
32060 msgid "guestfs_vgrename"
32064 #: ../src/guestfs-actions.pod:7981
32068 " guestfs_vgrename (guestfs_h *g,\n"
32069 " const char *volgroup,\n"
32070 " const char *newvolgroup);\n"
32075 #: ../src/guestfs-actions.pod:7992
32076 msgid "guestfs_vgs"
32080 #: ../src/guestfs-actions.pod:7994
32084 " guestfs_vgs (guestfs_h *g);\n"
32089 #: ../src/guestfs-actions.pod:8003
32090 msgid "See also C<guestfs_vgs_full>."
32094 #: ../src/guestfs-actions.pod:8011
32095 msgid "guestfs_vgs_full"
32099 #: ../src/guestfs-actions.pod:8013
32102 " struct guestfs_lvm_vg_list *\n"
32103 " guestfs_vgs_full (guestfs_h *g);\n"
32108 #: ../src/guestfs-actions.pod:8019
32110 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
32111 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
32116 #: ../src/guestfs-actions.pod:8025
32117 msgid "guestfs_vgscan"
32121 #: ../src/guestfs-actions.pod:8027
32125 " guestfs_vgscan (guestfs_h *g);\n"
32130 #: ../src/guestfs-actions.pod:8037
32131 msgid "guestfs_vguuid"
32135 #: ../src/guestfs-actions.pod:8039
32139 " guestfs_vguuid (guestfs_h *g,\n"
32140 " const char *vgname);\n"
32145 #: ../src/guestfs-actions.pod:8050
32146 msgid "guestfs_wait_ready"
32150 #: ../src/guestfs-actions.pod:8052
32154 " guestfs_wait_ready (guestfs_h *g);\n"
32159 #: ../src/guestfs-actions.pod:8055
32161 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
32166 #: ../src/guestfs-actions.pod:8062
32167 msgid "This function is a no op."
32171 #: ../src/guestfs-actions.pod:8064
32173 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
32174 "calling C<guestfs_launch> to wait for the launch to complete. However this "
32175 "is no longer necessary because C<guestfs_launch> now does the waiting."
32179 #: ../src/guestfs-actions.pod:8069
32181 "If you see any calls to this function in code then you can just remove them, "
32182 "unless you want to retain compatibility with older versions of the API."
32186 #: ../src/guestfs-actions.pod:8077
32187 msgid "guestfs_wc_c"
32191 #: ../src/guestfs-actions.pod:8079
32195 " guestfs_wc_c (guestfs_h *g,\n"
32196 " const char *path);\n"
32201 #: ../src/guestfs-actions.pod:8090
32202 msgid "guestfs_wc_l"
32206 #: ../src/guestfs-actions.pod:8092
32210 " guestfs_wc_l (guestfs_h *g,\n"
32211 " const char *path);\n"
32216 #: ../src/guestfs-actions.pod:8103
32217 msgid "guestfs_wc_w"
32221 #: ../src/guestfs-actions.pod:8105
32225 " guestfs_wc_w (guestfs_h *g,\n"
32226 " const char *path);\n"
32231 #: ../src/guestfs-actions.pod:8116
32232 msgid "guestfs_write"
32236 #: ../src/guestfs-actions.pod:8118
32240 " guestfs_write (guestfs_h *g,\n"
32241 " const char *path,\n"
32242 " const char *content,\n"
32243 " size_t content_size);\n"
32248 #: ../src/guestfs-actions.pod:8127
32249 msgid "See also C<guestfs_write_append>."
32253 #: ../src/guestfs-actions.pod:8136
32254 msgid "guestfs_write_append"
32258 #: ../src/guestfs-actions.pod:8138
32262 " guestfs_write_append (guestfs_h *g,\n"
32263 " const char *path,\n"
32264 " const char *content,\n"
32265 " size_t content_size);\n"
32270 #: ../src/guestfs-actions.pod:8147
32271 msgid "See also C<guestfs_write>."
32275 #: ../src/guestfs-actions.pod:8156
32276 msgid "guestfs_write_file"
32280 #: ../src/guestfs-actions.pod:8158
32284 " guestfs_write_file (guestfs_h *g,\n"
32285 " const char *path,\n"
32286 " const char *content,\n"
32292 #: ../src/guestfs-actions.pod:8164
32294 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
32299 #: ../src/guestfs-actions.pod:8189
32300 msgid "guestfs_zegrep"
32304 #: ../src/guestfs-actions.pod:8191
32308 " guestfs_zegrep (guestfs_h *g,\n"
32309 " const char *regex,\n"
32310 " const char *path);\n"
32315 #: ../src/guestfs-actions.pod:8208
32316 msgid "guestfs_zegrepi"
32320 #: ../src/guestfs-actions.pod:8210
32324 " guestfs_zegrepi (guestfs_h *g,\n"
32325 " const char *regex,\n"
32326 " const char *path);\n"
32331 #: ../src/guestfs-actions.pod:8227
32332 msgid "guestfs_zero"
32336 #: ../src/guestfs-actions.pod:8229
32340 " guestfs_zero (guestfs_h *g,\n"
32341 " const char *device);\n"
32346 #: ../src/guestfs-actions.pod:8243
32348 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
32349 "C<guestfs_is_zero_device>"
32353 #: ../src/guestfs-actions.pod:8255
32354 msgid "guestfs_zero_device"
32358 #: ../src/guestfs-actions.pod:8257
32362 " guestfs_zero_device (guestfs_h *g,\n"
32363 " const char *device);\n"
32368 #: ../src/guestfs-actions.pod:8261
32370 "This command writes zeroes over the entire C<device>. Compare with "
32371 "C<guestfs_zero> which just zeroes the first few blocks of a device."
32375 #: ../src/guestfs-actions.pod:8276
32376 msgid "(Added in 1.3.1)"
32380 #: ../src/guestfs-actions.pod:8278
32381 msgid "guestfs_zerofree"
32385 #: ../src/guestfs-actions.pod:8280
32389 " guestfs_zerofree (guestfs_h *g,\n"
32390 " const char *device);\n"
32395 #: ../src/guestfs-actions.pod:8299
32396 msgid "guestfs_zfgrep"
32400 #: ../src/guestfs-actions.pod:8301
32404 " guestfs_zfgrep (guestfs_h *g,\n"
32405 " const char *pattern,\n"
32406 " const char *path);\n"
32411 #: ../src/guestfs-actions.pod:8318
32412 msgid "guestfs_zfgrepi"
32416 #: ../src/guestfs-actions.pod:8320
32420 " guestfs_zfgrepi (guestfs_h *g,\n"
32421 " const char *pattern,\n"
32422 " const char *path);\n"
32427 #: ../src/guestfs-actions.pod:8337
32428 msgid "guestfs_zfile"
32432 #: ../src/guestfs-actions.pod:8339
32436 " guestfs_zfile (guestfs_h *g,\n"
32437 " const char *meth,\n"
32438 " const char *path);\n"
32443 #: ../src/guestfs-actions.pod:8344
32445 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
32450 #: ../src/guestfs-actions.pod:8356
32452 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
32457 #: ../src/guestfs-actions.pod:8364
32458 msgid "guestfs_zgrep"
32462 #: ../src/guestfs-actions.pod:8366
32466 " guestfs_zgrep (guestfs_h *g,\n"
32467 " const char *regex,\n"
32468 " const char *path);\n"
32473 #: ../src/guestfs-actions.pod:8383
32474 msgid "guestfs_zgrepi"
32478 #: ../src/guestfs-actions.pod:8385
32482 " guestfs_zgrepi (guestfs_h *g,\n"
32483 " const char *regex,\n"
32484 " const char *path);\n"
32489 #: ../src/guestfs-availability.pod:3
32494 #: ../src/guestfs-availability.pod:5
32496 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
32497 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
32498 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
32499 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
32500 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
32504 #: ../src/guestfs-availability.pod:21
32509 #: ../src/guestfs-availability.pod:23
32510 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
32514 #: ../src/guestfs-availability.pod:26
32519 #: ../src/guestfs-availability.pod:28
32520 msgid "The following functions: L</guestfs_grub_install>"
32524 #: ../src/guestfs-availability.pod:31
32529 #: ../src/guestfs-availability.pod:33
32531 "The following functions: L</guestfs_inotify_add_watch> "
32532 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
32533 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
32537 #: ../src/guestfs-availability.pod:41
32538 msgid "B<linuxfsuuid>"
32542 #: ../src/guestfs-availability.pod:43
32544 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
32545 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
32549 #: ../src/guestfs-availability.pod:50
32550 msgid "B<linuxmodules>"
32554 #: ../src/guestfs-availability.pod:52
32555 msgid "The following functions: L</guestfs_modprobe>"
32559 #: ../src/guestfs-availability.pod:55
32560 msgid "B<linuxxattrs>"
32564 #: ../src/guestfs-availability.pod:57
32566 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
32567 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
32568 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
32569 "L</guestfs_setxattr>"
32573 #: ../src/guestfs-availability.pod:68
32578 #: ../src/guestfs-availability.pod:70
32580 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
32581 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
32582 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
32586 #: ../src/guestfs-availability.pod:79
32591 #: ../src/guestfs-availability.pod:81
32593 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
32594 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
32595 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
32596 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
32597 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
32598 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
32599 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
32600 "L</guestfs_vgs_full>"
32604 #: ../src/guestfs-availability.pod:104
32609 #: ../src/guestfs-availability.pod:106
32611 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
32612 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
32616 #: ../src/guestfs-availability.pod:112
32621 #: ../src/guestfs-availability.pod:114
32622 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
32626 #: ../src/guestfs-availability.pod:117
32627 msgid "B<ntfsprogs>"
32631 #: ../src/guestfs-availability.pod:119
32633 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
32634 "L</guestfs_ntfsresize_size>"
32638 #: ../src/guestfs-availability.pod:124
32639 msgid "B<realpath>"
32643 #: ../src/guestfs-availability.pod:126
32644 msgid "The following functions: L</guestfs_realpath>"
32648 #: ../src/guestfs-availability.pod:129
32653 #: ../src/guestfs-availability.pod:131
32655 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
32656 "L</guestfs_scrub_freespace>"
32660 #: ../src/guestfs-availability.pod:136
32665 #: ../src/guestfs-availability.pod:138
32666 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
32670 #: ../src/guestfs-availability.pod:142
32675 #: ../src/guestfs-availability.pod:144
32676 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
32680 #: ../src/guestfs-availability.pod:148
32681 msgid "B<zerofree>"
32685 #: ../src/guestfs-availability.pod:150
32686 msgid "The following functions: L</guestfs_zerofree>"
32690 #: ../src/guestfs-structs.pod:1
32691 msgid "guestfs_int_bool"
32695 #: ../src/guestfs-structs.pod:3
32698 " struct guestfs_int_bool {\n"
32706 #: ../src/guestfs-structs.pod:8
32709 " struct guestfs_int_bool_list {\n"
32710 " uint32_t len; /* Number of elements in list. */\n"
32711 " struct guestfs_int_bool *val; /* Elements. */\n"
32717 #: ../src/guestfs-structs.pod:13
32720 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
32721 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
32726 #: ../src/guestfs-structs.pod:16
32727 msgid "guestfs_lvm_pv"
32731 #: ../src/guestfs-structs.pod:18
32734 " struct guestfs_lvm_pv {\n"
32735 " char *pv_name;\n"
32736 " /* The next field is NOT nul-terminated, be careful when printing it: "
32738 " char pv_uuid[32];\n"
32740 " uint64_t pv_size;\n"
32741 " uint64_t dev_size;\n"
32742 " uint64_t pv_free;\n"
32743 " uint64_t pv_used;\n"
32744 " char *pv_attr;\n"
32745 " int64_t pv_pe_count;\n"
32746 " int64_t pv_pe_alloc_count;\n"
32747 " char *pv_tags;\n"
32748 " uint64_t pe_start;\n"
32749 " int64_t pv_mda_count;\n"
32750 " uint64_t pv_mda_free;\n"
32756 #: ../src/guestfs-structs.pod:36
32759 " struct guestfs_lvm_pv_list {\n"
32760 " uint32_t len; /* Number of elements in list. */\n"
32761 " struct guestfs_lvm_pv *val; /* Elements. */\n"
32767 #: ../src/guestfs-structs.pod:41
32770 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
32771 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
32776 #: ../src/guestfs-structs.pod:44
32777 msgid "guestfs_lvm_vg"
32781 #: ../src/guestfs-structs.pod:46
32784 " struct guestfs_lvm_vg {\n"
32785 " char *vg_name;\n"
32786 " /* The next field is NOT nul-terminated, be careful when printing it: "
32788 " char vg_uuid[32];\n"
32790 " char *vg_attr;\n"
32791 " uint64_t vg_size;\n"
32792 " uint64_t vg_free;\n"
32793 " char *vg_sysid;\n"
32794 " uint64_t vg_extent_size;\n"
32795 " int64_t vg_extent_count;\n"
32796 " int64_t vg_free_count;\n"
32797 " int64_t max_lv;\n"
32798 " int64_t max_pv;\n"
32799 " int64_t pv_count;\n"
32800 " int64_t lv_count;\n"
32801 " int64_t snap_count;\n"
32802 " int64_t vg_seqno;\n"
32803 " char *vg_tags;\n"
32804 " int64_t vg_mda_count;\n"
32805 " uint64_t vg_mda_free;\n"
32811 #: ../src/guestfs-structs.pod:69
32814 " struct guestfs_lvm_vg_list {\n"
32815 " uint32_t len; /* Number of elements in list. */\n"
32816 " struct guestfs_lvm_vg *val; /* Elements. */\n"
32822 #: ../src/guestfs-structs.pod:74
32825 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
32826 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
32831 #: ../src/guestfs-structs.pod:77
32832 msgid "guestfs_lvm_lv"
32836 #: ../src/guestfs-structs.pod:79
32839 " struct guestfs_lvm_lv {\n"
32840 " char *lv_name;\n"
32841 " /* The next field is NOT nul-terminated, be careful when printing it: "
32843 " char lv_uuid[32];\n"
32844 " char *lv_attr;\n"
32845 " int64_t lv_major;\n"
32846 " int64_t lv_minor;\n"
32847 " int64_t lv_kernel_major;\n"
32848 " int64_t lv_kernel_minor;\n"
32849 " uint64_t lv_size;\n"
32850 " int64_t seg_count;\n"
32852 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
32853 " float snap_percent;\n"
32854 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
32855 " float copy_percent;\n"
32856 " char *move_pv;\n"
32857 " char *lv_tags;\n"
32858 " char *mirror_log;\n"
32859 " char *modules;\n"
32865 #: ../src/guestfs-structs.pod:101
32868 " struct guestfs_lvm_lv_list {\n"
32869 " uint32_t len; /* Number of elements in list. */\n"
32870 " struct guestfs_lvm_lv *val; /* Elements. */\n"
32876 #: ../src/guestfs-structs.pod:106
32879 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
32880 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
32885 #: ../src/guestfs-structs.pod:111
32888 " struct guestfs_stat {\n"
32892 " int64_t nlink;\n"
32897 " int64_t blksize;\n"
32898 " int64_t blocks;\n"
32899 " int64_t atime;\n"
32900 " int64_t mtime;\n"
32901 " int64_t ctime;\n"
32907 #: ../src/guestfs-structs.pod:127
32910 " struct guestfs_stat_list {\n"
32911 " uint32_t len; /* Number of elements in list. */\n"
32912 " struct guestfs_stat *val; /* Elements. */\n"
32918 #: ../src/guestfs-structs.pod:132
32921 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
32922 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
32927 #: ../src/guestfs-structs.pod:137
32930 " struct guestfs_statvfs {\n"
32931 " int64_t bsize;\n"
32932 " int64_t frsize;\n"
32933 " int64_t blocks;\n"
32934 " int64_t bfree;\n"
32935 " int64_t bavail;\n"
32936 " int64_t files;\n"
32937 " int64_t ffree;\n"
32938 " int64_t favail;\n"
32941 " int64_t namemax;\n"
32947 #: ../src/guestfs-structs.pod:151
32950 " struct guestfs_statvfs_list {\n"
32951 " uint32_t len; /* Number of elements in list. */\n"
32952 " struct guestfs_statvfs *val; /* Elements. */\n"
32958 #: ../src/guestfs-structs.pod:156
32961 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
32962 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
32967 #: ../src/guestfs-structs.pod:159
32968 msgid "guestfs_dirent"
32972 #: ../src/guestfs-structs.pod:161
32975 " struct guestfs_dirent {\n"
32984 #: ../src/guestfs-structs.pod:167
32987 " struct guestfs_dirent_list {\n"
32988 " uint32_t len; /* Number of elements in list. */\n"
32989 " struct guestfs_dirent *val; /* Elements. */\n"
32995 #: ../src/guestfs-structs.pod:172
32998 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
32999 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
33004 #: ../src/guestfs-structs.pod:177
33007 " struct guestfs_version {\n"
33008 " int64_t major;\n"
33009 " int64_t minor;\n"
33010 " int64_t release;\n"
33017 #: ../src/guestfs-structs.pod:184
33020 " struct guestfs_version_list {\n"
33021 " uint32_t len; /* Number of elements in list. */\n"
33022 " struct guestfs_version *val; /* Elements. */\n"
33028 #: ../src/guestfs-structs.pod:189
33031 " void guestfs_free_version (struct guestfs_free_version *);\n"
33032 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
33037 #: ../src/guestfs-structs.pod:192
33038 msgid "guestfs_xattr"
33042 #: ../src/guestfs-structs.pod:194
33045 " struct guestfs_xattr {\n"
33046 " char *attrname;\n"
33047 " /* The next two fields describe a byte array. */\n"
33048 " uint32_t attrval_len;\n"
33049 " char *attrval;\n"
33055 #: ../src/guestfs-structs.pod:201
33058 " struct guestfs_xattr_list {\n"
33059 " uint32_t len; /* Number of elements in list. */\n"
33060 " struct guestfs_xattr *val; /* Elements. */\n"
33066 #: ../src/guestfs-structs.pod:206
33069 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
33070 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
33075 #: ../src/guestfs-structs.pod:209
33076 msgid "guestfs_inotify_event"
33080 #: ../src/guestfs-structs.pod:211
33083 " struct guestfs_inotify_event {\n"
33084 " int64_t in_wd;\n"
33085 " uint32_t in_mask;\n"
33086 " uint32_t in_cookie;\n"
33087 " char *in_name;\n"
33093 #: ../src/guestfs-structs.pod:218
33096 " struct guestfs_inotify_event_list {\n"
33097 " uint32_t len; /* Number of elements in list. */\n"
33098 " struct guestfs_inotify_event *val; /* Elements. */\n"
33104 #: ../src/guestfs-structs.pod:223
33107 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
33108 " void guestfs_free_inotify_event_list (struct "
33109 "guestfs_free_inotify_event_list *);\n"
33114 #: ../src/guestfs-structs.pod:226
33115 msgid "guestfs_partition"
33119 #: ../src/guestfs-structs.pod:228
33122 " struct guestfs_partition {\n"
33123 " int32_t part_num;\n"
33124 " uint64_t part_start;\n"
33125 " uint64_t part_end;\n"
33126 " uint64_t part_size;\n"
33132 #: ../src/guestfs-structs.pod:235
33135 " struct guestfs_partition_list {\n"
33136 " uint32_t len; /* Number of elements in list. */\n"
33137 " struct guestfs_partition *val; /* Elements. */\n"
33143 #: ../src/guestfs-structs.pod:240
33146 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
33147 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
33152 #: ../src/guestfs-structs.pod:243
33153 msgid "guestfs_application"
33157 #: ../src/guestfs-structs.pod:245
33160 " struct guestfs_application {\n"
33161 " char *app_name;\n"
33162 " char *app_display_name;\n"
33163 " int32_t app_epoch;\n"
33164 " char *app_version;\n"
33165 " char *app_release;\n"
33166 " char *app_install_path;\n"
33167 " char *app_trans_path;\n"
33168 " char *app_publisher;\n"
33169 " char *app_url;\n"
33170 " char *app_source_package;\n"
33171 " char *app_summary;\n"
33172 " char *app_description;\n"
33178 #: ../src/guestfs-structs.pod:260
33181 " struct guestfs_application_list {\n"
33182 " uint32_t len; /* Number of elements in list. */\n"
33183 " struct guestfs_application *val; /* Elements. */\n"
33189 #: ../src/guestfs-structs.pod:265
33192 " void guestfs_free_application (struct guestfs_free_application *);\n"
33193 " void guestfs_free_application_list (struct guestfs_free_application_list "
33199 #: ../src/guestfs.pod:5
33200 msgid "guestfs - Library for accessing and modifying virtual machine images"
33204 #: ../src/guestfs.pod:11
33207 " guestfs_h *g = guestfs_create ();\n"
33208 " guestfs_add_drive (g, \"guest.img\");\n"
33209 " guestfs_launch (g);\n"
33210 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
33211 " guestfs_touch (g, \"/hello\");\n"
33212 " guestfs_umount (g, \"/\");\n"
33213 " guestfs_close (g);\n"
33218 #: ../src/guestfs.pod:25
33220 "Libguestfs is a library for accessing and modifying guest disk images. "
33221 "Amongst the things this is good for: making batch configuration changes to "
33222 "guests, getting disk used/free statistics (see also: virt-df), migrating "
33223 "between virtualization systems (see also: virt-p2v), performing partial "
33224 "backups, performing partial guest clones, cloning guests and changing "
33225 "registry/UUID/hostname info, and much else besides."
33229 #: ../src/guestfs.pod:33
33231 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
33232 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
33233 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
33238 #: ../src/guestfs.pod:38
33240 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
33241 "what filesystem is in each LV, etc.). It can also run commands in the "
33242 "context of the guest. Also you can access filesystems over FUSE."
33246 #: ../src/guestfs.pod:43
33248 "Libguestfs is a library that can be linked with C and C++ management "
33249 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
33250 "PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
33255 #: ../src/guestfs.pod:48
33257 "You don't need to be root to use libguestfs, although obviously you do need "
33258 "enough permissions to access the disk images."
33262 #: ../src/guestfs.pod:51
33264 "Libguestfs is a large API because it can do many things. For a gentle "
33265 "introduction, please read the L</API OVERVIEW> section next."
33269 #: ../src/guestfs.pod:54
33271 "There are also some example programs in the L<guestfs-examples(3)> manual "
33276 #: ../src/guestfs.pod:57
33277 msgid "API OVERVIEW"
33281 #: ../src/guestfs.pod:59
33283 "This section provides a gentler overview of the libguestfs API. We also try "
33284 "to group API calls together, where that may not be obvious from reading "
33285 "about the individual calls in the main section of this manual."
33289 #: ../src/guestfs.pod:64
33294 #: ../src/guestfs.pod:66
33296 "Before you can use libguestfs calls, you have to create a handle. Then you "
33297 "must add at least one disk image to the handle, followed by launching the "
33298 "handle, then performing whatever operations you want, and finally closing "
33299 "the handle. By convention we use the single letter C<g> for the name of the "
33300 "handle variable, although of course you can use any name you want."
33304 #: ../src/guestfs.pod:73
33305 msgid "The general structure of all libguestfs-using programs looks like this:"
33309 #: ../src/guestfs.pod:76
33312 " guestfs_h *g = guestfs_create ();\n"
33317 #: ../src/guestfs.pod:78
33320 " /* Call guestfs_add_drive additional times if there are\n"
33321 " * multiple disk images.\n"
33323 " guestfs_add_drive (g, \"guest.img\");\n"
33328 #: ../src/guestfs.pod:83
33331 " /* Most manipulation calls won't work until you've launched\n"
33332 " * the handle 'g'. You have to do this _after_ adding drives\n"
33333 " * and _before_ other commands.\n"
33335 " guestfs_launch (g);\n"
33340 #: ../src/guestfs.pod:89
33343 " /* Now you can examine what partitions, LVs etc are available.\n"
33345 " char **partitions = guestfs_list_partitions (g);\n"
33346 " char **logvols = guestfs_lvs (g);\n"
33351 #: ../src/guestfs.pod:94
33354 " /* To access a filesystem in the image, you must mount it.\n"
33356 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
33361 #: ../src/guestfs.pod:98
33364 " /* Now you can perform filesystem actions on the guest\n"
33367 " guestfs_touch (g, \"/hello\");\n"
33372 #: ../src/guestfs.pod:103
33375 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
33376 " * it is done automatically when you close the handle. See\n"
33377 " * discussion of autosync in this page.\n"
33379 " guestfs_sync (g);\n"
33384 #: ../src/guestfs.pod:109
33387 " /* Close the handle 'g'. */\n"
33388 " guestfs_close (g);\n"
33393 #: ../src/guestfs.pod:112
33395 "The code above doesn't include any error checking. In real code you should "
33396 "check return values carefully for errors. In general all functions that "
33397 "return integers return C<-1> on error, and all functions that return "
33398 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
33399 "how to handle errors, and consult the documentation for each function call "
33400 "below to see precisely how they return error indications. See "
33401 "L<guestfs-examples(3)> for fully worked examples."
33405 #: ../src/guestfs.pod:121
33406 msgid "DISK IMAGES"
33410 #: ../src/guestfs.pod:123
33412 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
33413 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
33414 "actual block device, or simply an empty file of zeroes that you have created "
33415 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
33420 #: ../src/guestfs.pod:129
33422 "The call you should use in modern code for adding drives is "
33423 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
33424 "specifying that the format is raw, do:"
33428 #: ../src/guestfs.pod:133
33431 " guestfs_add_drive_opts (g, filename,\n"
33432 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
33438 #: ../src/guestfs.pod:137
33439 msgid "You can add a disk read-only using:"
33443 #: ../src/guestfs.pod:139
33446 " guestfs_add_drive_opts (g, filename,\n"
33447 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
33448 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33454 #: ../src/guestfs.pod:144
33456 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
33457 "libguestfs won't modify the file."
33461 #: ../src/guestfs.pod:147
33463 "Be extremely cautious if the disk image is in use, eg. if it is being used "
33464 "by a virtual machine. Adding it read-write will almost certainly cause disk "
33465 "corruption, but adding it read-only is safe."
33469 #: ../src/guestfs.pod:151
33471 "You must add at least one disk image, and you may add multiple disk images. "
33472 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
33473 "first one you added), C</dev/sdb> (for the second one you added), etc."
33477 #: ../src/guestfs.pod:156
33479 "Once L</guestfs_launch> has been called you cannot add any more images. You "
33480 "can call L</guestfs_list_devices> to get a list of the device names, in the "
33481 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
33485 #: ../src/guestfs.pod:161
33490 #: ../src/guestfs.pod:163
33492 "Before you can read or write files, create directories and so on in a disk "
33493 "image that contains filesystems, you have to mount those filesystems using "
33494 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
33495 "a disk image contains (for example) one partition with a filesystem on that "
33496 "partition, then you can mount it directly:"
33500 #: ../src/guestfs.pod:170
33503 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
33508 #: ../src/guestfs.pod:172
33510 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
33511 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
33512 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
33513 "that these are libguestfs virtual devices, and are nothing to do with host "
33518 #: ../src/guestfs.pod:178
33520 "If you are given a disk image and you don't know what it contains then you "
33521 "have to find out. Libguestfs can do that too: use "
33522 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
33523 "and LVs, and either try mounting each to see what is mountable, or else "
33524 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
33525 "filesystems, use L</guestfs_list_filesystems>."
33529 #: ../src/guestfs.pod:186
33531 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
33532 "L</INSPECTION> below). But you might find it easier to look at higher level "
33533 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
33537 #: ../src/guestfs.pod:191
33539 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
33540 "several other variations of the C<guestfs_mount_*> call."
33544 #: ../src/guestfs.pod:194
33545 msgid "FILESYSTEM ACCESS AND MODIFICATION"
33549 #: ../src/guestfs.pod:196
33551 "The majority of the libguestfs API consists of fairly low-level calls for "
33552 "accessing and modifying the files, directories, symlinks etc on mounted "
33553 "filesystems. There are over a hundred such calls which you can find listed "
33554 "in detail below in this man page, and we don't even pretend to cover them "
33555 "all in this overview."
33559 #: ../src/guestfs.pod:202
33561 "Specify filenames as full paths, starting with C<\"/\"> and including the "
33566 #: ../src/guestfs.pod:205
33568 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
33569 "the file called C<\"etc/passwd\"> then you could do:"
33573 #: ../src/guestfs.pod:208
33576 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
33581 #: ../src/guestfs.pod:210
33583 "This would return C<data> as a newly allocated buffer containing the full "
33584 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
33585 "or C<NULL> if there was an error."
33589 #: ../src/guestfs.pod:214
33591 "As another example, to create a top-level directory on that filesystem "
33592 "called C<\"var\"> you would do:"
33596 #: ../src/guestfs.pod:217
33599 " guestfs_mkdir (g, \"/var\");\n"
33604 #: ../src/guestfs.pod:219
33605 msgid "To create a symlink you could do:"
33609 #: ../src/guestfs.pod:221
33612 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
33613 " \"/etc/rc3.d/S30portmap\");\n"
33618 #: ../src/guestfs.pod:224
33620 "Libguestfs will reject attempts to use relative paths and there is no "
33621 "concept of a current working directory."
33625 #: ../src/guestfs.pod:227
33627 "Libguestfs can return errors in many situations: for example if the "
33628 "filesystem isn't writable, or if a file or directory that you requested "
33629 "doesn't exist. If you are using the C API (documented here) you have to "
33630 "check for those error conditions after each call. (Other language bindings "
33631 "turn these errors into exceptions)."
33635 #: ../src/guestfs.pod:233
33637 "File writes are affected by the per-handle umask, set by calling "
33638 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
33642 #: ../src/guestfs.pod:236
33643 msgid "PARTITIONING"
33647 #: ../src/guestfs.pod:238
33649 "Libguestfs contains API calls to read, create and modify partition tables on "
33654 #: ../src/guestfs.pod:241
33656 "In the common case where you want to create a single partition covering the "
33657 "whole disk, you should use the L</guestfs_part_disk> call:"
33661 #: ../src/guestfs.pod:245
33664 " const char *parttype = \"mbr\";\n"
33665 " if (disk_is_larger_than_2TB)\n"
33666 " parttype = \"gpt\";\n"
33667 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
33672 #: ../src/guestfs.pod:250
33674 "Obviously this effectively wipes anything that was on that disk image "
33679 #: ../src/guestfs.pod:253
33684 #: ../src/guestfs.pod:255
33686 "Libguestfs provides access to a large part of the LVM2 API, such as "
33687 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
33688 "unless you familiarize yourself with the concepts of physical volumes, "
33689 "volume groups and logical volumes."
33693 #: ../src/guestfs.pod:260
33695 "This author strongly recommends reading the LVM HOWTO, online at "
33696 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
33700 #: ../src/guestfs.pod:263
33701 msgid "DOWNLOADING"
33705 #: ../src/guestfs.pod:265
33707 "Use L</guestfs_cat> to download small, text only files. This call is "
33708 "limited to files which are less than 2 MB and which cannot contain any ASCII "
33709 "NUL (C<\\0>) characters. However the API is very simple to use."
33713 #: ../src/guestfs.pod:269
33715 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
33716 "bit data, since it returns a (pointer, size) pair. However it is still "
33717 "limited to \"small\" files, less than 2 MB."
33721 #: ../src/guestfs.pod:273
33723 "L</guestfs_download> can be used to download any file, with no limits on "
33724 "content or size (even files larger than 4 GB)."
33728 #: ../src/guestfs.pod:276
33729 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
33733 #: ../src/guestfs.pod:279
33738 #: ../src/guestfs.pod:281
33740 "It's often the case that you want to write a file or files to the disk "
33745 #: ../src/guestfs.pod:284
33747 "To write a small file with fixed content, use L</guestfs_write>. To create "
33748 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
33749 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
33750 "variety of other functions for creating test files, for example "
33751 "L</guestfs_fill> and L</guestfs_fill_pattern>."
33755 #: ../src/guestfs.pod:290
33757 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
33758 "file content or size (even files larger than 4 GB)."
33762 #: ../src/guestfs.pod:293
33763 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
33767 #: ../src/guestfs.pod:295
33769 "However the fastest way to upload I<large numbers of arbitrary files> is to "
33770 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
33771 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
33772 "the drive in a predictable way (eg. adding it last after all other drives) "
33773 "then you can get the device name from L</guestfs_list_devices> and mount it "
33774 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
33775 "sometimes non-portable between kernel versions, and they don't support "
33776 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
33777 "using a label or UUID, use an ISO image instead."
33781 #: ../src/guestfs.pod:306
33786 #: ../src/guestfs.pod:308
33788 "There are various different commands for copying between files and devices "
33789 "and in and out of the guest filesystem. These are summarised in the table "
33794 #: ../src/guestfs.pod:314
33795 msgid "B<file> to B<file>"
33799 #: ../src/guestfs.pod:316
33801 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
33802 "directories recursively."
33806 #: ../src/guestfs.pod:319
33807 msgid "To copy part of a file (offset and size) use L</guestfs_copy_file_to_file>."
33811 #: ../src/guestfs.pod:322
33812 msgid "B<file> to B<device>"
33816 #: ../src/guestfs.pod:324
33817 msgid "B<device> to B<file>"
33821 #: ../src/guestfs.pod:326
33822 msgid "B<device> to B<device>"
33826 #: ../src/guestfs.pod:328
33828 "Use L</guestfs_copy_file_to_device>, L</guestfs_copy_device_to_file>, or "
33829 "L</guestfs_copy_device_to_device>."
33833 #: ../src/guestfs.pod:331
33834 msgid "Example: duplicate the contents of an LV:"
33838 #: ../src/guestfs.pod:333
33841 " guestfs_copy_device_to_device (g,\n"
33842 " \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
33843 " /* -1 marks the end of the list of optional parameters */\n"
33849 #: ../src/guestfs.pod:338
33851 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
33852 "(C</dev/VG/Original>). To copy less than the whole source device, use the "
33853 "optional C<size> parameter:"
33857 #: ../src/guestfs.pod:342
33860 " guestfs_copy_device_to_device (g,\n"
33861 " \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
33862 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, 10000,\n"
33868 #: ../src/guestfs.pod:347
33869 msgid "B<file on the host> to B<file or device>"
33873 #: ../src/guestfs.pod:349
33874 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
33878 #: ../src/guestfs.pod:351
33879 msgid "B<file or device> to B<file on the host>"
33883 #: ../src/guestfs.pod:353
33884 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
33888 #: ../src/guestfs.pod:357
33889 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
33893 #: ../src/guestfs.pod:359
33895 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
33896 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
33897 "appears you can only upload and download to files. However many Un*x-like "
33898 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
33899 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
33900 "stderr, and arbitrary file descriptor N."
33904 #: ../src/guestfs.pod:367
33905 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
33909 #: ../src/guestfs.pod:370
33912 " guestfs_download (g, filename, \"/dev/stdout\");\n"
33917 #: ../src/guestfs.pod:372
33918 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
33922 #: ../src/guestfs.pod:374
33925 " char devfd[64];\n"
33926 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
33927 " guestfs_tar_out (g, \"/\", devfd);\n"
33932 #: ../src/guestfs.pod:378
33933 msgid "LISTING FILES"
33937 #: ../src/guestfs.pod:380
33939 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
33940 "L<guestfish(1)>-equivalent command C<ll>)."
33944 #: ../src/guestfs.pod:383
33946 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
33947 "programs, as a flat list of strings."
33951 #: ../src/guestfs.pod:386
33953 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
33954 "directory, plus additional information about each one. It is more "
33955 "equivalent to using the L<readdir(3)> call on a local filesystem."
33959 #: ../src/guestfs.pod:390
33961 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
33966 #: ../src/guestfs.pod:393
33967 msgid "RUNNING COMMANDS"
33971 #: ../src/guestfs.pod:395
33973 "Although libguestfs is primarily an API for manipulating files inside guest "
33974 "images, we also provide some limited facilities for running commands inside "
33979 #: ../src/guestfs.pod:399
33980 msgid "There are many limitations to this:"
33984 #: ../src/guestfs.pod:405
33986 "The kernel version that the command runs under will be different from what "
33991 #: ../src/guestfs.pod:410
33993 "If the command needs to communicate with daemons, then most likely they "
33994 "won't be running."
33998 #: ../src/guestfs.pod:415
33999 msgid "The command will be running in limited memory."
34003 #: ../src/guestfs.pod:419
34005 "The network may not be available unless you enable it (see "
34006 "L</guestfs_set_network>)."
34010 #: ../src/guestfs.pod:424
34011 msgid "Only supports Linux guests (not Windows, BSD, etc)."
34015 #: ../src/guestfs.pod:428
34016 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
34020 #: ../src/guestfs.pod:433
34022 "For SELinux guests, you may need to enable SELinux and load policy first. "
34023 "See L</SELINUX> in this manpage."
34027 #: ../src/guestfs.pod:438
34029 "I<Security:> It is not safe to run commands from untrusted, possibly "
34030 "malicious guests. These commands may attempt to exploit your program by "
34031 "sending unexpected output. They could also try to exploit the Linux kernel "
34032 "or qemu provided by the libguestfs appliance. They could use the network "
34033 "provided by the libguestfs appliance to bypass ordinary network partitions "
34034 "and firewalls. They could use the elevated privileges or different SELinux "
34035 "context of your program to their advantage."
34039 #: ../src/guestfs.pod:447
34041 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
34042 "(a script which runs when the guest next boots normally), and to have this "
34043 "script run the commands you want in the normal context of the running guest, "
34044 "network security and so on. For information about other security issues, "
34045 "see L</SECURITY>."
34049 #: ../src/guestfs.pod:455
34051 "The two main API calls to run commands are L</guestfs_command> and "
34052 "L</guestfs_sh> (there are also variations)."
34056 #: ../src/guestfs.pod:458
34058 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
34059 "shell globs, redirections, etc will work."
34063 #: ../src/guestfs.pod:461
34064 msgid "CONFIGURATION FILES"
34068 #: ../src/guestfs.pod:463
34070 "To read and write configuration files in Linux guest filesystems, we "
34071 "strongly recommend using Augeas. For example, Augeas understands how to "
34072 "read and write, say, a Linux shadow password file or X.org configuration "
34073 "file, and so avoids you having to write that code."
34077 #: ../src/guestfs.pod:468
34079 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
34080 "document Augeas itself here because there is excellent documentation on the "
34081 "L<http://augeas.net/> website."
34085 #: ../src/guestfs.pod:472
34087 "If you don't want to use Augeas (you fool!) then try calling "
34088 "L</guestfs_read_lines> to get the file as a list of lines which you can "
34093 #: ../src/guestfs.pod:476
34098 #: ../src/guestfs.pod:478
34100 "We support SELinux guests. To ensure that labeling happens correctly in "
34101 "SELinux guests, you need to enable SELinux and load the guest's policy:"
34105 #: ../src/guestfs.pod:486
34106 msgid "Before launching, do:"
34110 #: ../src/guestfs.pod:488
34113 " guestfs_set_selinux (g, 1);\n"
34118 #: ../src/guestfs.pod:492
34120 "After mounting the guest's filesystem(s), load the policy. This is best "
34121 "done by running the L<load_policy(8)> command in the guest itself:"
34125 #: ../src/guestfs.pod:496
34128 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
34133 #: ../src/guestfs.pod:498
34135 "(Older versions of C<load_policy> require you to specify the name of the "
34140 #: ../src/guestfs.pod:503
34142 "Optionally, set the security context for the API. The correct security "
34143 "context to use can only be known by inspecting the guest. As an example:"
34147 #: ../src/guestfs.pod:507
34150 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
34155 #: ../src/guestfs.pod:511
34156 msgid "This will work for running commands and editing existing files."
34160 #: ../src/guestfs.pod:513
34162 "When new files are created, you may need to label them explicitly, for "
34163 "example by running the external command C<restorecon pathname>."
34167 #: ../src/guestfs.pod:517
34172 #: ../src/guestfs.pod:519
34174 "Certain calls are affected by the current file mode creation mask (the "
34175 "\"umask\"). In particular ones which create files or directories, such as "
34176 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
34177 "either the default mode that the file is created with or modifies the mode "
34182 #: ../src/guestfs.pod:525
34184 "The default umask is C<022>, so files are created with modes such as C<0644> "
34185 "and directories with C<0755>."
34189 #: ../src/guestfs.pod:528
34191 "There are two ways to avoid being affected by umask. Either set umask to 0 "
34192 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
34193 "L</guestfs_chmod> after creating each file or directory."
34197 #: ../src/guestfs.pod:532
34198 msgid "For more information about umask, see L<umask(2)>."
34202 #: ../src/guestfs.pod:536
34204 "Libguestfs allows you to access Linux guests which have been encrypted using "
34205 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
34206 "standard. This includes nearly all whole disk encryption systems used by "
34207 "modern Linux guests."
34211 #: ../src/guestfs.pod:542
34213 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
34214 "returns the string C<crypto_LUKS>)."
34218 #: ../src/guestfs.pod:545
34220 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
34221 "will require the passphrase!"
34225 #: ../src/guestfs.pod:548
34227 "Opening a LUKS device creates a new device mapper device called "
34228 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
34229 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
34230 "decrypted from and encrypted to the underlying block device respectively."
34234 #: ../src/guestfs.pod:554
34236 "LVM volume groups on the device can be made visible by calling "
34237 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
34238 "volume(s) can now be mounted in the usual way."
34242 #: ../src/guestfs.pod:558
34244 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
34245 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
34246 "[\"/dev/VG\"])>. Then close the mapper device by calling "
34247 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
34248 "underlying encrypted block device)."
34252 #: ../src/guestfs.pod:565
34257 #: ../src/guestfs.pod:567
34259 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
34260 "contains operating systems, an install CD or a live CD. (These APIs used to "
34261 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
34262 "version 1.5.3 the most frequently used part of this library has been "
34263 "rewritten in C and moved into the core code)."
34267 #: ../src/guestfs.pod:574
34269 "Add all disks belonging to the unknown virtual machine and call "
34270 "L</guestfs_launch> in the usual way."
34274 #: ../src/guestfs.pod:577
34276 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
34277 "and certain heuristics, and returns a list of operating systems that were "
34278 "found. An empty list means none were found. A single element is the root "
34279 "filesystem of the operating system. For dual- or multi-boot guests, "
34280 "multiple roots can be returned, each one corresponding to a separate "
34281 "operating system. (Multi-boot virtual machines are extremely rare in the "
34282 "world of virtualization, but since this scenario can happen, we have built "
34283 "libguestfs to deal with it.)"
34287 #: ../src/guestfs.pod:586
34289 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
34290 "to get additional details about that operating system. For example, call "
34291 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
34292 "Windows and Linux-based operating systems respectively."
34296 #: ../src/guestfs.pod:592
34298 "Un*x-like and Linux-based operating systems usually consist of several "
34299 "filesystems which are mounted at boot time (for example, a separate boot "
34300 "partition mounted on C</boot>). The inspection rules are able to detect how "
34301 "filesystems correspond to mount points. Call "
34302 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
34303 "hash table like this example:"
34307 #: ../src/guestfs.pod:599
34310 " /boot => /dev/sda1\n"
34311 " / => /dev/vg_guest/lv_root\n"
34312 " /usr => /dev/vg_guest/lv_usr\n"
34317 #: ../src/guestfs.pod:603
34319 "The caller can then make calls to L</guestfs_mount_options> to mount the "
34320 "filesystems as suggested."
34324 #: ../src/guestfs.pod:606
34326 "Be careful to mount filesystems in the right order (eg. C</> before "
34327 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
34332 #: ../src/guestfs.pod:610
34334 "Inspection currently only works for some common operating systems. "
34335 "Contributors are welcome to send patches for other operating systems that we "
34336 "currently cannot detect."
34340 #: ../src/guestfs.pod:614
34342 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
34343 "for more details. The L</guestfs_inspect_os> function just ignores any "
34344 "encrypted devices."
34348 #: ../src/guestfs.pod:618
34350 "A note on the implementation: The call L</guestfs_inspect_os> performs "
34351 "inspection and caches the results in the guest handle. Subsequent calls to "
34352 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
34353 "re-read the disks. If you change the content of the guest disks, you can "
34354 "redo inspection by calling L</guestfs_inspect_os> again. "
34355 "(L</guestfs_inspect_list_applications> works a little differently from the "
34356 "other calls and does read the disks. See documentation for that function "
34361 #: ../src/guestfs.pod:627
34362 msgid "INSPECTING INSTALL DISKS"
34366 #: ../src/guestfs.pod:629
34368 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
34373 #: ../src/guestfs.pod:632
34375 "Call L</guestfs_inspect_get_format> to return the format of the operating "
34376 "system, which currently can be C<installed> (a regular operating system) or "
34377 "C<installer> (some sort of install disk)."
34381 #: ../src/guestfs.pod:636
34383 "Further information is available about the operating system that can be "
34384 "installed using the regular inspection APIs like "
34385 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
34390 #: ../src/guestfs.pod:641
34392 "Some additional information specific to installer disks is also available "
34393 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
34394 "L</guestfs_inspect_is_multipart> calls."
34398 #: ../src/guestfs.pod:646
34399 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
34403 #: ../src/guestfs.pod:648
34405 "Libguestfs can mount NTFS partitions. It does this using the "
34406 "L<http://www.ntfs-3g.org/> driver."
34410 #: ../src/guestfs.pod:651
34411 msgid "DRIVE LETTERS AND PATHS"
34415 #: ../src/guestfs.pod:653
34417 "DOS and Windows still use drive letters, and the filesystems are always "
34418 "treated as case insensitive by Windows itself, and therefore you might find "
34419 "a Windows configuration file referring to a path like "
34420 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
34421 "that directory might be referred to as C</WINDOWS/System32>."
34425 #: ../src/guestfs.pod:659
34427 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
34428 "L</guestfs_inspect_get_drive_mappings>)"
34432 #: ../src/guestfs.pod:662
34434 "Dealing with separator characters (backslash vs forward slash) is outside "
34435 "the scope of libguestfs, but usually a simple character replacement will "
34440 #: ../src/guestfs.pod:666
34442 "To resolve the case insensitivity of paths, call "
34443 "L</guestfs_case_sensitive_path>."
34447 #: ../src/guestfs.pod:669
34448 msgid "ACCESSING THE WINDOWS REGISTRY"
34452 #: ../src/guestfs.pod:671
34454 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
34455 "files, through the library C<hivex> which is part of the libguestfs project "
34456 "although ships as a separate tarball. You have to locate and download the "
34457 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
34458 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
34459 "L<virt-win-reg(1)> for more help on this issue."
34463 #: ../src/guestfs.pod:679
34464 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
34468 #: ../src/guestfs.pod:681
34470 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
34471 "provide something which looks like a Linux symlink. The way it tries to do "
34472 "the rewriting is described here:"
34476 #: ../src/guestfs.pod:685
34477 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
34481 #: ../src/guestfs.pod:687
34483 "The essential problem is that ntfs-3g simply does not have enough "
34484 "information to do a correct job. NTFS links can contain drive letters and "
34485 "references to external device GUIDs that ntfs-3g has no way of resolving. "
34486 "It is almost certainly the case that libguestfs callers should ignore what "
34487 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
34491 #: ../src/guestfs.pod:694
34493 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
34494 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
34495 "attribute, and read the raw reparse data from that (you can find the format "
34496 "documented in various places around the web)."
34500 #: ../src/guestfs.pod:699
34501 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
34505 #: ../src/guestfs.pod:701
34507 "There are other useful extended attributes that can be read from ntfs-3g "
34508 "filesystems (using L</guestfs_getxattr>). See:"
34512 #: ../src/guestfs.pod:704
34513 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
34517 #: ../src/guestfs.pod:706
34518 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
34522 #: ../src/guestfs.pod:708
34524 "Although we don't want to discourage you from using the C API, we will "
34525 "mention here that the same API is also available in other languages."
34529 #: ../src/guestfs.pod:711
34531 "The API is broadly identical in all supported languages. This means that "
34532 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
34533 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
34534 "OCaml. In other words, a straightforward, predictable isomorphism between "
34539 #: ../src/guestfs.pod:717
34541 "Error messages are automatically transformed into exceptions if the language "
34546 #: ../src/guestfs.pod:720
34548 "We don't try to \"object orientify\" parts of the API in OO languages, "
34549 "although contributors are welcome to write higher level APIs above what we "
34550 "provide in their favourite languages if they wish."
34554 #: ../src/guestfs.pod:726
34559 #: ../src/guestfs.pod:728
34561 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
34562 "identical to the C API. C++ classes and exceptions are not used."
34566 #: ../src/guestfs.pod:732
34571 #: ../src/guestfs.pod:734
34573 "The C# bindings are highly experimental. Please read the warnings at the "
34574 "top of C<csharp/Libguestfs.cs>."
34578 #: ../src/guestfs.pod:737
34583 #: ../src/guestfs.pod:739
34584 msgid "See L<guestfs-erlang(3)>."
34588 #: ../src/guestfs.pod:741
34593 #: ../src/guestfs.pod:743
34595 "This is the only language binding that is working but incomplete. Only "
34596 "calls which return simple integers have been bound in Haskell, and we are "
34597 "looking for help to complete this binding."
34601 #: ../src/guestfs.pod:747
34606 #: ../src/guestfs.pod:749
34608 "Full documentation is contained in the Javadoc which is distributed with "
34609 "libguestfs. For examples, see L<guestfs-java(3)>."
34613 #: ../src/guestfs.pod:752
34618 #: ../src/guestfs.pod:754
34619 msgid "See L<guestfs-ocaml(3)>."
34623 #: ../src/guestfs.pod:756
34628 #: ../src/guestfs.pod:758
34629 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
34633 #: ../src/guestfs.pod:760
34638 #: ../src/guestfs.pod:762
34640 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
34641 "the php-libguestfs package for your distribution."
34645 #: ../src/guestfs.pod:765
34646 msgid "The PHP binding only works correctly on 64 bit machines."
34650 #: ../src/guestfs.pod:767
34655 #: ../src/guestfs.pod:769
34656 msgid "See L<guestfs-python(3)>."
34660 #: ../src/guestfs.pod:771
34665 #: ../src/guestfs.pod:773
34666 msgid "See L<guestfs-ruby(3)>."
34670 #: ../src/guestfs.pod:775
34671 msgid "B<shell scripts>"
34675 #: ../src/guestfs.pod:777
34676 msgid "See L<guestfish(1)>."
34680 #: ../src/guestfs.pod:781
34681 msgid "LIBGUESTFS GOTCHAS"
34685 #: ../src/guestfs.pod:783
34687 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
34688 "system [...] that works in the way it is documented but is counterintuitive "
34689 "and almost invites mistakes.\""
34693 #: ../src/guestfs.pod:787
34695 "Since we developed libguestfs and the associated tools, there are several "
34696 "things we would have designed differently, but are now stuck with for "
34697 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
34698 "release, you can expect these to change. Beware of them."
34702 #: ../src/guestfs.pod:795
34703 msgid "Autosync / forgetting to sync."
34707 #: ../src/guestfs.pod:797
34709 "I<Update:> Autosync is enabled by default for all API users starting from "
34710 "libguestfs 1.5.24. This section only applies to older versions."
34714 #: ../src/guestfs.pod:800
34716 "When modifying a filesystem from C or another language, you B<must> unmount "
34717 "all filesystems and call L</guestfs_sync> explicitly before you close the "
34718 "libguestfs handle. You can also call:"
34722 #: ../src/guestfs.pod:804
34725 " guestfs_set_autosync (g, 1);\n"
34730 #: ../src/guestfs.pod:806
34732 "to have the unmount/sync done automatically for you when the handle 'g' is "
34733 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
34738 #: ../src/guestfs.pod:810
34740 "If you forget to do this, then it is entirely possible that your changes "
34741 "won't be written out, or will be partially written, or (very rarely) that "
34742 "you'll get disk corruption."
34746 #: ../src/guestfs.pod:814
34748 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
34749 "guestfish scripts that forget to sync will work just fine, which can make "
34750 "this very puzzling if you are trying to debug a problem."
34754 #: ../src/guestfs.pod:818
34755 msgid "Mount option C<-o sync> should not be the default."
34759 #: ../src/guestfs.pod:820
34761 "I<Update:> L</guestfs_mount> no longer adds any options starting from "
34762 "libguestfs 1.13.16. This section only applies to older versions."
34766 #: ../src/guestfs.pod:823
34768 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
34769 "However C<-o sync> does not add any reliability benefit, but does have a "
34770 "very large performance impact."
34774 #: ../src/guestfs.pod:827
34776 "The work around is to use L</guestfs_mount_options> and set the mount "
34777 "options that you actually want to use."
34781 #: ../src/guestfs.pod:830
34782 msgid "Read-only should be the default."
34786 #: ../src/guestfs.pod:832
34788 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
34789 "specify I<--rw> if you want to make changes to the image."
34793 #: ../src/guestfs.pod:835
34794 msgid "This would reduce the potential to corrupt live VM images."
34798 #: ../src/guestfs.pod:837
34800 "Note that many filesystems change the disk when you just mount and unmount, "
34801 "even if you didn't perform any writes. You need to use "
34802 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
34806 #: ../src/guestfs.pod:841
34807 msgid "guestfish command line is hard to use."
34811 #: ../src/guestfs.pod:843
34813 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
34814 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
34815 "exist, so it fails. In earlier versions of guestfish the error message was "
34816 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
34817 "we should have used C<guestfish -c command> to run commands."
34821 #: ../src/guestfs.pod:850
34822 msgid "guestfish megabyte modifiers don't work right on all commands"
34826 #: ../src/guestfs.pod:852
34828 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
34829 "other modifiers). What guestfish actually does is to multiply the number "
34830 "part by the modifier part and pass the result to the C API. However this "
34831 "doesn't work for a few APIs which aren't expecting bytes, but are already "
34832 "expecting some other unit (eg. megabytes)."
34836 #: ../src/guestfs.pod:859
34837 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
34841 #: ../src/guestfs.pod:861
34844 " lvcreate LV VG 100M\n"
34849 #: ../src/guestfs.pod:863
34851 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
34852 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
34853 "megabytes * megabytes) logical volume. The error message you get from this "
34854 "is also a little obscure."
34858 #: ../src/guestfs.pod:868
34860 "This could be fixed in the generator by specially marking parameters and "
34861 "return values which take bytes or other units."
34865 #: ../src/guestfs.pod:871
34866 msgid "Ambiguity between devices and paths"
34870 #: ../src/guestfs.pod:873
34872 "There is a subtle ambiguity in the API between a device name "
34873 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
34874 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
34878 #: ../src/guestfs.pod:878
34880 "In the current API we usually resolve this ambiguity by having two separate "
34881 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
34882 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
34883 "detecting if the path supplied begins with C</dev/>."
34887 #: ../src/guestfs.pod:884
34889 "To avoid both the ambiguity and the need to duplicate some calls, we could "
34890 "make paths/devices into structured names. One way to do this would be to "
34891 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
34892 "aspect of grub. Another way would be to use a structured type, equivalent "
34893 "to this OCaml type:"
34897 #: ../src/guestfs.pod:890
34900 " type path = Path of string | Device of int | Partition of int * int\n"
34905 #: ../src/guestfs.pod:892
34906 msgid "which would allow you to pass arguments like:"
34910 #: ../src/guestfs.pod:894
34913 " Path \"/foo/bar\"\n"
34914 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
34915 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
34916 " Path \"/dev/sdb2\" (* not a device *)\n"
34921 #: ../src/guestfs.pod:899
34923 "As you can see there are still problems to resolve even with this "
34924 "representation. Also consider how it might work in guestfish."
34928 #: ../src/guestfs.pod:904
34929 msgid "KEYS AND PASSPHRASES"
34933 #: ../src/guestfs.pod:906
34935 "Certain libguestfs calls take a parameter that contains sensitive key "
34936 "material, passed in as a C string."
34940 #: ../src/guestfs.pod:909
34942 "In the future we would hope to change the libguestfs implementation so that "
34943 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
34944 "swap. However this is I<not> done at the moment, because of the complexity "
34945 "of such an implementation."
34949 #: ../src/guestfs.pod:914
34951 "Therefore you should be aware that any key parameter you pass to libguestfs "
34952 "might end up being written out to the swap partition. If this is a concern, "
34953 "scrub the swap partition or don't use libguestfs on encrypted devices."
34957 #: ../src/guestfs.pod:919
34958 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
34962 #: ../src/guestfs.pod:921
34964 "All high-level libguestfs actions are synchronous. If you want to use "
34965 "libguestfs asynchronously then you must create a thread."
34969 #: ../src/guestfs.pod:924
34971 "Only use the handle from a single thread. Either use the handle exclusively "
34972 "from one thread, or provide your own mutex so that two threads cannot issue "
34973 "calls on the same handle at the same time."
34977 #: ../src/guestfs.pod:928
34979 "See the graphical program guestfs-browser for one possible architecture for "
34980 "multithreaded programs using libvirt and libguestfs."
34984 #: ../src/guestfs.pod:931
34989 #: ../src/guestfs.pod:933
34991 "Libguestfs needs a supermin appliance, which it finds by looking along an "
34996 #: ../src/guestfs.pod:936
34998 "By default it looks for these in the directory C<$libdir/guestfs> "
34999 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
35003 #: ../src/guestfs.pod:939
35005 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
35006 "to change the directories that libguestfs will search in. The value is a "
35007 "colon-separated list of paths. The current directory is I<not> searched "
35008 "unless the path contains an empty element or C<.>. For example "
35009 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
35010 "then C</usr/lib/guestfs>."
35014 #: ../src/guestfs.pod:946
35015 msgid "QEMU WRAPPERS"
35019 #: ../src/guestfs.pod:948
35021 "If you want to compile your own qemu, run qemu from a non-standard location, "
35022 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
35027 #: ../src/guestfs.pod:952
35029 "There is one important rule to remember: you I<must C<exec qemu>> as the "
35030 "last command in the shell script (so that qemu replaces the shell and "
35031 "becomes the direct child of the libguestfs-using program). If you don't do "
35032 "this, then the qemu process won't be cleaned up correctly."
35036 #: ../src/guestfs.pod:957
35038 "Here is an example of a wrapper, where I have built my own copy of qemu from "
35043 #: ../src/guestfs.pod:960
35047 " qemudir=/home/rjones/d/qemu\n"
35048 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
35054 #: ../src/guestfs.pod:964
35056 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
35057 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
35062 #: ../src/guestfs.pod:968
35065 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
35070 #: ../src/guestfs.pod:970
35072 "Note that libguestfs also calls qemu with the -help and -version options in "
35073 "order to determine features."
35077 #: ../src/guestfs.pod:973
35079 "Wrappers can also be used to edit the options passed to qemu. In the "
35080 "following example, the C<-machine ...> option (C<-machine> and the following "
35081 "argument) are removed from the command line and replaced with C<-machine "
35082 "pc,accel=tcg>. The while loop iterates over the options until it finds the "
35083 "right one to remove, putting the remaining options into the C<args> array."
35087 #: ../src/guestfs.pod:982
35091 " while [ $# -gt 0 ]; do\n"
35092 " case \"$1\" in\n"
35096 " args[i]=\"$1\"\n"
35105 #: ../src/guestfs.pod:994
35108 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
35113 #: ../src/guestfs.pod:996
35114 msgid "ATTACHING TO RUNNING DAEMONS"
35118 #: ../src/guestfs.pod:998
35120 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
35121 "babies. Use with caution."
35125 #: ../src/guestfs.pod:1001
35127 "I<Note (2):> This section explains how to attach to a running daemon from a "
35128 "low level perspective. For most users, simply using virt tools such as "
35129 "L<guestfish(1)> with the I<--live> option will \"just work\"."
35133 #: ../src/guestfs.pod:1005
35134 msgid "Using guestfs_set_attach_method"
35138 #: ../src/guestfs.pod:1007
35140 "By calling L</guestfs_set_attach_method> you can change how the library "
35141 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
35142 "L</ARCHITECTURE> for some background)."
35146 #: ../src/guestfs.pod:1011
35148 "The normal attach method is C<appliance>, where a small appliance is created "
35149 "containing the daemon, and then the library connects to this."
35153 #: ../src/guestfs.pod:1014
35155 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
35156 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
35157 "daemon over the Unix domain socket."
35161 #: ../src/guestfs.pod:1018
35163 "The normal use for this is to connect to a running virtual machine that "
35164 "contains a C<guestfsd> daemon, and send commands so you can read and write "
35165 "files inside the live virtual machine."
35169 #: ../src/guestfs.pod:1022
35170 msgid "Using guestfs_add_domain with live flag"
35174 #: ../src/guestfs.pod:1024
35176 "L</guestfs_add_domain> provides some help for getting the correct attach "
35177 "method. If you pass the C<live> option to this function, then (if the "
35178 "virtual machine is running) it will examine the libvirt XML looking for a "
35179 "virtio-serial channel to connect to:"
35183 #: ../src/guestfs.pod:1030
35190 " <channel type='unix'>\n"
35191 " <source mode='bind' path='/path/to/socket'/>\n"
35192 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
35201 #: ../src/guestfs.pod:1042
35203 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
35204 "method to C<unix:/path/to/socket>."
35208 #: ../src/guestfs.pod:1045
35210 "Some of the libguestfs tools (including guestfish) support a I<--live> "
35211 "option which is passed through to L</guestfs_add_domain> thus allowing you "
35212 "to attach to and modify live virtual machines."
35216 #: ../src/guestfs.pod:1049
35218 "The virtual machine needs to have been set up beforehand so that it has the "
35219 "virtio-serial channel and so that guestfsd is running inside it."
35223 #: ../src/guestfs.pod:1053
35224 msgid "ABI GUARANTEE"
35228 #: ../src/guestfs.pod:1055
35230 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
35231 "actions as outlined in this section. Although we will deprecate some "
35232 "actions, for example if they get replaced by newer calls, we will keep the "
35233 "old actions forever. This allows you the developer to program in confidence "
35234 "against the libguestfs API."
35238 #: ../src/guestfs.pod:1061
35239 msgid "BLOCK DEVICE NAMING"
35243 #: ../src/guestfs.pod:1063
35245 "In the kernel there is now quite a profusion of schemata for naming block "
35246 "devices (in this context, by I<block device> I mean a physical or virtual "
35247 "hard drive). The original Linux IDE driver used names starting with "
35248 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
35249 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
35250 "replacement for the old IDE driver (particularly for SATA devices) those "
35251 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
35252 "machines with paravirtualized drivers. This has created several different "
35253 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
35258 #: ../src/guestfs.pod:1075
35260 "As discussed above, libguestfs uses a qemu appliance running an embedded "
35261 "Linux kernel to access block devices. We can run a variety of appliances "
35262 "based on a variety of Linux kernels."
35266 #: ../src/guestfs.pod:1079
35268 "This causes a problem for libguestfs because many API calls use device or "
35269 "partition names. Working scripts and the recipe (example) scripts that we "
35270 "make available over the internet could fail if the naming scheme changes."
35274 #: ../src/guestfs.pod:1084
35276 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
35277 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
35278 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
35279 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
35283 #: ../src/guestfs.pod:1090
35285 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
35286 "L</guestfs_list_partitions> and similar calls return the true names of the "
35287 "devices and partitions as known to the appliance."
35291 #: ../src/guestfs.pod:1095
35292 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
35296 #: ../src/guestfs.pod:1097
35298 "Usually this translation is transparent. However in some (very rare) cases "
35299 "you may need to know the exact algorithm. Such cases include where you use "
35300 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
35301 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
35306 #: ../src/guestfs.pod:1103
35308 "The algorithm is applied only to I<parameters> which are known to be either "
35309 "device or partition names. Return values from functions such as "
35310 "L</guestfs_list_devices> are never changed."
35314 #: ../src/guestfs.pod:1111
35315 msgid "Is the string a parameter which is a device or partition name?"
35319 #: ../src/guestfs.pod:1115
35320 msgid "Does the string begin with C</dev/sd>?"
35324 #: ../src/guestfs.pod:1119
35326 "Does the named device exist? If so, we use that device. However if I<not> "
35327 "then we continue with this algorithm."
35331 #: ../src/guestfs.pod:1124
35332 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
35336 #: ../src/guestfs.pod:1126
35337 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
35341 #: ../src/guestfs.pod:1128
35342 msgid "If that named device exists, use it. If not, continue."
35346 #: ../src/guestfs.pod:1132
35347 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
35351 #: ../src/guestfs.pod:1134
35352 msgid "If that named device exists, use it. If not, return an error."
35356 #: ../src/guestfs.pod:1138
35357 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
35361 #: ../src/guestfs.pod:1140
35363 "Although the standard naming scheme and automatic translation is useful for "
35364 "simple programs and guestfish scripts, for larger programs it is best not to "
35365 "rely on this mechanism."
35369 #: ../src/guestfs.pod:1144
35371 "Where possible for maximum future portability programs using libguestfs "
35372 "should use these future-proof techniques:"
35376 #: ../src/guestfs.pod:1151
35378 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
35379 "device names, and then use those names directly."
35383 #: ../src/guestfs.pod:1154
35384 msgid "Since those device names exist by definition, they will never be translated."
35388 #: ../src/guestfs.pod:1159
35390 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
35391 "filesystem labels."
35395 #: ../src/guestfs.pod:1166
35397 "This section discusses security implications of using libguestfs, "
35398 "particularly with untrusted or malicious guests or disk images."
35402 #: ../src/guestfs.pod:1169
35403 msgid "GENERAL SECURITY CONSIDERATIONS"
35407 #: ../src/guestfs.pod:1171
35409 "Be careful with any files or data that you download from a guest (by "
35410 "\"download\" we mean not just the L</guestfs_download> command but any "
35411 "command that reads files, filenames, directories or anything else from a "
35412 "disk image). An attacker could manipulate the data to fool your program "
35413 "into doing the wrong thing. Consider cases such as:"
35417 #: ../src/guestfs.pod:1181
35418 msgid "the data (file etc) not being present"
35422 #: ../src/guestfs.pod:1185
35423 msgid "being present but empty"
35427 #: ../src/guestfs.pod:1189
35428 msgid "being much larger than normal"
35432 #: ../src/guestfs.pod:1193
35433 msgid "containing arbitrary 8 bit data"
35437 #: ../src/guestfs.pod:1197
35438 msgid "being in an unexpected character encoding"
35442 #: ../src/guestfs.pod:1201
35443 msgid "containing homoglyphs."
35447 #: ../src/guestfs.pod:1205
35448 msgid "SECURITY OF MOUNTING FILESYSTEMS"
35452 #: ../src/guestfs.pod:1207
35454 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
35455 "(VFS) module can sometimes be escalated into exploits by deliberately "
35456 "creating a malicious, malformed filesystem. These exploits are very severe "
35457 "for two reasons. Firstly there are very many filesystem drivers in the "
35458 "kernel, and many of them are infrequently used and not much developer "
35459 "attention has been paid to the code. Linux userspace helps potential "
35460 "crackers by detecting the filesystem type and automatically choosing the "
35461 "right VFS driver, even if that filesystem type is obscure or unexpected for "
35462 "the administrator. Secondly, a kernel-level exploit is like a local root "
35463 "exploit (worse in some ways), giving immediate and total access to the "
35464 "system right down to the hardware level."
35468 #: ../src/guestfs.pod:1220
35470 "That explains why you should never mount a filesystem from an untrusted "
35471 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
35472 "inside a qemu virtual machine, usually running as a non-root user. The "
35473 "attacker would need to write a filesystem which first exploited the kernel, "
35474 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
35475 "the libguestfs protocol, and finally to be as serious as the host kernel "
35476 "exploit it would need to escalate its privileges to root. This multi-step "
35477 "escalation, performed by a static piece of data, is thought to be extremely "
35478 "hard to do, although we never say 'never' about security issues."
35482 #: ../src/guestfs.pod:1231
35484 "In any case callers can reduce the attack surface by forcing the filesystem "
35485 "type when mounting (use L</guestfs_mount_vfs>)."
35489 #: ../src/guestfs.pod:1234
35490 msgid "PROTOCOL SECURITY"
35494 #: ../src/guestfs.pod:1236
35496 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
35497 "defined upper message size. However a program that uses libguestfs must "
35498 "also take care - for example you can write a program that downloads a binary "
35499 "from a disk image and executes it locally, and no amount of protocol "
35500 "security will save you from the consequences."
35504 #: ../src/guestfs.pod:1242
35505 msgid "INSPECTION SECURITY"
35509 #: ../src/guestfs.pod:1244
35511 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
35512 "directly from the guest, and these could contain any 8 bit data. Callers "
35513 "should be careful to escape these before printing them to a structured file "
35514 "(for example, use HTML escaping if creating a web page)."
35518 #: ../src/guestfs.pod:1250
35520 "Guest configuration may be altered in unusual ways by the administrator of "
35521 "the virtual machine, and may not reflect reality (particularly for untrusted "
35522 "or actively malicious guests). For example we parse the hostname from "
35523 "configuration files like C</etc/sysconfig/network> that we find in the "
35524 "guest, but the guest administrator can easily manipulate these files to "
35525 "provide the wrong hostname."
35529 #: ../src/guestfs.pod:1258
35531 "The inspection API parses guest configuration using two external libraries: "
35532 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
35533 "designed to be robust in the face of malicious data, although denial of "
35534 "service attacks are still possible, for example with oversized configuration "
35539 #: ../src/guestfs.pod:1264
35540 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
35544 #: ../src/guestfs.pod:1266
35546 "Be very cautious about running commands from the guest. By running a "
35547 "command in the guest, you are giving CPU time to a binary that you do not "
35548 "control, under the same user account as the library, albeit wrapped in qemu "
35549 "virtualization. More information and alternatives can be found in the "
35550 "section L</RUNNING COMMANDS>."
35554 #: ../src/guestfs.pod:1272
35555 msgid "CVE-2010-3851"
35559 #: ../src/guestfs.pod:1274
35560 msgid "https://bugzilla.redhat.com/642934"
35564 #: ../src/guestfs.pod:1276
35566 "This security bug concerns the automatic disk format detection that qemu "
35567 "does on disk images."
35571 #: ../src/guestfs.pod:1279
35573 "A raw disk image is just the raw bytes, there is no header. Other disk "
35574 "images like qcow2 contain a special header. Qemu deals with this by looking "
35575 "for one of the known headers, and if none is found then assuming the disk "
35576 "image must be raw."
35580 #: ../src/guestfs.pod:1284
35582 "This allows a guest which has been given a raw disk image to write some "
35583 "other header. At next boot (or when the disk image is accessed by "
35584 "libguestfs) qemu would do autodetection and think the disk image format was, "
35585 "say, qcow2 based on the header written by the guest."
35589 #: ../src/guestfs.pod:1289
35591 "This in itself would not be a problem, but qcow2 offers many features, one "
35592 "of which is to allow a disk image to refer to another image (called the "
35593 "\"backing disk\"). It does this by placing the path to the backing disk "
35594 "into the qcow2 header. This path is not validated and could point to any "
35595 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
35596 "\"holes\" in the qcow2 disk image, which of course is completely under the "
35597 "control of the attacker."
35601 #: ../src/guestfs.pod:1297
35602 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
35606 #: ../src/guestfs.pod:1304
35607 msgid "You have enabled the network or have opened the disk in write mode."
35611 #: ../src/guestfs.pod:1308
35613 "You are also running untrusted code from the guest (see L</RUNNING "
35618 #: ../src/guestfs.pod:1313
35620 "The way to avoid this is to specify the expected disk format when adding "
35621 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
35622 "should always do this if the disk is raw format, and it's a good idea for "
35627 #: ../src/guestfs.pod:1318
35629 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
35630 "format is fetched from libvirt and passed through."
35634 #: ../src/guestfs.pod:1321
35636 "For libguestfs tools, use the I<--format> command line parameter as "
35641 #: ../src/guestfs.pod:1324
35642 msgid "CONNECTION MANAGEMENT"
35646 #: ../src/guestfs.pod:1326
35647 msgid "guestfs_h *"
35651 #: ../src/guestfs.pod:1328
35653 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
35654 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
35655 "handle and release all resources used."
35659 #: ../src/guestfs.pod:1332
35661 "For information on using multiple handles and threads, see the section "
35662 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
35666 #: ../src/guestfs.pod:1335
35667 msgid "guestfs_create"
35671 #: ../src/guestfs.pod:1337
35674 " guestfs_h *guestfs_create (void);\n"
35679 #: ../src/guestfs.pod:1339
35680 msgid "Create a connection handle."
35684 #: ../src/guestfs.pod:1341
35686 "On success this returns a non-NULL pointer to a handle. On error it returns "
35691 #: ../src/guestfs.pod:1344
35693 "You have to \"configure\" the handle after creating it. This includes "
35694 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
35695 "handle at least once."
35699 #: ../src/guestfs.pod:1348
35700 msgid "After configuring the handle, you have to call L</guestfs_launch>."
35704 #: ../src/guestfs.pod:1350
35706 "You may also want to configure error handling for the handle. See the "
35707 "L</ERROR HANDLING> section below."
35711 #: ../src/guestfs.pod:1353
35712 msgid "guestfs_close"
35716 #: ../src/guestfs.pod:1355
35719 " void guestfs_close (guestfs_h *g);\n"
35724 #: ../src/guestfs.pod:1357
35725 msgid "This closes the connection handle and frees up all resources used."
35729 #: ../src/guestfs.pod:1359
35731 "If autosync was set on the handle and the handle was launched, then this "
35732 "implicitly calls various functions to unmount filesystems and sync the "
35733 "disk. See L</guestfs_set_autosync> for more details."
35737 #: ../src/guestfs.pod:1363
35738 msgid "If a close callback was set on the handle, then it is called."
35742 #: ../src/guestfs.pod:1365
35743 msgid "ERROR HANDLING"
35747 #: ../src/guestfs.pod:1367
35749 "API functions can return errors. For example, almost all functions that "
35750 "return C<int> will return C<-1> to indicate an error."
35754 #: ../src/guestfs.pod:1370
35756 "Additional information is available for errors: an error message string and "
35757 "optionally an error number (errno) if the thing that failed was a system "
35762 #: ../src/guestfs.pod:1374
35764 "You can get at the additional information about the last error on the handle "
35765 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
35766 "up an error handler with L</guestfs_set_error_handler>."
35770 #: ../src/guestfs.pod:1379
35772 "When the handle is created, a default error handler is installed which "
35773 "prints the error message string to C<stderr>. For small short-running "
35774 "command line programs it is sufficient to do:"
35778 #: ../src/guestfs.pod:1383
35781 " if (guestfs_launch (g) == -1)\n"
35782 " exit (EXIT_FAILURE);\n"
35787 #: ../src/guestfs.pod:1386
35789 "since the default error handler will ensure that an error message has been "
35790 "printed to C<stderr> before the program exits."
35794 #: ../src/guestfs.pod:1389
35796 "For other programs the caller will almost certainly want to install an "
35797 "alternate error handler or do error handling in-line like this:"
35801 #: ../src/guestfs.pod:1392
35804 " /* This disables the default behaviour of printing errors\n"
35806 " guestfs_set_error_handler (g, NULL, NULL);\n"
35811 #: ../src/guestfs.pod:1396
35814 " if (guestfs_launch (g) == -1) {\n"
35815 " /* Examine the error message and print it etc. */\n"
35816 " char *msg = guestfs_last_error (g);\n"
35817 " int errnum = guestfs_last_errno (g);\n"
35818 " fprintf (stderr, \"%s\", msg);\n"
35819 " if (errnum != 0)\n"
35820 " fprintf (stderr, \": %s\", strerror (errnum));\n"
35821 " fprintf (stderr, \"\\n\");\n"
35828 #: ../src/guestfs.pod:1407
35830 "Out of memory errors are handled differently. The default action is to call "
35831 "L<abort(3)>. If this is undesirable, then you can set a handler using "
35832 "L</guestfs_set_out_of_memory_handler>."
35836 #: ../src/guestfs.pod:1411
35838 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
35839 "because there is no handle if this happens there is no way to get additional "
35840 "error information. However L</guestfs_create> is supposed to be a "
35841 "lightweight operation which can only fail because of insufficient memory (it "
35842 "returns NULL in this case)."
35846 #: ../src/guestfs.pod:1417
35847 msgid "guestfs_last_error"
35851 #: ../src/guestfs.pod:1419
35854 " const char *guestfs_last_error (guestfs_h *g);\n"
35859 #: ../src/guestfs.pod:1421
35861 "This returns the last error message that happened on C<g>. If there has not "
35862 "been an error since the handle was created, then this returns C<NULL>."
35866 #: ../src/guestfs.pod:1425
35868 "The lifetime of the returned string is until the next error occurs, or "
35869 "L</guestfs_close> is called."
35873 #: ../src/guestfs.pod:1428
35874 msgid "guestfs_last_errno"
35878 #: ../src/guestfs.pod:1430
35881 " int guestfs_last_errno (guestfs_h *g);\n"
35886 #: ../src/guestfs.pod:1432
35887 msgid "This returns the last error number (errno) that happened on C<g>."
35891 #: ../src/guestfs.pod:1434
35892 msgid "If successful, an errno integer not equal to zero is returned."
35896 #: ../src/guestfs.pod:1436
35897 msgid "If no error, this returns 0. This call can return 0 in three situations:"
35901 #: ../src/guestfs.pod:1443
35902 msgid "There has not been any error on the handle."
35906 #: ../src/guestfs.pod:1447
35908 "There has been an error but the errno was meaningless. This corresponds to "
35909 "the case where the error did not come from a failed system call, but for "
35910 "some other reason."
35914 #: ../src/guestfs.pod:1453
35916 "There was an error from a failed system call, but for some reason the errno "
35917 "was not captured and returned. This usually indicates a bug in libguestfs."
35921 #: ../src/guestfs.pod:1459
35923 "Libguestfs tries to convert the errno from inside the applicance into a "
35924 "corresponding errno for the caller (not entirely trivial: the appliance "
35925 "might be running a completely different operating system from the library "
35926 "and error numbers are not standardized across Un*xen). If this could not be "
35927 "done, then the error is translated to C<EINVAL>. In practice this should "
35928 "only happen in very rare circumstances."
35932 #: ../src/guestfs.pod:1467
35933 msgid "guestfs_set_error_handler"
35937 #: ../src/guestfs.pod:1469
35940 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
35942 " const char *msg);\n"
35943 " void guestfs_set_error_handler (guestfs_h *g,\n"
35944 " guestfs_error_handler_cb cb,\n"
35945 " void *opaque);\n"
35950 #: ../src/guestfs.pod:1476
35952 "The callback C<cb> will be called if there is an error. The parameters "
35953 "passed to the callback are an opaque data pointer and the error message "
35958 #: ../src/guestfs.pod:1480
35960 "C<errno> is not passed to the callback. To get that the callback must call "
35961 "L</guestfs_last_errno>."
35965 #: ../src/guestfs.pod:1483
35967 "Note that the message string C<msg> is freed as soon as the callback "
35968 "function returns, so if you want to stash it somewhere you must make your "
35973 #: ../src/guestfs.pod:1487
35974 msgid "The default handler prints messages on C<stderr>."
35978 #: ../src/guestfs.pod:1489
35979 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
35983 #: ../src/guestfs.pod:1491
35984 msgid "guestfs_get_error_handler"
35988 #: ../src/guestfs.pod:1493
35991 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
35992 " void **opaque_rtn);\n"
35997 #: ../src/guestfs.pod:1496
35998 msgid "Returns the current error handler callback."
36002 #: ../src/guestfs.pod:1498
36003 msgid "guestfs_set_out_of_memory_handler"
36007 #: ../src/guestfs.pod:1500
36010 " typedef void (*guestfs_abort_cb) (void);\n"
36011 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
36012 " guestfs_abort_cb);\n"
36017 #: ../src/guestfs.pod:1504
36019 "The callback C<cb> will be called if there is an out of memory situation. "
36020 "I<Note this callback must not return>."
36024 #: ../src/guestfs.pod:1507
36025 msgid "The default is to call L<abort(3)>."
36029 #: ../src/guestfs.pod:1509
36030 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
36034 #: ../src/guestfs.pod:1512
36035 msgid "guestfs_get_out_of_memory_handler"
36039 #: ../src/guestfs.pod:1514
36042 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
36047 #: ../src/guestfs.pod:1516
36048 msgid "This returns the current out of memory handler."
36052 #: ../src/guestfs.pod:1518
36057 #: ../src/guestfs.pod:1522
36062 #: ../src/guestfs.pod:1524
36067 #: ../src/guestfs.pod:1526
36068 msgid "AVAILABILITY"
36072 #: ../src/guestfs.pod:1528
36073 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
36077 #: ../src/guestfs.pod:1530
36079 "Using L</guestfs_available> you can test availability of the following "
36080 "groups of functions. This test queries the appliance to see if the "
36081 "appliance you are currently using supports the functionality."
36085 #: ../src/guestfs.pod:1535
36086 msgid "@AVAILABILITY@"
36090 #: ../src/guestfs.pod:1537
36091 msgid "GUESTFISH supported COMMAND"
36095 #: ../src/guestfs.pod:1539
36097 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
36098 "prints out the available groups and whether they are supported by this build "
36099 "of libguestfs. Note however that you have to do C<run> first."
36103 #: ../src/guestfs.pod:1544
36104 msgid "SINGLE CALLS AT COMPILE TIME"
36108 #: ../src/guestfs.pod:1546
36110 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
36111 "function, such as:"
36115 #: ../src/guestfs.pod:1549
36118 " #define LIBGUESTFS_HAVE_DD 1\n"
36123 #: ../src/guestfs.pod:1551
36124 msgid "if L</guestfs_dd> is available."
36128 #: ../src/guestfs.pod:1553
36130 "Before version 1.5.8, if you needed to test whether a single libguestfs "
36131 "function is available at compile time, we recommended using build tools such "
36132 "as autoconf or cmake. For example in autotools you could use:"
36136 #: ../src/guestfs.pod:1558
36139 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
36140 " AC_CHECK_FUNCS([guestfs_dd])\n"
36145 #: ../src/guestfs.pod:1561
36147 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
36152 #: ../src/guestfs.pod:1564
36153 msgid "SINGLE CALLS AT RUN TIME"
36157 #: ../src/guestfs.pod:1566
36159 "Testing at compile time doesn't guarantee that a function really exists in "
36160 "the library. The reason is that you might be dynamically linked against a "
36161 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
36162 "This situation unfortunately results in a segmentation fault, which is a "
36163 "shortcoming of the C dynamic linking system itself."
36167 #: ../src/guestfs.pod:1573
36169 "You can use L<dlopen(3)> to test if a function is available at run time, as "
36170 "in this example program (note that you still need the compile time check as "
36175 #: ../src/guestfs.pod:1577
36178 " #include <stdio.h>\n"
36179 " #include <stdlib.h>\n"
36180 " #include <unistd.h>\n"
36181 " #include <dlfcn.h>\n"
36182 " #include <guestfs.h>\n"
36187 #: ../src/guestfs.pod:1583
36192 " #ifdef LIBGUESTFS_HAVE_DD\n"
36194 " int has_function;\n"
36199 #: ../src/guestfs.pod:1589
36202 " /* Test if the function guestfs_dd is really available. */\n"
36203 " dl = dlopen (NULL, RTLD_LAZY);\n"
36205 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
36206 " exit (EXIT_FAILURE);\n"
36208 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
36214 #: ../src/guestfs.pod:1598
36217 " if (!has_function)\n"
36218 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
36220 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
36221 " /* Now it's safe to call\n"
36222 " guestfs_dd (g, \"foo\", \"bar\");\n"
36226 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
36233 #: ../src/guestfs.pod:1611
36235 "You may think the above is an awful lot of hassle, and it is. There are "
36236 "other ways outside of the C linking system to ensure that this kind of "
36237 "incompatibility never arises, such as using package versioning:"
36241 #: ../src/guestfs.pod:1616
36244 " Requires: libguestfs >= 1.0.80\n"
36249 #: ../src/guestfs.pod:1618
36250 msgid "CALLS WITH OPTIONAL ARGUMENTS"
36254 #: ../src/guestfs.pod:1620
36256 "A recent feature of the API is the introduction of calls which take optional "
36257 "arguments. In C these are declared 3 ways. The main way is as a call which "
36258 "takes variable arguments (ie. C<...>), as in this example:"
36262 #: ../src/guestfs.pod:1625
36265 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
36270 #: ../src/guestfs.pod:1627
36272 "Call this with a list of optional arguments, terminated by C<-1>. So to "
36273 "call with no optional arguments specified:"
36277 #: ../src/guestfs.pod:1630
36280 " guestfs_add_drive_opts (g, filename, -1);\n"
36285 #: ../src/guestfs.pod:1632
36286 msgid "With a single optional argument:"
36290 #: ../src/guestfs.pod:1634
36293 " guestfs_add_drive_opts (g, filename,\n"
36294 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
36300 #: ../src/guestfs.pod:1638
36305 #: ../src/guestfs.pod:1640
36308 " guestfs_add_drive_opts (g, filename,\n"
36309 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
36310 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
36316 #: ../src/guestfs.pod:1645
36318 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
36323 #: ../src/guestfs.pod:1648
36324 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
36328 #: ../src/guestfs.pod:1650
36330 "The second variant has the same name with the suffix C<_va>, which works the "
36331 "same way but takes a C<va_list>. See the C manual for details. For the "
36332 "example function, this is declared:"
36336 #: ../src/guestfs.pod:1654
36339 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
36340 " va_list args);\n"
36345 #: ../src/guestfs.pod:1657
36346 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
36350 #: ../src/guestfs.pod:1659
36352 "The third variant is useful where you need to construct these calls. You "
36353 "pass in a structure where you fill in the optional fields. The structure "
36354 "has a bitmask as the first element which you must set to indicate which "
36355 "fields you have filled in. For our example function the structure and call "
36360 #: ../src/guestfs.pod:1665
36363 " struct guestfs_add_drive_opts_argv {\n"
36364 " uint64_t bitmask;\n"
36366 " const char *format;\n"
36369 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
36370 " const struct guestfs_add_drive_opts_argv *optargs);\n"
36375 #: ../src/guestfs.pod:1674
36376 msgid "You could call it like this:"
36380 #: ../src/guestfs.pod:1676
36383 " struct guestfs_add_drive_opts_argv optargs = {\n"
36384 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
36385 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
36386 " .readonly = 1,\n"
36387 " .format = \"qcow2\"\n"
36393 #: ../src/guestfs.pod:1683
36396 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
36401 #: ../src/guestfs.pod:1691
36402 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
36406 #: ../src/guestfs.pod:1696
36407 msgid "You do not need to fill in all fields of the structure."
36411 #: ../src/guestfs.pod:1700
36413 "There must be a one-to-one correspondence between fields of the structure "
36414 "that are filled in, and bits set in the bitmask."
36418 #: ../src/guestfs.pod:1705
36419 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
36423 #: ../src/guestfs.pod:1707
36425 "In other languages, optional arguments are expressed in the way that is "
36426 "natural for that language. We refer you to the language-specific "
36427 "documentation for more details on that."
36431 #: ../src/guestfs.pod:1711
36432 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
36436 #: ../src/guestfs.pod:1713
36437 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
36441 #: ../src/guestfs.pod:1715
36443 "B<Note:> This section documents the generic event mechanism introduced in "
36444 "libguestfs 1.10, which you should use in new code if possible. The old "
36445 "functions C<guestfs_set_log_message_callback>, "
36446 "C<guestfs_set_subprocess_quit_callback>, "
36447 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
36448 "C<guestfs_set_progress_callback> are no longer documented in this manual "
36449 "page. Because of the ABI guarantee, the old functions continue to work."
36453 #: ../src/guestfs.pod:1724
36455 "Handles generate events when certain things happen, such as log messages "
36456 "being generated, progress messages during long-running operations, or the "
36457 "handle being closed. The API calls described below let you register a "
36458 "callback to be called when events happen. You can register multiple "
36459 "callbacks (for the same, different or overlapping sets of events), and "
36460 "individually remove callbacks. If callbacks are not removed, then they "
36461 "remain in force until the handle is closed."
36465 #: ../src/guestfs.pod:1732
36467 "In the current implementation, events are only generated synchronously: that "
36468 "means that events (and hence callbacks) can only happen while you are in the "
36469 "middle of making another libguestfs call. The callback is called in the "
36474 #: ../src/guestfs.pod:1737
36476 "Events may contain a payload, usually nothing (void), an array of 64 bit "
36477 "unsigned integers, or a message buffer. Payloads are discussed later on."
36481 #: ../src/guestfs.pod:1741
36482 msgid "CLASSES OF EVENTS"
36486 #: ../src/guestfs.pod:1745
36487 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
36491 #: ../src/guestfs.pod:1748
36493 "The callback function will be called while the handle is being closed "
36494 "(synchronously from L</guestfs_close>)."
36498 #: ../src/guestfs.pod:1751
36500 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
36501 "handles that are open when the program exits. This means that this callback "
36502 "might be called indirectly from L<exit(3)>, which can cause unexpected "
36503 "problems in higher-level languages (eg. if your HLL interpreter has already "
36504 "been cleaned up by the time this is called, and if your callback then jumps "
36505 "into some HLL function)."
36509 #: ../src/guestfs.pod:1758
36511 "If no callback is registered: the handle is closed without any callback "
36516 #: ../src/guestfs.pod:1761
36517 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
36521 #: ../src/guestfs.pod:1764
36523 "The callback function will be called when the child process quits, either "
36524 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
36525 "corresponds to a transition from any state to the CONFIG state)."
36529 #: ../src/guestfs.pod:1768 ../src/guestfs.pod:1777 ../src/guestfs.pod:1894
36530 msgid "If no callback is registered: the event is ignored."
36534 #: ../src/guestfs.pod:1770
36535 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
36539 #: ../src/guestfs.pod:1773
36541 "The callback function will be called when the child process becomes ready "
36542 "first time after it has been launched. (This corresponds to a transition "
36543 "from LAUNCHING to the READY state)."
36547 #: ../src/guestfs.pod:1779
36548 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
36552 #: ../src/guestfs.pod:1782
36554 "Some long-running operations can generate progress messages. If this "
36555 "callback is registered, then it will be called each time a progress message "
36556 "is generated (usually two seconds after the operation started, and three "
36557 "times per second thereafter until it completes, although the frequency may "
36558 "change in future versions)."
36562 #: ../src/guestfs.pod:1788
36564 "The callback receives in the payload four unsigned 64 bit numbers which are "
36565 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
36569 #: ../src/guestfs.pod:1791
36571 "The units of C<total> are not defined, although for some operations C<total> "
36572 "may relate in some way to the amount of data to be transferred (eg. in bytes "
36573 "or megabytes), and C<position> may be the portion which has been "
36578 #: ../src/guestfs.pod:1796
36579 msgid "The only defined and stable parts of the API are:"
36583 #: ../src/guestfs.pod:1802
36585 "The callback can display to the user some type of progress bar or indicator "
36586 "which shows the ratio of C<position>:C<total>."
36590 #: ../src/guestfs.pod:1807
36591 msgid "0 E<lt>= C<position> E<lt>= C<total>"
36595 #: ../src/guestfs.pod:1811
36597 "If any progress notification is sent during a call, then a final progress "
36598 "notification is always sent when C<position> = C<total> (I<unless> the call "
36599 "fails with an error)."
36603 #: ../src/guestfs.pod:1815
36605 "This is to simplify caller code, so callers can easily set the progress "
36606 "indicator to \"100%\" at the end of the operation, without requiring special "
36607 "code to detect this case."
36611 #: ../src/guestfs.pod:1821
36613 "For some calls we are unable to estimate the progress of the call, but we "
36614 "can still generate progress messages to indicate activity. This is known as "
36615 "\"pulse mode\", and is directly supported by certain progress bar "
36616 "implementations (eg. GtkProgressBar)."
36620 #: ../src/guestfs.pod:1826
36622 "For these calls, zero or more progress messages are generated with "
36623 "C<position = 0> and C<total = 1>, followed by a final message with "
36624 "C<position = total = 1>."
36628 #: ../src/guestfs.pod:1830
36630 "As noted above, if the call fails with an error then the final message may "
36631 "not be generated."
36635 #: ../src/guestfs.pod:1835
36637 "The callback also receives the procedure number (C<proc_nr>) and serial "
36638 "number (C<serial>) of the call. These are only useful for debugging "
36639 "protocol issues, and the callback can normally ignore them. The callback "
36640 "may want to print these numbers in error messages or debugging messages."
36644 #: ../src/guestfs.pod:1841
36645 msgid "If no callback is registered: progress messages are discarded."
36649 #: ../src/guestfs.pod:1843
36650 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
36654 #: ../src/guestfs.pod:1846
36656 "The callback function is called whenever a log message is generated by qemu, "
36657 "the appliance kernel, guestfsd (daemon), or utility programs."
36661 #: ../src/guestfs.pod:1849
36663 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
36664 "(L</guestfs_launch>) then additional debug messages are generated."
36668 #: ../src/guestfs.pod:1852 ../src/guestfs.pod:1866
36670 "If no callback is registered: the messages are discarded unless the verbose "
36671 "flag is set in which case they are sent to stderr. You can override the "
36672 "printing of verbose messages to stderr by setting up a callback."
36676 #: ../src/guestfs.pod:1857
36677 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
36681 #: ../src/guestfs.pod:1860
36683 "The callback function is called whenever a log message is generated by the "
36684 "library part of libguestfs."
36688 #: ../src/guestfs.pod:1863
36690 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
36691 "messages are generated."
36695 #: ../src/guestfs.pod:1871
36696 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
36700 #: ../src/guestfs.pod:1874
36702 "The callback function is called whenever a trace message is generated. This "
36703 "only applies if the trace flag (L</guestfs_set_trace>) is set."
36707 #: ../src/guestfs.pod:1877
36709 "If no callback is registered: the messages are sent to stderr. You can "
36710 "override the printing of trace messages to stderr by setting up a callback."
36714 #: ../src/guestfs.pod:1881
36715 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
36719 #: ../src/guestfs.pod:1884
36720 msgid "The callback function is called whenever a libguestfs function is entered."
36724 #: ../src/guestfs.pod:1887
36726 "The payload is a string which contains the name of the function that we are "
36727 "entering (not including C<guestfs_> prefix)."
36731 #: ../src/guestfs.pod:1890
36733 "Note that libguestfs functions can call themselves, so you may see many "
36734 "events from a single call. A few libguestfs functions do not generate this "
36739 #: ../src/guestfs.pod:1898
36740 msgid "guestfs_set_event_callback"
36744 #: ../src/guestfs.pod:1900
36747 " int guestfs_set_event_callback (guestfs_h *g,\n"
36748 " guestfs_event_callback cb,\n"
36749 " uint64_t event_bitmask,\n"
36751 " void *opaque);\n"
36756 #: ../src/guestfs.pod:1906
36758 "This function registers a callback (C<cb>) for all event classes in the "
36759 "C<event_bitmask>."
36763 #: ../src/guestfs.pod:1909
36765 "For example, to register for all log message events, you could call this "
36766 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
36767 "To register a single callback for all possible classes of events, use "
36768 "C<GUESTFS_EVENT_ALL>."
36772 #: ../src/guestfs.pod:1915
36773 msgid "C<flags> should always be passed as 0."
36777 #: ../src/guestfs.pod:1917
36779 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
36780 "it for any purpose."
36784 #: ../src/guestfs.pod:1920
36786 "The return value is the event handle (an integer) which you can use to "
36787 "delete the callback (see below)."
36791 #: ../src/guestfs.pod:1923
36793 "If there is an error, this function returns C<-1>, and sets the error in the "
36794 "handle in the usual way (see L</guestfs_last_error> etc.)"
36798 #: ../src/guestfs.pod:1926
36800 "Callbacks remain in effect until they are deleted, or until the handle is "
36805 #: ../src/guestfs.pod:1929
36807 "In the case where multiple callbacks are registered for a particular event "
36808 "class, all of the callbacks are called. The order in which multiple "
36809 "callbacks are called is not defined."
36813 #: ../src/guestfs.pod:1933
36814 msgid "guestfs_delete_event_callback"
36818 #: ../src/guestfs.pod:1935
36821 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
36826 #: ../src/guestfs.pod:1937
36828 "Delete a callback that was previously registered. C<event_handle> should be "
36829 "the integer that was returned by a previous call to "
36830 "C<guestfs_set_event_callback> on the same handle."
36834 #: ../src/guestfs.pod:1941
36835 msgid "guestfs_event_callback"
36839 #: ../src/guestfs.pod:1943
36842 " typedef void (*guestfs_event_callback) (\n"
36845 " uint64_t event,\n"
36846 " int event_handle,\n"
36848 " const char *buf, size_t buf_len,\n"
36849 " const uint64_t *array, size_t array_len);\n"
36854 #: ../src/guestfs.pod:1952
36855 msgid "This is the type of the event callback function that you have to provide."
36859 #: ../src/guestfs.pod:1955
36861 "The basic parameters are: the handle (C<g>), the opaque user pointer "
36862 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
36863 "handle, and C<flags> which in the current API you should ignore."
36867 #: ../src/guestfs.pod:1959
36869 "The remaining parameters contain the event payload (if any). Each event may "
36870 "contain a payload, which usually relates to the event class, but for future "
36871 "proofing your code should be written to handle any payload for any event "
36876 #: ../src/guestfs.pod:1964
36878 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
36879 "there is no message buffer). Note that this message buffer can contain "
36880 "arbitrary 8 bit data, including NUL bytes."
36884 #: ../src/guestfs.pod:1968
36886 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
36887 "moment this is only used for progress messages."
36891 #: ../src/guestfs.pod:1971
36892 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
36896 #: ../src/guestfs.pod:1973
36898 "One motivation for the generic event API was to allow GUI programs to "
36899 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
36900 "unconditionally to C<stderr>."
36904 #: ../src/guestfs.pod:1977
36906 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
36907 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
36908 "messages are not events; you must capture error messages separately)."
36912 #: ../src/guestfs.pod:1982
36914 "Programs have to set up a callback to capture the classes of events of "
36919 #: ../src/guestfs.pod:1985
36923 " guestfs_set_event_callback\n"
36924 " (g, message_callback,\n"
36925 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
36926 " GUESTFS_EVENT_TRACE,\n"
36927 " 0, NULL) == -1)\n"
36928 " if (eh == -1) {\n"
36929 " // handle error in the usual way\n"
36935 #: ../src/guestfs.pod:1995
36937 "The callback can then direct messages to the appropriate place. In this "
36938 "example, messages are directed to syslog:"
36942 #: ../src/guestfs.pod:1998
36946 " message_callback (\n"
36949 " uint64_t event,\n"
36950 " int event_handle,\n"
36952 " const char *buf, size_t buf_len,\n"
36953 " const uint64_t *array, size_t array_len)\n"
36955 " const int priority = LOG_USER|LOG_INFO;\n"
36956 " if (buf_len > 0)\n"
36957 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
36963 #: ../src/guestfs.pod:2013
36964 msgid "CANCELLING LONG TRANSFERS"
36968 #: ../src/guestfs.pod:2015
36970 "Some operations can be cancelled by the caller while they are in progress. "
36971 "Currently only operations that involve uploading or downloading data can be "
36972 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
36973 "parameters in the generator)."
36977 #: ../src/guestfs.pod:2020
36978 msgid "guestfs_user_cancel"
36982 #: ../src/guestfs.pod:2022
36985 " void guestfs_user_cancel (guestfs_h *g);\n"
36990 #: ../src/guestfs.pod:2024
36991 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
36995 #: ../src/guestfs.pod:2027
36997 "Unlike most other libguestfs calls, this function is signal safe and thread "
36998 "safe. You can call it from a signal handler or from another thread, without "
36999 "needing to do any locking."
37003 #: ../src/guestfs.pod:2031
37005 "The transfer that was in progress (if there is one) will stop shortly "
37006 "afterwards, and will return an error. The errno (see "
37007 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
37008 "out if the operation was cancelled or failed because of another error."
37012 #: ../src/guestfs.pod:2037
37014 "No cleanup is performed: for example, if a file was being uploaded then "
37015 "after cancellation there may be a partially uploaded file. It is the "
37016 "caller's responsibility to clean up if necessary."
37020 #: ../src/guestfs.pod:2041
37021 msgid "There are two common places that you might call C<guestfs_user_cancel>."
37025 #: ../src/guestfs.pod:2043
37027 "In an interactive text-based program, you might call it from a C<SIGINT> "
37028 "signal handler so that pressing C<^C> cancels the current operation. (You "
37029 "also need to call L</guestfs_set_pgroup> so that child processes don't "
37030 "receive the C<^C> signal)."
37034 #: ../src/guestfs.pod:2048
37036 "In a graphical program, when the main thread is displaying a progress bar "
37037 "with a cancel button, wire up the cancel button to call this function."
37041 #: ../src/guestfs.pod:2052
37042 msgid "PRIVATE DATA AREA"
37046 #: ../src/guestfs.pod:2054
37048 "You can attach named pieces of private data to the libguestfs handle, fetch "
37049 "them by name, and walk over them, for the lifetime of the handle. This is "
37050 "called the private data area and is only available from the C API."
37054 #: ../src/guestfs.pod:2059
37055 msgid "To attach a named piece of data, use the following call:"
37059 #: ../src/guestfs.pod:2061
37062 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
37067 #: ../src/guestfs.pod:2063
37069 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
37070 "pointer (which can be C<NULL>). Any previous item with the same key is "
37075 #: ../src/guestfs.pod:2067
37077 "You can use any C<key> you want, but your key should I<not> start with an "
37078 "underscore character. Keys beginning with an underscore character are "
37079 "reserved for internal libguestfs purposes (eg. for implementing language "
37080 "bindings). It is recommended that you prefix the key with some unique "
37081 "string to avoid collisions with other users."
37085 #: ../src/guestfs.pod:2073
37086 msgid "To retrieve the pointer, use:"
37090 #: ../src/guestfs.pod:2075
37093 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
37098 #: ../src/guestfs.pod:2077
37100 "This function returns C<NULL> if either no data is found associated with "
37101 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
37106 #: ../src/guestfs.pod:2081
37108 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
37109 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
37110 "all. In particular, libguestfs does I<not> try to free the data when the "
37111 "handle is closed. If the data must be freed, then the caller must either "
37112 "free it before calling L</guestfs_close> or must set up a close callback to "
37113 "do it (see L</GUESTFS_EVENT_CLOSE>)."
37117 #: ../src/guestfs.pod:2088
37118 msgid "To walk over all entries, use these two functions:"
37122 #: ../src/guestfs.pod:2090
37125 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
37130 #: ../src/guestfs.pod:2092
37133 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
37138 #: ../src/guestfs.pod:2094
37140 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
37141 "not have any particular meaning -- keys are not returned in any defined "
37142 "order). A pointer to the key is returned in C<*key_rtn> and the "
37143 "corresponding data pointer is returned from the function. C<NULL> is "
37144 "returned if there are no keys stored in the handle."
37148 #: ../src/guestfs.pod:2100
37150 "C<guestfs_next_private> returns the next key, pointer pair. The return "
37151 "value of this function is also C<NULL> is there are no further entries to "
37156 #: ../src/guestfs.pod:2104
37157 msgid "Notes about walking over entries:"
37161 #: ../src/guestfs.pod:2110
37162 msgid "You must not call C<guestfs_set_private> while walking over the entries."
37166 #: ../src/guestfs.pod:2115
37168 "The handle maintains an internal iterator which is reset when you call "
37169 "C<guestfs_first_private>. This internal iterator is invalidated when you "
37170 "call C<guestfs_set_private>."
37174 #: ../src/guestfs.pod:2121
37175 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
37179 #: ../src/guestfs.pod:2123
37182 " guestfs_set_private (g, key, NULL);\n"
37187 #: ../src/guestfs.pod:2125
37188 msgid "then that C<key> is not returned when walking."
37192 #: ../src/guestfs.pod:2129
37194 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
37195 "C<guestfs_next_private> or C<guestfs_set_private>."
37199 #: ../src/guestfs.pod:2135
37201 "The following example code shows how to print all keys and data pointers "
37202 "that are associated with the handle C<g>:"
37206 #: ../src/guestfs.pod:2138
37209 " const char *key;\n"
37210 " void *data = guestfs_first_private (g, &key);\n"
37211 " while (data != NULL)\n"
37213 " printf (\"key = %s, data = %p\\n\", key, data);\n"
37214 " data = guestfs_next_private (g, &key);\n"
37220 #: ../src/guestfs.pod:2146
37222 "More commonly you are only interested in keys that begin with an "
37223 "application-specific prefix C<foo_>. Modify the loop like so:"
37227 #: ../src/guestfs.pod:2149
37230 " const char *key;\n"
37231 " void *data = guestfs_first_private (g, &key);\n"
37232 " while (data != NULL)\n"
37234 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
37235 " printf (\"key = %s, data = %p\\n\", key, data);\n"
37236 " data = guestfs_next_private (g, &key);\n"
37242 #: ../src/guestfs.pod:2158
37244 "If you need to modify keys while walking, then you have to jump back to the "
37245 "beginning of the loop. For example, to delete all keys prefixed with "
37250 #: ../src/guestfs.pod:2162
37253 " const char *key;\n"
37256 " data = guestfs_first_private (g, &key);\n"
37257 " while (data != NULL)\n"
37259 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
37261 " guestfs_set_private (g, key, NULL);\n"
37262 " /* note that 'key' pointer is now invalid, and so is\n"
37263 " the internal iterator */\n"
37266 " data = guestfs_next_private (g, &key);\n"
37272 #: ../src/guestfs.pod:2178
37274 "Note that the above loop is guaranteed to terminate because the keys are "
37275 "being deleted, but other manipulations of keys within the loop might not "
37276 "terminate unless you also maintain an indication of which keys have been "
37281 #: ../src/guestfs.pod:2183
37286 #: ../src/guestfs.pod:2185
37288 "The libguestfs C library can be probed using systemtap or DTrace. This is "
37289 "true of any library, not just libguestfs. However libguestfs also contains "
37290 "static markers to help in probing internal operations."
37294 #: ../src/guestfs.pod:2189
37295 msgid "You can list all the static markers by doing:"
37299 #: ../src/guestfs.pod:2191
37302 " stap -l 'process(\"/usr/lib*/libguestfs.so.0\")\n"
37303 " .provider(\"guestfs\").mark(\"*\")'\n"
37308 #: ../src/guestfs.pod:2194
37310 "B<Note:> These static markers are I<not> part of the stable API and may "
37311 "change in future versions."
37315 #: ../src/guestfs.pod:2197
37316 msgid "SYSTEMTAP SCRIPT EXAMPLE"
37320 #: ../src/guestfs.pod:2199
37322 "This script contains examples of displaying both the static markers and some "
37323 "ordinary C entry points:"
37327 #: ../src/guestfs.pod:2202
37335 #: ../src/guestfs.pod:2204
37338 " function display_time () {\n"
37339 " now = gettimeofday_us ();\n"
37342 " delta = now - last;\n"
37348 #: ../src/guestfs.pod:2211
37351 " printf (\"%d (+%d):\", now, delta);\n"
37357 #: ../src/guestfs.pod:2214
37362 " printf (\"ready\\n\");\n"
37368 #: ../src/guestfs.pod:2219
37371 " /* Display all calls to static markers. */\n"
37372 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
37373 " .provider(\"guestfs\").mark(\"*\") ? {\n"
37374 " display_time();\n"
37375 " printf (\"\\t%s %s\\n\", $$name, $$parms);\n"
37381 #: ../src/guestfs.pod:2226
37384 " /* Display all calls to guestfs_mkfs* functions. */\n"
37385 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
37386 " .function(\"guestfs_mkfs*\") ? {\n"
37387 " display_time();\n"
37388 " printf (\"\\t%s %s\\n\", probefunc(), $$parms);\n"
37394 #: ../src/guestfs.pod:2233
37396 "The script above can be saved to C<test.stap> and run using the L<stap(1)> "
37397 "program. Note that you either have to be root, or you have to add yourself "
37398 "to several special stap groups. Consult the systemtap documentation for "
37399 "more information."
37403 #: ../src/guestfs.pod:2238
37406 " # stap /tmp/test.stap\n"
37412 #: ../src/guestfs.pod:2241
37413 msgid "In another terminal, run a guestfish command such as this:"
37417 #: ../src/guestfs.pod:2245
37418 msgid "In the first terminal, stap trace output similar to this is shown:"
37422 #: ../src/guestfs.pod:2247
37425 " 1318248056692655 (+0):\tlaunch_start\n"
37426 " 1318248056692850 (+195): launch_build_appliance_start\n"
37427 " 1318248056818285 (+125435): launch_build_appliance_end\n"
37428 " 1318248056838059 (+19774): launch_run_qemu\n"
37429 " 1318248061071167 (+4233108): launch_end\n"
37430 " 1318248061280324 (+209157): guestfs_mkfs g=0x1024ab0 fstype=0x46116f "
37431 "device=0x1024e60\n"
37436 #: ../src/guestfs.pod:2254 ../src/guestfs.pod:2259
37441 #: ../src/guestfs.pod:2256
37443 "<!-- old anchor for the next section --> <a "
37444 "name=\"state_machine_and_low_level_event_api\"/>"
37448 #: ../src/guestfs.pod:2261
37449 msgid "ARCHITECTURE"
37453 #: ../src/guestfs.pod:2263
37455 "Internally, libguestfs is implemented by running an appliance (a special "
37456 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
37457 "process of the main program."
37461 #: ../src/guestfs.pod:2267
37464 " ___________________\n"
37466 " | main program |\n"
37468 " | | child process / appliance\n"
37469 " | | __________________________\n"
37471 " +-------------------+ RPC | +-----------------+ |\n"
37472 " | libguestfs <--------------------> guestfsd | |\n"
37473 " | | | +-----------------+ |\n"
37474 " \\___________________/ | | Linux kernel | |\n"
37475 " | +--^--------------+ |\n"
37476 " \\_________|________________/\n"
37478 " _______v______\n"
37481 " | disk image |\n"
37482 " \\______________/\n"
37487 #: ../src/guestfs.pod:2287
37489 "The library, linked to the main program, creates the child process and hence "
37490 "the appliance in the L</guestfs_launch> function."
37494 #: ../src/guestfs.pod:2290
37496 "Inside the appliance is a Linux kernel and a complete stack of userspace "
37497 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
37498 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
37499 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
37500 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
37501 "attached to the qemu process which translates device access by the "
37502 "appliance's Linux kernel into accesses to the image."
37506 #: ../src/guestfs.pod:2299
37508 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
37509 "Although the disk image you are attached to might also be used by some "
37510 "virtual machine, libguestfs doesn't know or care about this. (But you will "
37511 "care if both libguestfs's qemu process and your virtual machine are trying "
37512 "to update the disk image at the same time, since these usually results in "
37513 "massive disk corruption)."
37517 #: ../src/guestfs.pod:2306
37518 msgid "STATE MACHINE"
37522 #: ../src/guestfs.pod:2308
37523 msgid "libguestfs uses a state machine to model the child process:"
37527 #: ../src/guestfs.pod:2310
37531 " guestfs_create\n"
37539 " / | \\ \\ guestfs_launch\n"
37540 " / | _\\__V______\n"
37542 " / | | LAUNCHING |\n"
37543 " / | \\___________/\n"
37545 " / | guestfs_launch\n"
37547 " ______ / __|____V\n"
37548 " / \\ ------> / \\\n"
37549 " | BUSY | | READY |\n"
37550 " \\______/ <------ \\________/\n"
37555 #: ../src/guestfs.pod:2332
37557 "The normal transitions are (1) CONFIG (when the handle is created, but there "
37558 "is no child process), (2) LAUNCHING (when the child process is booting up), "
37559 "(3) alternating between READY and BUSY as commands are issued to, and "
37560 "carried out by, the child process."
37564 #: ../src/guestfs.pod:2337
37566 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
37567 "asynchronously at any time (eg. due to some internal error), and that causes "
37568 "the state to transition back to CONFIG."
37572 #: ../src/guestfs.pod:2341
37574 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
37575 "issued when in the CONFIG state."
37579 #: ../src/guestfs.pod:2344
37581 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
37582 "L</guestfs_launch> blocks until the child process is READY to accept "
37583 "commands (or until some failure or timeout). L</guestfs_launch> internally "
37584 "moves the state from CONFIG to LAUNCHING while it is running."
37588 #: ../src/guestfs.pod:2350
37590 "API actions such as L</guestfs_mount> can only be issued when in the READY "
37591 "state. These API calls block waiting for the command to be carried out "
37592 "(ie. the state to transition to BUSY and then back to READY). There are no "
37593 "non-blocking versions, and no way to issue more than one command per handle "
37594 "at the same time."
37598 #: ../src/guestfs.pod:2356
37600 "Finally, the child process sends asynchronous messages back to the main "
37601 "program, such as kernel log messages. You can register a callback to "
37602 "receive these messages."
37606 #: ../src/guestfs.pod:2360
37611 #: ../src/guestfs.pod:2362
37612 msgid "APPLIANCE BOOT PROCESS"
37616 #: ../src/guestfs.pod:2364
37618 "This process has evolved and continues to evolve. The description here "
37619 "corresponds only to the current version of libguestfs and is provided for "
37620 "information only."
37624 #: ../src/guestfs.pod:2368
37626 "In order to follow the stages involved below, enable libguestfs debugging "
37627 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
37631 #: ../src/guestfs.pod:2373
37632 msgid "Create the appliance"
37636 #: ../src/guestfs.pod:2375
37638 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
37639 "initrd and the appliance."
37643 #: ../src/guestfs.pod:2378
37645 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
37646 "directory if C<TMPDIR> is set)."
37650 #: ../src/guestfs.pod:2381
37652 "For a complete description of how the appliance is created and cached, read "
37653 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
37657 #: ../src/guestfs.pod:2385
37658 msgid "Start qemu and boot the kernel"
37662 #: ../src/guestfs.pod:2387
37663 msgid "qemu is invoked to boot the kernel."
37667 #: ../src/guestfs.pod:2389
37668 msgid "Run the initrd"
37672 #: ../src/guestfs.pod:2391
37674 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
37675 "appliance. The purpose of the initrd is to load enough kernel modules in "
37676 "order that the appliance itself can be mounted and started."
37680 #: ../src/guestfs.pod:2395
37682 "The initrd is a cpio archive called "
37683 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
37687 #: ../src/guestfs.pod:2398
37689 "When the initrd has started you will see messages showing that kernel "
37690 "modules are being loaded, similar to this:"
37694 #: ../src/guestfs.pod:2401
37697 " febootstrap: ext2 mini initrd starting up\n"
37698 " febootstrap: mounting /sys\n"
37699 " febootstrap: internal insmod libcrc32c.ko\n"
37700 " febootstrap: internal insmod crc32c-intel.ko\n"
37705 #: ../src/guestfs.pod:2406
37706 msgid "Find and mount the appliance device"
37710 #: ../src/guestfs.pod:2408
37712 "The appliance is a sparse file containing an ext2 filesystem which contains "
37713 "a familiar (although reduced in size) Linux operating system. It would "
37714 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
37718 #: ../src/guestfs.pod:2412
37720 "The regular disks being inspected by libguestfs are the first devices "
37721 "exposed by qemu (eg. as C</dev/vda>)."
37725 #: ../src/guestfs.pod:2415
37727 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
37728 "there was only one regular disk)."
37732 #: ../src/guestfs.pod:2418
37734 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
37735 "and switch root into the appliance, and run C</init> from the appliance."
37739 #: ../src/guestfs.pod:2422
37740 msgid "If this works successfully you will see messages such as:"
37744 #: ../src/guestfs.pod:2424
37747 " febootstrap: picked /sys/block/vdb/dev as root device\n"
37748 " febootstrap: creating /dev/root as block special 252:16\n"
37749 " febootstrap: mounting new root on /root\n"
37750 " febootstrap: chroot\n"
37751 " Starting /init script ...\n"
37756 #: ../src/guestfs.pod:2430
37758 "Note that C<Starting /init script ...> indicates that the appliance's init "
37759 "script is now running."
37763 #: ../src/guestfs.pod:2433
37764 msgid "Initialize the appliance"
37768 #: ../src/guestfs.pod:2435
37770 "The appliance itself now initializes itself. This involves starting certain "
37771 "processes like C<udev>, possibly printing some debug information, and "
37772 "finally running the daemon (C<guestfsd>)."
37776 #: ../src/guestfs.pod:2439
37781 #: ../src/guestfs.pod:2441
37783 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
37788 #: ../src/guestfs.pod:2444
37791 " verbose daemon enabled\n"
37796 #: ../src/guestfs.pod:2446
37798 "The daemon expects to see a named virtio-serial port exposed by qemu and "
37799 "connected on the other end to the library."
37803 #: ../src/guestfs.pod:2449
37805 "The daemon connects to this port (and hence to the library) and sends a four "
37806 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
37807 "protocol (see below)."
37811 #: ../src/guestfs.pod:2455
37812 msgid "COMMUNICATION PROTOCOL"
37816 #: ../src/guestfs.pod:2457
37818 "Don't rely on using this protocol directly. This section documents how it "
37819 "currently works, but it may change at any time."
37823 #: ../src/guestfs.pod:2460
37825 "The protocol used to talk between the library and the daemon running inside "
37826 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
37827 "1014, RFC 1832, RFC 4506)."
37831 #: ../src/guestfs.pod:2464
37833 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
37834 "this file is automatically generated)."
37838 #: ../src/guestfs.pod:2467
37840 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
37841 "and C<FileOut> parameters, which are handled with very simple request/reply "
37842 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
37843 "parameters, which use the same request and reply messages, but they may also "
37844 "be followed by files sent using a chunked encoding."
37848 #: ../src/guestfs.pod:2474
37849 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
37853 #: ../src/guestfs.pod:2476
37854 msgid "For ordinary functions, the request message is:"
37858 #: ../src/guestfs.pod:2478
37861 " total length (header + arguments,\n"
37862 " but not including the length word itself)\n"
37863 " struct guestfs_message_header (encoded as XDR)\n"
37864 " struct guestfs_<foo>_args (encoded as XDR)\n"
37869 #: ../src/guestfs.pod:2483
37871 "The total length field allows the daemon to allocate a fixed size buffer "
37872 "into which it slurps the rest of the message. As a result, the total length "
37873 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
37874 "effective size of any request is limited to somewhere under this size."
37878 #: ../src/guestfs.pod:2489
37880 "Note also that many functions don't take any arguments, in which case the "
37881 "C<guestfs_I<foo>_args> is completely omitted."
37885 #: ../src/guestfs.pod:2492
37887 "The header contains the procedure number (C<guestfs_proc>) which is how the "
37888 "receiver knows what type of args structure to expect, or none at all."
37892 #: ../src/guestfs.pod:2496
37894 "For functions that take optional arguments, the optional arguments are "
37895 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
37896 "arguments. A bitmask in the header indicates which optional arguments are "
37897 "meaningful. The bitmask is also checked to see if it contains bits set "
37898 "which the daemon does not know about (eg. if more optional arguments were "
37899 "added in a later version of the library), and this causes the call to be "
37904 #: ../src/guestfs.pod:2504
37905 msgid "The reply message for ordinary functions is:"
37909 #: ../src/guestfs.pod:2506
37912 " total length (header + ret,\n"
37913 " but not including the length word itself)\n"
37914 " struct guestfs_message_header (encoded as XDR)\n"
37915 " struct guestfs_<foo>_ret (encoded as XDR)\n"
37920 #: ../src/guestfs.pod:2511
37922 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
37923 "functions that return no formal return values."
37927 #: ../src/guestfs.pod:2514
37928 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
37932 #: ../src/guestfs.pod:2517
37934 "In the case of an error, a flag is set in the header, and the reply message "
37935 "is slightly changed:"
37939 #: ../src/guestfs.pod:2520
37942 " total length (header + error,\n"
37943 " but not including the length word itself)\n"
37944 " struct guestfs_message_header (encoded as XDR)\n"
37945 " struct guestfs_message_error (encoded as XDR)\n"
37950 #: ../src/guestfs.pod:2525
37952 "The C<guestfs_message_error> structure contains the error message as a "
37957 #: ../src/guestfs.pod:2528
37958 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
37962 #: ../src/guestfs.pod:2530
37964 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
37965 "The normal request message is sent (see above). However this is followed by "
37966 "a sequence of file chunks."
37970 #: ../src/guestfs.pod:2534
37973 " total length (header + arguments,\n"
37974 " but not including the length word itself,\n"
37975 " and not including the chunks)\n"
37976 " struct guestfs_message_header (encoded as XDR)\n"
37977 " struct guestfs_<foo>_args (encoded as XDR)\n"
37978 " sequence of chunks for FileIn param #0\n"
37979 " sequence of chunks for FileIn param #1 etc.\n"
37984 #: ../src/guestfs.pod:2542
37985 msgid "The \"sequence of chunks\" is:"
37989 #: ../src/guestfs.pod:2544
37992 " length of chunk (not including length word itself)\n"
37993 " struct guestfs_chunk (encoded as XDR)\n"
37994 " length of chunk\n"
37995 " struct guestfs_chunk (encoded as XDR)\n"
37997 " length of chunk\n"
37998 " struct guestfs_chunk (with data.data_len == 0)\n"
38003 #: ../src/guestfs.pod:2552
38005 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
38006 "is set in the final chunk to indicate either successful completion or early "
38011 #: ../src/guestfs.pod:2556
38013 "At time of writing there are no functions that have more than one FileIn "
38014 "parameter. However this is (theoretically) supported, by sending the "
38015 "sequence of chunks for each FileIn parameter one after another (from left to "
38020 #: ../src/guestfs.pod:2561
38022 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
38023 "transfer. The library does this by sending a chunk with a special flag set "
38024 "to indicate cancellation. When the daemon sees this, it cancels the whole "
38025 "RPC, does I<not> send any reply, and goes back to reading the next request."
38029 #: ../src/guestfs.pod:2567
38031 "The daemon may also cancel. It does this by writing a special word "
38032 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
38033 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
38034 "cancel chunk). The special word is chosen so that even if cancellation "
38035 "happens right at the end of the transfer (after the library has finished "
38036 "writing and has started listening for the reply), the \"spurious\" cancel "
38037 "flag will not be confused with the reply message."
38041 #: ../src/guestfs.pod:2576
38043 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
38044 "limit), and also files where the size is not known in advance (eg. from "
38045 "pipes or sockets). However the chunks are rather small "
38046 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
38047 "to keep much in memory."
38051 #: ../src/guestfs.pod:2582
38052 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
38056 #: ../src/guestfs.pod:2584
38058 "The protocol for FileOut parameters is exactly the same as for FileIn "
38059 "parameters, but with the roles of daemon and library reversed."
38063 #: ../src/guestfs.pod:2587
38066 " total length (header + ret,\n"
38067 " but not including the length word itself,\n"
38068 " and not including the chunks)\n"
38069 " struct guestfs_message_header (encoded as XDR)\n"
38070 " struct guestfs_<foo>_ret (encoded as XDR)\n"
38071 " sequence of chunks for FileOut param #0\n"
38072 " sequence of chunks for FileOut param #1 etc.\n"
38077 #: ../src/guestfs.pod:2595
38078 msgid "INITIAL MESSAGE"
38082 #: ../src/guestfs.pod:2597
38084 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
38085 "which indicates that the guest and daemon is alive. This is what "
38086 "L</guestfs_launch> waits for."
38090 #: ../src/guestfs.pod:2601
38091 msgid "PROGRESS NOTIFICATION MESSAGES"
38095 #: ../src/guestfs.pod:2603
38097 "The daemon may send progress notification messages at any time. These are "
38098 "distinguished by the normal length word being replaced by "
38099 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
38103 #: ../src/guestfs.pod:2607
38105 "The library turns them into progress callbacks (see "
38106 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
38111 #: ../src/guestfs.pod:2611
38113 "The daemon self-limits the frequency of progress messages it sends (see "
38114 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
38119 #: ../src/guestfs.pod:2615
38120 msgid "LIBGUESTFS VERSION NUMBERS"
38124 #: ../src/guestfs.pod:2617
38126 "Since April 2010, libguestfs has started to make separate development and "
38127 "stable releases, along with corresponding branches in our git repository. "
38128 "These separate releases can be identified by version number:"
38132 #: ../src/guestfs.pod:2622
38135 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
38136 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
38142 " | `-------- sub-version\n"
38144 " `------ always '1' because we don't change the ABI\n"
38149 #: ../src/guestfs.pod:2633
38150 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
38154 #: ../src/guestfs.pod:2635
38156 "As time passes we cherry pick fixes from the development branch and backport "
38157 "those into the stable branch, the effect being that the stable branch should "
38158 "get more stable and less buggy over time. So the stable releases are ideal "
38159 "for people who don't need new features but would just like the software to "
38164 #: ../src/guestfs.pod:2641
38165 msgid "Our criteria for backporting changes are:"
38169 #: ../src/guestfs.pod:2647
38171 "Documentation changes which don't affect any code are backported unless the "
38172 "documentation refers to a future feature which is not in stable."
38176 #: ../src/guestfs.pod:2653
38178 "Bug fixes which are not controversial, fix obvious problems, and have been "
38179 "well tested are backported."
38183 #: ../src/guestfs.pod:2658
38185 "Simple rearrangements of code which shouldn't affect how it works get "
38186 "backported. This is so that the code in the two branches doesn't get too "
38187 "far out of step, allowing us to backport future fixes more easily."
38191 #: ../src/guestfs.pod:2664
38193 "We I<don't> backport new features, new APIs, new tools etc, except in one "
38194 "exceptional case: the new feature is required in order to implement an "
38195 "important bug fix."
38199 #: ../src/guestfs.pod:2670
38201 "A new stable branch starts when we think the new features in development are "
38202 "substantial and compelling enough over the current stable branch to warrant "
38203 "it. When that happens we create new stable and development versions 1.N.0 "
38204 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
38205 "stable at this point, but by backporting fixes from development, that branch "
38206 "will stabilize over time."
38210 #: ../src/guestfs.pod:2678
38211 msgid "EXTENDING LIBGUESTFS"
38215 #: ../src/guestfs.pod:2680
38216 msgid "ADDING A NEW API ACTION"
38220 #: ../src/guestfs.pod:2682
38222 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
38223 "documentation) are generated, and this makes it easy to extend the "
38228 #: ../src/guestfs.pod:2686
38229 msgid "To add a new API action there are two changes:"
38233 #: ../src/guestfs.pod:2692
38235 "You need to add a description of the call (name, parameters, return type, "
38236 "tests, documentation) to C<generator/generator_actions.ml>."
38240 #: ../src/guestfs.pod:2695
38242 "There are two sorts of API action, depending on whether the call goes "
38243 "through to the daemon in the appliance, or is serviced entirely by the "
38244 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
38245 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
38246 "an example of the latter, since a trace flag is maintained in the handle and "
38247 "all tracing is done on the library side."
38251 #: ../src/guestfs.pod:2703
38253 "Most new actions are of the first type, and get added to the "
38254 "C<daemon_functions> list. Each function has a unique procedure number used "
38255 "in the RPC protocol which is assigned to that action when we publish "
38256 "libguestfs and cannot be reused. Take the latest procedure number and "
38261 #: ../src/guestfs.pod:2709
38263 "For library-only actions of the second type, add to the "
38264 "C<non_daemon_functions> list. Since these functions are serviced by the "
38265 "library and do not travel over the RPC mechanism to the daemon, these "
38266 "functions do not need a procedure number, and so the procedure number is set "
38271 #: ../src/guestfs.pod:2717
38272 msgid "Implement the action (in C):"
38276 #: ../src/guestfs.pod:2719
38278 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
38279 "C<daemon/> directory."
38283 #: ../src/guestfs.pod:2722
38285 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
38286 "(note: double underscore) in the C<src/> directory."
38290 #: ../src/guestfs.pod:2725
38291 msgid "In either case, use another function as an example of what to do."
38295 #: ../src/guestfs.pod:2729
38296 msgid "After making these changes, use C<make> to compile."
38300 #: ../src/guestfs.pod:2731
38302 "Note that you don't need to implement the RPC, language bindings, manual "
38303 "pages or anything else. It's all automatically generated from the OCaml "
38308 #: ../src/guestfs.pod:2735
38309 msgid "ADDING TESTS FOR AN API ACTION"
38313 #: ../src/guestfs.pod:2737
38315 "You can supply zero or as many tests as you want per API call. The tests "
38316 "can either be added as part of the API description "
38317 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
38318 "drop a script into C<regressions/>. Note that adding a script to "
38319 "C<regressions/> is slower, so if possible use the first method."
38323 #: ../src/guestfs.pod:2743
38325 "The following describes the test environment used when you add an API test "
38326 "in C<generator_actions.ml>."
38330 #: ../src/guestfs.pod:2746
38331 msgid "The test environment has 4 block devices:"
38335 #: ../src/guestfs.pod:2750
38336 msgid "C</dev/sda> 500MB"
38340 #: ../src/guestfs.pod:2752
38341 msgid "General block device for testing."
38345 #: ../src/guestfs.pod:2754
38346 msgid "C</dev/sdb> 50MB"
38350 #: ../src/guestfs.pod:2756
38352 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
38357 #: ../src/guestfs.pod:2759
38358 msgid "C</dev/sdc> 10MB"
38362 #: ../src/guestfs.pod:2761
38363 msgid "Used in a few tests where two block devices are needed."
38367 #: ../src/guestfs.pod:2763
38368 msgid "C</dev/sdd>"
38372 #: ../src/guestfs.pod:2765
38373 msgid "ISO with fixed content (see C<images/test.iso>)."
38377 #: ../src/guestfs.pod:2769
38379 "To be able to run the tests in a reasonable amount of time, the libguestfs "
38380 "appliance and block devices are reused between tests. So don't try testing "
38381 "L</guestfs_kill_subprocess> :-x"
38385 #: ../src/guestfs.pod:2773
38387 "Each test starts with an initial scenario, selected using one of the "
38388 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
38389 "initialize the disks mentioned above in a particular way as documented in "
38390 "C<generator_types.ml>. You should not assume anything about the previous "
38391 "contents of other disks that are not initialized."
38395 #: ../src/guestfs.pod:2779
38397 "You can add a prerequisite clause to any individual test. This is a "
38398 "run-time check, which, if it fails, causes the test to be skipped. Useful "
38399 "if testing a command which might not work on all variations of libguestfs "
38400 "builds. A test that has prerequisite of C<Always> means to run "
38405 #: ../src/guestfs.pod:2785
38407 "In addition, packagers can skip individual tests by setting environment "
38408 "variables before running C<make check>."
38412 #: ../src/guestfs.pod:2788
38415 " SKIP_TEST_<CMD>_<NUM>=1\n"
38420 #: ../src/guestfs.pod:2790
38421 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
38425 #: ../src/guestfs.pod:2792
38430 #: ../src/guestfs.pod:2794
38433 " SKIP_TEST_<CMD>=1\n"
38438 #: ../src/guestfs.pod:2796
38439 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
38443 #: ../src/guestfs.pod:2798
38444 msgid "Packagers can run only certain tests by setting for example:"
38448 #: ../src/guestfs.pod:2800
38451 " TEST_ONLY=\"vfs_type zerofree\"\n"
38456 #: ../src/guestfs.pod:2802
38458 "See C<capitests/tests.c> for more details of how these environment variables "
38463 #: ../src/guestfs.pod:2805
38464 msgid "DEBUGGING NEW API ACTIONS"
38468 #: ../src/guestfs.pod:2807
38469 msgid "Test new actions work before submitting them."
38473 #: ../src/guestfs.pod:2809
38474 msgid "You can use guestfish to try out new commands."
38478 #: ../src/guestfs.pod:2811
38480 "Debugging the daemon is a problem because it runs inside a minimal "
38481 "environment. However you can fprintf messages in the daemon to stderr, and "
38482 "they will show up if you use C<guestfish -v>."
38486 #: ../src/guestfs.pod:2815
38487 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
38491 #: ../src/guestfs.pod:2817
38493 "Our C source code generally adheres to some basic code-formatting "
38494 "conventions. The existing code base is not totally consistent on this "
38495 "front, but we do prefer that contributed code be formatted similarly. In "
38496 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
38497 "indentation level, and other than that, follow the K&R style."
38501 #: ../src/guestfs.pod:2823
38503 "If you use Emacs, add the following to one of one of your start-up files "
38504 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
38508 #: ../src/guestfs.pod:2826
38511 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
38512 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
38513 " (add-hook 'find-file-hook\n"
38514 " '(lambda () (if (and buffer-file-name\n"
38515 " (string-match \"/libguestfs\\\\>\"\n"
38516 " (buffer-file-name))\n"
38517 " (not (string-equal mode-name \"Change Log\"))\n"
38518 " (not (string-equal mode-name \"Makefile\")))\n"
38519 " (setq indent-tabs-mode nil))))\n"
38524 #: ../src/guestfs.pod:2836
38527 " ;;; When editing C sources in libguestfs, use this style.\n"
38528 " (defun libguestfs-c-mode ()\n"
38529 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
38531 " (c-set-style \"K&R\")\n"
38532 " (setq c-indent-level 2)\n"
38533 " (setq c-basic-offset 2))\n"
38534 " (add-hook 'c-mode-hook\n"
38535 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
38536 " (buffer-file-name))\n"
38537 " (libguestfs-c-mode))))\n"
38542 #: ../src/guestfs.pod:2848
38543 msgid "Enable warnings when compiling (and fix any problems this finds):"
38547 #: ../src/guestfs.pod:2851
38550 " ./configure --enable-gcc-warnings\n"
38555 #: ../src/guestfs.pod:2853
38556 msgid "Useful targets are:"
38560 #: ../src/guestfs.pod:2855
38563 " make syntax-check # checks the syntax of the C code\n"
38564 " make check # runs the test suite\n"
38569 #: ../src/guestfs.pod:2858
38570 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
38574 #: ../src/guestfs.pod:2860
38576 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
38577 "which are used to do shell quoting."
38581 #: ../src/guestfs.pod:2865
38586 #: ../src/guestfs.pod:2867
38588 "Simple shell quoted string. Any spaces or other shell characters are "
38593 #: ../src/guestfs.pod:2870
38598 #: ../src/guestfs.pod:2872
38600 "Same as C<%Q> except the string is treated as a path which is prefixed by "
38605 #: ../src/guestfs.pod:2879
38608 " asprintf (&cmd, \"cat %R\", path);\n"
38613 #: ../src/guestfs.pod:2881
38614 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
38618 #: ../src/guestfs.pod:2883
38620 "I<Note:> Do I<not> use these when you are passing parameters to the "
38621 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
38622 "because they are not passed via the shell (instead, straight to exec). You "
38623 "probably want to use the C<sysroot_path()> function however."
38627 #: ../src/guestfs.pod:2889
38628 msgid "SUBMITTING YOUR NEW API ACTIONS"
38632 #: ../src/guestfs.pod:2891
38634 "Submit patches to the mailing list: "
38635 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
38636 "L<rjones@redhat.com>."
38640 #: ../src/guestfs.pod:2895
38641 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
38645 #: ../src/guestfs.pod:2897
38646 msgid "We support i18n (gettext anyhow) in the library."
38650 #: ../src/guestfs.pod:2899
38652 "However many messages come from the daemon, and we don't translate those at "
38653 "the moment. One reason is that the appliance generally has all locale files "
38654 "removed from it, because they take up a lot of space. So we'd have to readd "
38655 "some of those, as well as copying our PO files into the appliance."
38659 #: ../src/guestfs.pod:2905
38661 "Debugging messages are never translated, since they are intended for the "
38666 #: ../src/guestfs.pod:2908
38667 msgid "SOURCE CODE SUBDIRECTORIES"
38671 #: ../src/guestfs.pod:2912
38676 #: ../src/guestfs.pod:2914
38677 msgid "L<virt-alignment-scan(1)> command and documentation."
38681 #: ../src/guestfs.pod:2918
38682 msgid "The libguestfs appliance, build scripts and so on."
38686 #: ../src/guestfs.pod:2920
38687 msgid "C<capitests>"
38691 #: ../src/guestfs.pod:2922
38692 msgid "Automated tests of the C API."
38696 #: ../src/guestfs.pod:2924
38701 #: ../src/guestfs.pod:2926
38703 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
38708 #: ../src/guestfs.pod:2929
38713 #: ../src/guestfs.pod:2931
38715 "Safety and liveness tests of components that libguestfs depends upon (not of "
38716 "libguestfs itself). Mainly this is for qemu and the kernel."
38720 #: ../src/guestfs.pod:2934
38725 #: ../src/guestfs.pod:2936
38727 "Tools for cloning virtual machines. Currently contains L<virt-sysprep(1)> "
38728 "command and documentation."
38732 #: ../src/guestfs.pod:2939
38737 #: ../src/guestfs.pod:2941
38738 msgid "Outside contributions, experimental parts."
38742 #: ../src/guestfs.pod:2943
38747 #: ../src/guestfs.pod:2945
38749 "The daemon that runs inside the libguestfs appliance and carries out "
38754 #: ../src/guestfs.pod:2948
38759 #: ../src/guestfs.pod:2950
38760 msgid "L<virt-df(1)> command and documentation."
38764 #: ../src/guestfs.pod:2952
38769 #: ../src/guestfs.pod:2954
38770 msgid "L<virt-edit(1)> command and documentation."
38774 #: ../src/guestfs.pod:2956
38775 msgid "C<examples>"
38779 #: ../src/guestfs.pod:2958
38780 msgid "C API example code."
38784 #: ../src/guestfs.pod:2960
38789 #: ../src/guestfs.pod:2962
38791 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
38792 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
38793 "L<virt-tar-out(1)>."
38797 #: ../src/guestfs.pod:2966
38802 #: ../src/guestfs.pod:2968
38803 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
38807 #: ../src/guestfs.pod:2970
38808 msgid "C<generator>"
38812 #: ../src/guestfs.pod:2972
38814 "The crucially important generator, used to automatically generate large "
38815 "amounts of boilerplate C code for things like RPC and bindings."
38819 #: ../src/guestfs.pod:2975
38824 #: ../src/guestfs.pod:2977
38825 msgid "Files used by the test suite."
38829 #: ../src/guestfs.pod:2979
38830 msgid "Some \"phony\" guest images which we test against."
38834 #: ../src/guestfs.pod:2981
38835 msgid "C<inspector>"
38839 #: ../src/guestfs.pod:2983
38840 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
38844 #: ../src/guestfs.pod:2985
38849 #: ../src/guestfs.pod:2987
38850 msgid "Logo used on the website. The fish is called Arthur by the way."
38854 #: ../src/guestfs.pod:2989
38859 #: ../src/guestfs.pod:2991
38860 msgid "M4 macros used by autoconf."
38864 #: ../src/guestfs.pod:2993
38869 #: ../src/guestfs.pod:2995
38870 msgid "Translations of simple gettext strings."
38874 #: ../src/guestfs.pod:2997
38879 #: ../src/guestfs.pod:2999
38881 "The build infrastructure and PO files for translations of manpages and POD "
38882 "files. Eventually this will be combined with the C<po> directory, but that "
38883 "is rather complicated."
38887 #: ../src/guestfs.pod:3003
38888 msgid "C<regressions>"
38892 #: ../src/guestfs.pod:3005
38893 msgid "Regression tests."
38897 #: ../src/guestfs.pod:3007
38902 #: ../src/guestfs.pod:3009
38903 msgid "L<virt-rescue(1)> command and documentation."
38907 #: ../src/guestfs.pod:3011
38912 #: ../src/guestfs.pod:3013
38913 msgid "L<virt-resize(1)> command and documentation."
38917 #: ../src/guestfs.pod:3015
38918 msgid "C<sparsify>"
38922 #: ../src/guestfs.pod:3017
38923 msgid "L<virt-sparsify(1)> command and documentation."
38927 #: ../src/guestfs.pod:3019
38932 #: ../src/guestfs.pod:3021
38933 msgid "Source code to the C library."
38937 #: ../src/guestfs.pod:3023
38942 #: ../src/guestfs.pod:3025
38943 msgid "Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
38947 #: ../src/guestfs.pod:3027
38948 msgid "C<test-tool>"
38952 #: ../src/guestfs.pod:3029
38954 "Test tool for end users to test if their qemu/kernel combination will work "
38959 #: ../src/guestfs.pod:3032
38964 #: ../src/guestfs.pod:3034
38969 #: ../src/guestfs.pod:3036
38974 #: ../src/guestfs.pod:3038
38979 #: ../src/guestfs.pod:3040
38984 #: ../src/guestfs.pod:3042
38989 #: ../src/guestfs.pod:3044
38994 #: ../src/guestfs.pod:3046
38999 #: ../src/guestfs.pod:3048
39004 #: ../src/guestfs.pod:3050
39005 msgid "Language bindings."
39009 #: ../src/guestfs.pod:3054
39010 msgid "MAKING A STABLE RELEASE"
39014 #: ../src/guestfs.pod:3056
39016 "When we make a stable release, there are several steps documented here. See "
39017 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
39022 #: ../src/guestfs.pod:3064
39023 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
39027 #: ../src/guestfs.pod:3069
39028 msgid "Finalize RELEASE-NOTES."
39032 #: ../src/guestfs.pod:3073
39033 msgid "Update ROADMAP."
39037 #: ../src/guestfs.pod:3077
39038 msgid "Run C<src/api-support/update-from-tarballs.sh>."
39042 #: ../src/guestfs.pod:3081
39043 msgid "Push and pull from Transifex."
39047 #: ../src/guestfs.pod:3083
39052 #: ../src/guestfs.pod:3085
39060 #: ../src/guestfs.pod:3087
39061 msgid "to push the latest POT files to Transifex. Then run:"
39065 #: ../src/guestfs.pod:3089
39073 #: ../src/guestfs.pod:3091
39074 msgid "which is a wrapper to pull the latest translated C<*.po> files."
39078 #: ../src/guestfs.pod:3095
39080 "Create new stable and development directories under "
39081 "L<http://libguestfs.org/download>."
39085 #: ../src/guestfs.pod:3100
39086 msgid "Create the branch in git:"
39090 #: ../src/guestfs.pod:3102
39093 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
39094 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
39095 " git branch stable-1.XX\n"
39096 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
39101 #: ../src/guestfs.pod:3109
39106 #: ../src/guestfs.pod:3111
39107 msgid "PROTOCOL LIMITS"
39111 #: ../src/guestfs.pod:3113
39113 "Internally libguestfs uses a message-based protocol to pass API calls and "
39114 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
39115 "plenty more detail about this). The maximum message size used by the "
39116 "protocol is slightly less than 4 MB. For some API calls you may need to be "
39117 "aware of this limit. The API calls which may be affected are individually "
39118 "documented, with a link back to this section of the documentation."
39122 #: ../src/guestfs.pod:3121
39124 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
39125 "a simple string. Because this string is at some point internally encoded as "
39126 "a message, the maximum size that it can return is slightly under 4 MB. If "
39127 "the requested file is larger than this then you will get an error."
39131 #: ../src/guestfs.pod:3127
39133 "In order to transfer large files into and out of the guest filesystem, you "
39134 "need to use particular calls that support this. The sections L</UPLOADING> "
39135 "and L</DOWNLOADING> document how to do this."
39139 #: ../src/guestfs.pod:3131
39141 "You might also consider mounting the disk image using our FUSE filesystem "
39142 "support (L<guestmount(1)>)."
39146 #: ../src/guestfs.pod:3134
39147 msgid "MAXIMUM NUMBER OF DISKS"
39151 #: ../src/guestfs.pod:3136
39152 msgid "When using virtio disks (the default) the current limit is B<25> disks."
39156 #: ../src/guestfs.pod:3139
39158 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
39159 "slots. However febootstrap only understands disks with names C</dev/vda> "
39160 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
39165 #: ../src/guestfs.pod:3144
39167 "We are working to substantially raise this limit in future versions but it "
39168 "requires complex changes to qemu."
39172 #: ../src/guestfs.pod:3147
39174 "In future versions of libguestfs it should also be possible to \"hot plug\" "
39175 "disks (add and remove disks after calling L</guestfs_launch>). This also "
39176 "requires changes to qemu."
39180 #: ../src/guestfs.pod:3151
39181 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
39185 #: ../src/guestfs.pod:3153
39186 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
39190 #: ../src/guestfs.pod:3155
39192 "This is because it reserves 4 bits for the minor device number (thus "
39193 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
39197 #: ../src/guestfs.pod:3158
39199 "If you attach a disk with more than 15 partitions, the extra partitions are "
39200 "ignored by libguestfs."
39204 #: ../src/guestfs.pod:3161
39205 msgid "MAXIMUM SIZE OF A DISK"
39209 #: ../src/guestfs.pod:3163
39210 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
39214 #: ../src/guestfs.pod:3165
39216 "We have tested block devices up to 1 exabyte (2**60 or "
39217 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
39222 #: ../src/guestfs.pod:3169
39224 "Although libguestfs probably does not impose any limit, the underlying host "
39225 "storage will. If you store disk images on a host ext4 filesystem, then the "
39226 "maximum size will be limited by the maximum ext4 file size (currently 16 "
39227 "TB). If you store disk images as host logical volumes then you are limited "
39228 "by the maximum size of an LV."
39232 #: ../src/guestfs.pod:3175
39234 "For the hugest disk image files, we recommend using XFS on the host for "
39239 #: ../src/guestfs.pod:3178
39240 msgid "MAXIMUM SIZE OF A PARTITION"
39244 #: ../src/guestfs.pod:3180
39246 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
39247 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
39248 "address a partition located beyond 2 TB on the disk."
39252 #: ../src/guestfs.pod:3184
39254 "It is recommended that you use GPT partitions on disks which are larger than "
39255 "this size. GPT uses 64 bit sector numbers and so can address partitions "
39256 "which are theoretically larger than the largest disk we could support."
39260 #: ../src/guestfs.pod:3189
39261 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
39265 #: ../src/guestfs.pod:3191
39267 "This depends on the filesystem type. libguestfs itself does not impose any "
39268 "known limit. Consult Wikipedia or the filesystem documentation to find out "
39269 "what these limits are."
39273 #: ../src/guestfs.pod:3195
39274 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
39278 #: ../src/guestfs.pod:3197
39280 "The API functions L</guestfs_upload>, L</guestfs_download>, "
39281 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
39282 "uploads and downloads."
39286 #: ../src/guestfs.pod:3201
39287 msgid "INSPECTION LIMITS"
39291 #: ../src/guestfs.pod:3203
39293 "The inspection code has several arbitrary limits on things like the size of "
39294 "Windows Registry hive it will read, and the length of product name. These "
39295 "are intended to stop a malicious guest from consuming arbitrary amounts of "
39296 "memory and disk space on the host, and should not be reached in practice. "
39297 "See the source code for more information."
39301 #: ../src/guestfs.pod:3229
39303 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
39304 "effect as calling C<guestfs_set_verbose (g, 1)>."
39308 #: ../src/guestfs.pod:3241
39310 "Set the path that libguestfs uses to search for a supermin appliance. See "
39311 "the discussion of paths in section L</PATH> above."
39315 #: ../src/guestfs.pod:3250
39316 msgid "See also L</QEMU WRAPPERS> above."
39320 #: ../src/guestfs.pod:3254
39322 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
39323 "effect as calling C<guestfs_set_trace (g, 1)>."
39327 #: ../src/guestfs.pod:3272
39329 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
39330 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
39331 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, "
39332 "L<virt-alignment-scan(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
39333 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
39334 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
39335 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
39336 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, "
39337 "L<virt-sysprep(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
39338 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
39339 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<stap(1)>, "
39340 "L<http://libguestfs.org/>."
39344 #: ../src/guestfs.pod:3308
39346 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
39347 "L<lvm(8)>, L<disktype(1)>."
39351 #: ../src/guestfs.pod:3315 ../tools/virt-make-fs.pl:571 ../tools/virt-win-reg.pl:772
39356 #: ../src/guestfs.pod:3317
39357 msgid "To get a list of bugs against libguestfs use this link:"
39361 #: ../src/guestfs.pod:3319
39362 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
39366 #: ../src/guestfs.pod:3321
39367 msgid "To report a new bug against libguestfs use this link:"
39371 #: ../src/guestfs.pod:3323
39372 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
39376 #: ../src/guestfs.pod:3325
39377 msgid "When reporting a bug, please check:"
39381 #: ../src/guestfs.pod:3331
39382 msgid "That the bug hasn't been reported already."
39386 #: ../src/guestfs.pod:3335
39387 msgid "That you are testing a recent version."
39391 #: ../src/guestfs.pod:3339
39392 msgid "Describe the bug accurately, and give a way to reproduce it."
39396 #: ../src/guestfs.pod:3343
39398 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
39403 #: ../test-tool/libguestfs-test-tool.pod:5
39404 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
39408 #: ../test-tool/libguestfs-test-tool.pod:9
39411 " libguestfs-test-tool [--options]\n"
39416 #: ../test-tool/libguestfs-test-tool.pod:13
39418 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
39419 "to check basic libguestfs functionality is working. This is needed because "
39420 "libguestfs occasionally breaks for reasons beyond our control: usually "
39421 "because of changes in the underlying qemu or kernel packages, or the host "
39426 #: ../test-tool/libguestfs-test-tool.pod:19
39427 msgid "If you suspect a problem in libguestfs, then just run:"
39431 #: ../test-tool/libguestfs-test-tool.pod:21
39434 " libguestfs-test-tool\n"
39439 #: ../test-tool/libguestfs-test-tool.pod:23
39440 msgid "It will print lots of diagnostic messages."
39444 #: ../test-tool/libguestfs-test-tool.pod:25
39445 msgid "If it runs to completion successfully, you will see this near the end:"
39449 #: ../test-tool/libguestfs-test-tool.pod:27
39452 " ===== TEST FINISHED OK =====\n"
39457 #: ../test-tool/libguestfs-test-tool.pod:29
39458 msgid "and the test tool will exit with code 0."
39462 #: ../test-tool/libguestfs-test-tool.pod:31
39464 "If it fails (and/or exits with non-zero error code), please paste the "
39465 "I<complete, unedited> output of the test tool into a bug report. More "
39466 "information about reporting bugs can be found on the "
39467 "L<http://libguestfs.org/> website."
39471 #: ../test-tool/libguestfs-test-tool.pod:42
39472 msgid "Display short usage information and exit."
39476 #: ../test-tool/libguestfs-test-tool.pod:44
39477 msgid "B<--qemu qemu_binary>"
39481 #: ../test-tool/libguestfs-test-tool.pod:46
39483 "If you have downloaded another qemu binary, point this option at the full "
39484 "path of the binary to try it."
39488 #: ../test-tool/libguestfs-test-tool.pod:49
39489 msgid "B<--qemudir qemu_source_dir>"
39493 #: ../test-tool/libguestfs-test-tool.pod:51
39495 "If you have compiled qemu from source, point this option at the source "
39496 "directory to try it."
39500 #: ../test-tool/libguestfs-test-tool.pod:54
39505 #: ../test-tool/libguestfs-test-tool.pod:56
39506 msgid "B<--timeout N>"
39510 #: ../test-tool/libguestfs-test-tool.pod:58
39512 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
39513 "minutes) which does not usually need to be adjusted."
39517 #: ../test-tool/libguestfs-test-tool.pod:63
39518 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
39522 #: ../test-tool/libguestfs-test-tool.pod:65
39524 "If you have compiled another version of qemu from source and would like to "
39525 "try that, then you can use the I<--qemudir> option to point to the qemu "
39526 "source directory."
39530 #: ../test-tool/libguestfs-test-tool.pod:69
39532 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
39533 "option to point to the binary."
39537 #: ../test-tool/libguestfs-test-tool.pod:72
39539 "Note when using these options, you can ignore the business of qemu wrapper "
39540 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
39541 "wrapper script for you if one is needed."
39545 #: ../test-tool/libguestfs-test-tool.pod:76
39546 msgid "TRYING OUT A DIFFERENT KERNEL"
39550 #: ../test-tool/libguestfs-test-tool.pod:78
39552 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
39553 "libguestfs tries. You do this by setting the environment variables "
39554 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
39558 #: ../test-tool/libguestfs-test-tool.pod:82
39560 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
39565 #: ../test-tool/libguestfs-test-tool.pod:85
39566 msgid "SELF-DIAGNOSIS"
39570 #: ../test-tool/libguestfs-test-tool.pod:87
39572 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
39573 "produced by libguestfs-test-tool and/or possible errors."
39577 #: ../test-tool/libguestfs-test-tool.pod:92
39579 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
39580 "I<1> if there was an error."
39584 #: ../test-tool/libguestfs-test-tool.pod:97
39586 "For the full list of environment variables which may affect libguestfs, "
39587 "please see the L<guestfs(3)> manual page."
39591 #: ../test-tool/libguestfs-test-tool.pod:102
39592 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
39596 #: ../tools/virt-list-filesystems.pl:32
39597 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
39601 #: ../tools/virt-list-filesystems.pl:36
39604 " virt-list-filesystems [--options] domname\n"
39609 #: ../tools/virt-list-filesystems.pl:38
39612 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
39617 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
39619 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
39624 #: ../tools/virt-list-filesystems.pl:45
39626 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
39627 "are contained in a virtual machine or disk image."
39631 #: ../tools/virt-list-filesystems.pl:49
39633 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
39634 "functionality. For more complex cases you should look at the "
39635 "L<guestfish(1)> tool."
39639 #: ../tools/virt-list-filesystems.pl:112
39641 "With this option, C<virt-list-filesystems> displays the type of each "
39642 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
39646 #: ../tools/virt-list-filesystems.pl:119
39651 #: ../tools/virt-list-filesystems.pl:123
39653 "Normally we only show mountable filesystems. If this option is given then "
39654 "swap devices are shown too."
39658 #: ../tools/virt-list-filesystems.pl:197
39660 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
39661 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
39662 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
39666 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
39667 msgid "Copyright (C) 2009 Red Hat Inc."
39671 #: ../tools/virt-list-partitions.pl:32
39672 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
39676 #: ../tools/virt-list-partitions.pl:36
39679 " virt-list-partitions [--options] domname\n"
39684 #: ../tools/virt-list-partitions.pl:38
39687 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
39692 #: ../tools/virt-list-partitions.pl:45
39694 "C<virt-list-partitions> is a command line tool to list the partitions that "
39695 "are contained in a virtual machine or disk image. It is mainly useful as a "
39696 "first step to using L<virt-resize(1)>."
39700 #: ../tools/virt-list-partitions.pl:50
39702 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
39703 "functionality. For more complex cases you should look at the "
39704 "L<guestfish(1)> tool."
39708 #: ../tools/virt-list-partitions.pl:113
39709 msgid "Show sizes in human-readable form (eg. \"1G\")."
39713 #: ../tools/virt-list-partitions.pl:123
39715 "With this option, C<virt-list-partitions> displays the type and size of each "
39716 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
39720 #: ../tools/virt-list-partitions.pl:130
39725 #: ../tools/virt-list-partitions.pl:132
39730 #: ../tools/virt-list-partitions.pl:134
39731 msgid "Display the total size of each block device (as a separate row or rows)."
39735 #: ../tools/virt-list-partitions.pl:267
39737 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
39738 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
39739 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
39743 #: ../tools/virt-list-partitions.pl:283
39744 msgid "Copyright (C) 2009-2010 Red Hat Inc."
39748 #: ../tools/virt-make-fs.pl:37
39749 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
39753 #: ../tools/virt-make-fs.pl:41
39756 " virt-make-fs [--options] input.tar output.img\n"
39761 #: ../tools/virt-make-fs.pl:43
39764 " virt-make-fs [--options] input.tar.gz output.img\n"
39769 #: ../tools/virt-make-fs.pl:45
39772 " virt-make-fs [--options] directory output.img\n"
39777 #: ../tools/virt-make-fs.pl:49
39779 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
39780 "archive or some files in a directory. It is similar to tools like "
39781 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
39782 "it can create common filesystem types like ext2/3 or NTFS, which can be "
39783 "useful if you want to attach these filesystems to existing virtual machines "
39784 "(eg. to import large amounts of read-only data to a VM)."
39788 #: ../tools/virt-make-fs.pl:57
39789 msgid "Basic usage is:"
39793 #: ../tools/virt-make-fs.pl:59
39796 " virt-make-fs input output.img\n"
39801 #: ../tools/virt-make-fs.pl:61
39803 "where C<input> is either a directory containing files that you want to add, "
39804 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
39805 "C<output.img> is a disk image. The input type is detected automatically. "
39806 "The output disk image defaults to a raw ext2 sparse image unless you specify "
39807 "extra flags (see L</OPTIONS> below)."
39811 #: ../tools/virt-make-fs.pl:67
39812 msgid "FILESYSTEM TYPE"
39816 #: ../tools/virt-make-fs.pl:69
39818 "The default filesystem type is C<ext2>. Just about any filesystem type that "
39819 "libguestfs supports can be used (but I<not> read-only formats like "
39820 "ISO9660). Here are some of the more common choices:"
39824 #: ../tools/virt-make-fs.pl:75
39829 #: ../tools/virt-make-fs.pl:77
39831 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
39832 "you are not going to use the filesystem in a way that requires the journal, "
39833 "then this is just wasted overhead."
39837 #: ../tools/virt-make-fs.pl:81
39838 msgid "I<ntfs> or I<vfat>"
39842 #: ../tools/virt-make-fs.pl:83
39843 msgid "Useful if exporting data to a Windows guest."
39847 #: ../tools/virt-make-fs.pl:85
39849 "I<Note for vfat>: The tar archive or local directory must only contain files "
39850 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
39851 "program running within libguestfs is unable to change the ownership of "
39852 "non-root files, since vfat itself does not support this."
39856 #: ../tools/virt-make-fs.pl:90
39861 #: ../tools/virt-make-fs.pl:92
39863 "Lower overhead than C<ext2>, but certain limitations on filename length and "
39864 "total filesystem size."
39868 #: ../tools/virt-make-fs.pl:97 ../tools/virt-make-fs.pl:116 ../tools/virt-make-fs.pl:149
39873 #: ../tools/virt-make-fs.pl:99
39876 " virt-make-fs --type=minix input minixfs.img\n"
39881 #: ../tools/virt-make-fs.pl:101
39882 msgid "TO PARTITION OR NOT TO PARTITION"
39886 #: ../tools/virt-make-fs.pl:103
39887 msgid "Optionally virt-make-fs can add a partition table to the output disk."
39891 #: ../tools/virt-make-fs.pl:105
39893 "Adding a partition can make the disk image more compatible with certain "
39894 "virtualized operating systems which don't expect to see a filesystem "
39895 "directly located on a block device (Linux doesn't care and will happily "
39896 "handle both types)."
39900 #: ../tools/virt-make-fs.pl:110
39902 "On the other hand, if you have a partition table then the output image is no "
39903 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
39904 "directly on a partitioned disk image. (However libguestfs tools such as "
39905 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
39909 #: ../tools/virt-make-fs.pl:118
39910 msgid "Add an MBR partition:"
39914 #: ../tools/virt-make-fs.pl:120
39917 " virt-make-fs --partition -- input disk.img\n"
39922 #: ../tools/virt-make-fs.pl:122
39924 "If the output disk image could be terabyte-sized or larger, it's better to "
39925 "use an EFI/GPT-compatible partition table:"
39929 #: ../tools/virt-make-fs.pl:125
39932 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
39937 #: ../tools/virt-make-fs.pl:127
39938 msgid "EXTRA SPACE"
39942 #: ../tools/virt-make-fs.pl:129
39944 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
39945 "the files that it contains, but might have extra space. Depending on how "
39946 "you are going to use the output, you might think this extra space is wasted "
39947 "and want to minimize it, or you might want to leave space so that more files "
39948 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
39949 "but you can use the I<--size> flag to leave space in the filesystem if you "
39954 #: ../tools/virt-make-fs.pl:137
39956 "An alternative way to leave extra space but not make the output image any "
39957 "bigger is to use an alternative disk image format (instead of the default "
39958 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
39959 "image format (check your hypervisor supports this before using it). This "
39960 "allows you to choose a large I<--size> but the extra space won't actually be "
39961 "allocated in the image until you try to store something in it."
39965 #: ../tools/virt-make-fs.pl:145
39967 "Don't forget that you can also use local commands including L<resize2fs(8)> "
39968 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
39969 "to build another image from scratch."
39973 #: ../tools/virt-make-fs.pl:151
39976 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
39981 #: ../tools/virt-make-fs.pl:179
39982 msgid "Enable debugging information."
39986 #: ../tools/virt-make-fs.pl:185
39987 msgid "B<--size=E<lt>NE<gt>>"
39991 #: ../tools/virt-make-fs.pl:187
39992 msgid "B<--size=+E<lt>NE<gt>>"
39996 #: ../tools/virt-make-fs.pl:189
39997 msgid "B<-s E<lt>NE<gt>>"
40001 #: ../tools/virt-make-fs.pl:191
40002 msgid "B<-s +E<lt>NE<gt>>"
40006 #: ../tools/virt-make-fs.pl:193
40007 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
40011 #: ../tools/virt-make-fs.pl:196
40013 "If this option is I<not> given, then the output image will be just large "
40014 "enough to contain all the files, with not much wasted space."
40018 #: ../tools/virt-make-fs.pl:199
40020 "To choose a fixed size output disk, specify an absolute number followed by "
40021 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
40022 "Petabytes or Exabytes. This must be large enough to contain all the input "
40023 "files, else you will get an error."
40027 #: ../tools/virt-make-fs.pl:204
40029 "To leave extra space, specify C<+> (plus sign) and a number followed by "
40030 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
40031 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
40032 "the input files, and (approximately) an extra 200 MB free space."
40036 #: ../tools/virt-make-fs.pl:210
40038 "Note that virt-make-fs estimates free space, and therefore will not produce "
40039 "filesystems containing precisely the free space requested. (It is much more "
40040 "expensive and time-consuming to produce a filesystem which has precisely the "
40041 "desired free space)."
40045 #: ../tools/virt-make-fs.pl:219
40046 msgid "B<--format=E<lt>fmtE<gt>>"
40050 #: ../tools/virt-make-fs.pl:221
40051 msgid "B<-F E<lt>fmtE<gt>>"
40055 #: ../tools/virt-make-fs.pl:223
40056 msgid "Choose the output disk image format."
40060 #: ../tools/virt-make-fs.pl:225
40061 msgid "The default is C<raw> (raw sparse disk image)."
40065 #: ../tools/virt-make-fs.pl:227
40067 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
40068 "that would really make sense here is C<qcow2>."
40072 #: ../tools/virt-make-fs.pl:234
40073 msgid "B<--type=E<lt>fsE<gt>>"
40077 #: ../tools/virt-make-fs.pl:236
40078 msgid "B<-t E<lt>fsE<gt>>"
40082 #: ../tools/virt-make-fs.pl:238
40083 msgid "Choose the output filesystem type."
40087 #: ../tools/virt-make-fs.pl:240
40088 msgid "The default is C<ext2>."
40092 #: ../tools/virt-make-fs.pl:242
40093 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
40097 #: ../tools/virt-make-fs.pl:249
40098 msgid "B<--partition>"
40102 #: ../tools/virt-make-fs.pl:251
40103 msgid "B<--partition=E<lt>parttypeE<gt>>"
40107 #: ../tools/virt-make-fs.pl:253
40109 "If specified, this flag adds an MBR partition table to the output disk "
40114 #: ../tools/virt-make-fs.pl:256
40116 "You can change the partition table type, eg. I<--partition=gpt> for large "
40121 #: ../tools/virt-make-fs.pl:259
40123 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
40124 "might consider the next parameter to be the partition type. For example:"
40128 #: ../tools/virt-make-fs.pl:263
40131 " virt-make-fs --partition input.tar output.img\n"
40136 #: ../tools/virt-make-fs.pl:265
40138 "would cause virt-make-fs to think you wanted to use a partition type of "
40139 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
40140 "dash) between options and the input and output arguments:"
40144 #: ../tools/virt-make-fs.pl:269
40147 " virt-make-fs --partition -- input.tar output.img\n"
40152 #: ../tools/virt-make-fs.pl:271
40153 msgid "For MBR, virt-make-fs sets the partition type byte automatically."
40157 #: ../tools/virt-make-fs.pl:559
40159 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
40160 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
40161 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
40165 #: ../tools/virt-make-fs.pl:573 ../tools/virt-win-reg.pl:774
40167 "When reporting bugs, please enable debugging and capture the I<complete> "
40172 #: ../tools/virt-make-fs.pl:576
40175 " export LIBGUESTFS_DEBUG=1\n"
40176 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
40181 #: ../tools/virt-make-fs.pl:579
40183 "Attach /tmp/virt-make-fs.log to a new bug report at "
40184 "L<https://bugzilla.redhat.com/>"
40188 #: ../tools/virt-tar.pl:33
40189 msgid "virt-tar - Extract or upload files to a virtual machine"
40193 #: ../tools/virt-tar.pl:37
40196 " virt-tar [--options] -x domname directory tarball\n"
40201 #: ../tools/virt-tar.pl:39
40204 " virt-tar [--options] -u domname tarball directory\n"
40209 #: ../tools/virt-tar.pl:41
40212 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
40217 #: ../tools/virt-tar.pl:43
40220 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
40225 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
40230 #: ../tools/virt-tar.pl:47
40232 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
40233 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
40237 #: ../tools/virt-tar.pl:52
40238 msgid "Download C</home> from the VM into a local tarball:"
40242 #: ../tools/virt-tar.pl:54
40245 " virt-tar -x domname /home home.tar\n"
40250 #: ../tools/virt-tar.pl:56
40253 " virt-tar -zx domname /home home.tar.gz\n"
40258 #: ../tools/virt-tar.pl:58
40259 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
40263 #: ../tools/virt-tar.pl:60
40266 " virt-tar -u domname uploadstuff.tar /tmp\n"
40271 #: ../tools/virt-tar.pl:62
40274 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
40279 #: ../tools/virt-tar.pl:66
40281 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
40282 "virtual machines. If you do this, you risk disk corruption in the VM. "
40283 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
40287 #: ../tools/virt-tar.pl:71
40289 "You can use I<-x> (extract) on live virtual machines, but you might get "
40290 "inconsistent results or errors if there is filesystem activity inside the "
40291 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
40292 "work, but the only way to guarantee consistent results is if the virtual "
40293 "machine is shut down."
40297 #: ../tools/virt-tar.pl:79
40299 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
40300 "parts of a guest filesystem. There are many possibilities: making backups, "
40301 "uploading data files, snooping on guest activity, fixing or customizing "
40306 #: ../tools/virt-tar.pl:84
40308 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
40309 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
40310 "should look at the L<guestfish(1)> tool."
40314 #: ../tools/virt-tar.pl:88
40316 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
40317 "its contents (recursively) from the virtual machine into a local tarball. "
40318 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
40319 "virtual machine. You cannot use these two options together."
40323 #: ../tools/virt-tar.pl:94
40325 "In addition, you may need to use the I<-z> (gZip) option to enable "
40326 "compression. When uploading, you have to specify I<-z> if the upload file "
40327 "is compressed because virt-tar won't detect this on its own."
40331 #: ../tools/virt-tar.pl:98
40333 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
40334 "example it cannot do PKZip files or bzip2 compression. If you want that "
40335 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
40336 "the L<libguestfs(3)> API)."
40340 #: ../tools/virt-tar.pl:160
40341 msgid "B<--extract>"
40345 #: ../tools/virt-tar.pl:162
40346 msgid "B<--download>"
40350 #: ../tools/virt-tar.pl:164
40355 #: ../tools/virt-tar.pl:166
40356 msgid "B<--upload>"
40360 #: ../tools/virt-tar.pl:168
40362 "Use I<-x> to extract (download) a directory from a virtual machine to a "
40367 #: ../tools/virt-tar.pl:171
40369 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
40370 "Please read the L</WARNING> section above before using this option."
40374 #: ../tools/virt-tar.pl:175
40375 msgid "You must specify exactly one of these options."
40379 #: ../tools/virt-tar.pl:181
40384 #: ../tools/virt-tar.pl:183
40389 #: ../tools/virt-tar.pl:185
40390 msgid "Specify that the input or output tarball is gzip-compressed."
40394 #: ../tools/virt-tar.pl:298
40396 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
40397 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
40398 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
40399 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
40403 #: ../tools/virt-win-reg.pl:37
40405 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
40410 #: ../tools/virt-win-reg.pl:41
40413 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
40418 #: ../tools/virt-win-reg.pl:43
40421 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
40426 #: ../tools/virt-win-reg.pl:45
40429 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
40434 #: ../tools/virt-win-reg.pl:47
40437 " virt-win-reg --merge domname [input.reg ...]\n"
40442 #: ../tools/virt-win-reg.pl:49
40445 " virt-win-reg [--options] disk.img ... # instead of domname\n"
40450 #: ../tools/virt-win-reg.pl:53
40452 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
40453 "virtual machines. If you do this, you I<will> get irreversible disk "
40454 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
40455 "but doesn't catch all cases."
40459 #: ../tools/virt-win-reg.pl:58
40461 "Modifying the Windows Registry is an inherently risky operation. The format "
40462 "is deliberately obscure and undocumented, and Registry changes can leave the "
40463 "system unbootable. Therefore when using the I<--merge> option, make sure "
40464 "you have a reliable backup first."
40468 #: ../tools/virt-win-reg.pl:65
40470 "This program can export and merge Windows Registry entries from a Windows "
40475 #: ../tools/virt-win-reg.pl:68
40477 "The first parameter is the libvirt guest name or the raw disk image of a "
40482 #: ../tools/virt-win-reg.pl:71
40484 "If I<--merge> is I<not> specified, then the chosen registry key is "
40485 "displayed/exported (recursively). For example:"
40489 #: ../tools/virt-win-reg.pl:74
40492 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
40497 #: ../tools/virt-win-reg.pl:76
40498 msgid "You can also display single values from within registry keys, for example:"
40502 #: ../tools/virt-win-reg.pl:79
40505 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
40506 " $ virt-win-reg Windows7 $cvkey ProductName\n"
40507 " Windows 7 Enterprise\n"
40512 #: ../tools/virt-win-reg.pl:83
40514 "With I<--merge>, you can merge a textual regedit file into the Windows "
40519 #: ../tools/virt-win-reg.pl:86
40522 " $ virt-win-reg --merge Windows7 changes.reg\n"
40527 #: ../tools/virt-win-reg.pl:90
40529 "This program is only meant for simple access to the registry. If you want "
40530 "to do complicated things with the registry, we suggest you download the "
40531 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
40532 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
40533 "L<hivexregedit(1)>."
40537 #: ../tools/virt-win-reg.pl:159
40542 #: ../tools/virt-win-reg.pl:161
40544 "In merge mode, this merges a textual regedit file into the Windows Registry "
40545 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
40546 "displays or exports Registry entries instead."
40550 #: ../tools/virt-win-reg.pl:165
40552 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
40553 "result in disk corruption. However exporting (without this flag) is always "
40558 #: ../tools/virt-win-reg.pl:173
40559 msgid "B<--encoding> UTF-16LE|ASCII"
40563 #: ../tools/virt-win-reg.pl:175
40565 "When merging (only), you may need to specify the encoding for strings to be "
40566 "used in the hive file. This is explained in detail in "
40567 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
40571 #: ../tools/virt-win-reg.pl:179
40573 "The default is to use UTF-16LE, which should work with recent versions of "
40578 #: ../tools/virt-win-reg.pl:186
40579 msgid "B<--unsafe-printable-strings>"
40583 #: ../tools/virt-win-reg.pl:188
40585 "When exporting (only), assume strings are UTF-16LE and print them as strings "
40586 "instead of hex sequences. Remove the final zero codepoint from strings if "
40591 #: ../tools/virt-win-reg.pl:192
40593 "This is unsafe and does not preserve the fidelity of strings in the original "
40594 "Registry for various reasons:"
40598 #: ../tools/virt-win-reg.pl:199
40600 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
40601 "other encodings will be corrupted by this transformation."
40605 #: ../tools/virt-win-reg.pl:204
40607 "Assumes that everything which has type 1 or 2 is really a string and that "
40608 "everything else is not a string, but the type field in real Registries is "
40613 #: ../tools/virt-win-reg.pl:210
40615 "Loses information about whether a zero codepoint followed the string in the "
40620 #: ../tools/virt-win-reg.pl:215
40622 "This all happens because the Registry itself contains no information about "
40623 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
40627 #: ../tools/virt-win-reg.pl:219
40629 "You should only use this option for quick hacking and debugging of the "
40630 "Registry contents, and I<never> use it if the output is going to be passed "
40631 "into another program or stored in another Registry."
40635 #: ../tools/virt-win-reg.pl:556
40636 msgid "SUPPORTED SYSTEMS"
40640 #: ../tools/virt-win-reg.pl:558
40642 "The program currently supports Windows NT-derived guests starting with "
40643 "Windows XP through to at least Windows 7."
40647 #: ../tools/virt-win-reg.pl:561
40648 msgid "The following Registry keys are supported:"
40652 #: ../tools/virt-win-reg.pl:565
40653 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
40657 #: ../tools/virt-win-reg.pl:567
40658 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
40662 #: ../tools/virt-win-reg.pl:569
40663 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
40667 #: ../tools/virt-win-reg.pl:571
40668 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
40672 #: ../tools/virt-win-reg.pl:573
40673 msgid "C<HKEY_USERS\\.DEFAULT>"
40677 #: ../tools/virt-win-reg.pl:575
40678 msgid "C<HKEY_USERS\\I<SID>>"
40682 #: ../tools/virt-win-reg.pl:577
40683 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
40687 #: ../tools/virt-win-reg.pl:579
40688 msgid "C<HKEY_USERS\\I<username>>"
40692 #: ../tools/virt-win-reg.pl:581
40693 msgid "where I<username> is a local user name (this is a libguestfs extension)."
40697 #: ../tools/virt-win-reg.pl:585
40699 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
40704 #: ../tools/virt-win-reg.pl:588
40706 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
40707 "supported (there is no \"current user\")."
40711 #: ../tools/virt-win-reg.pl:591
40716 #: ../tools/virt-win-reg.pl:593
40718 "C<virt-win-reg> expects that regedit files have already been reencoded in "
40719 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
40720 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
40721 "with Windows-style line endings, you may need to reencode the whole file "
40722 "before or after processing."
40726 #: ../tools/virt-win-reg.pl:599
40728 "To reencode a file from Windows format to Linux (before processing it with "
40729 "the I<--merge> option), you would do something like this:"
40733 #: ../tools/virt-win-reg.pl:602
40736 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
40741 #: ../tools/virt-win-reg.pl:604
40743 "To go in the opposite direction, after exporting and before sending the file "
40744 "to a Windows user, do something like this:"
40748 #: ../tools/virt-win-reg.pl:607
40751 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
40756 #: ../tools/virt-win-reg.pl:609
40757 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
40761 #: ../tools/virt-win-reg.pl:611
40763 "If you are unsure about the current encoding, use the L<file(1)> command. "
40764 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
40765 "Windows-style (CRLF) line endings, like this:"
40769 #: ../tools/virt-win-reg.pl:615
40772 " $ file software.reg\n"
40773 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
40774 " with CRLF line terminators\n"
40779 #: ../tools/virt-win-reg.pl:619
40780 msgid "This file would need conversion before you could I<--merge> it."
40784 #: ../tools/virt-win-reg.pl:621
40785 msgid "CurrentControlSet etc."
40789 #: ../tools/virt-win-reg.pl:623
40791 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
40792 "Registry at the level of the hive file, and therefore you cannot modify "
40797 #: ../tools/virt-win-reg.pl:627
40799 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
40800 "circumstances it might refer to another control set. The way to find out is "
40801 "to look at the C<HKLM\\SYSTEM\\Select> key:"
40805 #: ../tools/virt-win-reg.pl:631
40808 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
40809 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
40810 " \"Current\"=dword:00000001\n"
40811 " \"Default\"=dword:00000001\n"
40812 " \"Failed\"=dword:00000000\n"
40813 " \"LastKnownGood\"=dword:00000002\n"
40818 #: ../tools/virt-win-reg.pl:638
40819 msgid "\"Current\" is the one which Windows will choose when it boots."
40823 #: ../tools/virt-win-reg.pl:640
40824 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
40828 #: ../tools/virt-win-reg.pl:643
40829 msgid "DELETING REGISTRY KEYS AND VALUES"
40833 #: ../tools/virt-win-reg.pl:645
40834 msgid "To delete a whole registry key, use the syntax:"
40838 #: ../tools/virt-win-reg.pl:647
40841 " [-HKEY_LOCAL_MACHINE\\Foo]\n"
40846 #: ../tools/virt-win-reg.pl:649
40847 msgid "To delete a single value within a key, use the syntax:"
40851 #: ../tools/virt-win-reg.pl:651
40854 " [HKEY_LOCAL_MACHINE\\Foo]\n"
40860 #: ../tools/virt-win-reg.pl:654
40861 msgid "WINDOWS TIPS"
40865 #: ../tools/virt-win-reg.pl:656
40867 "Note that some of these tips modify the guest disk image. The guest I<must> "
40868 "be shut off, else you will get disk corruption."
40872 #: ../tools/virt-win-reg.pl:659
40873 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
40877 #: ../tools/virt-win-reg.pl:661
40879 "Prepare a DOS batch script, VBScript or executable. Upload this using "
40880 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
40881 "is uploaded into C<C:\\>:"
40885 #: ../tools/virt-win-reg.pl:665
40888 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
40893 #: ../tools/virt-win-reg.pl:667
40894 msgid "Prepare a regedit file containing the registry change:"
40898 #: ../tools/virt-win-reg.pl:669
40901 " cat > test.reg <<'EOF'\n"
40902 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
40903 " \"Test\"=\"c:\\\\test.bat\"\n"
40909 #: ../tools/virt-win-reg.pl:674
40911 "In this example we use the key C<RunOnce> which means that the script will "
40912 "run precisely once when the first user logs in. If you want it to run every "
40913 "time a user logs in, replace C<RunOnce> with C<Run>."
40917 #: ../tools/virt-win-reg.pl:678
40918 msgid "Now update the registry:"
40922 #: ../tools/virt-win-reg.pl:680
40925 " virt-win-reg --merge WindowsGuest test.reg\n"
40930 #: ../tools/virt-win-reg.pl:682
40931 msgid "INSTALLING A SERVICE"
40935 #: ../tools/virt-win-reg.pl:684
40937 "This section assumes you are familiar with Windows services, and you either "
40938 "have a program which handles the Windows Service Control Protocol directly "
40939 "or you want to run any program using a service wrapper like SrvAny or the "
40944 #: ../tools/virt-win-reg.pl:689
40946 "First upload the program and optionally the service wrapper. In this case "
40947 "the test program is called C<test.exe> and we are using the RHSrvAny "
40952 #: ../tools/virt-win-reg.pl:693
40955 " guestfish -i -d WindowsGuest <<EOF\n"
40956 " upload rhsrvany.exe /rhsrvany.exe\n"
40957 " upload test.exe /test.exe\n"
40963 #: ../tools/virt-win-reg.pl:698
40965 "Prepare a regedit file containing the registry changes. In this example, "
40966 "the first registry change is needed for the service itself or the service "
40967 "wrapper (if used). The second registry change is only needed because I am "
40968 "using the RHSrvAny service wrapper."
40972 #: ../tools/virt-win-reg.pl:703
40975 " cat > service.reg <<'EOF'\n"
40976 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
40977 " \"Type\"=dword:00000010\n"
40978 " \"Start\"=dword:00000002\n"
40979 " \"ErrorControl\"=dword:00000001\n"
40980 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
40981 " \"DisplayName\"=\"RHSrvAny\"\n"
40982 " \"ObjectName\"=\"NetworkService\"\n"
40987 #: ../tools/virt-win-reg.pl:712
40990 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
40991 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
40992 " \"PWD\"=\"c:\\\\Temp\"\n"
40998 #: ../tools/virt-win-reg.pl:723
41000 "For use of C<ControlSet001> see the section above in this manual page. You "
41001 "may need to adjust this according to the control set that is in use by the "
41006 #: ../tools/virt-win-reg.pl:729
41008 "C<\"ObjectName\"> controls the privileges that the service will have. An "
41009 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
41010 "privileged account."
41014 #: ../tools/virt-win-reg.pl:735
41016 "For the meaning of the magic numbers, see this Microsoft KB article: "
41017 "L<http://support.microsoft.com/kb/103000>."
41021 #: ../tools/virt-win-reg.pl:740
41022 msgid "Update the registry:"
41026 #: ../tools/virt-win-reg.pl:742
41029 " virt-win-reg --merge WindowsGuest service.reg\n"
41034 #: ../tools/virt-win-reg.pl:746
41036 "Be careful when passing parameters containing C<\\> (backslash) in the "
41037 "shell. Usually you will have to use 'single quotes' or double backslashes "
41038 "(but not both) to protect them from the shell."
41042 #: ../tools/virt-win-reg.pl:750
41043 msgid "Paths and value names are case-insensitive."
41047 #: ../tools/virt-win-reg.pl:759
41049 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
41050 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
41051 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
41052 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
41056 #: ../tools/virt-win-reg.pl:777
41059 " export LIBGUESTFS_DEBUG=1\n"
41060 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
41065 #: ../tools/virt-win-reg.pl:780
41067 "Attach /tmp/virt-win-reg.log to a new bug report at "
41068 "L<https://bugzilla.redhat.com/>"