1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
6 # rjones <rjones@redhat.com>, 2011.
7 # <www.carrotsoft@gmail.com>, 2011.
10 "Project-Id-Version: libguestfs\n"
11 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
12 "POT-Creation-Date: 2011-11-24 22:09+0000\n"
13 "PO-Revision-Date: 2011-10-27 09:15+0000\n"
14 "Last-Translator: rjones <rjones@redhat.com>\n"
15 "Language-Team: Japanese <trans-ja@lists.fedoraproject.org>\n"
18 "Content-Type: text/plain; charset=UTF-8\n"
19 "Content-Transfer-Encoding: 8bit\n"
20 "Plural-Forms: nplurals=1; plural=0\n"
23 #: ../align/virt-alignment-scan.pod:3 ../cat/virt-cat.pod:3
24 #: ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3
25 #: ../clone/virt-sysprep.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3
26 #: ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3
27 #: ../examples/guestfs-recipes.pod:14 ../examples/guestfs-testing.pod:3
28 #: ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3
29 #: ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3
30 #: ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3
31 #: ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3
32 #: ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3
33 #: ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3
34 #: ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3
35 #: ../sparsify/virt-sparsify.pod:3 ../src/guestfs.pod:3
36 #: ../test-tool/libguestfs-test-tool.pod:3
37 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
38 #: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
39 #: ../tools/virt-win-reg.pl:35
44 #: ../align/virt-alignment-scan.pod:5
45 msgid "virt-alignment-scan - Check alignment of virtual machine partitions"
49 #: ../align/virt-alignment-scan.pod:7 ../cat/virt-cat.pod:7
50 #: ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
51 #: ../clone/virt-sysprep.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
52 #: ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7
53 #: ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7
54 #: ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7
55 #: ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7
56 #: ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7
57 #: ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7
58 #: ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7
59 #: ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7
60 #: ../sparsify/virt-sparsify.pod:7 ../src/guestfs.pod:7
61 #: ../test-tool/libguestfs-test-tool.pod:7
62 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
63 #: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
64 #: ../tools/virt-win-reg.pl:39
69 #: ../align/virt-alignment-scan.pod:9
72 " virt-alignment-scan [--options] -d domname\n"
77 #: ../align/virt-alignment-scan.pod:11
80 " virt-alignment-scan [--options] -a disk.img [-a disk.img ...]\n"
85 #: ../align/virt-alignment-scan.pod:13 ../cat/virt-cat.pod:19
86 #: ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
87 #: ../clone/virt-sysprep.pod:13 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
88 #: ../erlang/examples/guestfs-erlang.pod:16
89 #: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
90 #: ../examples/guestfs-testing.pod:7 ../fish/guestfish.pod:30
91 #: ../fish/virt-copy-in.pod:19 ../fish/virt-copy-out.pod:13
92 #: ../fish/virt-tar-in.pod:21 ../fish/virt-tar-out.pod:15
93 #: ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pod:19
94 #: ../java/examples/guestfs-java.pod:15 ../ocaml/examples/guestfs-ocaml.pod:25
95 #: ../perl/examples/guestfs-perl.pod:18
96 #: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
97 #: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
98 #: ../sparsify/virt-sparsify.pod:11 ../src/guestfs.pod:23
99 #: ../test-tool/libguestfs-test-tool.pod:11
100 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
101 #: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
102 #: ../tools/virt-win-reg.pl:63
107 #: ../align/virt-alignment-scan.pod:15
109 "When older operating systems install themselves, the partitioning tools "
110 "place partitions at a sector misaligned with the underlying storage "
111 "(commonly the first partition starts on sector C<63>). Misaligned "
112 "partitions can result in an operating system issuing more I/O than should be "
117 #: ../align/virt-alignment-scan.pod:21
119 "The virt-alignment-scan tool checks the alignment of partitions in virtual "
120 "machines and disk images and warns you if there are alignment problems."
124 #: ../align/virt-alignment-scan.pod:25
126 "Currently there is no virt tool for fixing alignment problems. You can only "
127 "reinstall the guest operating system. The following NetApp document "
128 "summarises the problem and possible solutions: L<http://media.netapp.com/"
129 "documents/tr-3747.pdf>"
133 #: ../align/virt-alignment-scan.pod:30
138 #: ../align/virt-alignment-scan.pod:32
139 msgid "To run this tool on a disk image directly, use the I<-a> option:"
143 #: ../align/virt-alignment-scan.pod:34
146 " $ virt-alignment-scan -a winxp.img\n"
147 " /dev/sda1 32256 512 bad (alignment < 4K)\n"
152 #: ../align/virt-alignment-scan.pod:37
155 " $ virt-alignment-scan -a fedora16.img\n"
156 " /dev/sda1 1048576 1024K ok\n"
157 " /dev/sda2 2097152 2048K ok\n"
158 " /dev/sda3 526385152 2048K ok\n"
163 #: ../align/virt-alignment-scan.pod:42
165 "To run the tool on a guest known to libvirt, use the I<-d> option and "
166 "possibly the I<-c> option:"
170 #: ../align/virt-alignment-scan.pod:45
173 " # virt-alignment-scan -d RHEL5\n"
174 " /dev/sda1 32256 512 bad (alignment < 4K)\n"
175 " /dev/sda2 106928640 512 bad (alignment < 4K)\n"
180 #: ../align/virt-alignment-scan.pod:49
183 " $ virt-alignment-scan -c qemu:///system -d Win7TwoDisks\n"
184 " /dev/sda1 1048576 1024K ok\n"
185 " /dev/sda2 105906176 1024K ok\n"
186 " /dev/sdb1 65536 64K ok\n"
191 #: ../align/virt-alignment-scan.pod:54
193 "The output consists of 4 or more whitespace-separated columns. Only the "
194 "first 4 columns are signficant if you want to parse this from a program. "
199 #: ../align/virt-alignment-scan.pod:60
204 #: ../align/virt-alignment-scan.pod:62
206 "the device and partition name (eg. C</dev/sda1> meaning the first partition "
207 "on the first block device)"
211 #: ../align/virt-alignment-scan.pod:65
216 #: ../align/virt-alignment-scan.pod:67
217 msgid "the start of the partition in bytes"
221 #: ../align/virt-alignment-scan.pod:69
226 #: ../align/virt-alignment-scan.pod:71
227 msgid "the alignment in bytes or Kbytes (eg. C<512> or C<4K>)"
231 #: ../align/virt-alignment-scan.pod:73
236 #: ../align/virt-alignment-scan.pod:75
238 "C<ok> if the alignment is best for performance, or C<bad> if the alignment "
239 "can cause performance problems"
243 #: ../align/virt-alignment-scan.pod:78
248 #: ../align/virt-alignment-scan.pod:80
249 msgid "optional free-text explanation."
253 #: ../align/virt-alignment-scan.pod:84
255 "The exit code from the program changes depending on whether poorly aligned "
256 "partitions were found. See L</EXIT STATUS> below."
260 #: ../align/virt-alignment-scan.pod:87
261 msgid "If you just want the exit code with no output, use the I<-q> option."
265 #: ../align/virt-alignment-scan.pod:89 ../cat/virt-cat.pod:62
266 #: ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261
267 #: ../clone/virt-sysprep.pod:42 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
268 #: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
269 #: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
270 #: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:92
271 #: ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84
272 #: ../resize/virt-resize.pod:262 ../sparsify/virt-sparsify.pod:99
273 #: ../test-tool/libguestfs-test-tool.pod:36
274 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
275 #: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
276 #: ../tools/virt-win-reg.pl:96
281 #: ../align/virt-alignment-scan.pod:93 ../cat/virt-cat.pod:66
282 #: ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265
283 #: ../clone/virt-sysprep.pod:46 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
284 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:160
285 #: ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88
286 #: ../resize/virt-resize.pod:266 ../sparsify/virt-sparsify.pod:103
287 #: ../test-tool/libguestfs-test-tool.pod:40
288 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62
289 #: ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111
290 #: ../tools/virt-win-reg.pl:104
295 #: ../align/virt-alignment-scan.pod:95 ../cat/virt-cat.pod:68
296 #: ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267
297 #: ../clone/virt-sysprep.pod:48 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
298 #: ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90
299 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64
300 #: ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113
301 #: ../tools/virt-win-reg.pl:106
302 msgid "Display brief help."
306 #: ../align/virt-alignment-scan.pod:97 ../cat/virt-cat.pod:70
307 #: ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269
308 #: ../clone/virt-sysprep.pod:50 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
309 #: ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
314 #: ../align/virt-alignment-scan.pod:99 ../cat/virt-cat.pod:72
315 #: ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271
316 #: ../clone/virt-sysprep.pod:52 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
317 #: ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
318 msgid "B<--add> file"
322 #: ../align/virt-alignment-scan.pod:101 ../clone/virt-sysprep.pod:54
323 msgid "Add I<file> which should be a disk image from a virtual machine."
327 #: ../align/virt-alignment-scan.pod:103 ../cat/virt-cat.pod:78
328 #: ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277
329 #: ../clone/virt-sysprep.pod:56 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
330 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:102
331 #: ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
333 "The format of the disk image is auto-detected. To override this and force a "
334 "particular format use the I<--format=..> option."
338 #: ../align/virt-alignment-scan.pod:106 ../cat/virt-cat.pod:81
339 #: ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291
340 #: ../clone/virt-sysprep.pod:59 ../df/virt-df.pod:78
341 #: ../rescue/virt-rescue.pod:107
346 #: ../align/virt-alignment-scan.pod:108 ../cat/virt-cat.pod:83
347 #: ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293
348 #: ../clone/virt-sysprep.pod:61 ../df/virt-df.pod:80
349 #: ../rescue/virt-rescue.pod:109
350 msgid "B<--connect> URI"
354 #: ../align/virt-alignment-scan.pod:110 ../cat/virt-cat.pod:85
355 #: ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295
356 #: ../clone/virt-sysprep.pod:63 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
357 #: ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111
358 #: ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82
359 #: ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
361 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
362 "to the default libvirt hypervisor."
366 #: ../align/virt-alignment-scan.pod:113 ../cat/virt-cat.pod:88
367 #: ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298
368 #: ../clone/virt-sysprep.pod:66 ../df/virt-df.pod:85
369 #: ../rescue/virt-rescue.pod:114
371 "If you specify guest block devices directly (I<-a>), then libvirt is not "
376 #: ../align/virt-alignment-scan.pod:116 ../cat/virt-cat.pod:91
377 #: ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307
378 #: ../clone/virt-sysprep.pod:69 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105
379 #: ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
384 #: ../align/virt-alignment-scan.pod:118 ../cat/virt-cat.pod:93
385 #: ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309
386 #: ../clone/virt-sysprep.pod:71 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107
387 #: ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
388 msgid "B<--domain> guest"
392 #: ../align/virt-alignment-scan.pod:120 ../cat/virt-cat.pod:95
393 #: ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311
394 #: ../clone/virt-sysprep.pod:73 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109
395 #: ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
397 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
402 #: ../align/virt-alignment-scan.pod:123 ../cat/virt-cat.pod:105
403 #: ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328
404 #: ../clone/virt-sysprep.pod:95 ../df/virt-df.pod:101
405 #: ../fish/guestfish.pod:233 ../fuse/guestmount.pod:142
406 #: ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
407 msgid "B<--format=raw|qcow2|..>"
411 #: ../align/virt-alignment-scan.pod:125 ../cat/virt-cat.pod:107
412 #: ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330
413 #: ../clone/virt-sysprep.pod:97 ../df/virt-df.pod:103
414 #: ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235
415 #: ../fuse/guestmount.pod:144 ../inspector/virt-inspector.pod:101
416 #: ../rescue/virt-rescue.pod:126
421 #: ../align/virt-alignment-scan.pod:127 ../cat/virt-cat.pod:109
422 #: ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332
423 #: ../clone/virt-sysprep.pod:99 ../df/virt-df.pod:105
424 #: ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237
425 #: ../fuse/guestmount.pod:146 ../rescue/virt-rescue.pod:128
427 "The default for the I<-a> option is to auto-detect the format of the disk "
428 "image. Using this forces the disk format for I<-a> options which follow on "
429 "the command line. Using I<--format> with no argument switches back to auto-"
430 "detection for subsequent I<-a> options."
434 #: ../align/virt-alignment-scan.pod:132 ../cat/virt-cat.pod:114
435 #: ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337
436 #: ../clone/virt-sysprep.pod:104 ../df/virt-df.pod:110
437 #: ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242
438 #: ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:351
439 #: ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2877
444 #: ../align/virt-alignment-scan.pod:134
447 " virt-alignment-scan --format=raw -a disk.img\n"
452 #: ../align/virt-alignment-scan.pod:136 ../cat/virt-cat.pod:118
453 #: ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341
454 #: ../clone/virt-sysprep.pod:108 ../df/virt-df.pod:114
455 #: ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246
456 #: ../rescue/virt-rescue.pod:137
457 msgid "forces raw format (no auto-detection) for C<disk.img>."
461 #: ../align/virt-alignment-scan.pod:138
464 " virt-alignment-scan --format=raw -a disk.img --format -a another.img\n"
469 #: ../align/virt-alignment-scan.pod:140 ../cat/virt-cat.pod:122
470 #: ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345
471 #: ../clone/virt-sysprep.pod:112 ../df/virt-df.pod:118
472 #: ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250
473 #: ../rescue/virt-rescue.pod:141
475 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
476 "detection for C<another.img>."
480 #: ../align/virt-alignment-scan.pod:143 ../cat/virt-cat.pod:125
481 #: ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348
482 #: ../clone/virt-sysprep.pod:115 ../df/virt-df.pod:121
483 #: ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
485 "If you have untrusted raw-format guest disk images, you should use this "
486 "option to specify the disk format. This avoids a possible security problem "
487 "with malicious guests (CVE-2010-3851)."
491 #: ../align/virt-alignment-scan.pod:147 ../resize/virt-resize.pod:491
492 #: ../sparsify/virt-sparsify.pod:152
497 #: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:493
498 #: ../sparsify/virt-sparsify.pod:154
503 #: ../align/virt-alignment-scan.pod:151
505 "Don't produce any output. Just set the exit code (see L</EXIT STATUS> "
510 #: ../align/virt-alignment-scan.pod:154 ../cat/virt-cat.pod:134
511 #: ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425
512 #: ../clone/virt-sysprep.pod:138 ../df/virt-df.pod:173
513 #: ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390
514 #: ../fuse/guestmount.pod:266 ../inspector/virt-inspector.pod:119
515 #: ../rescue/virt-rescue.pod:182 ../sparsify/virt-sparsify.pod:158
520 #: ../align/virt-alignment-scan.pod:156 ../cat/virt-cat.pod:136
521 #: ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427
522 #: ../clone/virt-sysprep.pod:140 ../df/virt-df.pod:175
523 #: ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392
524 #: ../fuse/guestmount.pod:268 ../inspector/virt-inspector.pod:121
525 #: ../rescue/virt-rescue.pod:184 ../sparsify/virt-sparsify.pod:160
530 #: ../align/virt-alignment-scan.pod:158 ../cat/virt-cat.pod:138
531 #: ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429
532 #: ../clone/virt-sysprep.pod:142 ../df/virt-df.pod:177
533 #: ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123
534 #: ../rescue/virt-rescue.pod:186 ../sparsify/virt-sparsify.pod:162
535 msgid "Enable verbose messages for debugging."
539 #: ../align/virt-alignment-scan.pod:160 ../cat/virt-cat.pod:140
540 #: ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431
541 #: ../clone/virt-sysprep.pod:144 ../df/virt-df.pod:179
542 #: ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397
543 #: ../fuse/guestmount.pod:272 ../inspector/virt-inspector.pod:125
544 #: ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:561
545 #: ../sparsify/virt-sparsify.pod:164
550 #: ../align/virt-alignment-scan.pod:162 ../cat/virt-cat.pod:142
551 #: ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433
552 #: ../clone/virt-sysprep.pod:146 ../df/virt-df.pod:181
553 #: ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399
554 #: ../fuse/guestmount.pod:274 ../inspector/virt-inspector.pod:127
555 #: ../rescue/virt-rescue.pod:190 ../resize/virt-resize.pod:563
556 #: ../sparsify/virt-sparsify.pod:166 ../tools/virt-list-filesystems.pl:69
557 #: ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169
558 #: ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
563 #: ../align/virt-alignment-scan.pod:164 ../cat/virt-cat.pod:144
564 #: ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435
565 #: ../clone/virt-sysprep.pod:148 ../df/virt-df.pod:183
566 #: ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129
567 #: ../rescue/virt-rescue.pod:192 ../resize/virt-resize.pod:565
568 #: ../sparsify/virt-sparsify.pod:168 ../tools/virt-list-filesystems.pl:71
569 #: ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171
570 #: ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
571 msgid "Display version number and exit."
575 #: ../align/virt-alignment-scan.pod:166 ../cat/virt-cat.pod:146
576 #: ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437
577 #: ../clone/virt-sysprep.pod:150 ../df/virt-df.pod:185
578 #: ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412
579 #: ../fuse/guestmount.pod:287 ../inspector/virt-inspector.pod:131
580 #: ../rescue/virt-rescue.pod:203 ../sparsify/virt-sparsify.pod:170
581 #: ../tools/virt-tar.pl:158
586 #: ../align/virt-alignment-scan.pod:168 ../cat/virt-cat.pod:148
587 #: ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439
588 #: ../clone/virt-sysprep.pod:152 ../df/virt-df.pod:187
589 #: ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133
590 #: ../rescue/virt-rescue.pod:205 ../sparsify/virt-sparsify.pod:172
591 msgid "Enable tracing of libguestfs API calls."
595 #: ../align/virt-alignment-scan.pod:172
596 msgid "RECOMMENDED ALIGNMENT"
600 #: ../align/virt-alignment-scan.pod:174
602 "Operating systems older than Windows 2008 and Linux before ca.2010 place the "
603 "first sector of the first partition at sector 63, with a 512 byte sector "
604 "size. This happens because of a historical accident. Drives have to report "
605 "a cylinder / head / sector (CHS) geometry to the BIOS. The geometry is "
606 "completely meaningless on modern drives, but it happens that the geometry "
607 "reported always has 63 sectors per track. The operating system therefore "
608 "places the first partition at the start of the second \"track\", at sector "
613 #: ../align/virt-alignment-scan.pod:183
615 "When the guest OS is virtualized, the host operating system and hypervisor "
616 "may prefer accesses aligned to one of:"
620 #: ../align/virt-alignment-scan.pod:188
625 #: ../align/virt-alignment-scan.pod:190
627 "if the host OS uses local storage directly on hard drive partitions, and the "
628 "hard drive has 512 byte physical sectors."
632 #: ../align/virt-alignment-scan.pod:193
637 #: ../align/virt-alignment-scan.pod:195
639 "for local storage on new hard drives with 4Kbyte physical sectors; for file-"
640 "backed storage on filesystems with 4Kbyte block size; or for some types of "
641 "network-attached storage."
645 #: ../align/virt-alignment-scan.pod:199
650 #: ../align/virt-alignment-scan.pod:201
652 "for high-end network-attached storage. This is the optimal block size for "
653 "some NetApp hardware."
657 #: ../align/virt-alignment-scan.pod:204
662 #: ../align/virt-alignment-scan.pod:206
663 msgid "see L</1 MB PARTITION ALIGNMENT> below."
667 #: ../align/virt-alignment-scan.pod:210
669 "Partitions which are not aligned correctly to the underlying storage cause "
670 "extra I/O. For example:"
674 #: ../align/virt-alignment-scan.pod:213
678 " +--------------------------+------\n"
680 " | filesystem block |\n"
681 " ---+------------------+------+-------------------+-----+---\n"
682 " | host block | host block |\n"
684 " ---+-------------------------+-------------------------+---\n"
689 #: ../align/virt-alignment-scan.pod:222
691 "In this example, each time a 4K guest block is read, two blocks on the host "
692 "must be accessed (so twice as much I/O is done). When a 4K guest block is "
693 "written, two host blocks must first be read, the old and new data combined, "
694 "and the two blocks written back (4x I/O)."
698 #: ../align/virt-alignment-scan.pod:227
699 msgid "LINUX HOST BLOCK AND I/O SIZE"
703 #: ../align/virt-alignment-scan.pod:229
705 "New versions of the Linux kernel expose the physical and logical block size, "
706 "and minimum and recommended I/O size."
710 #: ../align/virt-alignment-scan.pod:232
711 msgid "For a typical consumer hard drive with 512 byte sectors:"
715 #: ../align/virt-alignment-scan.pod:234
718 " $ cat /sys/block/sda/queue/hw_sector_size\n"
720 " $ cat /sys/block/sda/queue/physical_block_size\n"
722 " $ cat /sys/block/sda/queue/logical_block_size\n"
724 " $ cat /sys/block/sda/queue/minimum_io_size\n"
726 " $ cat /sys/block/sda/queue/optimal_io_size\n"
732 #: ../align/virt-alignment-scan.pod:245
733 msgid "For a new consumer hard drive with 4Kbyte sectors:"
737 #: ../align/virt-alignment-scan.pod:247
740 " $ cat /sys/block/sda/queue/hw_sector_size\n"
742 " $ cat /sys/block/sda/queue/physical_block_size\n"
744 " $ cat /sys/block/sda/queue/logical_block_size\n"
746 " $ cat /sys/block/sda/queue/minimum_io_size\n"
748 " $ cat /sys/block/sda/queue/optimal_io_size\n"
754 #: ../align/virt-alignment-scan.pod:258
755 msgid "For a NetApp LUN:"
759 #: ../align/virt-alignment-scan.pod:260
762 " $ cat /sys/block/sdc/queue/logical_block_size\n"
764 " $ cat /sys/block/sdc/queue/physical_block_size\n"
766 " $ cat /sys/block/sdc/queue/minimum_io_size\n"
768 " $ cat /sys/block/sdc/queue/optimal_io_size\n"
774 #: ../align/virt-alignment-scan.pod:269
776 "The NetApp allows 512 byte accesses (but they will be very inefficient), "
777 "prefers a minimum 4K I/O size, but the optimal I/O size is 64K."
781 #: ../align/virt-alignment-scan.pod:273
783 "For detailed information about what these numbers mean, see L<http://docs."
784 "redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/"
785 "Storage_Administration_Guide/newstorage-iolimits.html>"
789 #: ../align/virt-alignment-scan.pod:276
791 "[Thanks to Matt Booth for providing 4K drive data. Thanks to Mike Snitzer "
792 "for providing NetApp data and additional information.]"
796 #: ../align/virt-alignment-scan.pod:279
797 msgid "1 MB PARTITION ALIGNMENT"
801 #: ../align/virt-alignment-scan.pod:281
803 "Microsoft picked 1 MB as the default alignment for all partitions starting "
804 "with Windows 2008 Server, and Linux has followed this."
808 #: ../align/virt-alignment-scan.pod:284
810 "Assuming 512 byte sectors in the guest, you will now see the first partition "
811 "starting at sector 2048, and subsequent partitions (if any) will start at a "
812 "multiple of 2048 sectors."
816 #: ../align/virt-alignment-scan.pod:288
818 "1 MB alignment is compatible with all current alignment requirements (4K, "
819 "64K) and provides room for future growth in physical block sizes."
823 #: ../align/virt-alignment-scan.pod:291
824 msgid "SETTING ALIGNMENT"
828 #: ../align/virt-alignment-scan.pod:293
830 "L<virt-resize(1)> can change the alignment of the partitions of some "
831 "guests. Currently it can fully align all the partitions of all Windows "
832 "guests, and it will fix the bootloader where necessary. For Linux guests, "
833 "it can align the second and subsequent partitions, so the majority of OS "
834 "accesses except at boot will be aligned."
838 #: ../align/virt-alignment-scan.pod:299
840 "Another way to correct partition alignment problems is to reinstall your "
841 "guest operating systems. If you install operating systems from templates, "
842 "ensure these have correct partition alignment too."
846 #: ../align/virt-alignment-scan.pod:303
848 "For older versions of Windows, the following NetApp document contains useful "
849 "information: L<http://media.netapp.com/documents/tr-3747.pdf>"
853 #: ../align/virt-alignment-scan.pod:306
855 "For Red Hat Enterprise Linux E<le> 5, use a Kickstart script that contains "
856 "an explicit C<%pre> section that creates aligned partitions using L<parted(8)"
857 ">. Do not use the Kickstart C<part> command. The NetApp document above "
858 "contains an example."
862 #: ../align/virt-alignment-scan.pod:311 ../cat/virt-cat.pod:231
863 #: ../cat/virt-filesystems.pod:373 ../cat/virt-ls.pod:483
864 #: ../clone/virt-sysprep.pod:475 ../df/virt-df.pod:241
865 #: ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:367
866 #: ../rescue/virt-rescue.pod:266 ../resize/virt-resize.pod:676
867 #: ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258
868 #: ../tools/virt-make-fs.pl:550 ../tools/virt-tar.pl:289
869 #: ../tools/virt-win-reg.pl:744
870 msgid "SHELL QUOTING"
874 #: ../align/virt-alignment-scan.pod:313 ../cat/virt-cat.pod:233
875 #: ../cat/virt-filesystems.pod:375 ../cat/virt-ls.pod:485
876 #: ../clone/virt-sysprep.pod:477 ../df/virt-df.pod:243
877 #: ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:369
878 #: ../rescue/virt-rescue.pod:268 ../resize/virt-resize.pod:678
879 #: ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260
880 #: ../tools/virt-make-fs.pl:552 ../tools/virt-tar.pl:291
881 #: ../tools/virt-win-reg.pl:752
883 "Libvirt guest names can contain arbitrary characters, some of which have "
884 "meaning to the shell such as C<#> and space. You may need to quote or "
885 "escape these characters on the command line. See the shell manual page L<sh"
890 #: ../align/virt-alignment-scan.pod:318 ../cat/virt-cat.pod:238
891 #: ../cat/virt-filesystems.pod:380 ../cat/virt-ls.pod:490
892 #: ../clone/virt-sysprep.pod:482 ../df/virt-df.pod:248
893 #: ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1114
894 #: ../fuse/guestmount.pod:312 ../inspector/virt-inspector.pod:390
895 #: ../resize/virt-resize.pod:683 ../sparsify/virt-sparsify.pod:226
896 #: ../test-tool/libguestfs-test-tool.pod:90
901 #: ../align/virt-alignment-scan.pod:320
902 msgid "This program returns:"
906 #: ../align/virt-alignment-scan.pod:324 ../align/virt-alignment-scan.pod:330
907 #: ../align/virt-alignment-scan.pod:336 ../align/virt-alignment-scan.pod:343
908 #: ../cat/virt-cat.pod:177 ../cat/virt-cat.pod:182 ../cat/virt-cat.pod:187
909 #: ../cat/virt-cat.pod:198 ../cat/virt-cat.pod:202
910 #: ../clone/virt-sysprep.pod:283 ../clone/virt-sysprep.pod:287
911 #: ../clone/virt-sysprep.pod:291 ../clone/virt-sysprep.pod:295
912 #: ../clone/virt-sysprep.pod:310 ../clone/virt-sysprep.pod:314
913 #: ../clone/virt-sysprep.pod:318 ../clone/virt-sysprep.pod:322
914 #: ../clone/virt-sysprep.pod:326 ../clone/virt-sysprep.pod:362
915 #: ../clone/virt-sysprep.pod:384 ../clone/virt-sysprep.pod:388
916 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266
917 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
918 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
919 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
920 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
921 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
922 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
923 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
924 #: ../examples/guestfs-testing.pod:110 ../examples/guestfs-testing.pod:114
925 #: ../examples/guestfs-testing.pod:118 ../fish/guestfish-actions.pod:13
926 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:441
927 #: ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:456
928 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:1262
929 #: ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270
930 #: ../fish/guestfish-actions.pod:1274 ../fish/guestfish-actions.pod:1282
931 #: ../fish/guestfish-actions.pod:1286 ../fish/guestfish-actions.pod:1290
932 #: ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1304
933 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1398
934 #: ../fish/guestfish-actions.pod:1402 ../fish/guestfish-actions.pod:1407
935 #: ../fish/guestfish-actions.pod:1412 ../fish/guestfish-actions.pod:1454
936 #: ../fish/guestfish-actions.pod:1458 ../fish/guestfish-actions.pod:1463
937 #: ../fish/guestfish-actions.pod:1719 ../fish/guestfish-actions.pod:1726
938 #: ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:2136
939 #: ../fish/guestfish-actions.pod:2142 ../fish/guestfish-actions.pod:2150
940 #: ../fish/guestfish-actions.pod:2157 ../fish/guestfish-actions.pod:2164
941 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
942 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
943 #: ../inspector/virt-inspector.pod:408 ../inspector/virt-inspector.pod:412
944 #: ../resize/virt-resize.pod:359 ../resize/virt-resize.pod:363
945 #: ../resize/virt-resize.pod:372 ../resize/virt-resize.pod:378
946 #: ../sparsify/virt-sparsify.pod:32 ../sparsify/virt-sparsify.pod:39
947 #: ../sparsify/virt-sparsify.pod:43 ../sparsify/virt-sparsify.pod:49
948 #: ../sparsify/virt-sparsify.pod:54 ../sparsify/virt-sparsify.pod:58
949 #: ../sparsify/virt-sparsify.pod:64 ../src/guestfs-actions.pod:22
950 #: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:641
951 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:656
952 #: ../src/guestfs-actions.pod:663 ../src/guestfs-actions.pod:2079
953 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2087
954 #: ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:2099
955 #: ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2107
956 #: ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:2121
957 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:2263
958 #: ../src/guestfs-actions.pod:2267 ../src/guestfs-actions.pod:2272
959 #: ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2338
960 #: ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:2347
961 #: ../src/guestfs-actions.pod:2762 ../src/guestfs-actions.pod:2769
962 #: ../src/guestfs-actions.pod:2776 ../src/guestfs-actions.pod:3321
963 #: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3335
964 #: ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3349
965 #: ../src/guestfs.pod:403 ../src/guestfs.pod:408 ../src/guestfs.pod:413
966 #: ../src/guestfs.pod:417 ../src/guestfs.pod:422 ../src/guestfs.pod:426
967 #: ../src/guestfs.pod:431 ../src/guestfs.pod:436 ../src/guestfs.pod:1109
968 #: ../src/guestfs.pod:1113 ../src/guestfs.pod:1117 ../src/guestfs.pod:1122
969 #: ../src/guestfs.pod:1130 ../src/guestfs.pod:1149 ../src/guestfs.pod:1157
970 #: ../src/guestfs.pod:1179 ../src/guestfs.pod:1183 ../src/guestfs.pod:1187
971 #: ../src/guestfs.pod:1191 ../src/guestfs.pod:1195 ../src/guestfs.pod:1199
972 #: ../src/guestfs.pod:1689 ../src/guestfs.pod:1694 ../src/guestfs.pod:1698
973 #: ../src/guestfs.pod:1800 ../src/guestfs.pod:1805 ../src/guestfs.pod:1809
974 #: ../src/guestfs.pod:1819 ../src/guestfs.pod:2108 ../src/guestfs.pod:2113
975 #: ../src/guestfs.pod:2119 ../src/guestfs.pod:2127 ../src/guestfs.pod:2645
976 #: ../src/guestfs.pod:2651 ../src/guestfs.pod:2656 ../src/guestfs.pod:2662
977 #: ../src/guestfs.pod:3067 ../src/guestfs.pod:3072 ../src/guestfs.pod:3076
978 #: ../src/guestfs.pod:3080 ../src/guestfs.pod:3084 ../src/guestfs.pod:3098
979 #: ../src/guestfs.pod:3103 ../src/guestfs.pod:3335 ../src/guestfs.pod:3339
980 #: ../src/guestfs.pod:3343 ../src/guestfs.pod:3347
981 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
982 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:721
983 #: ../tools/virt-win-reg.pl:727 ../tools/virt-win-reg.pl:733
988 #: ../align/virt-alignment-scan.pod:326
993 #: ../align/virt-alignment-scan.pod:328
995 "successful exit, all partitions are aligned E<ge> 64K for best performance"
999 #: ../align/virt-alignment-scan.pod:332
1004 #: ../align/virt-alignment-scan.pod:334
1005 msgid "an error scanning the disk image or guest"
1009 #: ../align/virt-alignment-scan.pod:338
1014 #: ../align/virt-alignment-scan.pod:340
1016 "successful exit, some partitions have alignment E<lt> 64K which can result "
1017 "in poor performance on high end network storage"
1021 #: ../align/virt-alignment-scan.pod:345
1026 #: ../align/virt-alignment-scan.pod:347
1028 "successful exit, some partitions have alignment E<lt> 4K which can result in "
1029 "poor performance on most hypervisors"
1033 #: ../align/virt-alignment-scan.pod:352 ../cat/virt-cat.pod:243
1034 #: ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:495
1035 #: ../clone/virt-sysprep.pod:486 ../df/virt-df.pod:253
1036 #: ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97
1037 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
1038 #: ../examples/guestfs-testing.pod:291 ../fish/guestfish.pod:1268
1039 #: ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39
1040 #: ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41
1041 #: ../fuse/guestmount.pod:317 ../inspector/virt-inspector.pod:395
1042 #: ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78
1043 #: ../perl/examples/guestfs-perl.pod:39
1044 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:288
1045 #: ../resize/virt-resize.pod:688 ../ruby/examples/guestfs-ruby.pod:36
1046 #: ../sparsify/virt-sparsify.pod:250 ../src/guestfs.pod:3275
1047 #: ../test-tool/libguestfs-test-tool.pod:100
1048 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
1049 #: ../tools/virt-make-fs.pl:557 ../tools/virt-tar.pl:296
1050 #: ../tools/virt-win-reg.pl:757
1055 #: ../align/virt-alignment-scan.pod:354
1057 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-rescue(1)>, "
1058 "L<virt-resize(1)>, L<http://libguestfs.org/>."
1062 #: ../align/virt-alignment-scan.pod:361 ../cat/virt-cat.pod:252
1063 #: ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:507
1064 #: ../clone/virt-sysprep.pod:501 ../df/virt-df.pod:261
1065 #: ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:296
1066 #: ../resize/virt-resize.pod:711 ../sparsify/virt-sparsify.pod:263
1067 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
1068 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:311
1069 #: ../tools/virt-win-reg.pl:783
1074 #: ../align/virt-alignment-scan.pod:363 ../cat/virt-cat.pod:254
1075 #: ../cat/virt-filesystems.pod:398 ../cat/virt-ls.pod:509
1076 #: ../clone/virt-sysprep.pod:503 ../df/virt-df.pod:263
1077 #: ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:410
1078 #: ../rescue/virt-rescue.pod:298 ../resize/virt-resize.pod:713
1079 #: ../sparsify/virt-sparsify.pod:265 ../tools/virt-list-filesystems.pl:210
1080 #: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:584
1081 #: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:785
1082 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
1086 #: ../align/virt-alignment-scan.pod:365 ../cat/virt-cat.pod:256
1087 #: ../cat/virt-filesystems.pod:400 ../cat/virt-ls.pod:511
1088 #: ../clone/virt-sysprep.pod:505 ../df/virt-df.pod:265
1089 #: ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114
1090 #: ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401
1091 #: ../examples/guestfs-testing.pod:302 ../fish/guestfish.pod:1300
1092 #: ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53
1093 #: ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55
1094 #: ../fuse/guestmount.pod:332 ../inspector/virt-inspector.pod:418
1095 #: ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95
1096 #: ../perl/examples/guestfs-perl.pod:56
1097 #: ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:300
1098 #: ../resize/virt-resize.pod:715 ../ruby/examples/guestfs-ruby.pod:52
1099 #: ../sparsify/virt-sparsify.pod:267 ../src/guestfs.pod:3358
1100 #: ../test-tool/libguestfs-test-tool.pod:110
1101 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
1102 #: ../tools/virt-make-fs.pl:586 ../tools/virt-tar.pl:315
1103 #: ../tools/virt-win-reg.pl:787
1108 #: ../align/virt-alignment-scan.pod:367 ../clone/virt-sysprep.pod:507
1109 #: ../sparsify/virt-sparsify.pod:269
1110 msgid "Copyright (C) 2011 Red Hat Inc."
1114 #: ../align/virt-alignment-scan.pod:369 ../cat/virt-cat.pod:260
1115 #: ../cat/virt-filesystems.pod:404 ../cat/virt-ls.pod:515
1116 #: ../clone/virt-sysprep.pod:509 ../df/virt-df.pod:269
1117 #: ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1305
1118 #: ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58
1119 #: ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60
1120 #: ../fuse/guestmount.pod:337 ../inspector/virt-inspector.pod:422
1121 #: ../rescue/virt-rescue.pod:304 ../resize/virt-resize.pod:719
1122 #: ../sparsify/virt-sparsify.pod:271 ../test-tool/libguestfs-test-tool.pod:115
1123 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
1124 #: ../tools/virt-make-fs.pl:590 ../tools/virt-tar.pl:319
1125 #: ../tools/virt-win-reg.pl:791
1127 "This program is free software; you can redistribute it and/or modify it "
1128 "under the terms of the GNU General Public License as published by the Free "
1129 "Software Foundation; either version 2 of the License, or (at your option) "
1130 "any later version."
1134 #: ../align/virt-alignment-scan.pod:374 ../cat/virt-cat.pod:265
1135 #: ../cat/virt-filesystems.pod:409 ../cat/virt-ls.pod:520
1136 #: ../clone/virt-sysprep.pod:514 ../df/virt-df.pod:274
1137 #: ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1310
1138 #: ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63
1139 #: ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65
1140 #: ../fuse/guestmount.pod:342 ../inspector/virt-inspector.pod:427
1141 #: ../rescue/virt-rescue.pod:309 ../resize/virt-resize.pod:724
1142 #: ../sparsify/virt-sparsify.pod:276 ../test-tool/libguestfs-test-tool.pod:120
1143 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
1144 #: ../tools/virt-make-fs.pl:595 ../tools/virt-tar.pl:324
1145 #: ../tools/virt-win-reg.pl:796
1147 "This program is distributed in the hope that it will be useful, but WITHOUT "
1148 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
1149 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
1154 #: ../align/virt-alignment-scan.pod:379 ../cat/virt-cat.pod:270
1155 #: ../cat/virt-filesystems.pod:414 ../cat/virt-ls.pod:525
1156 #: ../clone/virt-sysprep.pod:519 ../df/virt-df.pod:279
1157 #: ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1315
1158 #: ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68
1159 #: ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70
1160 #: ../fuse/guestmount.pod:347 ../inspector/virt-inspector.pod:432
1161 #: ../rescue/virt-rescue.pod:314 ../resize/virt-resize.pod:729
1162 #: ../sparsify/virt-sparsify.pod:281 ../test-tool/libguestfs-test-tool.pod:125
1163 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
1164 #: ../tools/virt-make-fs.pl:600 ../tools/virt-tar.pl:329
1165 #: ../tools/virt-win-reg.pl:801
1167 "You should have received a copy of the GNU General Public License along with "
1168 "this program; if not, write to the Free Software Foundation, Inc., 51 "
1169 "Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA."
1173 #: ../cat/virt-cat.pod:5
1174 msgid "virt-cat - Display files in a virtual machine"
1178 #: ../cat/virt-cat.pod:9
1181 " virt-cat [--options] -d domname file [file ...]\n"
1186 #: ../cat/virt-cat.pod:11
1189 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
1194 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
1195 #: ../inspector/virt-inspector.pod:13
1200 #: ../cat/virt-cat.pod:15
1203 " virt-cat domname file\n"
1208 #: ../cat/virt-cat.pod:17
1211 " virt-cat disk.img file\n"
1216 #: ../cat/virt-cat.pod:21
1218 "C<virt-cat> is a command line tool to display the contents of C<file> where "
1219 "C<file> exists in the named virtual machine (or disk image)."
1223 #: ../cat/virt-cat.pod:24
1225 "Multiple filenames can be given, in which case they are concatenated "
1226 "together. Each filename must be a full path, starting at the root directory "
1227 "(starting with '/')."
1231 #: ../cat/virt-cat.pod:28
1233 "C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
1234 "edit>. For more complex cases you should look at the L<guestfish(1)> tool "
1235 "(see L</USING GUESTFISH> below)."
1239 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
1240 #: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
1241 #: ../fish/guestfish.pod:1051 ../fish/virt-copy-in.pod:29
1242 #: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
1243 #: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
1244 #: ../resize/virt-resize.pod:27 ../sparsify/virt-sparsify.pod:75
1245 #: ../tools/virt-tar.pl:50
1250 #: ../cat/virt-cat.pod:34
1252 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
1256 #: ../cat/virt-cat.pod:37
1259 " virt-cat -d mydomain /etc/fstab\n"
1264 #: ../cat/virt-cat.pod:39
1265 msgid "List syslog messages from a VM disk image file:"
1269 #: ../cat/virt-cat.pod:41
1272 " virt-cat -a disk.img /var/log/messages | tail\n"
1277 #: ../cat/virt-cat.pod:43
1278 msgid "Find out what DHCP IP address a VM acquired:"
1282 #: ../cat/virt-cat.pod:45
1285 " virt-cat -d mydomain /var/log/messages | \\\n"
1286 " grep 'dhclient: bound to' | tail\n"
1291 #: ../cat/virt-cat.pod:48
1292 msgid "Find out what packages were recently installed:"
1296 #: ../cat/virt-cat.pod:50
1299 " virt-cat -d mydomain /var/log/yum.log | tail\n"
1304 #: ../cat/virt-cat.pod:52
1305 msgid "Find out who is logged on inside a virtual machine:"
1309 #: ../cat/virt-cat.pod:54
1312 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
1318 #: ../cat/virt-cat.pod:57
1319 msgid "or who was logged on:"
1323 #: ../cat/virt-cat.pod:59
1326 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
1327 " last -f /tmp/wtmp\n"
1332 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
1333 #: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
1334 #: ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
1336 "Add I<file> which should be a disk image from a virtual machine. If the "
1337 "virtual machine has multiple block devices, you must supply all of them with "
1338 "separate I<-a> options."
1342 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
1343 #: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
1344 #: ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:92
1345 msgid "B<--echo-keys>"
1349 #: ../cat/virt-cat.pod:100
1351 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
1352 "so you cannot see what you are typing. If you are not worried about Tempest "
1353 "attacks and there is no one else in the room you can specify this flag to "
1354 "see what you are typing."
1358 #: ../cat/virt-cat.pod:116
1361 " virt-cat --format=raw -a disk.img file\n"
1366 #: ../cat/virt-cat.pod:120
1369 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
1374 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
1375 #: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
1376 #: ../fuse/guestmount.pod:172 ../inspector/virt-inspector.pod:114
1377 msgid "B<--keys-from-stdin>"
1381 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
1382 #: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
1383 #: ../fuse/guestmount.pod:174 ../inspector/virt-inspector.pod:116
1385 "Read key or passphrase parameters from stdin. The default is to try to read "
1386 "passphrases from the user by opening C</dev/tty>."
1390 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
1391 #: ../inspector/virt-inspector.pod:144 ../rescue/virt-rescue.pod:209
1392 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
1396 #: ../cat/virt-cat.pod:154
1397 msgid "Previous versions of virt-cat allowed you to write either:"
1401 #: ../cat/virt-cat.pod:156
1404 " virt-cat disk.img [disk.img ...] file\n"
1409 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
1410 #: ../inspector/virt-inspector.pod:150 ../rescue/virt-rescue.pod:215
1415 #: ../cat/virt-cat.pod:160
1418 " virt-cat guestname file\n"
1423 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
1424 #: ../inspector/virt-inspector.pod:154 ../rescue/virt-rescue.pod:219
1426 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
1427 "the confusing case where a disk image might have the same name as a guest."
1431 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
1432 #: ../inspector/virt-inspector.pod:158 ../rescue/virt-rescue.pod:223
1433 msgid "For compatibility the old style is still supported."
1437 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
1438 msgid "WINDOWS PATHS"
1442 #: ../cat/virt-cat.pod:170
1444 "C<virt-cat> has a limited ability to understand Windows drive letters and "
1445 "paths (eg. C<E:\\foo\\bar.txt>)."
1449 #: ../cat/virt-cat.pod:173 ../edit/virt-edit.pod:262
1450 msgid "If and only if the guest is running Windows then:"
1454 #: ../cat/virt-cat.pod:179 ../edit/virt-edit.pod:268
1456 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
1457 "to the correct filesystem."
1461 #: ../cat/virt-cat.pod:184 ../edit/virt-edit.pod:273
1463 "Any backslash (C<\\>) characters in the path are replaced with forward "
1464 "slashes so that libguestfs can process it."
1468 #: ../cat/virt-cat.pod:189
1470 "The path is resolved case insensitively to locate the file that should be "
1475 #: ../cat/virt-cat.pod:194 ../edit/virt-edit.pod:283
1476 msgid "There are some known shortcomings:"
1480 #: ../cat/virt-cat.pod:200 ../edit/virt-edit.pod:289
1481 msgid "Some NTFS symbolic links may not be followed correctly."
1485 #: ../cat/virt-cat.pod:204 ../edit/virt-edit.pod:293
1486 msgid "NTFS junction points that cross filesystems are not followed."
1490 #: ../cat/virt-cat.pod:208 ../edit/virt-edit.pod:297
1491 msgid "USING GUESTFISH"
1495 #: ../cat/virt-cat.pod:210
1497 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
1498 "C<virt-cat> doesn't work."
1502 #: ../cat/virt-cat.pod:213
1503 msgid "Using C<virt-cat> is approximately equivalent to doing:"
1507 #: ../cat/virt-cat.pod:215
1510 " guestfish --ro -i -d domname download file -\n"
1515 #: ../cat/virt-cat.pod:217
1517 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
1518 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
1522 #: ../cat/virt-cat.pod:221
1524 "The command above uses libguestfs's guest inspection feature and so does not "
1525 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
1526 "disk images that don't contain guests. To display a file from a disk image "
1531 #: ../cat/virt-cat.pod:226
1534 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
1539 #: ../cat/virt-cat.pod:228
1541 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
1542 "the disk image, and C<file> is the full path to the file."
1546 #: ../cat/virt-cat.pod:240 ../cat/virt-filesystems.pod:382
1547 #: ../cat/virt-ls.pod:492 ../df/virt-df.pod:250 ../edit/virt-edit.pod:351
1548 #: ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:392
1549 #: ../resize/virt-resize.pod:685 ../sparsify/virt-sparsify.pod:228
1551 "This program returns 0 if successful, or non-zero if there was an error."
1555 #: ../cat/virt-cat.pod:245
1557 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
1558 "tar-out(1)>, L<http://libguestfs.org/>."
1562 #: ../cat/virt-cat.pod:258 ../inspector/virt-inspector.pod:420
1563 #: ../resize/virt-resize.pod:717 ../tools/virt-make-fs.pl:588
1564 msgid "Copyright (C) 2010-2011 Red Hat Inc."
1568 #: ../cat/virt-filesystems.pod:5
1570 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
1571 "virtual machine or disk image"
1575 #: ../cat/virt-filesystems.pod:9
1578 " virt-filesystems [--options] -d domname\n"
1583 #: ../cat/virt-filesystems.pod:11
1586 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
1591 #: ../cat/virt-filesystems.pod:15
1593 "This tool allows you to discover filesystems, partitions, logical volumes, "
1594 "and their sizes in a disk image or virtual machine. It is a replacement for "
1595 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
1599 #: ../cat/virt-filesystems.pod:20
1601 "One use for this tool is from shell scripts to iterate over all filesystems "
1602 "from a disk image:"
1606 #: ../cat/virt-filesystems.pod:23
1609 " for fs in $(virt-filesystems -a disk.img); do\n"
1616 #: ../cat/virt-filesystems.pod:27
1618 "Another use is to list partitions before using another tool to modify those "
1619 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
1620 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
1624 #: ../cat/virt-filesystems.pod:32
1626 "Various command line options control what this program displays. You need "
1627 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
1628 "guest respectively. If you just specify that then the program shows "
1629 "filesystems found, one per line, like this:"
1633 #: ../cat/virt-filesystems.pod:37
1636 " $ virt-filesystems -a disk.img\n"
1638 " /dev/vg_guest/lv_root\n"
1643 #: ../cat/virt-filesystems.pod:41
1645 "If you add I<-l> or I<--long> then the output includes extra information:"
1649 #: ../cat/virt-filesystems.pod:44
1652 " $ virt-filesystems -a disk.img -l\n"
1653 " Name Type VFS Label Size\n"
1654 " /dev/sda1 filesystem ext4 boot 524288000\n"
1655 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
1660 #: ../cat/virt-filesystems.pod:49
1662 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
1667 #: ../cat/virt-filesystems.pod:52
1670 " $ virt-filesystems -a disk.img --extra\n"
1672 " /dev/vg_guest/lv_root\n"
1673 " /dev/vg_guest/lv_swap\n"
1674 " /dev/vg_guest/lv_data\n"
1679 #: ../cat/virt-filesystems.pod:58
1681 "If you add I<--partitions> then partitions are shown instead of filesystems:"
1685 #: ../cat/virt-filesystems.pod:60
1688 " $ virt-filesystems -a disk.img --partitions\n"
1695 #: ../cat/virt-filesystems.pod:64
1697 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
1698 "volumes>, I<--block-devices> to list those items."
1702 #: ../cat/virt-filesystems.pod:67
1704 "You can use these options in combination as well (if you want a combination "
1705 "including filesystems, you have to add I<--filesystems>). Notice that some "
1706 "items fall into several categories (eg. C</dev/sda1> might be both a "
1707 "partition and a filesystem). These items are listed several times. To get "
1708 "a list which includes absolutely everything that virt-filesystems knows "
1709 "about, use the I<--all> option."
1713 #: ../cat/virt-filesystems.pod:74
1715 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
1716 "uuid> option to display device and filesystem UUIDs in the long output."
1720 #: ../cat/virt-filesystems.pod:78
1722 "I<--all --long --uuid> is a useful combination to display all possible "
1723 "information about everything."
1727 #: ../cat/virt-filesystems.pod:81
1730 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
1731 " Name Type VFS Label Size Parent UUID\n"
1732 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
1733 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
1734 " /dev/sda1 partition - - 100M /dev/sda -\n"
1735 " /dev/sda2 partition - - 20G /dev/sda -\n"
1736 " /dev/sda device - - 20G - -\n"
1741 #: ../cat/virt-filesystems.pod:89
1743 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
1747 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
1752 #: ../cat/virt-filesystems.pod:112
1754 "Display everything. This is currently the same as specifying these options: "
1755 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
1756 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
1757 "added to this list in future)."
1761 #: ../cat/virt-filesystems.pod:117
1762 msgid "See also I<--long>."
1766 #: ../cat/virt-filesystems.pod:119
1767 msgid "B<--blkdevs>"
1771 #: ../cat/virt-filesystems.pod:121
1772 msgid "B<--block-devices>"
1776 #: ../cat/virt-filesystems.pod:123
1777 msgid "Display block devices."
1781 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1786 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1788 "Write out the results in CSV format (comma-separated values). This format "
1789 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1790 "ABOUT CSV FORMAT> below."
1794 #: ../cat/virt-filesystems.pod:150
1796 "When prompting for keys and passphrases, virt-filesystems normally turns "
1797 "echoing off so you cannot see what you are typing. If you are not worried "
1798 "about Tempest attacks and there is no one else in the room you can specify "
1799 "this flag to see what you are typing."
1803 #: ../cat/virt-filesystems.pod:155
1808 #: ../cat/virt-filesystems.pod:157
1810 "This causes filesystems that are not ordinary, mountable filesystems to be "
1811 "displayed. This category includes swapspace, and filesystems that are empty "
1812 "or contain unknown data."
1816 #: ../cat/virt-filesystems.pod:161
1817 msgid "This option implies I<--filesystems>."
1821 #: ../cat/virt-filesystems.pod:163
1822 msgid "B<--filesystems>"
1826 #: ../cat/virt-filesystems.pod:165
1828 "Display mountable filesystems. If no display option was selected then this "
1829 "option is implied."
1833 #: ../cat/virt-filesystems.pod:168
1834 msgid "With I<--extra>, non-mountable filesystems are shown too."
1838 #: ../cat/virt-filesystems.pod:181
1841 " virt-filesystems --format=raw -a disk.img\n"
1846 #: ../cat/virt-filesystems.pod:185
1849 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1854 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1855 #: ../df/virt-df.pod:125 ../fish/guestfish.pod:156
1856 #: ../tools/virt-list-partitions.pl:109
1861 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1862 #: ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1863 msgid "B<--human-readable>"
1867 #: ../cat/virt-filesystems.pod:198
1868 msgid "In I<--long> mode, display sizes in human-readable format."
1872 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1873 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1878 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1879 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1884 #: ../cat/virt-filesystems.pod:209
1885 msgid "Display extra columns of data (\"long format\")."
1889 #: ../cat/virt-filesystems.pod:211
1890 msgid "A title row is added unless you also specify I<--no-title>."
1894 #: ../cat/virt-filesystems.pod:213
1896 "The extra columns displayed depend on what output you select, and the "
1897 "ordering of columns may change in future versions. Use the title row, I<--"
1898 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1903 #: ../cat/virt-filesystems.pod:218
1905 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1906 "default is to show raw numbers of I<bytes>."
1910 #: ../cat/virt-filesystems.pod:221
1911 msgid "Use I<--uuid> to display UUIDs too."
1915 #: ../cat/virt-filesystems.pod:223
1920 #: ../cat/virt-filesystems.pod:225
1921 msgid "B<--logvols>"
1925 #: ../cat/virt-filesystems.pod:227
1926 msgid "B<--logical-volumes>"
1930 #: ../cat/virt-filesystems.pod:229
1932 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1933 "of whether the LVs contain filesystems."
1937 #: ../cat/virt-filesystems.pod:232
1938 msgid "B<--no-title>"
1942 #: ../cat/virt-filesystems.pod:234
1943 msgid "In I<--long> mode, don't add a title row."
1947 #: ../cat/virt-filesystems.pod:236
1949 "Note that the order of the columns is not fixed, and may change in future "
1950 "versions of virt-filesystems, so using this option may give you unexpected "
1955 #: ../cat/virt-filesystems.pod:240
1960 #: ../cat/virt-filesystems.pod:242
1961 msgid "B<--partitions>"
1965 #: ../cat/virt-filesystems.pod:244
1967 "Display partitions. In this mode, these are displayed irrespective of "
1968 "whether the partitions contain filesystems."
1972 #: ../cat/virt-filesystems.pod:247
1977 #: ../cat/virt-filesystems.pod:249
1978 msgid "B<--physvols>"
1982 #: ../cat/virt-filesystems.pod:251
1983 msgid "B<--physical-volumes>"
1987 #: ../cat/virt-filesystems.pod:253
1988 msgid "Display LVM physical volumes."
1992 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1997 #: ../cat/virt-filesystems.pod:257
2002 #: ../cat/virt-filesystems.pod:259
2003 msgid "In I<--long> mode, display UUIDs as well."
2007 #: ../cat/virt-filesystems.pod:273
2012 #: ../cat/virt-filesystems.pod:275
2013 msgid "B<--volgroups>"
2017 #: ../cat/virt-filesystems.pod:277
2018 msgid "B<--volume-groups>"
2022 #: ../cat/virt-filesystems.pod:279
2023 msgid "Display LVM volume groups."
2027 #: ../cat/virt-filesystems.pod:287
2032 #: ../cat/virt-filesystems.pod:289
2034 "Note that columns in the output are subject to reordering and change in "
2035 "future versions of this tool."
2039 #: ../cat/virt-filesystems.pod:294
2044 #: ../cat/virt-filesystems.pod:296
2045 msgid "The filesystem, partition, block device or LVM name."
2049 #: ../cat/virt-filesystems.pod:298
2051 "For device and partition names these are displayed as canonical libguestfs "
2052 "names, so that for example C</dev/sda2> is the second partition on the first "
2057 #: ../cat/virt-filesystems.pod:302
2059 "If the I<--long> option is B<not> specified, then only the name column is "
2060 "shown in the output."
2064 #: ../cat/virt-filesystems.pod:305
2069 #: ../cat/virt-filesystems.pod:307
2070 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
2074 #: ../cat/virt-filesystems.pod:309
2079 #: ../cat/virt-filesystems.pod:311
2081 "If there is a filesystem, then this column displays the filesystem type if "
2082 "one could be detected, eg. C<ext4>."
2086 #: ../cat/virt-filesystems.pod:314
2091 #: ../cat/virt-filesystems.pod:316
2093 "If the object has a label (used for identifying and mounting filesystems) "
2094 "then this column contains the label."
2098 #: ../cat/virt-filesystems.pod:319
2103 #: ../cat/virt-filesystems.pod:321
2105 "The partition type byte, displayed as a two digit hexadecimal number. A "
2106 "comprehensive list of partition types can be found here: L<http://www.win."
2107 "tue.nl/~aeb/partitions/partition_types-1.html>"
2111 #: ../cat/virt-filesystems.pod:325
2112 msgid "This is only applicable for DOS (MBR) partitions."
2116 #: ../cat/virt-filesystems.pod:327
2121 #: ../cat/virt-filesystems.pod:329
2123 "The size of the object in bytes. If the I<--human> option is used then the "
2124 "size is displayed in a human-readable form."
2128 #: ../cat/virt-filesystems.pod:332
2133 #: ../cat/virt-filesystems.pod:334
2135 "The parent column records the parent relationship between objects. For "
2136 "example, if the object is a partition, then this column contains the name of "
2137 "the containing device. If the object is a logical volume, then this column "
2138 "is the name of the volume group."
2142 #: ../cat/virt-filesystems.pod:339
2147 #: ../cat/virt-filesystems.pod:341
2149 "If the object has a UUID (used for identifying and mounting filesystems and "
2150 "block devices) then this column contains the UUID as a string."
2154 #: ../cat/virt-filesystems.pod:345
2155 msgid "The UUID is only displayed if the I<--uuid> option is given."
2159 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:459
2160 #: ../df/virt-df.pod:217
2161 msgid "NOTE ABOUT CSV FORMAT"
2165 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:461
2166 #: ../df/virt-df.pod:219
2168 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
2169 "should be easy to parse, but it is definitely not easy to parse."
2173 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:464
2174 #: ../df/virt-df.pod:222
2176 "Myth: Just split fields at commas. Reality: This does I<not> work "
2177 "reliably. This example has two columns:"
2181 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:467
2182 #: ../df/virt-df.pod:225
2185 " \"foo,bar\",baz\n"
2190 #: ../cat/virt-filesystems.pod:359 ../cat/virt-ls.pod:469
2191 #: ../df/virt-df.pod:227
2193 "Myth: Read the file one line at a time. Reality: This does I<not> work "
2194 "reliably. This example has one row:"
2198 #: ../cat/virt-filesystems.pod:362 ../cat/virt-ls.pod:472
2199 #: ../df/virt-df.pod:230
2208 #: ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:475
2209 #: ../df/virt-df.pod:233
2211 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
2212 "packaged in major Linux distributions)."
2216 #: ../cat/virt-filesystems.pod:368 ../cat/virt-ls.pod:478
2217 #: ../df/virt-df.pod:236
2219 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
2220 "or Python's built-in csv library)."
2224 #: ../cat/virt-filesystems.pod:371 ../cat/virt-ls.pod:481
2225 #: ../df/virt-df.pod:239
2226 msgid "Most spreadsheets and databases can import CSV directly."
2230 #: ../cat/virt-filesystems.pod:387
2232 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
2233 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
2238 #: ../cat/virt-filesystems.pod:402 ../tools/virt-win-reg.pl:789
2239 msgid "Copyright (C) 2010 Red Hat Inc."
2243 #: ../cat/virt-ls.pod:5
2244 msgid "virt-ls - List files in a virtual machine"
2248 #: ../cat/virt-ls.pod:9
2251 " virt-ls [--options] -d domname directory [directory ...]\n"
2256 #: ../cat/virt-ls.pod:11
2259 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
2264 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
2269 #: ../cat/virt-ls.pod:15
2272 " virt-ls [--options] domname directory\n"
2277 #: ../cat/virt-ls.pod:17
2280 " virt-ls [--options] disk.img [disk.img ...] directory\n"
2285 #: ../cat/virt-ls.pod:21
2287 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
2288 "more from a virtual machine or disk image."
2292 #: ../cat/virt-ls.pod:24
2294 "Multiple directory names can be given, in which case the output from each is "
2299 #: ../cat/virt-ls.pod:27
2301 "To list directories from a libvirt guest use the I<-d> option to specify the "
2302 "name of the guest. For a disk image, use the I<-a> option."
2306 #: ../cat/virt-ls.pod:31
2308 "C<virt-ls> can do many simple file listings. For more complicated cases you "
2309 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
2314 #: ../cat/virt-ls.pod:37
2315 msgid "Get a list of all files and directories in a virtual machine:"
2319 #: ../cat/virt-ls.pod:39
2322 " virt-ls -R -d guest /\n"
2327 #: ../cat/virt-ls.pod:41 ../examples/guestfs-testing.pod:182
2328 msgid "List all setuid or setgid programs in a Linux virtual machine:"
2332 #: ../cat/virt-ls.pod:43
2335 " virt-ls -lR -d guest / | grep '^- [42]'\n"
2340 #: ../cat/virt-ls.pod:45 ../examples/guestfs-testing.pod:186
2341 msgid "List all public-writable directories in a Linux virtual machine:"
2345 #: ../cat/virt-ls.pod:47
2348 " virt-ls -lR -d guest / | grep '^d ...7'\n"
2353 #: ../cat/virt-ls.pod:49 ../examples/guestfs-testing.pod:190
2354 msgid "List all Unix domain sockets in a Linux virtual machine:"
2358 #: ../cat/virt-ls.pod:51
2361 " virt-ls -lR -d guest / | grep '^s'\n"
2366 #: ../cat/virt-ls.pod:53 ../examples/guestfs-testing.pod:194
2367 msgid "List all regular files with filenames ending in '.png':"
2371 #: ../cat/virt-ls.pod:55
2374 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
2379 #: ../cat/virt-ls.pod:57
2380 msgid "To display files larger than 10MB in home directories:"
2384 #: ../cat/virt-ls.pod:59
2387 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
2392 #: ../cat/virt-ls.pod:61 ../examples/guestfs-testing.pod:202
2393 msgid "Find everything modified in the last 7 days:"
2397 #: ../cat/virt-ls.pod:63
2400 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
2405 #: ../cat/virt-ls.pod:65 ../examples/guestfs-testing.pod:206
2406 msgid "Find regular files modified in the last 24 hours:"
2410 #: ../cat/virt-ls.pod:67
2413 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
2418 #: ../cat/virt-ls.pod:69
2419 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
2423 #: ../cat/virt-ls.pod:71
2425 "Find the differences between files in a guest and an earlier snapshot of the "
2430 #: ../cat/virt-ls.pod:74
2433 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
2434 " virt-ls -lR -a current.img / --uids --time-t > new\n"
2435 " diff -u old new | less\n"
2440 #: ../cat/virt-ls.pod:78
2442 "The commands above won't find files where the content has changed but the "
2443 "metadata (eg. file size and modification date) is the same. To do that, you "
2444 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
2445 "checksum> can be quite slow since it has to read and compute a checksum of "
2446 "every regular file in the virtual machine."
2450 #: ../cat/virt-ls.pod:84
2451 msgid "OUTPUT MODES"
2455 #: ../cat/virt-ls.pod:86
2457 "C<virt-ls> has four output modes, controlled by different combinations of "
2458 "the I<-l> and I<-R> options."
2462 #: ../cat/virt-ls.pod:89
2463 msgid "SIMPLE LISTING"
2467 #: ../cat/virt-ls.pod:91
2468 msgid "A simple listing is like the ordinary L<ls(1)> command:"
2472 #: ../cat/virt-ls.pod:93
2475 " $ virt-ls -d guest /\n"
2483 #: ../cat/virt-ls.pod:98
2484 msgid "LONG LISTING"
2488 #: ../cat/virt-ls.pod:100
2490 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
2491 "(more specifically, like the C<guestfs_ll> function)."
2495 #: ../cat/virt-ls.pod:103
2498 " $ virt-ls -l -d guest /\n"
2500 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
2501 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
2507 #: ../cat/virt-ls.pod:109
2509 "Note that while this is useful for displaying a directory, do not try "
2510 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
2515 #: ../cat/virt-ls.pod:113
2516 msgid "RECURSIVE LISTING"
2520 #: ../cat/virt-ls.pod:115
2522 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
2523 "and directories recursively:"
2527 #: ../cat/virt-ls.pod:118
2530 " $ virt-ls -R -d guest /tmp\n"
2538 #: ../cat/virt-ls.pod:123
2540 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
2541 "converts C<\\0> characters to C<\\n>."
2545 #: ../cat/virt-ls.pod:126
2546 msgid "RECURSIVE LONG LISTING"
2550 #: ../cat/virt-ls.pod:128
2552 "Using I<-lR> options together changes the output to display directories "
2553 "recursively, with file stats, and optionally other features such as "
2554 "checksums and extended attributes."
2558 #: ../cat/virt-ls.pod:132
2560 "Most of the interesting features of C<virt-ls> are only available when using "
2565 #: ../cat/virt-ls.pod:135
2567 "The fields are normally space-separated. Filenames are B<not> quoted, so "
2568 "you cannot use the output in another program (because filenames can contain "
2569 "spaces and other unsafe characters). If the guest was untrusted and someone "
2570 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
2571 "on you by creating filenames with embedded newline characters. To B<safely> "
2572 "parse the output in another program, use the I<--csv> (Comma-Separated "
2577 #: ../cat/virt-ls.pod:143
2579 "Note that this output format is completely unrelated to the C<ls -lR> "
2584 #: ../cat/virt-ls.pod:146
2587 " $ virt-ls -lR -d guest /bin\n"
2588 " d 0555 4096 /bin\n"
2589 " - 0755 123 /bin/alsaunmute\n"
2590 " - 0755 28328 /bin/arch\n"
2591 " l 0777 4 /bin/awk -> gawk\n"
2592 " - 0755 27216 /bin/basename\n"
2593 " - 0755 943360 /bin/bash\n"
2599 #: ../cat/virt-ls.pod:155
2600 msgid "These basic fields are always shown:"
2604 #: ../cat/virt-ls.pod:159
2609 #: ../cat/virt-ls.pod:161
2611 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
2612 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
2613 "link), C<s> (socket) or C<u> (unknown)."
2617 #: ../cat/virt-ls.pod:171
2622 #: ../cat/virt-ls.pod:173
2623 msgid "The Unix permissions, displayed as a 4 digit octal number."
2627 #: ../cat/virt-ls.pod:175
2632 #: ../cat/virt-ls.pod:177
2634 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
2635 "readable> option is given, in which case this is shown as a human-readable "
2640 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4380
2645 #: ../cat/virt-ls.pod:183
2646 msgid "The full path of the file or directory."
2650 #: ../cat/virt-ls.pod:185
2655 #: ../cat/virt-ls.pod:187
2656 msgid "For symbolic links only, the link target."
2660 #: ../cat/virt-ls.pod:191
2662 "In I<-lR> mode, additional command line options enable the display of more "
2667 #: ../cat/virt-ls.pod:194
2669 "With the I<--uids> flag, these additional fields are displayed before the "
2674 #: ../cat/virt-ls.pod:199
2679 #: ../cat/virt-ls.pod:201
2684 #: ../cat/virt-ls.pod:203
2686 "The UID and GID of the owner of the file (displayed numerically). Note "
2687 "these only make sense in the context of a Unix-like guest."
2691 #: ../cat/virt-ls.pod:208
2692 msgid "With the I<--times> flag, these additional fields are displayed:"
2696 #: ../cat/virt-ls.pod:212
2701 #: ../cat/virt-ls.pod:214
2702 msgid "The time of last access."
2706 #: ../cat/virt-ls.pod:216
2711 #: ../cat/virt-ls.pod:218
2712 msgid "The time of last modification."
2716 #: ../cat/virt-ls.pod:220
2721 #: ../cat/virt-ls.pod:222
2722 msgid "The time of last status change."
2726 #: ../cat/virt-ls.pod:226
2728 "The time fields are displayed as string dates and times, unless one of the "
2729 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
2733 #: ../cat/virt-ls.pod:229
2734 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
2738 #: ../cat/virt-ls.pod:233
2743 #: ../cat/virt-ls.pod:235
2745 "The device containing the file (displayed as major:minor). This may not "
2746 "match devices as known to the guest."
2750 #: ../cat/virt-ls.pod:238
2755 #: ../cat/virt-ls.pod:240
2756 msgid "The inode number."
2760 #: ../cat/virt-ls.pod:242
2765 #: ../cat/virt-ls.pod:244
2766 msgid "The number of hard links."
2770 #: ../cat/virt-ls.pod:246
2775 #: ../cat/virt-ls.pod:248
2777 "For block and char special files, the device (displayed as major:minor)."
2781 #: ../cat/virt-ls.pod:251
2786 #: ../cat/virt-ls.pod:253
2787 msgid "The number of 512 byte blocks allocated to the file."
2791 #: ../cat/virt-ls.pod:257
2793 "With the I<--checksum> flag, the checksum of the file contents is shown "
2794 "(only for regular files). Computing file checksums can take a considerable "
2799 #: ../cat/virt-ls.pod:280
2800 msgid "B<--checksum>"
2804 #: ../cat/virt-ls.pod:282
2805 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2809 #: ../cat/virt-ls.pod:284
2811 "Display checksum over file contents for regular files. With no argument, "
2812 "this defaults to using I<md5>. Using an argument, you can select the "
2813 "checksum type to use."
2817 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2818 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2819 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2821 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2826 #: ../cat/virt-ls.pod:316
2828 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2829 "so you cannot see what you are typing. If you are not worried about Tempest "
2830 "attacks and there is no one else in the room you can specify this flag to "
2831 "see what you are typing."
2835 #: ../cat/virt-ls.pod:321
2836 msgid "B<--extra-stats>"
2840 #: ../cat/virt-ls.pod:323
2841 msgid "Display extra stats."
2845 #: ../cat/virt-ls.pod:339
2848 " virt-ls --format=raw -a disk.img /dir\n"
2853 #: ../cat/virt-ls.pod:343
2856 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2861 #: ../cat/virt-ls.pod:356
2862 msgid "Display file sizes in human-readable format."
2866 #: ../cat/virt-ls.pod:370
2871 #: ../cat/virt-ls.pod:372
2872 msgid "B<--recursive>"
2876 #: ../cat/virt-ls.pod:374
2878 "Select the mode. With neither of these options, C<virt-ls> produces a "
2879 "simple, flat list of the files in the named directory. See L</SIMPLE "
2884 #: ../cat/virt-ls.pod:378
2886 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2891 #: ../cat/virt-ls.pod:381
2893 "C<virt-ls -R> produces a recursive list of files starting at the named "
2894 "directory. See L</RECURSIVE LISTING>."
2898 #: ../cat/virt-ls.pod:384
2900 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2901 "parsed. See L</RECURSIVE LONG LISTING>."
2905 #: ../cat/virt-ls.pod:387
2910 #: ../cat/virt-ls.pod:389
2911 msgid "Display time fields."
2915 #: ../cat/virt-ls.pod:394
2916 msgid "B<--time-days>"
2920 #: ../cat/virt-ls.pod:396
2921 msgid "Display time fields as days before now (negative if in the future)."
2925 #: ../cat/virt-ls.pod:398
2927 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2928 "of the file is between 0 and 86399 seconds."
2932 #: ../cat/virt-ls.pod:404
2933 msgid "B<--time-relative>"
2937 #: ../cat/virt-ls.pod:406
2938 msgid "Display time fields as seconds before now (negative if in the future)."
2942 #: ../cat/virt-ls.pod:411
2947 #: ../cat/virt-ls.pod:413
2948 msgid "Display time fields as seconds since the Unix epoch."
2952 #: ../cat/virt-ls.pod:418
2957 #: ../cat/virt-ls.pod:420
2958 msgid "Display UID and GID fields."
2962 #: ../cat/virt-ls.pod:445
2963 msgid "Previous versions of virt-ls allowed you to write either:"
2967 #: ../cat/virt-ls.pod:447
2970 " virt-ls disk.img [disk.img ...] /dir\n"
2975 #: ../cat/virt-ls.pod:451
2978 " virt-ls guestname /dir\n"
2983 #: ../cat/virt-ls.pod:497
2985 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2986 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2987 "L<http://libguestfs.org/>."
2991 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:267 ../edit/virt-edit.pod:374
2992 #: ../rescue/virt-rescue.pod:302
2993 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2997 #: ../clone/virt-sysprep.pod:5
2999 "virt-sysprep - Reset or unconfigure a virtual machine so clones can be made"
3003 #: ../clone/virt-sysprep.pod:9
3006 " virt-sysprep [--options] -d domname\n"
3011 #: ../clone/virt-sysprep.pod:11
3014 " virt-sysprep [--options] -a disk.img [-a disk.img ...]\n"
3019 #: ../clone/virt-sysprep.pod:15
3021 "Virt-sysprep \"resets\" or \"unconfigures\" a virtual machine so that clones "
3022 "can be made from it. Steps in this process include removing SSH host keys, "
3023 "removing persistent network MAC configuration, and removing user accounts. "
3024 "Each step can be enabled or disabled as required."
3028 #: ../clone/virt-sysprep.pod:21
3030 "Virt-sysprep is a simple shell script, allowing easy inspection or "
3031 "customization by the system administrator."
3035 #: ../clone/virt-sysprep.pod:24
3037 "Virt-sysprep modifies the guest or disk image I<in place>. The guest must "
3038 "be shut down. If you want to preserve the existing contents of the guest, "
3039 "you I<must copy or clone the disk first>. See L</COPYING AND CLONING> below."
3043 #: ../clone/virt-sysprep.pod:29
3045 "You do I<not> need to run virt-sysprep as root. In fact we'd generally "
3046 "recommend that you don't. The time you might want to run it as root is when "
3047 "you need root in order to access the disk image, but even in this case it "
3048 "would be better to change the permissions on the disk image to be writable "
3049 "as the non-root user running virt-sysprep."
3053 #: ../clone/virt-sysprep.pod:35
3055 "\"Sysprep\" stands for \"system preparation\" tool. The name comes from the "
3056 "Microsoft program C<sysprep.exe> which is used to unconfigure Windows "
3057 "machines in preparation for cloning them. Having said that, virt-sysprep "
3058 "does I<not> currently work on Microsoft Windows guests. We plan to support "
3059 "Windows sysprepping in a future version, and we already have code to do it."
3063 #: ../clone/virt-sysprep.pod:76
3064 msgid "B<--enable=...>"
3068 #: ../clone/virt-sysprep.pod:78
3070 "Choose which sysprep operations to perform. Give a comma-separated list of "
3071 "operations, for example:"
3075 #: ../clone/virt-sysprep.pod:81
3078 " --enable=ssh-hostkeys,udev-persistent-net\n"
3083 #: ../clone/virt-sysprep.pod:83
3085 "would enable ONLY C<ssh-hostkeys> and C<udev-persistent-net> operations."
3089 #: ../clone/virt-sysprep.pod:85
3091 "If the I<--enable> option is not given, then we default to trying all "
3092 "possible sysprep operations. But some sysprep operations are skipped for "
3097 #: ../clone/virt-sysprep.pod:89
3099 "Use I<--list-operations> to list operations supported by a particular "
3100 "version of virt-sysprep."
3104 #: ../clone/virt-sysprep.pod:92
3106 "See L</OPERATIONS> below for a list and an explanation of each operation."
3110 #: ../clone/virt-sysprep.pod:106
3113 " virt-sysprep --format=raw -a disk.img\n"
3118 #: ../clone/virt-sysprep.pod:110
3121 " virt-sysprep --format=raw -a disk.img --format -a another.img\n"
3126 #: ../clone/virt-sysprep.pod:119
3127 msgid "B<--hostname> newhostname"
3131 #: ../clone/virt-sysprep.pod:121
3133 "Change the hostname. See the L</hostname> operation below. If not given, "
3134 "defaults to C<localhost.localdomain>."
3138 #: ../clone/virt-sysprep.pod:124
3139 msgid "B<--list-operations>"
3143 #: ../clone/virt-sysprep.pod:126
3144 msgid "List the operations supported by the virt-sysprep program."
3148 #: ../clone/virt-sysprep.pod:128
3149 msgid "B<--selinux-relabel>"
3153 #: ../clone/virt-sysprep.pod:130
3154 msgid "B<--no-selinux-relabel>"
3158 #: ../clone/virt-sysprep.pod:132
3160 "I<--selinux-relabel> forces SELinux relabelling next time the guest boots. "
3161 "I<--no-selinux-relabel> disables relabelling."
3165 #: ../clone/virt-sysprep.pod:135
3167 "The default is to try to detect if SELinux relabelling is required. See L</"
3168 "SELINUX RELABELLING> below for more details."
3172 #: ../clone/virt-sysprep.pod:156
3177 #: ../clone/virt-sysprep.pod:158
3179 "If the I<--enable> option is I<not> given, then I<all sysprep operations are "
3180 "enabled>, although some are skipped depending on the type of guest."
3184 #: ../clone/virt-sysprep.pod:162
3186 "Operations can be individually enabled using the I<--enable> option. Use a "
3187 "comma-separated list, for example:"
3191 #: ../clone/virt-sysprep.pod:165
3194 " virt-sysprep --enable=ssh-hostkeys,udev-persistent-net [etc..]\n"
3199 #: ../clone/virt-sysprep.pod:167
3201 "To list the operations supported by the current version of virt-sysprep, use "
3202 "I<--list-operations>."
3206 #: ../clone/virt-sysprep.pod:170
3208 "Future versions of virt-sysprep may add more operations. If you are using "
3209 "virt-sysprep and want predictable behaviour, specify only the operations "
3210 "that you want to have enabled."
3214 #: ../clone/virt-sysprep.pod:174
3219 #: ../clone/virt-sysprep.pod:176
3220 msgid "Remove user at-jobs and cron-jobs."
3224 #: ../clone/virt-sysprep.pod:178
3225 msgid "dhcp-client-state"
3229 #: ../clone/virt-sysprep.pod:180
3230 msgid "Remove DHCP client leases."
3234 #: ../clone/virt-sysprep.pod:182
3235 msgid "dhcp-server-state"
3239 #: ../clone/virt-sysprep.pod:184
3240 msgid "Remove DHCP server leases."
3244 #: ../clone/virt-sysprep.pod:186
3249 #: ../clone/virt-sysprep.pod:188
3251 "Changes the hostname of the guest to the value given in the I<--hostname> "
3256 #: ../clone/virt-sysprep.pod:191
3258 "If the I<--hostname> parameter is not given, then the hostname is changed to "
3259 "C<localhost.localdomain>."
3263 #: ../clone/virt-sysprep.pod:194
3268 #: ../clone/virt-sysprep.pod:196
3269 msgid "Remove many log files."
3273 #: ../clone/virt-sysprep.pod:198
3278 #: ../clone/virt-sysprep.pod:200
3279 msgid "Remove email from the local mail spool directory."
3283 #: ../clone/virt-sysprep.pod:202
3288 #: ../clone/virt-sysprep.pod:204
3290 "Remove HWADDR (hard-coded MAC address) configuration. For Fedora and Red "
3291 "Hat Enterprise Linux, this is removed from C<ifcfg-*> files."
3295 #: ../clone/virt-sysprep.pod:207
3300 #: ../clone/virt-sysprep.pod:209
3302 "Write some random bytes from the host into the random seed file of the guest."
3306 #: ../clone/virt-sysprep.pod:212
3307 msgid "See L</RANDOM SEED> below."
3311 #: ../clone/virt-sysprep.pod:214
3312 msgid "rhn-systemid"
3316 #: ../clone/virt-sysprep.pod:216
3317 msgid "Remove the RHN system ID."
3321 #: ../clone/virt-sysprep.pod:218
3326 #: ../clone/virt-sysprep.pod:220
3327 msgid "Remove the Smolt hardware UUID."
3331 #: ../clone/virt-sysprep.pod:222
3332 msgid "ssh-hostkeys"
3336 #: ../clone/virt-sysprep.pod:224
3337 msgid "Remove the SSH host keys in the guest."
3341 #: ../clone/virt-sysprep.pod:226
3343 "The SSH host keys are regenerated (differently) next time the guest is "
3348 #: ../clone/virt-sysprep.pod:229
3350 "If, after cloning, the guest gets the same IP address, ssh will give you a "
3351 "stark warning about the host key changing:"
3355 #: ../clone/virt-sysprep.pod:232
3358 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
3359 " @ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @\n"
3360 " @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
3361 " IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!\n"
3366 #: ../clone/virt-sysprep.pod:237
3367 msgid "udev-persistent-net"
3371 #: ../clone/virt-sysprep.pod:239
3373 "Remove udev persistent net rules which map the guest's existing MAC address "
3374 "to a fixed ethernet device (eg. eth0)."
3378 #: ../clone/virt-sysprep.pod:242
3380 "After a guest is cloned, the MAC address usually changes. Since the old MAC "
3381 "address occupies the old name (eg. eth0), this means the fresh MAC address "
3382 "is assigned to a new name (eg. eth1) and this is usually undesirable. "
3383 "Erasing the udev persistent net rules avoids this."
3387 #: ../clone/virt-sysprep.pod:247
3392 #: ../clone/virt-sysprep.pod:249
3393 msgid "Remove the utmp file."
3397 #: ../clone/virt-sysprep.pod:251
3399 "This records who is currently logged in on a machine. In modern Linux "
3400 "distros it is stored in a ramdisk and hence not part of the virtual "
3401 "machine's disk, but it was stored on disk in older distros."
3405 #: ../clone/virt-sysprep.pod:255
3410 #: ../clone/virt-sysprep.pod:257
3411 msgid "Remove the yum UUID."
3415 #: ../clone/virt-sysprep.pod:259
3417 "Yum creates a fresh UUID the next time it runs when it notices that the "
3418 "original UUID has been erased."
3422 #: ../clone/virt-sysprep.pod:262
3423 msgid "COPYING AND CLONING"
3427 #: ../clone/virt-sysprep.pod:264
3429 "Virt-sysprep can be used as part of a process of cloning guests, or to "
3430 "prepare a template from which guests can be cloned. There are many "
3431 "different ways to achieve this using the virt tools, and this section is "
3432 "just an introduction."
3436 #: ../clone/virt-sysprep.pod:269
3437 msgid "A virtual machine (when switched off) consists of two parts:"
3441 #: ../clone/virt-sysprep.pod:273
3442 msgid "I<configuration>"
3446 #: ../clone/virt-sysprep.pod:275
3448 "The configuration or description of the guest. eg. The libvirt XML (see "
3449 "C<virsh dumpxml>), the running configuration of the guest, or another "
3450 "external format like OVF."
3454 #: ../clone/virt-sysprep.pod:279
3455 msgid "Some configuration items that might need to be changed:"
3459 #: ../clone/virt-sysprep.pod:285
3464 #: ../clone/virt-sysprep.pod:289 ../clone/virt-sysprep.pod:316
3469 #: ../clone/virt-sysprep.pod:293
3470 msgid "path to block device(s)"
3474 #: ../clone/virt-sysprep.pod:297
3475 msgid "network card MAC address"
3479 #: ../clone/virt-sysprep.pod:301
3480 msgid "I<block device(s)>"
3484 #: ../clone/virt-sysprep.pod:303
3486 "One or more hard disk images, themselves containing files, directories, "
3487 "applications, kernels, configuration, etc."
3491 #: ../clone/virt-sysprep.pod:306
3492 msgid "Some things inside the block devices that might need to be changed:"
3496 #: ../clone/virt-sysprep.pod:312
3497 msgid "hostname and other net configuration"
3501 #: ../clone/virt-sysprep.pod:320
3502 msgid "SSH host keys"
3506 #: ../clone/virt-sysprep.pod:324
3507 msgid "Windows unique security ID (SID)"
3511 #: ../clone/virt-sysprep.pod:328
3512 msgid "Puppet registration"
3516 #: ../clone/virt-sysprep.pod:334
3517 msgid "COPYING THE BLOCK DEVICE"
3521 #: ../clone/virt-sysprep.pod:336
3523 "Starting with an original guest, you probably wish to copy the guest block "
3524 "device and its configuration to make a template. Then once you are happy "
3525 "with the template, you will want to make many clones from it."
3529 #: ../clone/virt-sysprep.pod:341
3535 " original guest --------> template ---------->\n"
3536 " \\------> cloned\n"
3537 " \\-----> guests\n"
3543 #: ../clone/virt-sysprep.pod:349
3545 "You can, of course, just copy the block device on the host using L<cp(1)> or "
3550 #: ../clone/virt-sysprep.pod:352
3554 " original guest --------> template ---------->\n"
3555 " \\------> cloned\n"
3556 " \\-----> guests\n"
3562 #: ../clone/virt-sysprep.pod:358
3563 msgid "There are some smarter (and faster) ways too:"
3567 #: ../clone/virt-sysprep.pod:364
3571 " template ---------->\n"
3572 " \\------> cloned\n"
3573 " \\-----> guests\n"
3579 #: ../clone/virt-sysprep.pod:370
3581 "Use the block device as a backing file and create a snapshot on top for each "
3582 "guest. The advantage is that you don't need to copy the block device (very "
3583 "fast) and only changes are stored (less storage required)."
3587 #: ../clone/virt-sysprep.pod:375
3589 "Note that writing to the backing file once you have created guests on top of "
3590 "it is not possible: you will corrupt the guests."
3594 #: ../clone/virt-sysprep.pod:378
3596 "Tools that can do this include: L<qemu-img(1)> (with the I<create -f qcow2 -"
3597 "o backing_file> option), L<lvcreate(8)> (I<--snapshot> option). Some "
3598 "filesystems (such as btrfs) and most Network Attached Storage devices can "
3599 "also create cheap snapshots from files or LUNs."
3603 #: ../clone/virt-sysprep.pod:386
3604 msgid "Get your NAS to snapshot and/or duplicate the LUN."
3608 #: ../clone/virt-sysprep.pod:390
3609 msgid "Prepare your template using L<virt-sparsify(1)>. See below."
3613 #: ../clone/virt-sysprep.pod:394
3618 #: ../clone/virt-sysprep.pod:396
3620 "A separate tool, L<virt-clone(1)>, can be used to duplicate the block device "
3621 "and/or modify the external libvirt configuration of a guest. It will reset "
3622 "the name, UUID and MAC address of the guest in the libvirt XML."
3626 #: ../clone/virt-sysprep.pod:401
3628 "L<virt-clone(1)> does not use libguestfs and cannot look inside the disk "
3629 "image. This was the original motivation to write virt-sysprep."
3633 #: ../clone/virt-sysprep.pod:404
3638 #: ../clone/virt-sysprep.pod:406
3642 " original guest --------> template\n"
3647 #: ../clone/virt-sysprep.pod:409
3649 "L<virt-sparsify(1)> can be used to make the cloning template smaller, making "
3650 "it easier to compress and/or faster to copy."
3654 #: ../clone/virt-sysprep.pod:412
3656 "Notice that since virt-sparsify also copies the image, you can use it to "
3657 "make the initial copy (instead of C<dd>)."
3661 #: ../clone/virt-sysprep.pod:415
3666 #: ../clone/virt-sysprep.pod:417
3670 " template ---------->\n"
3671 " \\------> cloned\n"
3672 " \\-----> guests\n"
3678 #: ../clone/virt-sysprep.pod:423
3680 "If you want to give people cloned guests, but let them pick the size of the "
3681 "guest themselves (eg. depending on how much they are prepared to pay for "
3682 "disk space), then instead of copying the template, you can run L<virt-resize"
3683 "(1)>. Virt-resize performs a copy and resize, and thus is ideal for cloning "
3684 "guests from a template."
3688 #: ../clone/virt-sysprep.pod:429 ../src/guestfs.pod:1164
3693 #: ../clone/virt-sysprep.pod:431
3695 "Although virt-sysprep removes some sensitive information from the guest, it "
3696 "does not pretend to remove all of it. You should examine the L</OPERATIONS> "
3697 "above, and the implementation of the operations in the shell script. You "
3698 "should also examine the guest afterwards."
3702 #: ../clone/virt-sysprep.pod:436
3704 "Sensitive files are simply removed. The data they contained may still exist "
3705 "on the disk, easily recovered with a hex editor or undelete tool. Use "
3706 "L<virt-sparsify(1)> as one way to remove this content. See also the L<scrub"
3707 "(1)> command to get rid of deleted content in directory entries and inodes."
3711 #: ../clone/virt-sysprep.pod:442
3716 #: ../clone/virt-sysprep.pod:444
3717 msgid "I<(This section applies to Linux guests only)>"
3721 #: ../clone/virt-sysprep.pod:446
3723 "The virt-sysprep C<random-seed> operation writes a few bytes of randomness "
3724 "from the host into the guest's random seed file."
3728 #: ../clone/virt-sysprep.pod:449
3730 "If this is just done once and the guest is cloned from the same template, "
3731 "then each guest will start with the same entropy, and things like SSH host "
3732 "keys and TCP sequence numbers may be predictable."
3736 #: ../clone/virt-sysprep.pod:453
3738 "Therefore you should arrange to add more randomness I<after> cloning from a "
3739 "template too, which can be done by just enabling the C<random-seed> "
3744 #: ../clone/virt-sysprep.pod:457
3747 " cp template.img newguest.img\n"
3748 " virt-sysprep --enable=random-seed -a newguest.img\n"
3753 #: ../clone/virt-sysprep.pod:460
3754 msgid "SELINUX RELABELLING"
3758 #: ../clone/virt-sysprep.pod:462
3759 msgid "I<(This section applies to Linux guests using SELinux only)>"
3763 #: ../clone/virt-sysprep.pod:464
3765 "If any new files are created by virt-sysprep, then virt-sysprep touches C</."
3766 "autorelabel> so that these will be correctly labelled by SELinux the next "
3767 "time the guest is booted. This process interrupts boot and can take some "
3772 #: ../clone/virt-sysprep.pod:469
3774 "You can force relabelling for all guests by supplying the I<--selinux-"
3779 #: ../clone/virt-sysprep.pod:472
3781 "You can disable relabelling entirely by supplying the I<--no-selinux-"
3786 #: ../clone/virt-sysprep.pod:484
3787 msgid "This program returns 0 on success, or 1 if there was an error."
3791 #: ../clone/virt-sysprep.pod:488
3793 "L<guestfs(3)>, L<guestfish(1)>, L<virt-clone(1)>, L<virt-rescue(1)>, L<virt-"
3794 "resize(1)>, L<virt-sparsify(1)>, L<virsh(1)>, L<lvcreate(8)>, L<qemu-img(1)"
3795 ">, L<scrub(1)>, L<http://libguestfs.org/>, L<http://libvirt.org/>."
3799 #: ../df/virt-df.pod:5
3800 msgid "virt-df - Display free space on virtual filesystems"
3804 #: ../df/virt-df.pod:9
3807 " virt-df [--options]\n"
3812 #: ../df/virt-df.pod:11
3815 " virt-df [--options] -d domname\n"
3820 #: ../df/virt-df.pod:13
3823 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
3828 #: ../df/virt-df.pod:17
3831 " virt-df [--options] domname\n"
3836 #: ../df/virt-df.pod:19
3839 " virt-df [--options] disk.img [disk.img ...]\n"
3844 #: ../df/virt-df.pod:23
3846 "C<virt-df> is a command line tool to display free space on virtual machine "
3847 "filesystems. Unlike other tools, it doesn't just display the size of disk "
3848 "allocated to a virtual machine, but can look inside disk images to see how "
3849 "much space is really being used."
3853 #: ../df/virt-df.pod:28
3855 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
3856 "to get a list of all active and inactive guests, and performs a C<df>-type "
3857 "operation on each one in turn, printing out the results."
3861 #: ../df/virt-df.pod:32
3863 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
3864 "type operation on either the single named libvirt domain, or on the disk "
3865 "image(s) listed on the command line (which must all belong to a single VM). "
3866 "In this mode (with arguments), C<virt-df> will I<only work for a single "
3867 "guest>. If you want to run on multiple guests, then you have to invoke "
3868 "C<virt-df> multiple times."
3872 #: ../df/virt-df.pod:39
3874 "Use the I<--csv> option to get a format which can be easily parsed by other "
3875 "programs. Other options are similar to the standard L<df(1)> command."
3879 #: ../df/virt-df.pod:45
3881 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
3882 "output human-readable:"
3886 #: ../df/virt-df.pod:48
3889 " # virt-df -d F14x64 -h\n"
3890 " Filesystem Size Used Available Use%\n"
3891 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
3892 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
3897 #: ../df/virt-df.pod:53
3898 msgid "Show disk usage for a disk image file called C<test.img>:"
3902 #: ../df/virt-df.pod:55
3905 " $ virt-df -a test1.img\n"
3906 " Filesystem 1K-blocks Used Available Use%\n"
3907 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
3912 #: ../df/virt-df.pod:112
3915 " virt-df --format=raw -a disk.img\n"
3920 #: ../df/virt-df.pod:116
3923 " virt-df --format=raw -a disk.img --format -a another.img\n"
3928 #: ../df/virt-df.pod:129
3929 msgid "Print sizes in human-readable format."
3933 #: ../df/virt-df.pod:131
3934 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
3938 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:164
3943 #: ../df/virt-df.pod:135
3948 #: ../df/virt-df.pod:137
3949 msgid "Print inodes instead of blocks."
3953 #: ../df/virt-df.pod:139
3954 msgid "B<--one-per-guest>"
3958 #: ../df/virt-df.pod:141
3960 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
3961 "disks from several guests to a single libguestfs appliance."
3965 #: ../df/virt-df.pod:144
3966 msgid "You might use this option in the following circumstances:"
3970 #: ../df/virt-df.pod:150
3972 "If you think an untrusted guest might actively try to exploit the libguestfs "
3973 "appliance kernel, then this prevents one guest from interfering with the "
3974 "stats printed for another guest."
3978 #: ../df/virt-df.pod:156
3980 "If the kernel has a bug which stops it from accessing a filesystem in one "
3981 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
3982 "and report stats for further guests."
3986 #: ../df/virt-df.pod:165
3988 "Print UUIDs instead of names. This is useful for following a guest even "
3989 "when the guest is migrated or renamed, or when two guests happen to have the "
3994 #: ../df/virt-df.pod:169
3996 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
3997 "images, we still print the disk image name even when this option is "
4002 #: ../df/virt-df.pod:191
4003 msgid "STATVFS NUMBERS"
4007 #: ../df/virt-df.pod:193
4009 "C<virt-df> (and L<df(1)>) get information by issuing a L<statvfs(3)> system "
4010 "call. You can get the same information directly, either from the host "
4011 "(using libguestfs) or inside the guest:"
4015 #: ../df/virt-df.pod:199
4016 msgid "From the host"
4020 #: ../df/virt-df.pod:201 ../df/virt-df.pod:209
4021 msgid "Run this command:"
4025 #: ../df/virt-df.pod:203
4028 " guestfish --ro -d GuestName -i statvfs /\n"
4033 #: ../df/virt-df.pod:205 ../df/virt-df.pod:213
4034 msgid "(change C</> to see stats for other filesystems)."
4038 #: ../df/virt-df.pod:207
4039 msgid "From inside the guest"
4043 #: ../df/virt-df.pod:211
4046 " python -c 'import os; s = os.statvfs (\"/\"); print s'\n"
4051 #: ../df/virt-df.pod:255
4053 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
4058 #: ../edit/virt-edit.pod:5
4059 msgid "virt-edit - Edit a file in a virtual machine"
4063 #: ../edit/virt-edit.pod:9
4066 " virt-edit [--options] -d domname file [file ...]\n"
4071 #: ../edit/virt-edit.pod:11
4074 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
4079 #: ../edit/virt-edit.pod:13
4082 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
4087 #: ../edit/virt-edit.pod:17
4090 " virt-edit domname file\n"
4095 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
4098 " virt-edit disk.img [disk.img ...] file\n"
4103 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
4104 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
4105 #: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
4106 #: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
4111 #: ../edit/virt-edit.pod:23
4113 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
4114 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
4115 "doing this, but doesn't catch all cases."
4119 #: ../edit/virt-edit.pod:29
4121 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
4122 "exists in the named virtual machine (or disk image)."
4126 #: ../edit/virt-edit.pod:32
4128 "Multiple filenames can be given, in which case they are each edited in "
4129 "turn. Each filename must be a full path, starting at the root directory "
4130 "(starting with '/')."
4134 #: ../edit/virt-edit.pod:36
4135 msgid "If you want to just view a file, use L<virt-cat(1)>."
4139 #: ../edit/virt-edit.pod:38
4141 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
4142 "USING GUESTFISH> below)."
4146 #: ../edit/virt-edit.pod:41
4148 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
4149 "that and much more."
4153 #: ../edit/virt-edit.pod:46
4154 msgid "Edit the named files interactively:"
4158 #: ../edit/virt-edit.pod:48
4161 " virt-edit -d mydomain /boot/grub/grub.conf\n"
4166 #: ../edit/virt-edit.pod:50
4169 " virt-edit -d mydomain /etc/passwd\n"
4174 #: ../edit/virt-edit.pod:52
4175 msgid "For Windows guests, some Windows paths are understood:"
4179 #: ../edit/virt-edit.pod:54
4182 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
4187 #: ../edit/virt-edit.pod:56
4189 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
4190 "INTERACTIVE EDITING> below). To change the init default level to 5:"
4194 #: ../edit/virt-edit.pod:60
4197 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
4202 #: ../edit/virt-edit.pod:81
4203 msgid "B<-b> extension"
4207 #: ../edit/virt-edit.pod:83
4208 msgid "B<--backup> extension"
4212 #: ../edit/virt-edit.pod:85
4214 "Create a backup of the original file I<in the guest disk image>. The backup "
4215 "has the original filename with C<extension> added."
4219 #: ../edit/virt-edit.pod:88
4221 "Usually the first character of C<extension> would be a dot C<.> so you would "
4226 #: ../edit/virt-edit.pod:91
4229 " virt-edit -b .orig [etc]\n"
4234 #: ../edit/virt-edit.pod:93
4235 msgid "By default, no backup file is made."
4239 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
4240 #: ../fuse/guestmount.pod:105 ../inspector/virt-inspector.pod:74
4241 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
4242 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
4247 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
4248 #: ../fuse/guestmount.pod:107 ../inspector/virt-inspector.pod:76
4249 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
4250 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
4251 msgid "B<--connect URI>"
4255 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
4256 #: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
4257 #: ../tools/virt-win-reg.pl:135
4259 "If you specify guest block devices directly, then libvirt is not used at all."
4263 #: ../edit/virt-edit.pod:114
4265 "When prompting for keys and passphrases, virt-edit normally turns echoing "
4266 "off so you cannot see what you are typing. If you are not worried about "
4267 "Tempest attacks and there is no one else in the room you can specify this "
4268 "flag to see what you are typing."
4272 #: ../edit/virt-edit.pod:119
4277 #: ../edit/virt-edit.pod:121
4278 msgid "B<--expr> EXPR"
4282 #: ../edit/virt-edit.pod:123
4284 "Instead of launching the external editor, non-interactively apply the Perl "
4285 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
4290 #: ../edit/virt-edit.pod:127
4292 "Be careful to properly quote the expression to prevent it from being altered "
4297 #: ../edit/virt-edit.pod:130
4298 msgid "Note that this option is only available when Perl 5 is installed."
4302 #: ../edit/virt-edit.pod:132
4303 msgid "B<--format> raw|qcow2|..."
4307 #: ../edit/virt-edit.pod:143
4310 " virt-edit --format=raw -a disk.img file\n"
4315 #: ../edit/virt-edit.pod:147
4318 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
4323 #: ../edit/virt-edit.pod:181
4324 msgid "Previous versions of virt-edit allowed you to write either:"
4328 #: ../edit/virt-edit.pod:187
4331 " virt-edit guestname file\n"
4336 #: ../edit/virt-edit.pod:195
4337 msgid "NON-INTERACTIVE EDITING"
4341 #: ../edit/virt-edit.pod:197
4343 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
4344 "administrator can interactively edit the file."
4348 #: ../edit/virt-edit.pod:200
4350 "There are two ways also to use C<virt-edit> from scripts in order to make "
4351 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
4352 "like this, it's less error-prone to write scripts directly using the "
4353 "libguestfs API and Augeas for configuration file editing.)"
4357 #: ../edit/virt-edit.pod:206
4359 "The first method is to temporarily set C<$EDITOR> to any script or program "
4360 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
4361 "update C<tmpfile> in place however it likes."
4365 #: ../edit/virt-edit.pod:210
4367 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
4368 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
4369 "instances of C<foo> with C<bar> in a file:"
4373 #: ../edit/virt-edit.pod:214
4376 " virt-edit -d domname filename -e 's/foo/bar/'\n"
4381 #: ../edit/virt-edit.pod:216
4383 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
4384 "For example to delete root's password you could do:"
4388 #: ../edit/virt-edit.pod:219
4391 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
4396 #: ../edit/virt-edit.pod:221
4398 "What really happens is that the snippet is evaluated as a Perl expression "
4399 "for each line of the file. The line, including the final C<\\n>, is passed "
4400 "in C<$_> and the expression should update C<$_> or leave it unchanged."
4404 #: ../edit/virt-edit.pod:226
4406 "To delete a line, set C<$_> to the empty string. For example, to delete the "
4407 "C<apache> user account from the password file you can do:"
4411 #: ../edit/virt-edit.pod:229
4414 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
4419 #: ../edit/virt-edit.pod:231
4421 "To insert a line, prepend or append it to C<$_>. However appending lines to "
4422 "the end of the file is rather difficult this way since there is no concept "
4423 "of \"last line of the file\" - your expression just doesn't get called "
4424 "again. You might want to use the first method (setting C<$EDITOR>) if you "
4429 #: ../edit/virt-edit.pod:237
4431 "The variable C<$lineno> contains the current line number. As is "
4432 "traditional, the first line in the file is number C<1>."
4436 #: ../edit/virt-edit.pod:240
4438 "The return value from the expression is ignored, but the expression may call "
4439 "C<die> in order to abort the whole program, leaving the original file "
4444 #: ../edit/virt-edit.pod:244
4446 "Remember when matching the end of a line that C<$_> may contain the final C<"
4447 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
4448 "newline then neither of these. Thus to match or substitute some text at the "
4449 "end of a line, use this regular expression:"
4453 #: ../edit/virt-edit.pod:249
4456 " /some text(\\r?\\n)?$/\n"
4461 #: ../edit/virt-edit.pod:251
4463 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
4464 "$_> itself (since that would remove all newlines from the file):"
4468 #: ../edit/virt-edit.pod:255
4471 " my $m = $_; chomp $m; $m =~ /some text$/\n"
4476 #: ../edit/virt-edit.pod:259
4478 "C<virt-edit> has a limited ability to understand Windows drive letters and "
4479 "paths (eg. C<E:\\foo\\bar.txt>)."
4483 #: ../edit/virt-edit.pod:278
4485 "The path is resolved case insensitively to locate the file that should be "
4490 #: ../edit/virt-edit.pod:299
4492 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
4493 "C<virt-edit> doesn't work."
4497 #: ../edit/virt-edit.pod:302
4498 msgid "Using C<virt-edit> is approximately equivalent to doing:"
4502 #: ../edit/virt-edit.pod:304
4505 " guestfish --rw -i -d domname edit /file\n"
4510 #: ../edit/virt-edit.pod:306
4512 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
4517 #: ../edit/virt-edit.pod:309
4519 "The command above uses libguestfs's guest inspection feature and so does not "
4520 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
4521 "disk images that don't contain guests. To edit a file on a disk image "
4526 #: ../edit/virt-edit.pod:314
4529 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
4534 #: ../edit/virt-edit.pod:316
4536 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
4537 "the disk image to edit, and C</file> is the full path to the file."
4541 #: ../edit/virt-edit.pod:320
4543 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
4544 "C<write> or C<upload> instead:"
4548 #: ../edit/virt-edit.pod:323
4551 " guestfish --rw -i -d domname touch /newfile\n"
4556 #: ../edit/virt-edit.pod:325
4559 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
4564 #: ../edit/virt-edit.pod:327
4567 " guestfish --rw -i -d domname upload localfile /newfile\n"
4572 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1119
4573 #: ../rescue/virt-rescue.pod:261 ../sparsify/virt-sparsify.pod:231
4574 #: ../src/guestfs.pod:3214 ../test-tool/libguestfs-test-tool.pod:95
4575 msgid "ENVIRONMENT VARIABLES"
4579 #: ../edit/virt-edit.pod:333
4584 #: ../edit/virt-edit.pod:335
4586 "If set, this string is used as the editor. It may contain arguments, eg. C<"
4591 #: ../edit/virt-edit.pod:338
4592 msgid "If not set, C<vi> is used."
4596 #: ../edit/virt-edit.pod:356
4598 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
4599 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
4600 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
4604 #: ../erlang/examples/guestfs-erlang.pod:5
4605 msgid "guestfs-erlang - How to use libguestfs from Erlang"
4609 #: ../erlang/examples/guestfs-erlang.pod:9
4612 " {ok, G} = guestfs:create(),\n"
4613 " ok = guestfs:add_drive_opts(G, Disk,\n"
4614 " [{format, \"raw\"}, {readonly, true}]),\n"
4615 " ok = guestfs:launch(G),\n"
4616 " [Device] = guestfs:list_devices(G),\n"
4617 " ok = guestfs:close(G).\n"
4622 #: ../erlang/examples/guestfs-erlang.pod:18
4624 "This manual page documents how to call libguestfs from the Erlang "
4625 "programming language. This page just documents the differences from the C "
4626 "API and gives some examples. If you are not familiar with using libguestfs, "
4627 "you also need to read L<guestfs(3)>."
4631 #: ../erlang/examples/guestfs-erlang.pod:23
4632 msgid "OPENING AND CLOSING THE HANDLE"
4636 #: ../erlang/examples/guestfs-erlang.pod:25
4638 "The Erlang bindings are implemented using an external program called C<erl-"
4639 "guestfs>. This program must be on the current PATH, or else you should "
4640 "specify the full path to the program:"
4644 #: ../erlang/examples/guestfs-erlang.pod:29
4647 " {ok, G} = guestfs:create().\n"
4652 #: ../erlang/examples/guestfs-erlang.pod:31
4655 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
4660 #: ../erlang/examples/guestfs-erlang.pod:33
4661 msgid "C<G> is the libguestfs handle which you should pass to other functions."
4665 #: ../erlang/examples/guestfs-erlang.pod:36
4666 msgid "To close the handle:"
4670 #: ../erlang/examples/guestfs-erlang.pod:38
4673 " ok = guestfs:close(G).\n"
4678 #: ../erlang/examples/guestfs-erlang.pod:40
4679 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
4683 #: ../erlang/examples/guestfs-erlang.pod:42
4685 "For functions that take optional arguments, the first arguments are the non-"
4686 "optional ones. The last argument is a list of tuples supplying the "
4687 "remaining optional arguments."
4691 #: ../erlang/examples/guestfs-erlang.pod:46
4694 " ok = guestfs:add_drive_opts(G, Disk,\n"
4695 " [{format, \"raw\"}, {readonly, true}]).\n"
4700 #: ../erlang/examples/guestfs-erlang.pod:49
4701 msgid "If the last argument would be an empty list, you can also omit it:"
4705 #: ../erlang/examples/guestfs-erlang.pod:51
4708 " ok = guestfs:add_drive_opts(G, Disk).\n"
4713 #: ../erlang/examples/guestfs-erlang.pod:53
4714 msgid "RETURN VALUES AND ERRORS"
4718 #: ../erlang/examples/guestfs-erlang.pod:55
4720 "On success, most functions return a C<Result> term (which could be a list, "
4721 "string, tuple etc.). If there is nothing for the function to return, then "
4722 "the atom C<ok> is returned."
4726 #: ../erlang/examples/guestfs-erlang.pod:59
4727 msgid "On error, you would see one of the following tuples:"
4731 #: ../erlang/examples/guestfs-erlang.pod:63
4732 msgid "C<{error, Msg, Errno}>"
4736 #: ../erlang/examples/guestfs-erlang.pod:65
4737 msgid "This indicates an ordinary error from the function."
4741 #: ../erlang/examples/guestfs-erlang.pod:67
4743 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
4748 #: ../erlang/examples/guestfs-erlang.pod:70
4749 msgid "C<Errno> can be zero. See L<guestfs(3)/guestfs_last_errno>."
4753 #: ../erlang/examples/guestfs-erlang.pod:72
4754 msgid "C<{unknown, Function}>"
4758 #: ../erlang/examples/guestfs-erlang.pod:74
4760 "This indicates that the function you called is not known. Generally this "
4761 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
4762 "which you should not do."
4766 #: ../erlang/examples/guestfs-erlang.pod:78
4767 msgid "C<Function> is the name of the unknown function."
4771 #: ../erlang/examples/guestfs-erlang.pod:80
4772 msgid "C<{unknownarg, Arg}>"
4776 #: ../erlang/examples/guestfs-erlang.pod:82
4778 "This indicates that you called a function with optional arguments, with an "
4779 "unknown argument name."
4783 #: ../erlang/examples/guestfs-erlang.pod:85
4784 msgid "C<Arg> is the name of the unknown argument."
4788 #: ../erlang/examples/guestfs-erlang.pod:89
4789 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
4790 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
4791 #: ../python/examples/guestfs-python.pod:34
4792 #: ../ruby/examples/guestfs-ruby.pod:28
4793 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
4797 #: ../erlang/examples/guestfs-erlang.pod:91
4798 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
4799 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
4800 #: ../python/examples/guestfs-python.pod:36
4801 #: ../ruby/examples/guestfs-ruby.pod:30
4806 #: ../erlang/examples/guestfs-erlang.pod:93
4807 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
4808 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
4809 #: ../python/examples/guestfs-python.pod:38
4810 #: ../ruby/examples/guestfs-ruby.pod:32
4811 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
4815 #: ../erlang/examples/guestfs-erlang.pod:95
4816 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
4817 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
4818 #: ../python/examples/guestfs-python.pod:40
4819 #: ../ruby/examples/guestfs-ruby.pod:34
4824 #: ../erlang/examples/guestfs-erlang.pod:99
4826 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
4827 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
4828 "L<guestfs-ruby(3)>, L<http://www.erlang.org/>. L<http://libguestfs.org/>."
4832 #: ../erlang/examples/guestfs-erlang.pod:110
4833 #: ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397
4834 #: ../examples/guestfs-testing.pod:298 ../fish/guestfish.pod:1296
4835 #: ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49
4836 #: ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51
4837 #: ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:404
4838 #: ../java/examples/guestfs-java.pod:58 ../ocaml/examples/guestfs-ocaml.pod:91
4839 #: ../perl/examples/guestfs-perl.pod:52
4840 #: ../python/examples/guestfs-python.pod:54
4841 #: ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3354
4842 #: ../test-tool/libguestfs-test-tool.pod:106
4847 #: ../erlang/examples/guestfs-erlang.pod:112
4848 #: ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399
4849 #: ../examples/guestfs-testing.pod:300 ../fish/guestfish.pod:1298
4850 #: ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51
4851 #: ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53
4852 #: ../fuse/guestmount.pod:330 ../java/examples/guestfs-java.pod:60
4853 #: ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54
4854 #: ../python/examples/guestfs-python.pod:56
4855 #: ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3356
4856 #: ../test-tool/libguestfs-test-tool.pod:108
4857 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4861 #: ../erlang/examples/guestfs-erlang.pod:116
4862 #: ../examples/guestfs-testing.pod:304 ../java/examples/guestfs-java.pod:64
4863 #: ../perl/examples/guestfs-perl.pod:58
4864 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
4868 #: ../erlang/examples/guestfs-erlang.pod:118
4869 #: ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405
4870 #: ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99
4871 #: ../perl/examples/guestfs-perl.pod:60
4872 #: ../python/examples/guestfs-python.pod:62
4873 #: ../ruby/examples/guestfs-ruby.pod:56
4875 "The examples in this manual page may be freely copied, modified and "
4876 "distributed without any restrictions."
4880 #: ../erlang/examples/guestfs-erlang.pod:121
4881 #: ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408
4882 #: ../examples/guestfs-testing.pod:306 ../java/examples/guestfs-java.pod:69
4883 #: ../ocaml/examples/guestfs-ocaml.pod:102
4884 #: ../perl/examples/guestfs-perl.pod:63
4885 #: ../python/examples/guestfs-python.pod:65
4886 #: ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3363
4888 "This library is free software; you can redistribute it and/or modify it "
4889 "under the terms of the GNU Lesser General Public License as published by the "
4890 "Free Software Foundation; either version 2 of the License, or (at your "
4891 "option) any later version."
4895 #: ../erlang/examples/guestfs-erlang.pod:126
4896 #: ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413
4897 #: ../examples/guestfs-testing.pod:311 ../java/examples/guestfs-java.pod:74
4898 #: ../ocaml/examples/guestfs-ocaml.pod:107
4899 #: ../perl/examples/guestfs-perl.pod:68
4900 #: ../python/examples/guestfs-python.pod:70
4901 #: ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3368
4903 "This library is distributed in the hope that it will be useful, but WITHOUT "
4904 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4905 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4910 #: ../erlang/examples/guestfs-erlang.pod:131
4911 #: ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418
4912 #: ../examples/guestfs-testing.pod:316 ../java/examples/guestfs-java.pod:79
4913 #: ../ocaml/examples/guestfs-ocaml.pod:112
4914 #: ../perl/examples/guestfs-perl.pod:73
4915 #: ../python/examples/guestfs-python.pod:75
4916 #: ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3373
4918 "You should have received a copy of the GNU Lesser General Public License "
4919 "along with this library; if not, write to the Free Software Foundation, "
4920 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4924 #: ../examples/guestfs-examples.pod:5
4925 msgid "guestfs-examples - Examples of using libguestfs from C"
4929 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
4932 " #include <guestfs.h>\n"
4934 msgstr "#include <guestfs.h>\n"
4937 #: ../examples/guestfs-examples.pod:11
4940 " guestfs_h *g = guestfs_create ();\n"
4941 " guestfs_add_drive_ro (g, \"disk.img\");\n"
4942 " guestfs_launch (g);\n"
4947 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
4950 " cc prog.c -o prog -lguestfs\n"
4952 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
4955 " cc prog.c -o prog -lguestfs\n"
4957 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
4961 #: ../examples/guestfs-examples.pod:21
4963 "This manual page contains examples of calling libguestfs from the C "
4964 "programming language. If you are not familiar with using libguestfs, you "
4965 "also need to read L<guestfs(3)>."
4969 #: ../examples/guestfs-examples.pod:35
4971 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
4972 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
4973 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
4977 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97
4978 #: ../python/examples/guestfs-python.pod:60
4979 #: ../ruby/examples/guestfs-ruby.pod:54
4980 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
4984 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
4989 #: ../examples/guestfs-recipes.pod:5
4991 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
4992 "here. The only way which works for both sorts of output is to just write "
4993 "the URL directly. Do NOT use L<...> for URLs."
4997 #: ../examples/guestfs-recipes.pod:9
4999 "We break with tradition here and don't use ALL CAPS for the section "
5000 "headings, as this makes them much easier to read."
5004 #: ../examples/guestfs-recipes.pod:16
5005 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
5009 #: ../examples/guestfs-recipes.pod:20
5011 "This page contains recipes for and links to things you can do using "
5012 "libguestfs, L<guestfish(1)> and the virt tools."
5016 #: ../examples/guestfs-recipes.pod:23
5017 msgid "Audit a virtual machine for setuid files"
5021 #: ../examples/guestfs-recipes.pod:25
5023 "The link below contains a small program which can be used to audit a Linux "
5024 "virtual machine to see what setuid and setgid files it contains."
5028 #: ../examples/guestfs-recipes.pod:28
5030 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
5035 #: ../examples/guestfs-recipes.pod:30
5036 msgid "Change the background image in a Windows XP VM"
5040 #: ../examples/guestfs-recipes.pod:32
5042 "The links below explain how to use L<guestfish(1)> to change the background "
5043 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
5044 "be substantially different for each version of Windows."
5048 #: ../examples/guestfs-recipes.pod:37
5050 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
5051 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
5055 #: ../examples/guestfs-recipes.pod:40
5056 msgid "Cloning a virtual machine (Linux)"
5060 #: ../examples/guestfs-recipes.pod:42
5062 "The guestfish technique described in the link below works well for most "
5063 "Linux VMs. Depending on the Linux distro you may need to change the paths "
5068 #: ../examples/guestfs-recipes.pod:46
5070 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
5075 #: ../examples/guestfs-recipes.pod:48
5077 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
5082 #: ../examples/guestfs-recipes.pod:51
5083 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
5087 #: ../examples/guestfs-recipes.pod:53
5088 msgid "Cloning a virtual machine (Windows)"
5092 #: ../examples/guestfs-recipes.pod:55
5094 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
5095 "straightforward. Currently there is code in the Aeolus Oz project which "
5096 "does this (using libguestfs). As part of our review of the virt-clone tool, "
5097 "we may add sysprepping ability."
5101 #: ../examples/guestfs-recipes.pod:60
5103 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
5104 "list/2011-May/msg00019.html"
5108 #: ../examples/guestfs-recipes.pod:63
5109 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
5113 #: ../examples/guestfs-recipes.pod:65
5114 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
5118 #: ../examples/guestfs-recipes.pod:67
5121 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
5126 #: ../examples/guestfs-recipes.pod:69
5127 msgid "To export just a subdirectory, eg. C</files>, do:"
5131 #: ../examples/guestfs-recipes.pod:71
5134 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
5139 #: ../examples/guestfs-recipes.pod:73
5140 msgid "Create empty disk images"
5144 #: ../examples/guestfs-recipes.pod:75
5146 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
5147 "The useful guide below explains the options available."
5151 #: ../examples/guestfs-recipes.pod:78
5153 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
5158 #: ../examples/guestfs-recipes.pod:80
5159 msgid "Dump raw filesystem content from inside a disk image or VM"
5163 #: ../examples/guestfs-recipes.pod:82
5165 "You can use the L<guestfish(1)> C<download> command to extract the raw "
5166 "filesystem content from any filesystem in a disk image or a VM (even one "
5167 "which is encrypted or buried inside an LV):"
5171 #: ../examples/guestfs-recipes.pod:86
5174 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
5179 #: ../examples/guestfs-recipes.pod:88
5182 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
5187 #: ../examples/guestfs-recipes.pod:90
5188 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
5192 #: ../examples/guestfs-recipes.pod:92
5193 msgid "Edit grub configuration in a VM"
5197 #: ../examples/guestfs-recipes.pod:94
5198 msgid "You can use this to:"
5202 #: ../examples/guestfs-recipes.pod:100
5203 msgid "Fix a virtual machine that does not boot."
5207 #: ../examples/guestfs-recipes.pod:104
5208 msgid "Change which kernel is used to boot the VM."
5212 #: ../examples/guestfs-recipes.pod:108
5213 msgid "Change kernel command line options."
5217 #: ../examples/guestfs-recipes.pod:112
5218 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
5222 #: ../examples/guestfs-recipes.pod:114
5225 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
5230 #: ../examples/guestfs-recipes.pod:116
5232 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
5237 #: ../examples/guestfs-recipes.pod:119
5240 " virt-rescue -d BrokenGuest\n"
5245 #: ../examples/guestfs-recipes.pod:121
5246 msgid "Export any directory from a VM"
5250 #: ../examples/guestfs-recipes.pod:123
5252 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
5256 #: ../examples/guestfs-recipes.pod:126 ../examples/guestfs-testing.pod:93
5259 " virt-copy-out -d Guest /home .\n"
5264 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
5265 #: ../fish/guestfish-actions.pod:1450 ../fish/guestfish-actions.pod:1715
5266 #: ../fish/guestfish-actions.pod:2132 ../src/guestfs-actions.pod:18
5267 #: ../src/guestfs-actions.pod:2334 ../src/guestfs-actions.pod:2758
5268 #: ../src/guestfs-actions.pod:3317 ../src/guestfs.pod:1685
5269 #: ../tools/virt-win-reg.pl:717
5274 #: ../examples/guestfs-recipes.pod:134
5276 "The final dot of the command is not a printing error. It means we want to "
5277 "copy out to the current directory."
5281 #: ../examples/guestfs-recipes.pod:139
5282 msgid "This creates a directory called C<home> under the current directory."
5286 #: ../examples/guestfs-recipes.pod:143
5288 "If the guest is a Windows guest then you can use drive letters and "
5289 "backslashes, but you must prefix the path with C<win:> and quote it to "
5290 "protect it from the shell, like this:"
5294 #: ../examples/guestfs-recipes.pod:147
5297 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
5302 #: ../examples/guestfs-recipes.pod:149
5303 msgid "To get the output as a compressed tarball, do:"
5307 #: ../examples/guestfs-recipes.pod:151
5310 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
5315 #: ../examples/guestfs-recipes.pod:153
5317 "Although it sounds tempting, this is usually not a reliable way to get a "
5318 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
5319 "org/FAQ.html#backup"
5323 #: ../examples/guestfs-recipes.pod:157
5324 msgid "Find out which user is using the most space"
5328 #: ../examples/guestfs-recipes.pod:159
5330 "This simple script examines a Linux guest to find out which user is using "
5331 "the most space in their home directory:"
5335 #: ../examples/guestfs-recipes.pod:162
5343 #: ../examples/guestfs-recipes.pod:164 ../fish/guestfish.pod:984
5351 #: ../examples/guestfs-recipes.pod:166
5360 #: ../examples/guestfs-recipes.pod:169
5363 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
5368 #: ../examples/guestfs-recipes.pod:171
5371 " for d in $(guestfish --remote ls \"$dir\"); do\n"
5372 " echo -n \"$dir/$d\"\n"
5374 " guestfish --remote du \"$dir/$d\";\n"
5375 " done | sort -nr -k 2\n"
5380 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
5383 " guestfish --remote exit\n"
5388 #: ../examples/guestfs-recipes.pod:179
5389 msgid "Get DHCP address from a VM"
5393 #: ../examples/guestfs-recipes.pod:181
5395 "The link below explains the many different possible techniques for getting "
5396 "the last assigned DHCP address of a virtual machine."
5400 #: ../examples/guestfs-recipes.pod:184
5402 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
5403 "a-virtual-machine-disk-image/#content"
5407 #: ../examples/guestfs-recipes.pod:186
5409 "In the libguestfs source examples directory you will find the latest version "
5410 "of the C<virt-dhcp-address.c> program."
5414 #: ../examples/guestfs-recipes.pod:189
5415 msgid "Get the operating system product name string"
5419 #: ../examples/guestfs-recipes.pod:191
5420 msgid "Save the following script into a file called C<product-name.sh>:"
5424 #: ../examples/guestfs-recipes.pod:193
5429 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
5430 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
5431 " guestfish --remote inspect-get-product-name \"$root\"\n"
5432 " guestfish --remote exit\n"
5437 #: ../examples/guestfs-recipes.pod:200
5438 msgid "Make the script executable and run it on a named guest:"
5442 #: ../examples/guestfs-recipes.pod:202
5445 " # product-name.sh RHEL60x64\n"
5446 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
5451 #: ../examples/guestfs-recipes.pod:205
5453 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
5454 "C<xpath> command line tool or from your favourite programming language:"
5458 #: ../examples/guestfs-recipes.pod:209
5461 " # virt-inspector RHEL60x64 > xml\n"
5462 " # xpath '//product_name' < xml\n"
5465 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
5470 #: ../examples/guestfs-recipes.pod:215
5471 msgid "Get the default boot kernel for a Linux VM"
5475 #: ../examples/guestfs-recipes.pod:217
5477 "The link below contains a program to print the default boot kernel for a "
5482 #: ../examples/guestfs-recipes.pod:220
5484 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
5485 "kernel-for-a-vm/#content"
5489 #: ../examples/guestfs-recipes.pod:222
5491 "It uses Augeas, and the technique is generally applicable for many different "
5496 #: ../examples/guestfs-recipes.pod:229
5497 msgid "listing the user accounts in the guest"
5501 #: ../examples/guestfs-recipes.pod:233
5502 msgid "what repositories is it configured to use"
5506 #: ../examples/guestfs-recipes.pod:237
5507 msgid "what NTP servers does it connect to"
5511 #: ../examples/guestfs-recipes.pod:241
5512 msgid "what were the boot messages last time it booted"
5516 #: ../examples/guestfs-recipes.pod:245
5517 msgid "listing who was logged in recently"
5521 #: ../examples/guestfs-recipes.pod:249
5522 msgid "http://augeas.net/"
5526 #: ../examples/guestfs-recipes.pod:251
5527 msgid "Install RPMs in a guest"
5531 #: ../examples/guestfs-recipes.pod:253
5533 "The link below contains a method to install RPMs in a guest. In fact the "
5534 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
5535 "installs them next time the guest is booted. You could use this technique "
5536 "to install vital security updates in an offline guest."
5540 #: ../examples/guestfs-recipes.pod:259
5542 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
5546 #: ../examples/guestfs-recipes.pod:261
5547 msgid "List applications installed in a VM"
5551 #: ../examples/guestfs-recipes.pod:263
5552 msgid "Save the following to a file C<list-apps.sh>:"
5556 #: ../examples/guestfs-recipes.pod:265
5561 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
5562 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
5563 " guestfish --remote inspect-list-applications \"$root\"\n"
5564 " guestfish --remote exit\n"
5569 #: ../examples/guestfs-recipes.pod:272
5571 "Make the file executable and then you can run it on any named virtual "
5576 #: ../examples/guestfs-recipes.pod:275
5579 " # list-apps.sh WinGuest\n"
5581 " app_name: Mozilla Firefox (3.6.12)\n"
5582 " app_display_name: Mozilla Firefox (3.6.12)\n"
5584 " app_version: 3.6.12 (en-GB)\n"
5586 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
5587 " app_trans_path:\n"
5588 " app_publisher: Mozilla\n"
5589 " app_url: http://www.mozilla.com/en-GB/\n"
5590 " app_source_package:\n"
5592 " app_description: Mozilla Firefox\n"
5595 " app_name: VLC media player\n"
5596 " app_display_name: VLC media player 1.1.5\n"
5598 " app_version: 1.1.5\n"
5600 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
5601 " app_trans_path:\n"
5602 " app_publisher: VideoLAN\n"
5603 " app_url: http://www.videolan.org/\n"
5604 " app_source_package:\n"
5606 " app_description:\n"
5612 #: ../examples/guestfs-recipes.pod:305
5614 "If you want to run the script on disk images (instead of libvirt virtual "
5615 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
5620 #: ../examples/guestfs-recipes.pod:309
5621 msgid "List files and directories in a VM"
5625 #: ../examples/guestfs-recipes.pod:311
5626 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
5630 #: ../examples/guestfs-recipes.pod:313
5633 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
5638 #: ../examples/guestfs-recipes.pod:315
5639 msgid "List services in a Windows VM"
5643 #: ../examples/guestfs-recipes.pod:317
5645 "The link below contains a script that can be used to list out the services "
5646 "from a Windows VM, and whether those services run at boot time or are loaded "
5651 #: ../examples/guestfs-recipes.pod:321
5653 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
5658 #: ../examples/guestfs-recipes.pod:323
5659 msgid "Make a disk image sparse"
5663 #: ../examples/guestfs-recipes.pod:325
5665 "The link below contains some guides for making a disk image sparse (or "
5666 "reintroducing sparseness)."
5670 #: ../examples/guestfs-recipes.pod:328
5672 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
5676 #: ../examples/guestfs-recipes.pod:330
5677 msgid "Monitor disk usage over time"
5681 #: ../examples/guestfs-recipes.pod:332
5683 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
5684 "The link below contains a guide."
5688 #: ../examples/guestfs-recipes.pod:335
5689 msgid "http://virt-tools.org/learning/advanced-virt-df/"
5693 #: ../examples/guestfs-recipes.pod:337
5694 msgid "Reading the Windows Event Log from Windows Vista (or later)"
5698 #: ../examples/guestfs-recipes.pod:339
5700 "L<guestfish(1)> plus the tools described in the link below can be used to "
5701 "read out the Windows Event Log from any virtual machine running Windows "
5702 "Vista or a later version."
5706 #: ../examples/guestfs-recipes.pod:343
5708 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
5709 "guestfish/#content"
5713 #: ../examples/guestfs-recipes.pod:345
5714 msgid "Remove root password (Linux)"
5718 #: ../examples/guestfs-recipes.pod:347
5720 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
5721 "files. One use is to remove the root password from a Linux guest:"
5725 #: ../examples/guestfs-recipes.pod:350
5728 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
5733 #: ../examples/guestfs-recipes.pod:352
5734 msgid "Remove Administrator password (Windows)"
5738 #: ../examples/guestfs-recipes.pod:354
5740 "The link below contains one technique for removing the Administrator "
5741 "password from a Windows VM, or to be more precise, it gives you a command "
5742 "prompt the next time you log in which you can use to bypass any security:"
5746 #: ../examples/guestfs-recipes.pod:359
5748 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
5749 "administrator-password-with-guestfish/"
5753 #: ../examples/guestfs-recipes.pod:361
5754 msgid "Unpack a live CD"
5758 #: ../examples/guestfs-recipes.pod:363
5760 "Linux live CDs often contain multiple layers of disk images wrapped like a "
5761 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
5762 "layers, as outlined in the guide below."
5766 #: ../examples/guestfs-recipes.pod:367
5768 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
5773 #: ../examples/guestfs-recipes.pod:369
5774 msgid "Uploading and downloading files"
5778 #: ../examples/guestfs-recipes.pod:371
5780 "The link below contains general tips on uploading (copying in) and "
5781 "downloading (copying out) files from VMs."
5785 #: ../examples/guestfs-recipes.pod:374
5787 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
5791 #: ../examples/guestfs-recipes.pod:376
5792 msgid "Use libguestfs tools on VMware ESX guests"
5796 #: ../examples/guestfs-recipes.pod:378
5798 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
5799 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
5803 #: ../examples/guestfs-recipes.pod:382
5805 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
5810 #: ../examples/guestfs-recipes.pod:386
5812 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)"
5813 ">, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
5814 "python(3)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
5818 #: ../examples/guestfs-recipes.pod:403
5819 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5823 #: ../examples/guestfs-testing.pod:5
5824 msgid "guestfs-testing - manual testing of libguestfs, you can help!"
5828 #: ../examples/guestfs-testing.pod:9
5830 "This page has manual tests you can try on libguestfs. Everyone has a "
5831 "slightly different combination of platform, hardware and guests, so this "
5832 "testing is very valuable. Thanks for helping out!"
5836 #: ../examples/guestfs-testing.pod:13
5837 msgid "These tests require libguestfs E<ge> 1.14."
5841 #: ../examples/guestfs-testing.pod:15
5843 "Tests marked with a B<*> (asterisk) can B<destroy data> if you're not "
5844 "careful. The others are safe and won't modify anything."
5848 #: ../examples/guestfs-testing.pod:18
5849 msgid "You can report bugs you find through this link:"
5853 #: ../examples/guestfs-testing.pod:20
5855 "https://bugzilla.redhat.com/enter_bug.cgi?"
5856 "component=libguestfs&product=Virtualization+Tools"
5860 #: ../examples/guestfs-testing.pod:22
5862 "or post on the mailing list (registration is B<not> required, but if you're "
5863 "not registered then you'll have to wait for a moderator to manually approve "
5868 #: ../examples/guestfs-testing.pod:26
5869 msgid "https://www.redhat.com/mailman/listinfo/libguestfs"
5873 #: ../examples/guestfs-testing.pod:28
5878 #: ../examples/guestfs-testing.pod:30
5879 msgid "Check KVM acceleration is being used."
5883 #: ../examples/guestfs-testing.pod:32
5885 "If your host has hardware virt acceleration, then with a hot cache "
5886 "libguestfs should be able to start up in a few seconds. Run the following "
5887 "command a few times:"
5891 #: ../examples/guestfs-testing.pod:36
5894 " time guestfish -a /dev/null run\n"
5899 #: ../examples/guestfs-testing.pod:38
5901 "After a few runs, the time should settle down to a few seconds (under 5 "
5902 "seconds on fast 64 bit hardware)."
5906 #: ../examples/guestfs-testing.pod:41
5907 msgid "How to check for hardware virt:"
5911 #: ../examples/guestfs-testing.pod:43
5912 msgid "http://virt-tools.org/learning/check-hardware-virt/"
5916 #: ../examples/guestfs-testing.pod:45
5918 "If the command above does not work at all, use L<libguestfs-test-tool(1)>."
5922 #: ../examples/guestfs-testing.pod:48
5923 msgid "Run virt-alignment-scan on all your guests."
5927 #: ../examples/guestfs-testing.pod:50
5928 msgid "Run L<virt-alignment-scan(1)> on guests or disk images:"
5932 #: ../examples/guestfs-testing.pod:52
5935 " virt-alignment-scan -a /path/to/disk.img\n"
5940 #: ../examples/guestfs-testing.pod:54 ../examples/guestfs-testing.pod:161
5941 #: ../examples/guestfs-testing.pod:174 ../examples/guestfs-testing.pod:234
5942 #: ../src/guestfs.pod:2792
5947 #: ../examples/guestfs-testing.pod:56
5950 " virt-alignment-scan -d Guest\n"
5955 #: ../examples/guestfs-testing.pod:58
5956 msgid "Does the alignment report match how the guest partitions are aligned?"
5960 #: ../examples/guestfs-testing.pod:60
5961 msgid "Run virt-cat on some files in guests."
5965 #: ../examples/guestfs-testing.pod:62
5966 msgid "L<virt-cat(1)> can display files from guests. For a Linux guest, try:"
5970 #: ../examples/guestfs-testing.pod:64
5973 " virt-cat LinuxGuest /etc/passwd\n"
5978 #: ../examples/guestfs-testing.pod:66
5979 msgid "A recent feature is support for Windows paths, for example:"
5983 #: ../examples/guestfs-testing.pod:68
5986 " virt-cat WindowsGuest 'c:\\windows\\win.ini'\n"
5991 #: ../examples/guestfs-testing.pod:70
5993 "An even better test is if you have a Windows guest with multiple drives. Do "
5994 "C<D:>, C<E:> etc paths work correctly?"
5998 #: ../examples/guestfs-testing.pod:73
5999 msgid "B<*> Copy some files into a B<shut off> guest."
6003 #: ../examples/guestfs-testing.pod:75
6005 "L<virt-copy-in(1)> can recursively copy files and directories into a guest "
6010 #: ../examples/guestfs-testing.pod:78
6013 " virt-copy-in -d Guest /etc /tmp\n"
6018 #: ../examples/guestfs-testing.pod:80
6020 "This should copy local directory C</etc> to C</tmp/etc> in the guest "
6021 "(recursively). If you boot the guest, can you see all of the copied files "
6026 #: ../examples/guestfs-testing.pod:84
6027 msgid "Shut the guest down and try copying multiple files and directories:"
6031 #: ../examples/guestfs-testing.pod:86
6034 " virt-copy-in -d Guest /home /etc/issue /tmp\n"
6039 #: ../examples/guestfs-testing.pod:88
6040 msgid "Copy some files out of a guest."
6044 #: ../examples/guestfs-testing.pod:90
6046 "L<virt-copy-out(1)> can recursively copy files and directories out of a "
6047 "guest or disk image."
6051 #: ../examples/guestfs-testing.pod:95
6052 msgid "Note the final space and period in the command is not a typo."
6056 #: ../examples/guestfs-testing.pod:97
6057 msgid "This should copy C</home> from the guest into the current directory."
6061 #: ../examples/guestfs-testing.pod:99
6062 msgid "Run virt-df."
6066 #: ../examples/guestfs-testing.pod:101
6067 msgid "L<virt-df(1)> lists disk space. Run:"
6071 #: ../examples/guestfs-testing.pod:103
6079 #: ../examples/guestfs-testing.pod:105
6081 "You can try comparing this to the results from L<df(1)> inside the guest, "
6082 "but there are some provisos:"
6086 #: ../examples/guestfs-testing.pod:112
6087 msgid "The guest must be idle."
6091 #: ../examples/guestfs-testing.pod:116
6092 msgid "The guest disks must be synched using L<sync(1)>."
6096 #: ../examples/guestfs-testing.pod:120
6098 "Any action such as booting the guest will write log files causing the "
6099 "numbers to change."
6103 #: ../examples/guestfs-testing.pod:125
6105 "We don't guarantee that the numbers will be identical even under these "
6106 "circumstances. They should be similar. It would indicate a bug if you saw "
6107 "greatly differing numbers."
6111 #: ../examples/guestfs-testing.pod:129
6112 msgid "Try importing virt-df CSV output into a spreadsheet or database."
6116 #: ../examples/guestfs-testing.pod:131 ../src/guestfs.pod:3088
6121 #: ../examples/guestfs-testing.pod:133
6124 " virt-df --csv > /tmp/report.csv\n"
6129 #: ../examples/guestfs-testing.pod:135
6131 "Now try to load this into your favorite spreadsheet or database. Are the "
6132 "results reproduced faithfully in the spreadsheet/database?"
6136 #: ../examples/guestfs-testing.pod:138
6138 "http://www.postgresql.org/docs/8.1/static/sql-copy.html http://dev.mysql.com/"
6139 "doc/refman/5.1/en/load-data.html"
6143 #: ../examples/guestfs-testing.pod:141
6144 msgid "B<*> Edit a file in a B<shut off> guest."
6148 #: ../examples/guestfs-testing.pod:143
6150 "L<virt-edit(1)> can edit files in guests. Try this command on a RHEL or "
6155 #: ../examples/guestfs-testing.pod:146
6158 " virt-edit LinuxGuest /etc/sysconfig/network\n"
6163 #: ../examples/guestfs-testing.pod:148
6164 msgid "On other Linux guests try editing other files such as:"
6168 #: ../examples/guestfs-testing.pod:150
6171 " virt-edit LinuxGuest /etc/motd\n"
6176 #: ../examples/guestfs-testing.pod:152
6177 msgid "Are the changes seen inside the guest when it is booted?"
6181 #: ../examples/guestfs-testing.pod:154
6182 msgid "Display the filesystems / partitions / LVs in a guest."
6186 #: ../examples/guestfs-testing.pod:156
6188 "L<virt-filesystems(1)> can be used to display filesystems in a guest. Try "
6189 "this command on any disk image or guest:"
6193 #: ../examples/guestfs-testing.pod:159
6196 " virt-filesystems -a /path/to/disk.img --all --long -h\n"
6201 #: ../examples/guestfs-testing.pod:163
6204 " virt-filesystems -d Guest --all --long -h\n"
6209 #: ../examples/guestfs-testing.pod:165
6210 msgid "Do the results match what is seen in the guest?"
6214 #: ../examples/guestfs-testing.pod:167
6215 msgid "Run virt-inspector on all your guests."
6219 #: ../examples/guestfs-testing.pod:169
6221 "Use L<virt-inspector(1)> to get a report on all of your guests or disk "
6226 #: ../examples/guestfs-testing.pod:172
6229 " virt-inspector -a /path/to/disk.img | less\n"
6234 #: ../examples/guestfs-testing.pod:176
6237 " virt-inspector -d Guest | less\n"
6242 #: ../examples/guestfs-testing.pod:178
6243 msgid "Do the results match what is actually in the guest?"
6247 #: ../examples/guestfs-testing.pod:180
6248 msgid "Try the auditing features of virt-ls on all your guests."
6252 #: ../examples/guestfs-testing.pod:184
6255 " virt-ls -lR -d Guest / | grep '^- [42]'\n"
6260 #: ../examples/guestfs-testing.pod:188
6263 " virt-ls -lR -d Guest / | grep '^d ...7'\n"
6268 #: ../examples/guestfs-testing.pod:192
6271 " virt-ls -lR -d Guest / | grep '^s'\n"
6276 #: ../examples/guestfs-testing.pod:196
6279 " virt-ls -lR -d Guest / | grep -i '^-.*\\.png$'\n"
6284 #: ../examples/guestfs-testing.pod:198
6285 msgid "Display files larger than 10MB in home directories:"
6289 #: ../examples/guestfs-testing.pod:200
6292 " virt-ls -lR -d Guest /home | awk '$3 > 10*1024*1024'\n"
6297 #: ../examples/guestfs-testing.pod:204
6300 " virt-ls -lR -d Guest --time-days / | awk '$6 <= 7'\n"
6305 #: ../examples/guestfs-testing.pod:208
6308 " virt-ls -lR -d Guest --time-days / | grep '^-' | awk '$6 < 1'\n"
6313 #: ../examples/guestfs-testing.pod:210
6314 msgid "Do the results match what is in the guest?"
6318 #: ../examples/guestfs-testing.pod:212
6319 msgid "Create a disk image from a tarball."
6323 #: ../examples/guestfs-testing.pod:214
6325 "Use L<virt-make-fs(1)> to create a disk image from any tarball that you "
6330 #: ../examples/guestfs-testing.pod:217
6333 " virt-make-fs --partition=mbr --type=vfat /any/tarball.tar.gz output.img\n"
6338 #: ../examples/guestfs-testing.pod:219
6340 "Add 'output.img' as a raw disk to an existing guest. Check the guest can "
6341 "see the files. This test is particularly useful if you try it with a "
6346 #: ../examples/guestfs-testing.pod:223
6347 msgid "Try other partitioning schemes, eg. I<--partition=gpt>."
6351 #: ../examples/guestfs-testing.pod:225
6352 msgid "Try other filesystem formats, eg. I<--type=ntfs>, I<--type=ext2>."
6356 #: ../examples/guestfs-testing.pod:227
6357 msgid "B<*> Run virt-rescue on a B<shut off> disk image or guest."
6361 #: ../examples/guestfs-testing.pod:229
6363 "Use L<virt-rescue(1)> to examine, rescue or repair a B<shut off> guest or "
6368 #: ../examples/guestfs-testing.pod:232
6371 " virt-rescue -a /path/to/disk.img\n"
6376 #: ../examples/guestfs-testing.pod:236
6379 " virt-rescue -d Guest\n"
6384 #: ../examples/guestfs-testing.pod:238
6385 msgid "Can you use ordinary shell commands to examine the guest?"
6389 #: ../examples/guestfs-testing.pod:240
6390 msgid "B<*> Resize your guests."
6394 #: ../examples/guestfs-testing.pod:242
6396 "Use L<virt-resize(1)> to give a guest some more disk space. For example, if "
6397 "you have a disk image that is smaller than 30G, increase it to 30G by doing:"
6401 #: ../examples/guestfs-testing.pod:246
6404 " truncate -s 30G newdisk.img\n"
6405 " virt-filesystems -a /path/to/olddisk.img --all --long -h\n"
6406 " virt-resize /path/to/olddisk.img newdisk.img --expand /dev/sda1\n"
6407 " qemu-kvm -m 1024 -hda newdisk.img\n"
6412 #: ../examples/guestfs-testing.pod:251
6413 msgid "Does the guest still boot? Try expanding other partitions."
6417 #: ../examples/guestfs-testing.pod:253
6418 msgid "B<*> Sparsify a guest disk."
6422 #: ../examples/guestfs-testing.pod:255
6423 msgid "Using L<virt-sparsify(1)>, make a disk image more sparse:"
6427 #: ../examples/guestfs-testing.pod:257
6430 " virt-sparsify /path/to/olddisk.img newdisk.img\n"
6435 #: ../examples/guestfs-testing.pod:259
6437 "Is C<newdisk.img> still bootable after sparsifying? Is the resulting disk "
6438 "image smaller (use C<du> to check)?"
6442 #: ../examples/guestfs-testing.pod:262
6443 msgid "B<*> \"sysprep\" a B<shut off> Linux guest."
6447 #: ../examples/guestfs-testing.pod:264
6449 "Note that this really will mess up an existing guest, so it's better to "
6450 "clone the guest before trying this."
6454 #: ../examples/guestfs-testing.pod:267
6457 " virt-sysprep --hostname newhost.example.com -a /path/to/disk.img\n"
6462 #: ../examples/guestfs-testing.pod:269
6464 "Was the sysprep successful? After booting, what changes were made and were "
6469 #: ../examples/guestfs-testing.pod:272
6470 msgid "Dump the Windows Registry from your Windows guests."
6474 #: ../examples/guestfs-testing.pod:274
6476 "Use L<virt-win-reg(1)> to dump out the Windows Registry from any Windows "
6477 "guests that you have."
6481 #: ../examples/guestfs-testing.pod:277
6484 " virt-win-reg --unsafe-printable-strings WindowsGuest 'HKLM\\Software' |\n"
6490 #: ../examples/guestfs-testing.pod:280
6493 " virt-win-reg --unsafe-printable-strings WindowsGuest 'HKLM\\System' |\n"
6499 #: ../examples/guestfs-testing.pod:283
6500 msgid "Does the output match running C<regedit> inside the guest?"
6504 #: ../examples/guestfs-testing.pod:285
6506 "A recent feature is the ability to dump user registries, so try this, "
6507 "replacing I<username> with the name of a local user in the guest:"
6511 #: ../examples/guestfs-testing.pod:288
6514 " virt-win-reg --unsafe-printable-strings WindowsGuest 'HKEY_USERS\\username' |\n"
6520 #: ../examples/guestfs-testing.pod:293
6522 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<http://libguestfs."
6527 #: ../fish/guestfish-actions.pod:1
6532 #: ../fish/guestfish-actions.pod:3
6535 " add-cdrom filename\n"
6540 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
6541 msgid "This function adds a virtual CD-ROM disk image to the guest."
6545 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
6546 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
6550 #: ../fish/guestfish-actions.pod:15
6552 "This call checks for the existence of C<filename>. This stops you from "
6553 "specifying other types of drive which are supported by qemu such as C<nbd:> "
6554 "and C<http:> URLs. To specify those, use the general L</config> call "
6559 #: ../fish/guestfish-actions.pod:22
6561 "If you just want to add an ISO file (often you use this as an efficient way "
6562 "to transfer large files into the guest), then you should probably use L</add-"
6563 "drive-ro> instead."
6567 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:214
6568 #: ../fish/guestfish-actions.pod:228
6570 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
6575 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:217
6576 #: ../fish/guestfish-actions.pod:231 ../fish/guestfish-actions.pod:941
6577 #: ../fish/guestfish-actions.pod:976 ../fish/guestfish-actions.pod:1149
6578 #: ../fish/guestfish-actions.pod:1509 ../fish/guestfish-actions.pod:1523
6579 #: ../fish/guestfish-actions.pod:3284 ../fish/guestfish-actions.pod:3595
6580 #: ../fish/guestfish-actions.pod:3643 ../fish/guestfish-actions.pod:4561
6581 #: ../fish/guestfish-actions.pod:4581 ../fish/guestfish-actions.pod:4600
6582 #: ../fish/guestfish-actions.pod:4638 ../fish/guestfish-actions.pod:5287
6583 #: ../fish/guestfish-actions.pod:5390 ../src/guestfs-actions.pod:10
6584 #: ../src/guestfs-actions.pod:305 ../src/guestfs-actions.pod:326
6585 #: ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:1637
6586 #: ../src/guestfs-actions.pod:1920 ../src/guestfs-actions.pod:2419
6587 #: ../src/guestfs-actions.pod:2440 ../src/guestfs-actions.pod:5076
6588 #: ../src/guestfs-actions.pod:5598 ../src/guestfs-actions.pod:5698
6589 #: ../src/guestfs-actions.pod:6994 ../src/guestfs-actions.pod:7035
6590 #: ../src/guestfs-actions.pod:7066 ../src/guestfs-actions.pod:7126
6591 #: ../src/guestfs-actions.pod:8058 ../src/guestfs-actions.pod:8167
6592 #: ../src/guestfs-actions.pod:8347
6594 "Deprecated functions will not be removed from the API, but the fact that "
6595 "they are deprecated indicates that there are problems with correct use of "
6600 #: ../fish/guestfish-actions.pod:35
6605 #: ../fish/guestfish-actions.pod:37
6610 #: ../fish/guestfish-actions.pod:39
6613 " add-domain dom [libvirturi:..] [readonly:true|false] [iface:..] [live:true|false] [allowuuid:true|false] [readonlydisk:..]\n"
6618 #: ../fish/guestfish-actions.pod:41
6620 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
6621 "It works by connecting to libvirt, requesting the domain and domain XML from "
6622 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
6626 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:65
6628 "The number of disks added is returned. This operation is atomic: if an "
6629 "error is returned, then no disks are added."
6633 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:68
6635 "This function does some minimal checks to make sure the libvirt domain is "
6636 "not running (unless C<readonly> is true). In a future version we will try "
6637 "to acquire the libvirt lock on each disk."
6641 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:72
6643 "Disks must be accessible locally. This often means that adding disks from a "
6644 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
6645 "unless those disks are accessible via the same device path locally too."
6649 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:77
6651 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
6652 "libvirt.org/uri.html>). If this is not set then we connect to the default "
6653 "libvirt URI (or one set through an environment variable, see the libvirt "
6654 "documentation for full details)."
6658 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:83
6660 "The optional C<live> flag controls whether this call will try to connect to "
6661 "a running virtual machine C<guestfsd> process if it sees a suitable "
6662 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6663 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
6664 "DAEMONS> for more information."
6668 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:90
6670 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6671 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6672 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6677 #: ../fish/guestfish-actions.pod:76 ../src/guestfs-actions.pod:95
6679 "The optional C<readonlydisk> parameter controls what we do for disks which "
6680 "are marked E<lt>readonly/E<gt> in the libvirt XML. Possible values are:"
6684 #: ../fish/guestfish-actions.pod:82 ../src/guestfs-actions.pod:101
6685 msgid "readonlydisk = \"error\""
6689 #: ../fish/guestfish-actions.pod:84 ../fish/guestfish-actions.pod:95
6690 #: ../fish/guestfish-actions.pod:106 ../src/guestfs-actions.pod:103
6691 #: ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:125
6692 msgid "If C<readonly> is false:"
6696 #: ../fish/guestfish-actions.pod:86 ../src/guestfs-actions.pod:105
6698 "The whole call is aborted with an error if any disk with the E<lt>readonly/"
6699 "E<gt> flag is found."
6703 #: ../fish/guestfish-actions.pod:89 ../fish/guestfish-actions.pod:100
6704 #: ../fish/guestfish-actions.pod:110 ../src/guestfs-actions.pod:108
6705 #: ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:129
6706 msgid "If C<readonly> is true:"
6710 #: ../fish/guestfish-actions.pod:91 ../fish/guestfish-actions.pod:102
6711 #: ../fish/guestfish-actions.pod:112 ../src/guestfs-actions.pod:110
6712 #: ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:131
6713 msgid "Disks with the E<lt>readonly/E<gt> flag are added read-only."
6717 #: ../fish/guestfish-actions.pod:93 ../src/guestfs-actions.pod:112
6718 msgid "readonlydisk = \"read\""
6722 #: ../fish/guestfish-actions.pod:97 ../src/guestfs-actions.pod:116
6724 "Disks with the E<lt>readonly/E<gt> flag are added read-only. Other disks "
6725 "are added read/write."
6729 #: ../fish/guestfish-actions.pod:104 ../src/guestfs-actions.pod:123
6730 msgid "readonlydisk = \"write\" (default)"
6734 #: ../fish/guestfish-actions.pod:108 ../src/guestfs-actions.pod:127
6735 msgid "Disks with the E<lt>readonly/E<gt> flag are added read/write."
6739 #: ../fish/guestfish-actions.pod:114 ../src/guestfs-actions.pod:133
6740 msgid "readonlydisk = \"ignore\""
6744 #: ../fish/guestfish-actions.pod:116 ../src/guestfs-actions.pod:135
6745 msgid "If C<readonly> is true or false:"
6749 #: ../fish/guestfish-actions.pod:118 ../src/guestfs-actions.pod:137
6750 msgid "Disks with the E<lt>readonly/E<gt> flag are skipped."
6754 #: ../fish/guestfish-actions.pod:122
6756 "The other optional parameters are passed directly through to L</add-drive-"
6761 #: ../fish/guestfish-actions.pod:125 ../fish/guestfish-actions.pod:194
6762 #: ../fish/guestfish-actions.pod:624 ../fish/guestfish-actions.pod:835
6763 #: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:894
6764 #: ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:912
6765 #: ../fish/guestfish-actions.pod:926 ../fish/guestfish-actions.pod:2171
6766 #: ../fish/guestfish-actions.pod:3333 ../fish/guestfish-actions.pod:3496
6767 #: ../fish/guestfish-actions.pod:3631
6769 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
6773 #: ../fish/guestfish-actions.pod:127
6778 #: ../fish/guestfish-actions.pod:129
6781 " add-drive filename\n"
6786 #: ../fish/guestfish-actions.pod:131
6788 "This function is the equivalent of calling L</add-drive-opts> with no "
6789 "optional parameters, so the disk is added writable, with the format being "
6790 "detected automatically."
6794 #: ../fish/guestfish-actions.pod:135
6796 "Automatic detection of the format opens you up to a potential security hole "
6797 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6798 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6799 "you should think about replacing calls to this function with calls to L</add-"
6800 "drive-opts>, and specifying the format."
6804 #: ../fish/guestfish-actions.pod:142
6805 msgid "add-drive-opts"
6809 #: ../fish/guestfish-actions.pod:144
6814 #: ../fish/guestfish-actions.pod:146
6817 " add-drive-opts filename [readonly:true|false] [format:..] [iface:..] [name:..]\n"
6822 #: ../fish/guestfish-actions.pod:148 ../src/guestfs-actions.pod:208
6824 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6825 "The first time you call this function, the disk appears as C</dev/sda>, the "
6826 "second time as C</dev/sdb>, and so on."
6830 #: ../fish/guestfish-actions.pod:153 ../src/guestfs-actions.pod:213
6832 "You don't necessarily need to be root when using libguestfs. However you "
6833 "obviously do need sufficient permissions to access the filename for whatever "
6834 "operations you want to perform (ie. read access if you just want to read the "
6835 "image or write access if you want to modify the image)."
6839 #: ../fish/guestfish-actions.pod:159 ../src/guestfs-actions.pod:219
6840 msgid "This call checks that C<filename> exists."
6844 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:3295
6845 #: ../src/guestfs-actions.pod:221 ../src/guestfs-actions.pod:5113
6846 msgid "The optional arguments are:"
6850 #: ../fish/guestfish-actions.pod:165 ../src/guestfs-actions.pod:225
6855 #: ../fish/guestfish-actions.pod:167 ../src/guestfs-actions.pod:227
6857 "If true then the image is treated as read-only. Writes are still allowed, "
6858 "but they are stored in a temporary snapshot overlay which is discarded at "
6859 "the end. The disk that you add is not modified."
6863 #: ../fish/guestfish-actions.pod:171 ../src/guestfs-actions.pod:231
6868 #: ../fish/guestfish-actions.pod:173
6870 "This forces the image format. If you omit this (or use L</add-drive> or L</"
6871 "add-drive-ro>) then the format is automatically detected. Possible formats "
6872 "include C<raw> and C<qcow2>."
6876 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:237
6878 "Automatic detection of the format opens you up to a potential security hole "
6879 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6880 "RHBZ#642934. Specifying the format closes this security hole."
6884 #: ../fish/guestfish-actions.pod:182 ../src/guestfs-actions.pod:242
6889 #: ../fish/guestfish-actions.pod:184
6891 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
6892 "add-drive-with-if> call (q.v.)"
6896 #: ../fish/guestfish-actions.pod:187 ../src/guestfs-actions.pod:247
6901 #: ../fish/guestfish-actions.pod:189 ../src/guestfs-actions.pod:249
6903 "The name the drive had in the original guest, e.g. /dev/sdb. This is used as "
6904 "a hint to the guest inspection process if it is available."
6908 #: ../fish/guestfish-actions.pod:196
6909 msgid "add-drive-ro"
6913 #: ../fish/guestfish-actions.pod:198
6918 #: ../fish/guestfish-actions.pod:200
6921 " add-drive-ro filename\n"
6926 #: ../fish/guestfish-actions.pod:202
6928 "This function is the equivalent of calling L</add-drive-opts> with the "
6929 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
6930 "is added read-only, with the format being detected automatically."
6934 #: ../fish/guestfish-actions.pod:207
6935 msgid "add-drive-ro-with-if"
6939 #: ../fish/guestfish-actions.pod:209
6942 " add-drive-ro-with-if filename iface\n"
6947 #: ../fish/guestfish-actions.pod:211
6949 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
6950 "interface emulation to use at run time."
6954 #: ../fish/guestfish-actions.pod:221
6955 msgid "add-drive-with-if"
6959 #: ../fish/guestfish-actions.pod:223
6962 " add-drive-with-if filename iface\n"
6967 #: ../fish/guestfish-actions.pod:225
6969 "This is the same as L</add-drive> but it allows you to specify the QEMU "
6970 "interface emulation to use at run time."
6974 #: ../fish/guestfish-actions.pod:235
6979 #: ../fish/guestfish-actions.pod:237
6982 " aug-clear augpath\n"
6987 #: ../fish/guestfish-actions.pod:239 ../src/guestfs-actions.pod:343
6989 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6990 "L<augtool(1)> C<clear> command."
6994 #: ../fish/guestfish-actions.pod:242
6999 #: ../fish/guestfish-actions.pod:244
7007 #: ../fish/guestfish-actions.pod:246
7009 "Close the current Augeas handle and free up any resources used by it. After "
7010 "calling this, you have to call L</aug-init> again before you can use any "
7011 "other Augeas functions."
7015 #: ../fish/guestfish-actions.pod:251
7020 #: ../fish/guestfish-actions.pod:253
7023 " aug-defnode name expr val\n"
7028 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:372
7030 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7034 #: ../fish/guestfish-actions.pod:258
7036 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7037 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
7038 "containing that single node."
7042 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:379
7044 "On success this returns a pair containing the number of nodes in the "
7045 "nodeset, and a boolean flag if a node was created."
7049 #: ../fish/guestfish-actions.pod:266
7054 #: ../fish/guestfish-actions.pod:268
7057 " aug-defvar name expr\n"
7062 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:396
7064 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7065 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7069 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:400
7071 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7072 "evaluates to something which is not a nodeset."
7076 #: ../fish/guestfish-actions.pod:277
7081 #: ../fish/guestfish-actions.pod:279
7084 " aug-get augpath\n"
7089 #: ../fish/guestfish-actions.pod:281 ../src/guestfs-actions.pod:413
7091 "Look up the value associated with C<path>. If C<path> matches exactly one "
7092 "node, the C<value> is returned."
7096 #: ../fish/guestfish-actions.pod:284
7101 #: ../fish/guestfish-actions.pod:286
7104 " aug-init root flags\n"
7109 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:428
7111 "Create a new Augeas handle for editing configuration files. If there was "
7112 "any previous Augeas handle associated with this guestfs session, then it is "
7117 #: ../fish/guestfish-actions.pod:292
7118 msgid "You must call this before using any other L</aug-*> commands."
7122 #: ../fish/guestfish-actions.pod:295 ../src/guestfs-actions.pod:435
7124 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7128 #: ../fish/guestfish-actions.pod:298 ../src/guestfs-actions.pod:438
7130 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7131 "logical I<or> of the following integers:"
7135 #: ../fish/guestfish-actions.pod:304 ../src/guestfs-actions.pod:444
7136 msgid "C<AUG_SAVE_BACKUP> = 1"
7140 #: ../fish/guestfish-actions.pod:306 ../src/guestfs-actions.pod:446
7141 msgid "Keep the original file with a C<.augsave> extension."
7145 #: ../fish/guestfish-actions.pod:308 ../src/guestfs-actions.pod:448
7146 msgid "C<AUG_SAVE_NEWFILE> = 2"
7150 #: ../fish/guestfish-actions.pod:310 ../src/guestfs-actions.pod:450
7152 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7153 "original. Overrides C<AUG_SAVE_BACKUP>."
7157 #: ../fish/guestfish-actions.pod:313 ../src/guestfs-actions.pod:453
7158 msgid "C<AUG_TYPE_CHECK> = 4"
7162 #: ../fish/guestfish-actions.pod:315 ../src/guestfs-actions.pod:455
7163 msgid "Typecheck lenses."
7167 #: ../fish/guestfish-actions.pod:317
7169 "This option is only useful when debugging Augeas lenses. Use of this option "
7170 "may require additional memory for the libguestfs appliance. You may need to "
7171 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
7175 #: ../fish/guestfish-actions.pod:322 ../src/guestfs-actions.pod:462
7176 msgid "C<AUG_NO_STDINC> = 8"
7180 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:464
7181 msgid "Do not use standard load path for modules."
7185 #: ../fish/guestfish-actions.pod:326 ../src/guestfs-actions.pod:466
7186 msgid "C<AUG_SAVE_NOOP> = 16"
7190 #: ../fish/guestfish-actions.pod:328 ../src/guestfs-actions.pod:468
7191 msgid "Make save a no-op, just record what would have been changed."
7195 #: ../fish/guestfish-actions.pod:330 ../src/guestfs-actions.pod:470
7196 msgid "C<AUG_NO_LOAD> = 32"
7200 #: ../fish/guestfish-actions.pod:332
7201 msgid "Do not load the tree in L</aug-init>."
7205 #: ../fish/guestfish-actions.pod:336
7206 msgid "To close the handle, you can call L</aug-close>."
7210 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:478
7211 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7215 #: ../fish/guestfish-actions.pod:340
7220 #: ../fish/guestfish-actions.pod:342
7223 " aug-insert augpath label true|false\n"
7228 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:492
7230 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7231 "or after C<path> (depending on the boolean flag C<before>)."
7235 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:496
7237 "C<path> must match exactly one existing node in the tree, and C<label> must "
7238 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7242 #: ../fish/guestfish-actions.pod:352
7247 #: ../fish/guestfish-actions.pod:354
7255 #: ../fish/guestfish-actions.pod:356 ../src/guestfs-actions.pod:509
7256 msgid "Load files into the tree."
7260 #: ../fish/guestfish-actions.pod:358 ../src/guestfs-actions.pod:511
7261 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7265 #: ../fish/guestfish-actions.pod:361
7270 #: ../fish/guestfish-actions.pod:363
7278 #: ../fish/guestfish-actions.pod:365
7280 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
7281 "resulting nodes into alphabetical order."
7285 #: ../fish/guestfish-actions.pod:368
7290 #: ../fish/guestfish-actions.pod:370
7293 " aug-match augpath\n"
7298 #: ../fish/guestfish-actions.pod:372 ../src/guestfs-actions.pod:539
7300 "Returns a list of paths which match the path expression C<path>. The "
7301 "returned paths are sufficiently qualified so that they match exactly one "
7302 "node in the current tree."
7306 #: ../fish/guestfish-actions.pod:376
7311 #: ../fish/guestfish-actions.pod:378
7314 " aug-mv src dest\n"
7319 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:556
7321 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7322 "C<dest> is overwritten if it exists."
7326 #: ../fish/guestfish-actions.pod:383
7331 #: ../fish/guestfish-actions.pod:385
7339 #: ../fish/guestfish-actions.pod:387 ../src/guestfs-actions.pod:569
7340 msgid "Remove C<path> and all of its children."
7344 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:571
7345 msgid "On success this returns the number of entries which were removed."
7349 #: ../fish/guestfish-actions.pod:391
7354 #: ../fish/guestfish-actions.pod:393
7362 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:582
7363 msgid "This writes all pending changes to disk."
7367 #: ../fish/guestfish-actions.pod:397
7369 "The flags which were passed to L</aug-init> affect exactly how files are "
7374 #: ../fish/guestfish-actions.pod:400
7379 #: ../fish/guestfish-actions.pod:402
7382 " aug-set augpath val\n"
7387 #: ../fish/guestfish-actions.pod:404 ../src/guestfs-actions.pod:598
7388 msgid "Set the value associated with C<path> to C<val>."
7392 #: ../fish/guestfish-actions.pod:406
7394 "In the Augeas API, it is possible to clear a node by setting the value to "
7395 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7396 "this call. Instead you must use the L</aug-clear> call."
7400 #: ../fish/guestfish-actions.pod:411
7405 #: ../fish/guestfish-actions.pod:413
7408 " available 'groups ...'\n"
7413 #: ../fish/guestfish-actions.pod:415 ../src/guestfs-actions.pod:615
7415 "This command is used to check the availability of some groups of "
7416 "functionality in the appliance, which not all builds of the libguestfs "
7417 "appliance will be able to provide."
7421 #: ../fish/guestfish-actions.pod:419
7423 "The libguestfs groups, and the functions that those groups correspond to, "
7424 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7425 "runtime by calling L</available-all-groups>."
7429 #: ../fish/guestfish-actions.pod:424 ../src/guestfs-actions.pod:624
7431 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7432 "\"]> would check for the availability of the Linux inotify functions and "
7433 "Augeas (configuration file editing) functions."
7437 #: ../fish/guestfish-actions.pod:429 ../src/guestfs-actions.pod:629
7438 msgid "The command returns no error if I<all> requested groups are available."
7442 #: ../fish/guestfish-actions.pod:431 ../src/guestfs-actions.pod:631
7444 "It fails with an error if one or more of the requested groups is unavailable "
7449 #: ../fish/guestfish-actions.pod:434 ../src/guestfs-actions.pod:634
7451 "If an unknown group name is included in the list of groups then an error is "
7456 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:637
7461 #: ../fish/guestfish-actions.pod:443
7462 msgid "You must call L</launch> before calling this function."
7466 #: ../fish/guestfish-actions.pod:445 ../src/guestfs-actions.pod:645
7468 "The reason is because we don't know what groups are supported by the "
7469 "appliance/daemon until it is running and can be queried."
7473 #: ../fish/guestfish-actions.pod:451 ../src/guestfs-actions.pod:651
7475 "If a group of functions is available, this does not necessarily mean that "
7476 "they will work. You still have to check for errors when calling individual "
7477 "API functions even if they are available."
7481 #: ../fish/guestfish-actions.pod:458 ../src/guestfs-actions.pod:658
7483 "It is usually the job of distro packagers to build complete functionality "
7484 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7485 "with all requirements satisfied, will support everything."
7489 #: ../fish/guestfish-actions.pod:465
7491 "This call was added in version C<1.0.80>. In previous versions of "
7492 "libguestfs all you could do would be to speculatively execute a command to "
7493 "find out if the daemon implemented it. See also L</version>."
7497 #: ../fish/guestfish-actions.pod:472
7498 msgid "available-all-groups"
7502 #: ../fish/guestfish-actions.pod:474
7505 " available-all-groups\n"
7510 #: ../fish/guestfish-actions.pod:476
7512 "This command returns a list of all optional groups that this daemon knows "
7513 "about. Note this returns both supported and unsupported groups. To find "
7514 "out which ones the daemon can actually support you have to call L</"
7515 "available> on each member of the returned list."
7519 #: ../fish/guestfish-actions.pod:482
7520 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
7524 #: ../fish/guestfish-actions.pod:484
7529 #: ../fish/guestfish-actions.pod:486
7532 " base64-in (base64file|-) filename\n"
7537 #: ../fish/guestfish-actions.pod:488 ../src/guestfs-actions.pod:702
7539 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7543 #: ../fish/guestfish-actions.pod:491 ../fish/guestfish-actions.pod:500
7544 #: ../fish/guestfish-actions.pod:749 ../fish/guestfish-actions.pod:833
7545 #: ../fish/guestfish-actions.pod:854 ../fish/guestfish-actions.pod:1025
7546 #: ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1418
7547 #: ../fish/guestfish-actions.pod:4858 ../fish/guestfish-actions.pod:4870
7548 #: ../fish/guestfish-actions.pod:4881 ../fish/guestfish-actions.pod:4892
7549 #: ../fish/guestfish-actions.pod:4944 ../fish/guestfish-actions.pod:4953
7550 #: ../fish/guestfish-actions.pod:5007 ../fish/guestfish-actions.pod:5030
7551 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
7555 #: ../fish/guestfish-actions.pod:493
7560 #: ../fish/guestfish-actions.pod:495
7563 " base64-out filename (base64file|-)\n"
7568 #: ../fish/guestfish-actions.pod:497 ../src/guestfs-actions.pod:716
7570 "This command downloads the contents of C<filename>, writing it out to local "
7571 "file C<base64file> encoded as base64."
7575 #: ../fish/guestfish-actions.pod:502
7576 msgid "blockdev-flushbufs"
7580 #: ../fish/guestfish-actions.pod:504
7583 " blockdev-flushbufs device\n"
7588 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:729
7590 "This tells the kernel to flush internal buffers associated with C<device>."
7594 #: ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520
7595 #: ../fish/guestfish-actions.pod:529 ../fish/guestfish-actions.pod:539
7596 #: ../fish/guestfish-actions.pod:551 ../fish/guestfish-actions.pod:564
7597 #: ../fish/guestfish-actions.pod:572 ../fish/guestfish-actions.pod:583
7598 #: ../fish/guestfish-actions.pod:591 ../fish/guestfish-actions.pod:599
7599 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:749
7600 #: ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:780
7601 #: ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:817
7602 #: ../src/guestfs-actions.pod:831 ../src/guestfs-actions.pod:849
7603 #: ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:877
7604 msgid "This uses the L<blockdev(8)> command."
7608 #: ../fish/guestfish-actions.pod:511
7609 msgid "blockdev-getbsz"
7613 #: ../fish/guestfish-actions.pod:513
7616 " blockdev-getbsz device\n"
7621 #: ../fish/guestfish-actions.pod:515 ../src/guestfs-actions.pod:744
7622 msgid "This returns the block size of a device."
7626 #: ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:580
7627 #: ../src/guestfs-actions.pod:746 ../src/guestfs-actions.pod:846
7629 "(Note this is different from both I<size in blocks> and I<filesystem block "
7634 #: ../fish/guestfish-actions.pod:522
7635 msgid "blockdev-getro"
7639 #: ../fish/guestfish-actions.pod:524
7642 " blockdev-getro device\n"
7647 #: ../fish/guestfish-actions.pod:526 ../src/guestfs-actions.pod:761
7649 "Returns a boolean indicating if the block device is read-only (true if read-"
7650 "only, false if not)."
7654 #: ../fish/guestfish-actions.pod:531
7655 msgid "blockdev-getsize64"
7659 #: ../fish/guestfish-actions.pod:533
7662 " blockdev-getsize64 device\n"
7667 #: ../fish/guestfish-actions.pod:535 ../src/guestfs-actions.pod:776
7668 msgid "This returns the size of the device in bytes."
7672 #: ../fish/guestfish-actions.pod:537
7673 msgid "See also L</blockdev-getsz>."
7677 #: ../fish/guestfish-actions.pod:541
7678 msgid "blockdev-getss"
7682 #: ../fish/guestfish-actions.pod:543
7685 " blockdev-getss device\n"
7690 #: ../fish/guestfish-actions.pod:545 ../src/guestfs-actions.pod:792
7692 "This returns the size of sectors on a block device. Usually 512, but can be "
7693 "larger for modern devices."
7697 #: ../fish/guestfish-actions.pod:548
7699 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
7703 #: ../fish/guestfish-actions.pod:553
7704 msgid "blockdev-getsz"
7708 #: ../fish/guestfish-actions.pod:555
7711 " blockdev-getsz device\n"
7716 #: ../fish/guestfish-actions.pod:557 ../src/guestfs-actions.pod:810
7718 "This returns the size of the device in units of 512-byte sectors (even if "
7719 "the sectorsize isn't 512 bytes ... weird)."
7723 #: ../fish/guestfish-actions.pod:560
7725 "See also L</blockdev-getss> for the real sector size of the device, and L</"
7726 "blockdev-getsize64> for the more useful I<size in bytes>."
7730 #: ../fish/guestfish-actions.pod:566
7731 msgid "blockdev-rereadpt"
7735 #: ../fish/guestfish-actions.pod:568
7738 " blockdev-rereadpt device\n"
7743 #: ../fish/guestfish-actions.pod:570 ../src/guestfs-actions.pod:829
7744 msgid "Reread the partition table on C<device>."
7748 #: ../fish/guestfish-actions.pod:574
7749 msgid "blockdev-setbsz"
7753 #: ../fish/guestfish-actions.pod:576
7756 " blockdev-setbsz device blocksize\n"
7761 #: ../fish/guestfish-actions.pod:578 ../src/guestfs-actions.pod:844
7762 msgid "This sets the block size of a device."
7766 #: ../fish/guestfish-actions.pod:585
7767 msgid "blockdev-setro"
7771 #: ../fish/guestfish-actions.pod:587
7774 " blockdev-setro device\n"
7779 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:861
7780 msgid "Sets the block device named C<device> to read-only."
7784 #: ../fish/guestfish-actions.pod:593
7785 msgid "blockdev-setrw"
7789 #: ../fish/guestfish-actions.pod:595
7792 " blockdev-setrw device\n"
7797 #: ../fish/guestfish-actions.pod:597 ../src/guestfs-actions.pod:875
7798 msgid "Sets the block device named C<device> to read-write."
7802 #: ../fish/guestfish-actions.pod:601
7803 msgid "btrfs-filesystem-resize"
7807 #: ../fish/guestfish-actions.pod:603
7810 " btrfs-filesystem-resize mountpoint [size:N]\n"
7815 #: ../fish/guestfish-actions.pod:605 ../src/guestfs-actions.pod:897
7816 msgid "This command resizes a btrfs filesystem."
7820 #: ../fish/guestfish-actions.pod:607 ../src/guestfs-actions.pod:899
7822 "Note that unlike other resize calls, the filesystem has to be mounted and "
7823 "the parameter is the mountpoint not the device (this is a requirement of "
7828 #: ../fish/guestfish-actions.pod:611 ../fish/guestfish-actions.pod:3606
7829 #: ../src/guestfs-actions.pod:903 ../src/guestfs-actions.pod:5637
7830 msgid "The optional parameters are:"
7834 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3610
7835 #: ../src/guestfs-actions.pod:907 ../src/guestfs-actions.pod:5641
7840 #: ../fish/guestfish-actions.pod:617 ../src/guestfs-actions.pod:909
7842 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7843 "resized to the maximum size."
7847 #: ../fish/guestfish-actions.pod:622 ../src/guestfs-actions.pod:914
7848 msgid "See also L<btrfs(8)>."
7852 #: ../fish/guestfish-actions.pod:626
7853 msgid "case-sensitive-path"
7857 #: ../fish/guestfish-actions.pod:628
7860 " case-sensitive-path path\n"
7865 #: ../fish/guestfish-actions.pod:630 ../src/guestfs-actions.pod:948
7867 "This can be used to resolve case insensitive paths on a filesystem which is "
7868 "case sensitive. The use case is to resolve paths which you have read from "
7869 "Windows configuration files or the Windows Registry, to the true path."
7873 #: ../fish/guestfish-actions.pod:635 ../src/guestfs-actions.pod:953
7875 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7876 "(and probably others), which is that although the underlying filesystem is "
7877 "case-insensitive, the driver exports the filesystem to Linux as case-"
7882 #: ../fish/guestfish-actions.pod:640 ../src/guestfs-actions.pod:958
7884 "One consequence of this is that special directories such as C<c:\\windows> "
7885 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7886 "precise details of how they were created. In Windows itself this would not "
7891 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:964
7893 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7898 #: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:967
7900 "This function resolves the true case of each element in the path and returns "
7901 "the case-sensitive path."
7905 #: ../fish/guestfish-actions.pod:652
7907 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
7908 "WINDOWS/system32\"> (the exact return value would depend on details of how "
7909 "the directories were originally created under Windows)."
7913 #: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:975
7914 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7918 #: ../fish/guestfish-actions.pod:660
7919 msgid "See also L</realpath>."
7923 #: ../fish/guestfish-actions.pod:662
7928 #: ../fish/guestfish-actions.pod:664
7936 #: ../fish/guestfish-actions.pod:666 ../fish/guestfish-actions.pod:4037
7937 #: ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:6297
7938 msgid "Return the contents of the file named C<path>."
7942 #: ../fish/guestfish-actions.pod:668
7944 "Note that this function cannot correctly handle binary files (specifically, "
7945 "files containing C<\\0> character which is treated as end of string). For "
7946 "those you need to use the L</read-file> or L</download> functions which have "
7947 "a more complex interface."
7951 #: ../fish/guestfish-actions.pod:673 ../fish/guestfish-actions.pod:808
7952 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:1103
7953 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1180
7954 #: ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1382
7955 #: ../fish/guestfish-actions.pod:1695 ../fish/guestfish-actions.pod:1705
7956 #: ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1770
7957 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1799
7958 #: ../fish/guestfish-actions.pod:3907 ../fish/guestfish-actions.pod:3922
7959 #: ../fish/guestfish-actions.pod:3998 ../fish/guestfish-actions.pod:4015
7960 #: ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4699
7961 #: ../fish/guestfish-actions.pod:4745 ../fish/guestfish-actions.pod:4830
7962 #: ../fish/guestfish-actions.pod:4845 ../fish/guestfish-actions.pod:5251
7963 #: ../fish/guestfish-actions.pod:5263 ../fish/guestfish-actions.pod:5281
7964 #: ../fish/guestfish-actions.pod:5298 ../fish/guestfish-actions.pod:5308
7965 #: ../fish/guestfish-actions.pod:5362 ../fish/guestfish-actions.pod:5372
7966 #: ../fish/guestfish-actions.pod:5401 ../fish/guestfish-actions.pod:5411
7967 #: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1180
7968 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1855
7969 #: ../src/guestfs-actions.pod:1874 ../src/guestfs-actions.pod:1977
7970 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:2242
7971 #: ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2743
7972 #: ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2832
7973 #: ../src/guestfs-actions.pod:2849 ../src/guestfs-actions.pod:2878
7974 #: ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6105
7975 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6262
7976 #: ../src/guestfs-actions.pod:6286 ../src/guestfs-actions.pod:7241
7977 #: ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7442
7978 #: ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:8131
7979 #: ../src/guestfs-actions.pod:8151 ../src/guestfs-actions.pod:8184
7980 #: ../src/guestfs-actions.pod:8203 ../src/guestfs-actions.pod:8222
7981 #: ../src/guestfs-actions.pod:8313 ../src/guestfs-actions.pod:8332
7982 #: ../src/guestfs-actions.pod:8378 ../src/guestfs-actions.pod:8397
7984 "Because of the message protocol, there is a transfer limit of somewhere "
7985 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7989 #: ../fish/guestfish-actions.pod:676
7994 #: ../fish/guestfish-actions.pod:678
7997 " checksum csumtype path\n"
8002 #: ../fish/guestfish-actions.pod:680 ../src/guestfs-actions.pod:1013
8004 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8008 #: ../fish/guestfish-actions.pod:683 ../src/guestfs-actions.pod:1016
8010 "The type of checksum to compute is given by the C<csumtype> parameter which "
8011 "must have one of the following values:"
8015 #: ../fish/guestfish-actions.pod:688 ../src/guestfs-actions.pod:1021
8020 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1023
8022 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8027 #: ../fish/guestfish-actions.pod:693 ../src/guestfs-actions.pod:1026
8032 #: ../fish/guestfish-actions.pod:695 ../src/guestfs-actions.pod:1028
8033 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8037 #: ../fish/guestfish-actions.pod:697 ../src/guestfs-actions.pod:1030
8042 #: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1032
8043 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8047 #: ../fish/guestfish-actions.pod:701 ../src/guestfs-actions.pod:1034
8052 #: ../fish/guestfish-actions.pod:703 ../src/guestfs-actions.pod:1036
8053 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8057 #: ../fish/guestfish-actions.pod:705 ../src/guestfs-actions.pod:1038
8062 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1040
8063 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8067 #: ../fish/guestfish-actions.pod:709 ../src/guestfs-actions.pod:1042
8072 #: ../fish/guestfish-actions.pod:711 ../src/guestfs-actions.pod:1044
8073 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8077 #: ../fish/guestfish-actions.pod:713 ../src/guestfs-actions.pod:1046
8082 #: ../fish/guestfish-actions.pod:715 ../src/guestfs-actions.pod:1048
8083 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8087 #: ../fish/guestfish-actions.pod:719 ../src/guestfs-actions.pod:1052
8088 msgid "The checksum is returned as a printable string."
8092 #: ../fish/guestfish-actions.pod:721
8093 msgid "To get the checksum for a device, use L</checksum-device>."
8097 #: ../fish/guestfish-actions.pod:723
8098 msgid "To get the checksums for many files, use L</checksums-out>."
8102 #: ../fish/guestfish-actions.pod:725
8103 msgid "checksum-device"
8107 #: ../fish/guestfish-actions.pod:727
8110 " checksum-device csumtype device\n"
8115 #: ../fish/guestfish-actions.pod:729
8117 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8118 "device named C<device>. For the types of checksums supported see the L</"
8119 "checksum> command."
8123 #: ../fish/guestfish-actions.pod:733
8124 msgid "checksums-out"
8128 #: ../fish/guestfish-actions.pod:735
8131 " checksums-out csumtype directory (sumsfile|-)\n"
8136 #: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1087
8138 "This command computes the checksums of all regular files in C<directory> and "
8139 "then emits a list of those checksums to the local output file C<sumsfile>."
8143 #: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1091
8145 "This can be used for verifying the integrity of a virtual machine. However "
8146 "to be properly secure you should pay attention to the output of the checksum "
8147 "command (it uses the ones from GNU coreutils). In particular when the "
8148 "filename is not printable, coreutils uses a special backslash syntax. For "
8149 "more information, see the GNU coreutils info file."
8153 #: ../fish/guestfish-actions.pod:751
8158 #: ../fish/guestfish-actions.pod:753
8161 " chmod mode path\n"
8166 #: ../fish/guestfish-actions.pod:755 ../src/guestfs-actions.pod:1110
8168 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8173 #: ../fish/guestfish-actions.pod:758 ../src/guestfs-actions.pod:1113
8175 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8176 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8181 #: ../fish/guestfish-actions.pod:762 ../fish/guestfish-actions.pod:3259
8182 #: ../fish/guestfish-actions.pod:3398 ../fish/guestfish-actions.pod:3408
8183 #: ../fish/guestfish-actions.pod:3418 ../src/guestfs-actions.pod:1117
8184 #: ../src/guestfs-actions.pod:5044 ../src/guestfs-actions.pod:5253
8185 #: ../src/guestfs-actions.pod:5272 ../src/guestfs-actions.pod:5291
8186 msgid "The mode actually set is affected by the umask."
8190 #: ../fish/guestfish-actions.pod:764
8195 #: ../fish/guestfish-actions.pod:766
8198 " chown owner group path\n"
8203 #: ../fish/guestfish-actions.pod:768 ../src/guestfs-actions.pod:1131
8204 msgid "Change the file owner to C<owner> and group to C<group>."
8208 #: ../fish/guestfish-actions.pod:770 ../fish/guestfish-actions.pod:2703
8209 #: ../src/guestfs-actions.pod:1133 ../src/guestfs-actions.pod:4124
8211 "Only numeric uid and gid are supported. If you want to use names, you will "
8212 "need to locate and parse the password file yourself (Augeas support makes "
8213 "this relatively easy)."
8217 #: ../fish/guestfish-actions.pod:774
8222 #: ../fish/guestfish-actions.pod:776
8225 " command 'arguments ...'\n"
8230 #: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1147
8232 "This call runs a command from the guest filesystem. The filesystem must be "
8233 "mounted, and must contain a compatible operating system (ie. something "
8234 "Linux, with the same or compatible processor architecture)."
8238 #: ../fish/guestfish-actions.pod:783
8240 "The single parameter is an argv-style list of arguments. The first element "
8241 "is the name of the program to run. Subsequent elements are parameters. The "
8242 "list must be non-empty (ie. must contain a program name). Note that the "
8243 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
8247 #: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1159
8248 msgid "The return value is anything printed to I<stdout> by the command."
8252 #: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1162
8254 "If the command returns a non-zero exit status, then this function returns an "
8255 "error message. The error message string is the content of I<stderr> from "
8260 #: ../fish/guestfish-actions.pod:797 ../src/guestfs-actions.pod:1166
8262 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8263 "bin>. If you require a program from another location, you should provide "
8264 "the full path in the first parameter."
8268 #: ../fish/guestfish-actions.pod:802 ../src/guestfs-actions.pod:1171
8270 "Shared libraries and data files required by the program must be available on "
8271 "filesystems which are mounted in the correct places. It is the caller's "
8272 "responsibility to ensure all filesystems that are needed are mounted at the "
8277 #: ../fish/guestfish-actions.pod:811
8278 msgid "command-lines"
8282 #: ../fish/guestfish-actions.pod:813
8285 " command-lines 'arguments ...'\n"
8290 #: ../fish/guestfish-actions.pod:815
8292 "This is the same as L</command>, but splits the result into a list of lines."
8296 #: ../fish/guestfish-actions.pod:818
8297 msgid "See also: L</sh-lines>"
8301 #: ../fish/guestfish-actions.pod:823
8302 msgid "compress-device-out"
8306 #: ../fish/guestfish-actions.pod:825
8309 " compress-device-out ctype device (zdevice|-) [level:N]\n"
8314 #: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1221
8316 "This command compresses C<device> and writes it out to the local file "
8321 #: ../fish/guestfish-actions.pod:830
8323 "The C<ctype> and optional C<level> parameters have the same meaning as in L</"
8328 #: ../fish/guestfish-actions.pod:837
8329 msgid "compress-out"
8333 #: ../fish/guestfish-actions.pod:839
8336 " compress-out ctype file (zfile|-) [level:N]\n"
8341 #: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1273
8343 "This command compresses C<file> and writes it out to the local file C<zfile>."
8347 #: ../fish/guestfish-actions.pod:844 ../src/guestfs-actions.pod:1276
8349 "The compression program used is controlled by the C<ctype> parameter. "
8350 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>. "
8351 "Some compression types may not be supported by particular builds of "
8352 "libguestfs, in which case you will get an error containing the substring "
8353 "\"not supported\"."
8357 #: ../fish/guestfish-actions.pod:850 ../src/guestfs-actions.pod:1282
8359 "The optional C<level> parameter controls compression level. The meaning and "
8360 "default for this parameter depends on the compression program being used."
8364 #: ../fish/guestfish-actions.pod:858
8369 #: ../fish/guestfish-actions.pod:860
8372 " config qemuparam qemuvalue\n"
8377 #: ../fish/guestfish-actions.pod:862 ../src/guestfs-actions.pod:1323
8379 "This can be used to add arbitrary qemu command line parameters of the form "
8380 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8381 "setting some parameters which would interfere with parameters that we use."
8385 #: ../fish/guestfish-actions.pod:867 ../src/guestfs-actions.pod:1328
8386 msgid "The first character of C<param> string must be a C<-> (dash)."
8390 #: ../fish/guestfish-actions.pod:869 ../src/guestfs-actions.pod:1330
8391 msgid "C<value> can be NULL."
8395 #: ../fish/guestfish-actions.pod:871
8396 msgid "copy-device-to-device"
8400 #: ../fish/guestfish-actions.pod:873
8403 " copy-device-to-device src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8408 #: ../fish/guestfish-actions.pod:875
8410 "The four calls L</copy-device-to-device>, L</copy-device-to-file>, L</copy-"
8411 "file-to-device>, and L</copy-file-to-file> let you copy from a source "
8412 "(device|file) to a destination (device|file)."
8416 #: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1360
8418 "Partial copies can be made since you can specify optionally the source "
8419 "offset, destination offset and size to copy. These values are all specified "
8420 "in bytes. If not given, the offsets both default to zero, and the size "
8421 "defaults to copying as much as possible until we hit the end of the source."
8425 #: ../fish/guestfish-actions.pod:888 ../src/guestfs-actions.pod:1366
8427 "The source and destination may be the same object. However overlapping "
8428 "regions may not be copied correctly."
8432 #: ../fish/guestfish-actions.pod:891 ../src/guestfs-actions.pod:1369
8434 "If the destination is a file, it is created if required. If the destination "
8435 "file is not large enough, it is extended."
8439 #: ../fish/guestfish-actions.pod:896
8440 msgid "copy-device-to-file"
8444 #: ../fish/guestfish-actions.pod:898
8447 " copy-device-to-file src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8452 #: ../fish/guestfish-actions.pod:900 ../fish/guestfish-actions.pod:909
8453 #: ../fish/guestfish-actions.pod:918
8454 msgid "See L</copy-device-to-device> for a general overview of this call."
8458 #: ../fish/guestfish-actions.pod:905
8459 msgid "copy-file-to-device"
8463 #: ../fish/guestfish-actions.pod:907
8466 " copy-file-to-device src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8471 #: ../fish/guestfish-actions.pod:914
8472 msgid "copy-file-to-file"
8476 #: ../fish/guestfish-actions.pod:916
8479 " copy-file-to-file src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8484 #: ../fish/guestfish-actions.pod:921
8486 "This is B<not> the function you want for copying files. This is for copying "
8487 "blocks within existing files. See L</cp>, L</cp-a> and L</mv> for general "
8488 "file copying and moving functions."
8492 #: ../fish/guestfish-actions.pod:928
8497 #: ../fish/guestfish-actions.pod:930
8500 " copy-size src dest size\n"
8505 #: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1584
8507 "This command copies exactly C<size> bytes from one source device or file "
8508 "C<src> to another destination device or file C<dest>."
8512 #: ../fish/guestfish-actions.pod:935 ../src/guestfs-actions.pod:1587
8514 "Note this will fail if the source is too short or if the destination is not "
8519 #: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:973
8521 "I<This function is deprecated.> In new code, use the L</"
8522 "copy_device_to_device> call instead."
8526 #: ../fish/guestfish-actions.pod:945
8531 #: ../fish/guestfish-actions.pod:947
8539 #: ../fish/guestfish-actions.pod:949 ../src/guestfs-actions.pod:1606
8541 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8542 "destination filename or destination directory."
8546 #: ../fish/guestfish-actions.pod:952
8551 #: ../fish/guestfish-actions.pod:954
8559 #: ../fish/guestfish-actions.pod:956 ../src/guestfs-actions.pod:1620
8561 "This copies a file or directory from C<src> to C<dest> recursively using the "
8566 #: ../fish/guestfish-actions.pod:959
8571 #: ../fish/guestfish-actions.pod:961
8579 #: ../fish/guestfish-actions.pod:963 ../src/guestfs-actions.pod:1641
8581 "This command copies from one source device or file C<src> to another "
8582 "destination device or file C<dest>. Normally you would use this to copy to "
8583 "or from a device or partition, for example to duplicate a filesystem."
8587 #: ../fish/guestfish-actions.pod:968
8589 "If the destination is a device, it must be as large or larger than the "
8590 "source file or device, otherwise the copy will fail. This command cannot do "
8591 "partial copies (see L</copy-device-to-device>)."
8595 #: ../fish/guestfish-actions.pod:980
8600 #: ../fish/guestfish-actions.pod:982
8608 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1660
8609 msgid "This command runs the C<df> command to report disk space used."
8613 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:997
8615 "This command is mostly useful for interactive sessions. It is I<not> "
8616 "intended that you try to parse the output string. Use L</statvfs> from "
8621 #: ../fish/guestfish-actions.pod:990
8626 #: ../fish/guestfish-actions.pod:992
8634 #: ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1676
8636 "This command runs the C<df -h> command to report disk space used in human-"
8641 #: ../fish/guestfish-actions.pod:1001
8646 #: ../fish/guestfish-actions.pod:1003
8654 #: ../fish/guestfish-actions.pod:1005 ../src/guestfs-actions.pod:1693
8656 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8657 "This is sometimes useful for extended debugging of problems."
8661 #: ../fish/guestfish-actions.pod:1009
8663 "Another way to get the same information is to enable verbose messages with "
8664 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
8665 "before running the program."
8669 #: ../fish/guestfish-actions.pod:1014
8674 #: ../fish/guestfish-actions.pod:1016
8677 " download remotefilename (filename|-)\n"
8682 #: ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1031
8683 #: ../src/guestfs-actions.pod:1714 ../src/guestfs-actions.pod:1739
8685 "Download file C<remotefilename> and save it as C<filename> on the local "
8690 #: ../fish/guestfish-actions.pod:1021 ../fish/guestfish-actions.pod:5003
8691 #: ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:7701
8692 msgid "C<filename> can also be a named pipe."
8696 #: ../fish/guestfish-actions.pod:1023
8697 msgid "See also L</upload>, L</cat>."
8701 #: ../fish/guestfish-actions.pod:1027
8702 msgid "download-offset"
8706 #: ../fish/guestfish-actions.pod:1029
8709 " download-offset remotefilename (filename|-) offset size\n"
8714 #: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1742
8716 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8717 "region must be within the file or device)."
8721 #: ../fish/guestfish-actions.pod:1037
8723 "Note that there is no limit on the amount of data that can be downloaded "
8724 "with this call, unlike with L</pread>, and this call always reads the full "
8725 "amount unless an error occurs."
8729 #: ../fish/guestfish-actions.pod:1042
8730 msgid "See also L</download>, L</pread>."
8734 #: ../fish/guestfish-actions.pod:1046
8739 #: ../fish/guestfish-actions.pod:1048
8742 " drop-caches whattodrop\n"
8747 #: ../fish/guestfish-actions.pod:1050 ../src/guestfs-actions.pod:1767
8749 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8750 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8751 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8755 #: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1772
8756 msgid "Setting C<whattodrop> to 3 should drop everything."
8760 #: ../fish/guestfish-actions.pod:1057 ../src/guestfs-actions.pod:1774
8762 "This automatically calls L<sync(2)> before the operation, so that the "
8763 "maximum guest memory is freed."
8767 #: ../fish/guestfish-actions.pod:1060
8772 #: ../fish/guestfish-actions.pod:1062
8780 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1787
8782 "This command runs the C<du -s> command to estimate file space usage for "
8787 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1790
8789 "C<path> can be a file or a directory. If C<path> is a directory then the "
8790 "estimate includes the contents of the directory and all subdirectories "
8795 #: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1794
8797 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8801 #: ../fish/guestfish-actions.pod:1074
8806 #: ../fish/guestfish-actions.pod:1076
8809 " e2fsck-f device\n"
8814 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1812
8816 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8817 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8822 #: ../fish/guestfish-actions.pod:1082
8824 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
8825 "should use L</fsck>."
8829 #: ../fish/guestfish-actions.pod:1085
8834 #: ../fish/guestfish-actions.pod:1087
8837 " echo-daemon 'words ...'\n"
8842 #: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1829
8844 "This command concatenates the list of C<words> passed with single spaces "
8845 "between them and returns the resulting string."
8849 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1832
8850 msgid "You can use this command to test the connection through to the daemon."
8854 #: ../fish/guestfish-actions.pod:1094
8855 msgid "See also L</ping-daemon>."
8859 #: ../fish/guestfish-actions.pod:1096
8864 #: ../fish/guestfish-actions.pod:1098
8867 " egrep regex path\n"
8872 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1848
8874 "This calls the external C<egrep> program and returns the matching lines."
8878 #: ../fish/guestfish-actions.pod:1106
8883 #: ../fish/guestfish-actions.pod:1108
8886 " egrepi regex path\n"
8891 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1867
8893 "This calls the external C<egrep -i> program and returns the matching lines."
8897 #: ../fish/guestfish-actions.pod:1116
8902 #: ../fish/guestfish-actions.pod:1118
8905 " equal file1 file2\n"
8910 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1886
8912 "This compares the two files C<file1> and C<file2> and returns true if their "
8913 "content is exactly equal, or false otherwise."
8917 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1889
8918 msgid "The external L<cmp(1)> program is used for the comparison."
8922 #: ../fish/guestfish-actions.pod:1125
8927 #: ../fish/guestfish-actions.pod:1127
8935 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1901
8937 "This returns C<true> if and only if there is a file, directory (or anything) "
8938 "with the given C<path> name."
8942 #: ../fish/guestfish-actions.pod:1132
8943 msgid "See also L</is-file>, L</is-dir>, L</stat>."
8947 #: ../fish/guestfish-actions.pod:1134
8952 #: ../fish/guestfish-actions.pod:1136
8955 " fallocate path len\n"
8960 #: ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1157
8961 #: ../src/guestfs-actions.pod:1924 ../src/guestfs-actions.pod:1943
8963 "This command preallocates a file (containing zero bytes) named C<path> of "
8964 "size C<len> bytes. If the file exists already, it is overwritten."
8968 #: ../fish/guestfish-actions.pod:1142 ../src/guestfs-actions.pod:1928
8970 "Do not confuse this with the guestfish-specific C<alloc> command which "
8971 "allocates a file in the host and attaches it as a device."
8975 #: ../fish/guestfish-actions.pod:1146
8977 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
8982 #: ../fish/guestfish-actions.pod:1153
8987 #: ../fish/guestfish-actions.pod:1155
8990 " fallocate64 path len\n"
8995 #: ../fish/guestfish-actions.pod:1161
8997 "Note that this call allocates disk blocks for the file. To create a sparse "
8998 "file use L</truncate-size> instead."
9002 #: ../fish/guestfish-actions.pod:1164
9004 "The deprecated call L</fallocate> does the same, but owing to an oversight "
9005 "it only allowed 30 bit lengths to be specified, effectively limiting the "
9006 "maximum size of files created through that call to 1GB."
9010 #: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1955
9012 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9013 "commands which create a file in the host and attach it as a device."
9017 #: ../fish/guestfish-actions.pod:1173
9022 #: ../fish/guestfish-actions.pod:1175
9025 " fgrep pattern path\n"
9030 #: ../fish/guestfish-actions.pod:1177 ../src/guestfs-actions.pod:1970
9032 "This calls the external C<fgrep> program and returns the matching lines."
9036 #: ../fish/guestfish-actions.pod:1183
9041 #: ../fish/guestfish-actions.pod:1185
9044 " fgrepi pattern path\n"
9049 #: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1989
9051 "This calls the external C<fgrep -i> program and returns the matching lines."
9055 #: ../fish/guestfish-actions.pod:1193
9060 #: ../fish/guestfish-actions.pod:1195
9068 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:2007
9070 "This call uses the standard L<file(1)> command to determine the type or "
9071 "contents of the file."
9075 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:2010
9077 "This call will also transparently look inside various types of compressed "
9082 #: ../fish/guestfish-actions.pod:1203 ../src/guestfs-actions.pod:2013
9084 "The exact command which runs is C<file -zb path>. Note in particular that "
9085 "the filename is not prepended to the output (the I<-b> option)."
9089 #: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:2017
9091 "The output depends on the output of the underlying L<file(1)> command and it "
9092 "can change in future in ways beyond our control. In other words, the output "
9093 "is not guaranteed by the ABI."
9097 #: ../fish/guestfish-actions.pod:1211
9099 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
9100 "(etc), L</is-zero>."
9104 #: ../fish/guestfish-actions.pod:1214
9105 msgid "file-architecture"
9109 #: ../fish/guestfish-actions.pod:1216
9112 " file-architecture filename\n"
9117 #: ../fish/guestfish-actions.pod:1218 ../src/guestfs-actions.pod:2035
9119 "This detects the architecture of the binary C<filename>, and returns it if "
9124 #: ../fish/guestfish-actions.pod:1221 ../src/guestfs-actions.pod:2038
9125 msgid "Currently defined architectures are:"
9129 #: ../fish/guestfish-actions.pod:1225 ../src/guestfs-actions.pod:2042
9134 #: ../fish/guestfish-actions.pod:1227 ../src/guestfs-actions.pod:2044
9136 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9137 "irrespective of the precise processor requirements of the binary."
9141 #: ../fish/guestfish-actions.pod:1230 ../src/guestfs-actions.pod:2047
9146 #: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:2049
9147 msgid "64 bit x86-64."
9151 #: ../fish/guestfish-actions.pod:1234 ../src/guestfs-actions.pod:2051
9156 #: ../fish/guestfish-actions.pod:1236 ../src/guestfs-actions.pod:2053
9157 msgid "32 bit SPARC."
9161 #: ../fish/guestfish-actions.pod:1238 ../src/guestfs-actions.pod:2055
9166 #: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:2057
9167 msgid "64 bit SPARC V9 and above."
9171 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:2059
9176 #: ../fish/guestfish-actions.pod:1244 ../src/guestfs-actions.pod:2061
9177 msgid "Intel Itanium."
9181 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:2063
9186 #: ../fish/guestfish-actions.pod:1248 ../src/guestfs-actions.pod:2065
9187 msgid "32 bit Power PC."
9191 #: ../fish/guestfish-actions.pod:1250 ../src/guestfs-actions.pod:2067
9196 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:2069
9197 msgid "64 bit Power PC."
9201 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:2073
9202 msgid "Libguestfs may return other architecture strings in future."
9206 #: ../fish/guestfish-actions.pod:1258 ../src/guestfs-actions.pod:2075
9207 msgid "The function works on at least the following types of files:"
9211 #: ../fish/guestfish-actions.pod:1264 ../src/guestfs-actions.pod:2081
9212 msgid "many types of Un*x and Linux binary"
9216 #: ../fish/guestfish-actions.pod:1268 ../src/guestfs-actions.pod:2085
9217 msgid "many types of Un*x and Linux shared library"
9221 #: ../fish/guestfish-actions.pod:1272 ../src/guestfs-actions.pod:2089
9222 msgid "Windows Win32 and Win64 binaries"
9226 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:2093
9227 msgid "Windows Win32 and Win64 DLLs"
9231 #: ../fish/guestfish-actions.pod:1278 ../src/guestfs-actions.pod:2095
9232 msgid "Win32 binaries and DLLs return C<i386>."
9236 #: ../fish/guestfish-actions.pod:1280 ../src/guestfs-actions.pod:2097
9237 msgid "Win64 binaries and DLLs return C<x86_64>."
9241 #: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:2101
9242 msgid "Linux kernel modules"
9246 #: ../fish/guestfish-actions.pod:1288 ../src/guestfs-actions.pod:2105
9247 msgid "Linux new-style initrd images"
9251 #: ../fish/guestfish-actions.pod:1292 ../src/guestfs-actions.pod:2109
9252 msgid "some non-x86 Linux vmlinuz kernels"
9256 #: ../fish/guestfish-actions.pod:1296 ../src/guestfs-actions.pod:2113
9257 msgid "What it can't do currently:"
9261 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:2119
9262 msgid "static libraries (libfoo.a)"
9266 #: ../fish/guestfish-actions.pod:1306 ../src/guestfs-actions.pod:2123
9267 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9271 #: ../fish/guestfish-actions.pod:1310 ../src/guestfs-actions.pod:2127
9272 msgid "x86 Linux vmlinuz kernels"
9276 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:2129
9278 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9279 "compressed code, and are horribly hard to unpack. If you want to find the "
9280 "architecture of a kernel, use the architecture of the associated initrd or "
9281 "kernel module(s) instead."
9285 #: ../fish/guestfish-actions.pod:1319
9290 #: ../fish/guestfish-actions.pod:1321
9298 #: ../fish/guestfish-actions.pod:1323 ../src/guestfs-actions.pod:2147
9299 msgid "This command returns the size of C<file> in bytes."
9303 #: ../fish/guestfish-actions.pod:1325
9305 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
9306 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
9310 #: ../fish/guestfish-actions.pod:1329
9315 #: ../fish/guestfish-actions.pod:1331
9318 " fill c len path\n"
9323 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2165
9325 "This command creates a new file called C<path>. The initial content of the "
9326 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9331 #: ../fish/guestfish-actions.pod:1337
9333 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9334 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
9339 #: ../fish/guestfish-actions.pod:1342
9340 msgid "fill-pattern"
9344 #: ../fish/guestfish-actions.pod:1344
9347 " fill-pattern pattern len path\n"
9352 #: ../fish/guestfish-actions.pod:1346
9354 "This function is like L</fill> except that it creates a new file of length "
9355 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
9356 "is truncated if necessary to ensure the length of the file is exactly C<len> "
9361 #: ../fish/guestfish-actions.pod:1351
9366 #: ../fish/guestfish-actions.pod:1353
9374 #: ../fish/guestfish-actions.pod:1355 ../src/guestfs-actions.pod:2211
9376 "This command lists out all files and directories, recursively, starting at "
9377 "C<directory>. It is essentially equivalent to running the shell command "
9378 "C<find directory -print> but some post-processing happens on the output, "
9383 #: ../fish/guestfish-actions.pod:1360 ../src/guestfs-actions.pod:2216
9385 "This returns a list of strings I<without any prefix>. Thus if the directory "
9390 #: ../fish/guestfish-actions.pod:1363 ../src/guestfs-actions.pod:2219
9400 #: ../fish/guestfish-actions.pod:1367
9401 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
9405 #: ../fish/guestfish-actions.pod:1370 ../src/guestfs-actions.pod:2226
9416 #: ../fish/guestfish-actions.pod:1375 ../src/guestfs-actions.pod:2231
9417 msgid "If C<directory> is not a directory, then this command returns an error."
9421 #: ../fish/guestfish-actions.pod:1378 ../src/guestfs-actions.pod:2234
9422 msgid "The returned list is sorted."
9426 #: ../fish/guestfish-actions.pod:1380
9427 msgid "See also L</find0>."
9431 #: ../fish/guestfish-actions.pod:1385
9436 #: ../fish/guestfish-actions.pod:1387
9439 " find0 directory (files|-)\n"
9444 #: ../fish/guestfish-actions.pod:1389 ../src/guestfs-actions.pod:2254
9446 "This command lists out all files and directories, recursively, starting at "
9447 "C<directory>, placing the resulting list in the external file called "
9452 #: ../fish/guestfish-actions.pod:1393
9454 "This command works the same way as L</find> with the following exceptions:"
9458 #: ../fish/guestfish-actions.pod:1400 ../src/guestfs-actions.pod:2265
9459 msgid "The resulting list is written to an external file."
9463 #: ../fish/guestfish-actions.pod:1404 ../src/guestfs-actions.pod:2269
9465 "Items (filenames) in the result are separated by C<\\0> characters. See "
9466 "L<find(1)> option I<-print0>."
9470 #: ../fish/guestfish-actions.pod:1409 ../src/guestfs-actions.pod:2274
9471 msgid "This command is not limited in the number of names that it can return."
9475 #: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2279
9476 msgid "The result list is not sorted."
9480 #: ../fish/guestfish-actions.pod:1420
9481 msgid "findfs-label"
9485 #: ../fish/guestfish-actions.pod:1422
9488 " findfs-label label\n"
9493 #: ../fish/guestfish-actions.pod:1424 ../src/guestfs-actions.pod:2293
9495 "This command searches the filesystems and returns the one which has the "
9496 "given label. An error is returned if no such filesystem can be found."
9500 #: ../fish/guestfish-actions.pod:1428
9501 msgid "To find the label of a filesystem, use L</vfs-label>."
9505 #: ../fish/guestfish-actions.pod:1430
9510 #: ../fish/guestfish-actions.pod:1432
9513 " findfs-uuid uuid\n"
9518 #: ../fish/guestfish-actions.pod:1434 ../src/guestfs-actions.pod:2310
9520 "This command searches the filesystems and returns the one which has the "
9521 "given UUID. An error is returned if no such filesystem can be found."
9525 #: ../fish/guestfish-actions.pod:1438
9526 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
9530 #: ../fish/guestfish-actions.pod:1440
9535 #: ../fish/guestfish-actions.pod:1442
9538 " fsck fstype device\n"
9543 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2328
9545 "This runs the filesystem checker (fsck) on C<device> which should have "
9546 "filesystem type C<fstype>."
9550 #: ../fish/guestfish-actions.pod:1447 ../src/guestfs-actions.pod:2331
9552 "The returned integer is the status. See L<fsck(8)> for the list of status "
9553 "codes from C<fsck>."
9557 #: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2340
9558 msgid "Multiple status codes can be summed together."
9562 #: ../fish/guestfish-actions.pod:1460 ../src/guestfs-actions.pod:2344
9564 "A non-zero return code can mean \"success\", for example if errors have been "
9565 "corrected on the filesystem."
9569 #: ../fish/guestfish-actions.pod:1465 ../src/guestfs-actions.pod:2349
9570 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9574 #: ../fish/guestfish-actions.pod:1470 ../src/guestfs-actions.pod:2354
9576 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9580 #: ../fish/guestfish-actions.pod:1472
9585 #: ../fish/guestfish-actions.pod:1474
9593 #: ../fish/guestfish-actions.pod:1476 ../src/guestfs-actions.pod:2365
9595 "Return the additional kernel options which are added to the guest kernel "
9600 #: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2368
9601 msgid "If C<NULL> then no options are added."
9605 #: ../fish/guestfish-actions.pod:1481
9606 msgid "get-attach-method"
9610 #: ../fish/guestfish-actions.pod:1483
9613 " get-attach-method\n"
9618 #: ../fish/guestfish-actions.pod:1485
9619 msgid "Return the current attach method. See L</set-attach-method>."
9623 #: ../fish/guestfish-actions.pod:1487
9624 msgid "get-autosync"
9628 #: ../fish/guestfish-actions.pod:1489
9636 #: ../fish/guestfish-actions.pod:1491 ../src/guestfs-actions.pod:2393
9637 msgid "Get the autosync flag."
9641 #: ../fish/guestfish-actions.pod:1493
9646 #: ../fish/guestfish-actions.pod:1495
9654 #: ../fish/guestfish-actions.pod:1497 ../src/guestfs-actions.pod:2404
9655 msgid "Return the direct appliance mode flag."
9659 #: ../fish/guestfish-actions.pod:1499
9664 #: ../fish/guestfish-actions.pod:1501
9667 " get-e2label device\n"
9672 #: ../fish/guestfish-actions.pod:1503 ../src/guestfs-actions.pod:2423
9674 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9678 #: ../fish/guestfish-actions.pod:1506
9680 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
9685 #: ../fish/guestfish-actions.pod:1513
9690 #: ../fish/guestfish-actions.pod:1515
9693 " get-e2uuid device\n"
9698 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2444
9700 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9704 #: ../fish/guestfish-actions.pod:1520
9706 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
9711 #: ../fish/guestfish-actions.pod:1527
9716 #: ../fish/guestfish-actions.pod:1529
9724 #: ../fish/guestfish-actions.pod:1531 ../src/guestfs-actions.pod:2457
9726 "This gets the memory size in megabytes allocated to the qemu subprocess."
9730 #: ../fish/guestfish-actions.pod:1534
9732 "If L</set-memsize> was not called on this handle, and if "
9733 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9734 "value for memsize."
9738 #: ../fish/guestfish-actions.pod:1538 ../fish/guestfish-actions.pod:1595
9739 #: ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4462
9740 #: ../src/guestfs-actions.pod:2464 ../src/guestfs-actions.pod:2556
9741 #: ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6881
9743 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9747 #: ../fish/guestfish-actions.pod:1541
9752 #: ../fish/guestfish-actions.pod:1543
9760 #: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2476
9761 msgid "This returns the enable network flag."
9765 #: ../fish/guestfish-actions.pod:1547
9770 #: ../fish/guestfish-actions.pod:1549
9778 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2487
9779 msgid "Return the current search path."
9783 #: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2489
9785 "This is always non-NULL. If it wasn't set already, then this will return "
9790 #: ../fish/guestfish-actions.pod:1556
9795 #: ../fish/guestfish-actions.pod:1558
9803 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2502
9804 msgid "This returns the process group flag."
9808 #: ../fish/guestfish-actions.pod:1562
9813 #: ../fish/guestfish-actions.pod:1564
9818 #: ../fish/guestfish-actions.pod:1566
9826 #: ../fish/guestfish-actions.pod:1568 ../src/guestfs-actions.pod:2513
9828 "Return the process ID of the qemu subprocess. If there is no qemu "
9829 "subprocess, then this will return an error."
9833 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2516
9834 msgid "This is an internal call used for debugging and testing."
9838 #: ../fish/guestfish-actions.pod:1573
9843 #: ../fish/guestfish-actions.pod:1575
9851 #: ../fish/guestfish-actions.pod:1577 ../src/guestfs-actions.pod:2527
9852 msgid "Return the current qemu binary."
9856 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2529
9858 "This is always non-NULL. If it wasn't set already, then this will return "
9859 "the default qemu binary name."
9863 #: ../fish/guestfish-actions.pod:1582
9864 msgid "get-recovery-proc"
9868 #: ../fish/guestfish-actions.pod:1584
9871 " get-recovery-proc\n"
9876 #: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2542
9877 msgid "Return the recovery process enabled flag."
9881 #: ../fish/guestfish-actions.pod:1588
9886 #: ../fish/guestfish-actions.pod:1590
9894 #: ../fish/guestfish-actions.pod:1592
9896 "This returns the current setting of the selinux flag which is passed to the "
9897 "appliance at boot time. See L</set-selinux>."
9901 #: ../fish/guestfish-actions.pod:1598
9906 #: ../fish/guestfish-actions.pod:1600
9914 #: ../fish/guestfish-actions.pod:1602 ../src/guestfs-actions.pod:2568
9915 msgid "This returns the number of virtual CPUs assigned to the appliance."
9919 #: ../fish/guestfish-actions.pod:1604
9924 #: ../fish/guestfish-actions.pod:1606
9932 #: ../fish/guestfish-actions.pod:1608 ../src/guestfs-actions.pod:2579
9934 "This returns the current state as an opaque integer. This is only useful "
9935 "for printing debug and internal error messages."
9939 #: ../fish/guestfish-actions.pod:1611 ../fish/guestfish-actions.pod:2570
9940 #: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:2626
9941 #: ../fish/guestfish-actions.pod:2642 ../src/guestfs-actions.pod:2582
9942 #: ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3930
9943 #: ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:4018
9944 msgid "For more information on states, see L<guestfs(3)>."
9948 #: ../fish/guestfish-actions.pod:1613
9953 #: ../fish/guestfish-actions.pod:1615
9961 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2593
9962 msgid "Return the command trace flag."
9966 #: ../fish/guestfish-actions.pod:1619
9971 #: ../fish/guestfish-actions.pod:1621
9979 #: ../fish/guestfish-actions.pod:1623
9981 "Return the current umask. By default the umask is C<022> unless it has been "
9982 "set by calling L</umask>."
9986 #: ../fish/guestfish-actions.pod:1626
9991 #: ../fish/guestfish-actions.pod:1628
9999 #: ../fish/guestfish-actions.pod:1630 ../src/guestfs-actions.pod:2616
10000 msgid "This returns the verbose messages flag."
10004 #: ../fish/guestfish-actions.pod:1632
10009 #: ../fish/guestfish-actions.pod:1634
10017 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2627
10018 msgid "This gets the SELinux security context of the daemon."
10022 #: ../fish/guestfish-actions.pod:1638
10023 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
10027 #: ../fish/guestfish-actions.pod:1641
10032 #: ../fish/guestfish-actions.pod:1643
10035 " getxattr path name\n"
10040 #: ../fish/guestfish-actions.pod:1645
10042 "Get a single extended attribute from file C<path> named C<name>. This call "
10043 "follows symlinks. If you want to lookup an extended attribute for the "
10044 "symlink itself, use L</lgetxattr>."
10048 #: ../fish/guestfish-actions.pod:1649 ../fish/guestfish-actions.pod:2715
10050 "Normally it is better to get all extended attributes from a file in one go "
10051 "by calling L</getxattrs>. However some Linux filesystem implementations are "
10052 "buggy and do not provide a way to list out attributes. For these "
10053 "filesystems (notably ntfs-3g) you have to know the names of the extended "
10054 "attributes you want in advance and call this function."
10058 #: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:2722
10059 #: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:4151
10061 "Extended attribute values are blobs of binary data. If there is no extended "
10062 "attribute named C<name>, this returns an error."
10066 #: ../fish/guestfish-actions.pod:1659
10067 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
10071 #: ../fish/guestfish-actions.pod:1661
10076 #: ../fish/guestfish-actions.pod:1663
10079 " getxattrs path\n"
10084 #: ../fish/guestfish-actions.pod:1665 ../src/guestfs-actions.pod:2673
10086 "This call lists the extended attributes of the file or directory C<path>."
10090 #: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2676
10092 "At the system call level, this is a combination of the L<listxattr(2)> and "
10093 "L<getxattr(2)> calls."
10097 #: ../fish/guestfish-actions.pod:1671
10098 msgid "See also: L</lgetxattrs>, L<attr(5)>."
10102 #: ../fish/guestfish-actions.pod:1673
10103 msgid "glob-expand"
10107 #: ../fish/guestfish-actions.pod:1675
10110 " glob-expand pattern\n"
10115 #: ../fish/guestfish-actions.pod:1677 ../src/guestfs-actions.pod:2693
10117 "This command searches for all the pathnames matching C<pattern> according to "
10118 "the wildcard expansion rules used by the shell."
10122 #: ../fish/guestfish-actions.pod:1681 ../src/guestfs-actions.pod:2697
10124 "If no paths match, then this returns an empty list (note: not an error)."
10128 #: ../fish/guestfish-actions.pod:1684 ../src/guestfs-actions.pod:2700
10130 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10131 "GLOB_BRACE>. See that manual page for more details."
10135 #: ../fish/guestfish-actions.pod:1688
10140 #: ../fish/guestfish-actions.pod:1690
10143 " grep regex path\n"
10148 #: ../fish/guestfish-actions.pod:1692 ../src/guestfs-actions.pod:2717
10149 msgid "This calls the external C<grep> program and returns the matching lines."
10153 #: ../fish/guestfish-actions.pod:1698
10158 #: ../fish/guestfish-actions.pod:1700
10161 " grepi regex path\n"
10166 #: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2736
10168 "This calls the external C<grep -i> program and returns the matching lines."
10172 #: ../fish/guestfish-actions.pod:1708
10173 msgid "grub-install"
10177 #: ../fish/guestfish-actions.pod:1710
10180 " grub-install root device\n"
10185 #: ../fish/guestfish-actions.pod:1712 ../src/guestfs-actions.pod:2755
10187 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
10188 "with the root directory being C<root>."
10192 #: ../fish/guestfish-actions.pod:1721 ../src/guestfs-actions.pod:2764
10194 "There is currently no way in the API to install grub2, which is used by most "
10195 "modern Linux guests. It is possible to run the grub2 command from the "
10196 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
10200 #: ../fish/guestfish-actions.pod:1728 ../src/guestfs-actions.pod:2771
10202 "This uses C<grub-install> from the host. Unfortunately grub is not always "
10203 "compatible with itself, so this only works in rather narrow circumstances. "
10204 "Careful testing with each guest version is advisable."
10208 #: ../fish/guestfish-actions.pod:1735 ../src/guestfs-actions.pod:2778
10210 "If grub-install reports the error \"No suitable drive was found in the "
10211 "generated device map.\" it may be that you need to create a C</boot/grub/"
10212 "device.map> file first that contains the mapping between grub device names "
10213 "and Linux device names. It is usually sufficient to create a file "
10218 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2785
10221 " (hd0) /dev/vda\n"
10226 #: ../fish/guestfish-actions.pod:1744 ../src/guestfs-actions.pod:2787
10227 msgid "replacing C</dev/vda> with the name of the installation device."
10231 #: ../fish/guestfish-actions.pod:1748
10236 #: ../fish/guestfish-actions.pod:1750
10244 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2801
10246 "This command returns up to the first 10 lines of a file as a list of strings."
10250 #: ../fish/guestfish-actions.pod:1758
10255 #: ../fish/guestfish-actions.pod:1760
10258 " head-n nrlines path\n"
10263 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2820
10265 "If the parameter C<nrlines> is a positive number, this returns the first "
10266 "C<nrlines> lines of the file C<path>."
10270 #: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2823
10272 "If the parameter C<nrlines> is a negative number, this returns lines from "
10273 "the file C<path>, excluding the last C<nrlines> lines."
10277 #: ../fish/guestfish-actions.pod:1768 ../fish/guestfish-actions.pod:4843
10278 #: ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:7460
10279 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10283 #: ../fish/guestfish-actions.pod:1773
10288 #: ../fish/guestfish-actions.pod:1775
10296 #: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2843
10298 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10299 "readable, canonical hex dump of the file."
10303 #: ../fish/guestfish-actions.pod:1783
10308 #: ../fish/guestfish-actions.pod:1785
10311 " initrd-cat initrdpath filename\n"
10316 #: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2862
10318 "This command unpacks the file C<filename> from the initrd file called "
10319 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10324 #: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2866
10326 "For example, in guestfish you could use the following command to examine the "
10327 "boot script (usually called C</init>) contained in a Linux initrd or "
10332 #: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2870
10335 " initrd-cat /boot/initrd-<version>.img init\n"
10340 #: ../fish/guestfish-actions.pod:1797
10341 msgid "See also L</initrd-list>."
10345 #: ../fish/guestfish-actions.pod:1802
10346 msgid "initrd-list"
10350 #: ../fish/guestfish-actions.pod:1804
10353 " initrd-list path\n"
10358 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2889
10359 msgid "This command lists out files contained in an initrd."
10363 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2891
10365 "The files are listed without any initial C</> character. The files are "
10366 "listed in the order they appear (not necessarily alphabetical). Directory "
10367 "names are listed as separate items."
10371 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2895
10373 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10374 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10379 #: ../fish/guestfish-actions.pod:1816
10380 msgid "inotify-add-watch"
10384 #: ../fish/guestfish-actions.pod:1818
10387 " inotify-add-watch path mask\n"
10392 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2912
10393 msgid "Watch C<path> for the events listed in C<mask>."
10397 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2914
10399 "Note that if C<path> is a directory then events within that directory are "
10400 "watched, but this does I<not> happen recursively (in subdirectories)."
10404 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2918
10406 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10407 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10411 #: ../fish/guestfish-actions.pod:1830
10412 msgid "inotify-close"
10416 #: ../fish/guestfish-actions.pod:1832
10424 #: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2931
10426 "This closes the inotify handle which was previously opened by inotify_init. "
10427 "It removes all watches, throws away any pending events, and deallocates all "
10432 #: ../fish/guestfish-actions.pod:1838
10433 msgid "inotify-files"
10437 #: ../fish/guestfish-actions.pod:1840
10445 #: ../fish/guestfish-actions.pod:1842
10447 "This function is a helpful wrapper around L</inotify-read> which just "
10448 "returns a list of pathnames of objects that were touched. The returned "
10449 "pathnames are sorted and deduplicated."
10453 #: ../fish/guestfish-actions.pod:1846
10454 msgid "inotify-init"
10458 #: ../fish/guestfish-actions.pod:1848
10461 " inotify-init maxevents\n"
10466 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2960
10468 "This command creates a new inotify handle. The inotify subsystem can be "
10469 "used to notify events which happen to objects in the guest filesystem."
10473 #: ../fish/guestfish-actions.pod:1854
10475 "C<maxevents> is the maximum number of events which will be queued up between "
10476 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
10477 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
10478 "default was 16384 events. Beyond this limit, the kernel throws away events, "
10479 "but records the fact that it threw them away by setting a flag "
10480 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
10484 #: ../fish/guestfish-actions.pod:1864
10486 "Before any events are generated, you have to add some watches to the "
10487 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
10488 "L</inotify-watch-all>."
10492 #: ../fish/guestfish-actions.pod:1870
10494 "Queued up events should be read periodically by calling L</inotify-read> (or "
10495 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
10496 "If you don't read the events out often enough then you risk the internal "
10497 "queue overflowing."
10501 #: ../fish/guestfish-actions.pod:1877
10503 "The handle should be closed after use by calling L</inotify-close>. This "
10504 "also removes any watches automatically."
10508 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2991
10510 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10511 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10512 "that there is one global inotify handle per libguestfs instance."
10516 #: ../fish/guestfish-actions.pod:1886
10517 msgid "inotify-read"
10521 #: ../fish/guestfish-actions.pod:1888
10529 #: ../fish/guestfish-actions.pod:1890 ../src/guestfs-actions.pod:3005
10531 "Return the complete queue of events that have happened since the previous "
10536 #: ../fish/guestfish-actions.pod:1893 ../src/guestfs-actions.pod:3008
10537 msgid "If no events have happened, this returns an empty list."
10541 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:3010
10543 "I<Note>: In order to make sure that all events have been read, you must call "
10544 "this function repeatedly until it returns an empty list. The reason is that "
10545 "the call will read events up to the maximum appliance-to-host message size "
10546 "and leave remaining events in the queue."
10550 #: ../fish/guestfish-actions.pod:1901
10551 msgid "inotify-rm-watch"
10555 #: ../fish/guestfish-actions.pod:1903
10558 " inotify-rm-watch wd\n"
10563 #: ../fish/guestfish-actions.pod:1905
10564 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
10568 #: ../fish/guestfish-actions.pod:1908
10569 msgid "inspect-get-arch"
10573 #: ../fish/guestfish-actions.pod:1910
10576 " inspect-get-arch root\n"
10581 #: ../fish/guestfish-actions.pod:1912
10583 "This returns the architecture of the inspected operating system. The "
10584 "possible return values are listed under L</file-architecture>."
10588 #: ../fish/guestfish-actions.pod:1916 ../src/guestfs-actions.pod:3045
10590 "If the architecture could not be determined, then the string C<unknown> is "
10595 #: ../fish/guestfish-actions.pod:1919 ../fish/guestfish-actions.pod:2014
10596 #: ../fish/guestfish-actions.pod:2093 ../fish/guestfish-actions.pod:2105
10597 #: ../fish/guestfish-actions.pod:2189 ../fish/guestfish-actions.pod:2251
10598 #: ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2286
10599 #: ../fish/guestfish-actions.pod:2326 ../fish/guestfish-actions.pod:2362
10600 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2388
10601 #: ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2408
10602 #: ../fish/guestfish-actions.pod:2420 ../fish/guestfish-actions.pod:2516
10603 #: ../fish/guestfish-actions.pod:2550 ../src/guestfs-actions.pod:3048
10604 #: ../src/guestfs-actions.pod:3150 ../src/guestfs-actions.pod:3254
10605 #: ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3404
10606 #: ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3516
10607 #: ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3590
10608 #: ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3654
10609 #: ../src/guestfs-actions.pod:3674 ../src/guestfs-actions.pod:3691
10610 #: ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3725
10611 #: ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3868
10612 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10616 #: ../fish/guestfish-actions.pod:1921
10617 msgid "inspect-get-distro"
10621 #: ../fish/guestfish-actions.pod:1923
10624 " inspect-get-distro root\n"
10629 #: ../fish/guestfish-actions.pod:1925 ../src/guestfs-actions.pod:3061
10631 "This returns the distro (distribution) of the inspected operating system."
10635 #: ../fish/guestfish-actions.pod:1928 ../src/guestfs-actions.pod:3064
10636 msgid "Currently defined distros are:"
10640 #: ../fish/guestfish-actions.pod:1932 ../src/guestfs-actions.pod:3068
10641 msgid "\"archlinux\""
10645 #: ../fish/guestfish-actions.pod:1934 ../src/guestfs-actions.pod:3070
10646 msgid "Arch Linux."
10650 #: ../fish/guestfish-actions.pod:1936 ../src/guestfs-actions.pod:3072
10655 #: ../fish/guestfish-actions.pod:1938 ../src/guestfs-actions.pod:3074
10660 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:3076
10665 #: ../fish/guestfish-actions.pod:1942 ../src/guestfs-actions.pod:3078
10670 #: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:3080
10675 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:3082
10680 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:3084
10685 #: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:3086
10690 #: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:3088
10691 msgid "\"linuxmint\""
10695 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:3090
10696 msgid "Linux Mint."
10700 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:3092
10705 #: ../fish/guestfish-actions.pod:1958 ../src/guestfs-actions.pod:3094
10710 #: ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:3096
10711 msgid "\"mandriva\""
10715 #: ../fish/guestfish-actions.pod:1962 ../src/guestfs-actions.pod:3098
10720 #: ../fish/guestfish-actions.pod:1964 ../src/guestfs-actions.pod:3100
10725 #: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:3102
10730 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:3104
10731 msgid "\"opensuse\""
10735 #: ../fish/guestfish-actions.pod:1970 ../src/guestfs-actions.pod:3106
10740 #: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:3108
10745 #: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:3110
10750 #: ../fish/guestfish-actions.pod:1976 ../src/guestfs-actions.pod:3112
10751 msgid "\"redhat-based\""
10755 #: ../fish/guestfish-actions.pod:1978 ../src/guestfs-actions.pod:3114
10756 msgid "Some Red Hat-derived distro."
10760 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:3116
10765 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:3118
10766 msgid "Red Hat Enterprise Linux."
10770 #: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:3120
10771 msgid "\"scientificlinux\""
10775 #: ../fish/guestfish-actions.pod:1986 ../src/guestfs-actions.pod:3122
10776 msgid "Scientific Linux."
10780 #: ../fish/guestfish-actions.pod:1988 ../src/guestfs-actions.pod:3124
10781 msgid "\"slackware\""
10785 #: ../fish/guestfish-actions.pod:1990 ../src/guestfs-actions.pod:3126
10790 #: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:3128
10791 msgid "\"ttylinux\""
10795 #: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:3130
10800 #: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3132
10805 #: ../fish/guestfish-actions.pod:1998 ../src/guestfs-actions.pod:3134
10810 #: ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2084
10811 #: ../fish/guestfish-actions.pod:2353 ../src/guestfs-actions.pod:3136
10812 #: ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3625
10813 msgid "\"unknown\""
10817 #: ../fish/guestfish-actions.pod:2002 ../src/guestfs-actions.pod:3138
10818 msgid "The distro could not be determined."
10822 #: ../fish/guestfish-actions.pod:2004 ../fish/guestfish-actions.pod:2341
10823 #: ../src/guestfs-actions.pod:3140 ../src/guestfs-actions.pod:3613
10824 msgid "\"windows\""
10828 #: ../fish/guestfish-actions.pod:2006 ../src/guestfs-actions.pod:3142
10830 "Windows does not have distributions. This string is returned if the OS type "
10835 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2090
10836 #: ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3147
10837 #: ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3631
10839 "Future versions of libguestfs may return other strings here. The caller "
10840 "should be prepared to handle any string."
10844 #: ../fish/guestfish-actions.pod:2016
10845 msgid "inspect-get-drive-mappings"
10849 #: ../fish/guestfish-actions.pod:2018
10852 " inspect-get-drive-mappings root\n"
10857 #: ../fish/guestfish-actions.pod:2020 ../src/guestfs-actions.pod:3163
10859 "This call is useful for Windows which uses a primitive system of assigning "
10860 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10861 "Windows Registry to find out how disks/partitions are mapped to drive "
10862 "letters, and returns a hash table as in the example below:"
10866 #: ../fish/guestfish-actions.pod:2026 ../src/guestfs-actions.pod:3169
10869 " C => /dev/vda2\n"
10870 " E => /dev/vdb1\n"
10871 " F => /dev/vdc1\n"
10876 #: ../fish/guestfish-actions.pod:2030 ../src/guestfs-actions.pod:3173
10878 "Note that keys are drive letters. For Windows, the key is case insensitive "
10879 "and just contains the drive letter, without the customary colon separator "
10884 #: ../fish/guestfish-actions.pod:2034 ../src/guestfs-actions.pod:3177
10886 "In future we may support other operating systems that also used drive "
10887 "letters, but the keys for those might not be case insensitive and might be "
10888 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10893 #: ../fish/guestfish-actions.pod:2039 ../src/guestfs-actions.pod:3182
10895 "For Windows guests, currently only hard drive mappings are returned. "
10896 "Removable disks (eg. DVD-ROMs) are ignored."
10900 #: ../fish/guestfish-actions.pod:2042 ../src/guestfs-actions.pod:3185
10902 "For guests that do not use drive mappings, or if the drive mappings could "
10903 "not be determined, this returns an empty hash table."
10907 #: ../fish/guestfish-actions.pod:2045
10909 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10910 "get-mountpoints>, L</inspect-get-filesystems>."
10914 #: ../fish/guestfish-actions.pod:2049
10915 msgid "inspect-get-filesystems"
10919 #: ../fish/guestfish-actions.pod:2051
10922 " inspect-get-filesystems root\n"
10927 #: ../fish/guestfish-actions.pod:2053 ../src/guestfs-actions.pod:3206
10929 "This returns a list of all the filesystems that we think are associated with "
10930 "this operating system. This includes the root filesystem, other ordinary "
10931 "filesystems, and non-mounted devices like swap partitions."
10935 #: ../fish/guestfish-actions.pod:2058 ../src/guestfs-actions.pod:3211
10937 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10938 "to be shared between operating systems."
10942 #: ../fish/guestfish-actions.pod:2061
10944 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10945 "get-mountpoints>."
10949 #: ../fish/guestfish-actions.pod:2064
10950 msgid "inspect-get-format"
10954 #: ../fish/guestfish-actions.pod:2066
10957 " inspect-get-format root\n"
10962 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3229
10964 "This returns the format of the inspected operating system. You can use it "
10965 "to detect install images, live CDs and similar."
10969 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3232
10970 msgid "Currently defined formats are:"
10974 #: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3236
10975 msgid "\"installed\""
10979 #: ../fish/guestfish-actions.pod:2077 ../src/guestfs-actions.pod:3238
10980 msgid "This is an installed operating system."
10984 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3240
10985 msgid "\"installer\""
10989 #: ../fish/guestfish-actions.pod:2081 ../src/guestfs-actions.pod:3242
10991 "The disk image being inspected is not an installed operating system, but a "
10992 "I<bootable> install disk, live CD, or similar."
10996 #: ../fish/guestfish-actions.pod:2086 ../src/guestfs-actions.pod:3247
10997 msgid "The format of this disk image is not known."
11001 #: ../fish/guestfish-actions.pod:2095
11002 msgid "inspect-get-hostname"
11006 #: ../fish/guestfish-actions.pod:2097
11009 " inspect-get-hostname root\n"
11014 #: ../fish/guestfish-actions.pod:2099 ../src/guestfs-actions.pod:3267
11016 "This function returns the hostname of the operating system as found by "
11017 "inspection of the guest's configuration files."
11021 #: ../fish/guestfish-actions.pod:2102 ../src/guestfs-actions.pod:3270
11023 "If the hostname could not be determined, then the string C<unknown> is "
11028 #: ../fish/guestfish-actions.pod:2107
11029 msgid "inspect-get-icon"
11033 #: ../fish/guestfish-actions.pod:2109
11036 " inspect-get-icon root [favicon:true|false] [highquality:true|false]\n"
11041 #: ../fish/guestfish-actions.pod:2111 ../src/guestfs-actions.pod:3296
11043 "This function returns an icon corresponding to the inspected operating "
11044 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
11045 "to PNG if necessary)."
11049 #: ../fish/guestfish-actions.pod:2115 ../src/guestfs-actions.pod:3300
11051 "If it was not possible to get an icon this function returns a zero-length "
11052 "(non-NULL) buffer. I<Callers must check for this case>."
11056 #: ../fish/guestfish-actions.pod:2118 ../src/guestfs-actions.pod:3303
11058 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11059 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11060 "this file will be returned. You can disable favicons by passing the "
11061 "optional C<favicon> boolean as false (default is true)."
11065 #: ../fish/guestfish-actions.pod:2124 ../src/guestfs-actions.pod:3309
11067 "If finding the favicon fails, then we look in other places in the guest for "
11072 #: ../fish/guestfish-actions.pod:2127 ../src/guestfs-actions.pod:3312
11074 "If the optional C<highquality> boolean is true then only high quality icons "
11075 "are returned, which means only icons of high resolution with an alpha "
11076 "channel. The default (false) is to return any icon we can, even if it is of "
11077 "substandard quality."
11081 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3323
11083 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11084 "before you call this, since it needs to read information from the guest "
11085 "filesystem during the call."
11089 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3329
11091 "B<Security:> The icon data comes from the untrusted guest, and should be "
11092 "treated with caution. PNG files have been known to contain exploits. "
11093 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11094 "trying to process or display the icon."
11098 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3337
11100 "The PNG image returned can be any size. It might not be square. Libguestfs "
11101 "tries to return the largest, highest quality icon available. The "
11102 "application must scale the icon to the required size."
11106 #: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3344
11108 "Extracting icons from Windows guests requires the external C<wrestool> "
11109 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11110 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11111 "installed separately."
11115 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3351
11117 "Operating system icons are usually trademarks. Seek legal advice before "
11118 "using trademarks in applications."
11122 #: ../fish/guestfish-actions.pod:2173
11123 msgid "inspect-get-major-version"
11127 #: ../fish/guestfish-actions.pod:2175
11130 " inspect-get-major-version root\n"
11135 #: ../fish/guestfish-actions.pod:2177 ../src/guestfs-actions.pod:3392
11137 "This returns the major version number of the inspected operating system."
11141 #: ../fish/guestfish-actions.pod:2180 ../src/guestfs-actions.pod:3395
11143 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11144 "popular public names used by the operating system. Notably the operating "
11145 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11146 "1). You can find out the real versions corresponding to releases of Windows "
11147 "by consulting Wikipedia or MSDN."
11151 #: ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2198
11152 #: ../src/guestfs-actions.pod:3402 ../src/guestfs-actions.pod:3419
11153 msgid "If the version could not be determined, then C<0> is returned."
11157 #: ../fish/guestfish-actions.pod:2191
11158 msgid "inspect-get-minor-version"
11162 #: ../fish/guestfish-actions.pod:2193
11165 " inspect-get-minor-version root\n"
11170 #: ../fish/guestfish-actions.pod:2195 ../src/guestfs-actions.pod:3416
11172 "This returns the minor version number of the inspected operating system."
11176 #: ../fish/guestfish-actions.pod:2200
11178 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11179 "get-major-version>."
11183 #: ../fish/guestfish-actions.pod:2203
11184 msgid "inspect-get-mountpoints"
11188 #: ../fish/guestfish-actions.pod:2205
11191 " inspect-get-mountpoints root\n"
11196 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3434
11198 "This returns a hash of where we think the filesystems associated with this "
11199 "operating system should be mounted. Callers should note that this is at "
11200 "best an educated guess made by reading configuration files such as C</etc/"
11201 "fstab>. I<In particular note> that this may return filesystems which are "
11202 "non-existent or not mountable and callers should be prepared to handle or "
11203 "ignore failures if they try to mount them."
11207 #: ../fish/guestfish-actions.pod:2216 ../src/guestfs-actions.pod:3443
11209 "Each element in the returned hashtable has a key which is the path of the "
11210 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11211 "mounted there (eg. C</dev/sda1>)."
11215 #: ../fish/guestfish-actions.pod:2221 ../src/guestfs-actions.pod:3448
11217 "Non-mounted devices such as swap devices are I<not> returned in this list."
11221 #: ../fish/guestfish-actions.pod:2224
11223 "For operating systems like Windows which still use drive letters, this call "
11224 "will only return an entry for the first drive \"mounted on\" C</>. For "
11225 "information about the mapping of drive letters to partitions, see L</inspect-"
11226 "get-drive-mappings>."
11230 #: ../fish/guestfish-actions.pod:2230
11232 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11233 "get-filesystems>."
11237 #: ../fish/guestfish-actions.pod:2233
11238 msgid "inspect-get-package-format"
11242 #: ../fish/guestfish-actions.pod:2235
11245 " inspect-get-package-format root\n"
11250 #: ../fish/guestfish-actions.pod:2237
11252 "This function and L</inspect-get-package-management> return the package "
11253 "format and package management tool used by the inspected operating system. "
11254 "For example for Fedora these functions would return C<rpm> (package format) "
11255 "and C<yum> (package management)."
11259 #: ../fish/guestfish-actions.pod:2243 ../src/guestfs-actions.pod:3480
11261 "This returns the string C<unknown> if we could not determine the package "
11262 "format I<or> if the operating system does not have a real packaging system "
11267 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3484
11269 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, "
11270 "C<pkgsrc>. Future versions of libguestfs may return other strings."
11274 #: ../fish/guestfish-actions.pod:2253
11275 msgid "inspect-get-package-management"
11279 #: ../fish/guestfish-actions.pod:2255
11282 " inspect-get-package-management root\n"
11287 #: ../fish/guestfish-actions.pod:2257
11289 "L</inspect-get-package-format> and this function return the package format "
11290 "and package management tool used by the inspected operating system. For "
11291 "example for Fedora these functions would return C<rpm> (package format) and "
11292 "C<yum> (package management)."
11296 #: ../fish/guestfish-actions.pod:2263 ../src/guestfs-actions.pod:3507
11298 "This returns the string C<unknown> if we could not determine the package "
11299 "management tool I<or> if the operating system does not have a real packaging "
11300 "system (eg. Windows)."
11304 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3511
11306 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11307 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>. Future "
11308 "versions of libguestfs may return other strings."
11312 #: ../fish/guestfish-actions.pod:2274
11313 msgid "inspect-get-product-name"
11317 #: ../fish/guestfish-actions.pod:2276
11320 " inspect-get-product-name root\n"
11325 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3529
11327 "This returns the product name of the inspected operating system. The "
11328 "product name is generally some freeform string which can be displayed to the "
11329 "user, but should not be parsed by programs."
11333 #: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3534
11335 "If the product name could not be determined, then the string C<unknown> is "
11340 #: ../fish/guestfish-actions.pod:2288
11341 msgid "inspect-get-product-variant"
11345 #: ../fish/guestfish-actions.pod:2290
11348 " inspect-get-product-variant root\n"
11353 #: ../fish/guestfish-actions.pod:2292 ../src/guestfs-actions.pod:3550
11354 msgid "This returns the product variant of the inspected operating system."
11358 #: ../fish/guestfish-actions.pod:2295 ../src/guestfs-actions.pod:3553
11360 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11361 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11362 "is usually a string such as C<Client> or C<Server> (other values are "
11363 "possible). This can be used to distinguish consumer and enterprise versions "
11364 "of Windows that have the same version number (for example, Windows 7 and "
11365 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11366 "the latter is C<Server>)."
11370 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3562
11372 "For enterprise Linux guests, in future we intend this to return the product "
11373 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11374 "implemented at present."
11378 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3566
11380 "If the product variant could not be determined, then the string C<unknown> "
11385 #: ../fish/guestfish-actions.pod:2311
11387 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11388 "get-product-name>, L</inspect-get-major-version>."
11392 #: ../fish/guestfish-actions.pod:2315
11393 msgid "inspect-get-roots"
11397 #: ../fish/guestfish-actions.pod:2317
11400 " inspect-get-roots\n"
11405 #: ../fish/guestfish-actions.pod:2319
11407 "This function is a convenient way to get the list of root devices, as "
11408 "returned from a previous call to L</inspect-os>, but without redoing the "
11409 "whole inspection process."
11413 #: ../fish/guestfish-actions.pod:2323
11415 "This returns an empty list if either no root devices were found or the "
11416 "caller has not called L</inspect-os>."
11420 #: ../fish/guestfish-actions.pod:2328
11421 msgid "inspect-get-type"
11425 #: ../fish/guestfish-actions.pod:2330
11428 " inspect-get-type root\n"
11433 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3604
11435 "This returns the type of the inspected operating system. Currently defined "
11440 #: ../fish/guestfish-actions.pod:2337 ../src/guestfs-actions.pod:3609
11445 #: ../fish/guestfish-actions.pod:2339 ../src/guestfs-actions.pod:3611
11446 msgid "Any Linux-based operating system."
11450 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3615
11451 msgid "Any Microsoft Windows operating system."
11455 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3617
11456 msgid "\"freebsd\""
11460 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3619
11465 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3621
11470 #: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3623
11475 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3627
11476 msgid "The operating system type could not be determined."
11480 #: ../fish/guestfish-actions.pod:2364
11481 msgid "inspect-get-windows-current-control-set"
11485 #: ../fish/guestfish-actions.pod:2366
11488 " inspect-get-windows-current-control-set root\n"
11493 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3647
11495 "This returns the Windows CurrentControlSet of the inspected guest. The "
11496 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11500 #: ../fish/guestfish-actions.pod:2371 ../src/guestfs-actions.pod:3650
11502 "This call assumes that the guest is Windows and that the Registry could be "
11503 "examined by inspection. If this is not the case then an error is returned."
11507 #: ../fish/guestfish-actions.pod:2377
11508 msgid "inspect-get-windows-systemroot"
11512 #: ../fish/guestfish-actions.pod:2379
11515 " inspect-get-windows-systemroot root\n"
11520 #: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3667
11522 "This returns the Windows systemroot of the inspected guest. The systemroot "
11523 "is a directory path such as C</WINDOWS>."
11527 #: ../fish/guestfish-actions.pod:2384 ../src/guestfs-actions.pod:3670
11529 "This call assumes that the guest is Windows and that the systemroot could be "
11530 "determined by inspection. If this is not the case then an error is returned."
11534 #: ../fish/guestfish-actions.pod:2390
11535 msgid "inspect-is-live"
11539 #: ../fish/guestfish-actions.pod:2392
11542 " inspect-is-live root\n"
11547 #: ../fish/guestfish-actions.pod:2394
11549 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11550 "then this returns true if a live image was detected on the disk."
11554 #: ../fish/guestfish-actions.pod:2400
11555 msgid "inspect-is-multipart"
11559 #: ../fish/guestfish-actions.pod:2402
11562 " inspect-is-multipart root\n"
11567 #: ../fish/guestfish-actions.pod:2404
11569 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11570 "then this returns true if the disk is part of a set."
11574 #: ../fish/guestfish-actions.pod:2410
11575 msgid "inspect-is-netinst"
11579 #: ../fish/guestfish-actions.pod:2412
11582 " inspect-is-netinst root\n"
11587 #: ../fish/guestfish-actions.pod:2414
11589 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11590 "then this returns true if the disk is a network installer, ie. not a self-"
11591 "contained install CD but one which is likely to require network access to "
11592 "complete the install."
11596 #: ../fish/guestfish-actions.pod:2422
11597 msgid "inspect-list-applications"
11601 #: ../fish/guestfish-actions.pod:2424
11604 " inspect-list-applications root\n"
11609 #: ../fish/guestfish-actions.pod:2426 ../src/guestfs-actions.pod:3737
11610 msgid "Return the list of applications installed in the operating system."
11614 #: ../fish/guestfish-actions.pod:2428
11616 "I<Note:> This call works differently from other parts of the inspection "
11617 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
11618 "then mount up the disks, before calling this. Listing applications is a "
11619 "significantly more difficult operation which requires access to the full "
11620 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
11621 "are just returning data cached in the libguestfs handle, this call actually "
11622 "reads parts of the mounted filesystems during the call."
11626 #: ../fish/guestfish-actions.pod:2438 ../src/guestfs-actions.pod:3749
11628 "This returns an empty list if the inspection code was not able to determine "
11629 "the list of applications."
11633 #: ../fish/guestfish-actions.pod:2441 ../src/guestfs-actions.pod:3752
11634 msgid "The application structure contains the following fields:"
11638 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3756
11639 msgid "C<app_name>"
11643 #: ../fish/guestfish-actions.pod:2447 ../src/guestfs-actions.pod:3758
11645 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11646 "guests, this is the package name."
11650 #: ../fish/guestfish-actions.pod:2450 ../src/guestfs-actions.pod:3761
11651 msgid "C<app_display_name>"
11655 #: ../fish/guestfish-actions.pod:2452 ../src/guestfs-actions.pod:3763
11657 "The display name of the application, sometimes localized to the install "
11658 "language of the guest operating system."
11662 #: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3766
11664 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11665 "to display something can use C<app_name> instead."
11669 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3769
11670 msgid "C<app_epoch>"
11674 #: ../fish/guestfish-actions.pod:2460 ../src/guestfs-actions.pod:3771
11676 "For package managers which use epochs, this contains the epoch of the "
11677 "package (an integer). If unavailable, this is returned as C<0>."
11681 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3774
11682 msgid "C<app_version>"
11686 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3776
11688 "The version string of the application or package. If unavailable this is "
11689 "returned as an empty string C<\"\">."
11693 #: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3779
11694 msgid "C<app_release>"
11698 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3781
11700 "The release string of the application or package, for package managers that "
11701 "use this. If unavailable this is returned as an empty string C<\"\">."
11705 #: ../fish/guestfish-actions.pod:2474 ../src/guestfs-actions.pod:3785
11706 msgid "C<app_install_path>"
11710 #: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3787
11712 "The installation path of the application (on operating systems such as "
11713 "Windows which use installation paths). This path is in the format used by "
11714 "the guest operating system, it is not a libguestfs path."
11718 #: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3792
11719 msgid "If unavailable this is returned as an empty string C<\"\">."
11723 #: ../fish/guestfish-actions.pod:2483 ../src/guestfs-actions.pod:3794
11724 msgid "C<app_trans_path>"
11728 #: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3796
11730 "The install path translated into a libguestfs path. If unavailable this is "
11731 "returned as an empty string C<\"\">."
11735 #: ../fish/guestfish-actions.pod:2488 ../src/guestfs-actions.pod:3799
11736 msgid "C<app_publisher>"
11740 #: ../fish/guestfish-actions.pod:2490 ../src/guestfs-actions.pod:3801
11742 "The name of the publisher of the application, for package managers that use "
11743 "this. If unavailable this is returned as an empty string C<\"\">."
11747 #: ../fish/guestfish-actions.pod:2494 ../src/guestfs-actions.pod:3805
11752 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3807
11754 "The URL (eg. upstream URL) of the application. If unavailable this is "
11755 "returned as an empty string C<\"\">."
11759 #: ../fish/guestfish-actions.pod:2499 ../src/guestfs-actions.pod:3810
11760 msgid "C<app_source_package>"
11764 #: ../fish/guestfish-actions.pod:2501 ../src/guestfs-actions.pod:3812
11766 "For packaging systems which support this, the name of the source package. "
11767 "If unavailable this is returned as an empty string C<\"\">."
11771 #: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3815
11772 msgid "C<app_summary>"
11776 #: ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:3817
11778 "A short (usually one line) description of the application or package. If "
11779 "unavailable this is returned as an empty string C<\"\">."
11783 #: ../fish/guestfish-actions.pod:2509 ../src/guestfs-actions.pod:3820
11784 msgid "C<app_description>"
11788 #: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3822
11790 "A longer description of the application or package. If unavailable this is "
11791 "returned as an empty string C<\"\">."
11795 #: ../fish/guestfish-actions.pod:2518
11800 #: ../fish/guestfish-actions.pod:2520
11808 #: ../fish/guestfish-actions.pod:2522 ../src/guestfs-actions.pod:3840
11810 "This function uses other libguestfs functions and certain heuristics to "
11811 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11812 "for operating systems."
11816 #: ../fish/guestfish-actions.pod:2526 ../src/guestfs-actions.pod:3844
11817 msgid "The list returned is empty if no operating systems were found."
11821 #: ../fish/guestfish-actions.pod:2528 ../src/guestfs-actions.pod:3846
11823 "If one operating system was found, then this returns a list with a single "
11824 "element, which is the name of the root filesystem of this operating system. "
11825 "It is also possible for this function to return a list containing more than "
11826 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11827 "element being the root filesystem of one of the operating systems."
11831 #: ../fish/guestfish-actions.pod:2535
11833 "You can pass the root string(s) returned to other L</inspect-get-*> "
11834 "functions in order to query further information about each operating system, "
11835 "such as the name and version."
11839 #: ../fish/guestfish-actions.pod:2540
11841 "This function uses other libguestfs features such as L</mount-ro> and L</"
11842 "umount-all> in order to mount and unmount filesystems and look at the "
11843 "contents. This should be called with no disks currently mounted. The "
11844 "function may also use Augeas, so any existing Augeas handle will be closed."
11848 #: ../fish/guestfish-actions.pod:2546 ../src/guestfs-actions.pod:3864
11850 "This function cannot decrypt encrypted disks. The caller must do that first "
11851 "(supplying the necessary keys) if the disk is encrypted."
11855 #: ../fish/guestfish-actions.pod:2552 ../fish/guestfish-actions.pod:2750
11856 #: ../fish/guestfish-actions.pod:2809
11857 msgid "See also L</list-filesystems>."
11861 #: ../fish/guestfish-actions.pod:2554
11862 msgid "is-blockdev"
11866 #: ../fish/guestfish-actions.pod:2556
11869 " is-blockdev path\n"
11874 #: ../fish/guestfish-actions.pod:2558 ../src/guestfs-actions.pod:3884
11876 "This returns C<true> if and only if there is a block device with the given "
11881 #: ../fish/guestfish-actions.pod:2561 ../fish/guestfish-actions.pod:2579
11882 #: ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:2607
11883 #: ../fish/guestfish-actions.pod:2617 ../fish/guestfish-actions.pod:2651
11884 #: ../fish/guestfish-actions.pod:2660
11885 msgid "See also L</stat>."
11889 #: ../fish/guestfish-actions.pod:2563
11894 #: ../fish/guestfish-actions.pod:2565
11902 #: ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:3898
11904 "This returns true iff this handle is busy processing a command (in the "
11909 #: ../fish/guestfish-actions.pod:2572
11914 #: ../fish/guestfish-actions.pod:2574
11917 " is-chardev path\n"
11922 #: ../fish/guestfish-actions.pod:2576 ../src/guestfs-actions.pod:3913
11924 "This returns C<true> if and only if there is a character device with the "
11925 "given C<path> name."
11929 #: ../fish/guestfish-actions.pod:2581
11934 #: ../fish/guestfish-actions.pod:2583
11942 #: ../fish/guestfish-actions.pod:2585 ../src/guestfs-actions.pod:3927
11944 "This returns true iff this handle is being configured (in the C<CONFIG> "
11949 #: ../fish/guestfish-actions.pod:2590
11954 #: ../fish/guestfish-actions.pod:2592
11962 #: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3942
11964 "This returns C<true> if and only if there is a directory with the given "
11965 "C<path> name. Note that it returns false for other objects like files."
11969 #: ../fish/guestfish-actions.pod:2600
11974 #: ../fish/guestfish-actions.pod:2602
11982 #: ../fish/guestfish-actions.pod:2604 ../src/guestfs-actions.pod:3958
11984 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11985 "given C<path> name."
11989 #: ../fish/guestfish-actions.pod:2609
11994 #: ../fish/guestfish-actions.pod:2611
12002 #: ../fish/guestfish-actions.pod:2613 ../src/guestfs-actions.pod:3973
12004 "This returns C<true> if and only if there is a regular file with the given "
12005 "C<path> name. Note that it returns false for other objects like directories."
12009 #: ../fish/guestfish-actions.pod:2619
12010 msgid "is-launching"
12014 #: ../fish/guestfish-actions.pod:2621
12022 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3988
12024 "This returns true iff this handle is launching the subprocess (in the "
12025 "C<LAUNCHING> state)."
12029 #: ../fish/guestfish-actions.pod:2628
12034 #: ../fish/guestfish-actions.pod:2630
12042 #: ../fish/guestfish-actions.pod:2632 ../src/guestfs-actions.pod:4003
12044 "This command tests whether C<device> is a logical volume, and returns true "
12045 "iff this is the case."
12049 #: ../fish/guestfish-actions.pod:2635
12054 #: ../fish/guestfish-actions.pod:2637
12062 #: ../fish/guestfish-actions.pod:2639 ../src/guestfs-actions.pod:4015
12064 "This returns true iff this handle is ready to accept commands (in the "
12069 #: ../fish/guestfish-actions.pod:2644
12074 #: ../fish/guestfish-actions.pod:2646
12077 " is-socket path\n"
12082 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:4030
12084 "This returns C<true> if and only if there is a Unix domain socket with the "
12085 "given C<path> name."
12089 #: ../fish/guestfish-actions.pod:2653
12094 #: ../fish/guestfish-actions.pod:2655
12097 " is-symlink path\n"
12102 #: ../fish/guestfish-actions.pod:2657 ../src/guestfs-actions.pod:4045
12104 "This returns C<true> if and only if there is a symbolic link with the given "
12109 #: ../fish/guestfish-actions.pod:2662
12114 #: ../fish/guestfish-actions.pod:2664
12122 #: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:4060
12124 "This returns true iff the file exists and the file is empty or it contains "
12129 #: ../fish/guestfish-actions.pod:2669
12130 msgid "is-zero-device"
12134 #: ../fish/guestfish-actions.pod:2671
12137 " is-zero-device device\n"
12142 #: ../fish/guestfish-actions.pod:2673 ../src/guestfs-actions.pod:4073
12143 msgid "This returns true iff the device exists and contains all zero bytes."
12147 #: ../fish/guestfish-actions.pod:2675 ../src/guestfs-actions.pod:4075
12148 msgid "Note that for large devices this can take a long time to run."
12152 #: ../fish/guestfish-actions.pod:2677
12153 msgid "kill-subprocess"
12157 #: ../fish/guestfish-actions.pod:2679
12160 " kill-subprocess\n"
12165 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:4086
12166 msgid "This kills the qemu subprocess. You should never need to call this."
12170 #: ../fish/guestfish-actions.pod:2683
12175 #: ../fish/guestfish-actions.pod:2685
12180 #: ../fish/guestfish-actions.pod:2687
12188 #: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:4097
12190 "Internally libguestfs is implemented by running a virtual machine using "
12195 #: ../fish/guestfish-actions.pod:2692 ../src/guestfs-actions.pod:4100
12197 "You should call this after configuring the handle (eg. adding drives) but "
12198 "before performing any actions."
12202 #: ../fish/guestfish-actions.pod:2695
12207 #: ../fish/guestfish-actions.pod:2697
12210 " lchown owner group path\n"
12215 #: ../fish/guestfish-actions.pod:2699
12217 "Change the file owner to C<owner> and group to C<group>. This is like L</"
12218 "chown> but if C<path> is a symlink then the link itself is changed, not the "
12223 #: ../fish/guestfish-actions.pod:2707
12228 #: ../fish/guestfish-actions.pod:2709
12231 " lgetxattr path name\n"
12236 #: ../fish/guestfish-actions.pod:2711 ../src/guestfs-actions.pod:4140
12238 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12239 "is a symlink, then this call returns an extended attribute from the symlink."
12243 #: ../fish/guestfish-actions.pod:2725
12244 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
12248 #: ../fish/guestfish-actions.pod:2727
12253 #: ../fish/guestfish-actions.pod:2729
12256 " lgetxattrs path\n"
12261 #: ../fish/guestfish-actions.pod:2731
12263 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
12264 "it returns the extended attributes of the link itself."
12268 #: ../fish/guestfish-actions.pod:2735
12273 #: ../fish/guestfish-actions.pod:2737
12281 #: ../fish/guestfish-actions.pod:2739 ../src/guestfs-actions.pod:4183
12283 "List all 9p filesystems attached to the guest. A list of mount tags is "
12288 #: ../fish/guestfish-actions.pod:2742
12289 msgid "list-devices"
12293 #: ../fish/guestfish-actions.pod:2744
12301 #: ../fish/guestfish-actions.pod:2746 ../src/guestfs-actions.pod:4197
12302 msgid "List all the block devices."
12306 #: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4199
12307 msgid "The full block device names are returned, eg. C</dev/sda>."
12311 #: ../fish/guestfish-actions.pod:2752
12312 msgid "list-dm-devices"
12316 #: ../fish/guestfish-actions.pod:2754
12319 " list-dm-devices\n"
12324 #: ../fish/guestfish-actions.pod:2756 ../src/guestfs-actions.pod:4214
12325 msgid "List all device mapper devices."
12329 #: ../fish/guestfish-actions.pod:2758
12331 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12332 "previous call to L</luks-open>."
12336 #: ../fish/guestfish-actions.pod:2761
12338 "Device mapper devices which correspond to logical volumes are I<not> "
12339 "returned in this list. Call L</lvs> if you want to list logical volumes."
12343 #: ../fish/guestfish-actions.pod:2765
12344 msgid "list-filesystems"
12348 #: ../fish/guestfish-actions.pod:2767
12351 " list-filesystems\n"
12356 #: ../fish/guestfish-actions.pod:2769 ../src/guestfs-actions.pod:4234
12358 "This inspection command looks for filesystems on partitions, block devices "
12359 "and logical volumes, returning a list of devices containing filesystems and "
12364 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4238
12366 "The return value is a hash, where the keys are the devices containing "
12367 "filesystems, and the values are the filesystem types. For example:"
12371 #: ../fish/guestfish-actions.pod:2777 ../src/guestfs-actions.pod:4242
12374 " \"/dev/sda1\" => \"ntfs\"\n"
12375 " \"/dev/sda2\" => \"ext2\"\n"
12376 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12377 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12382 #: ../fish/guestfish-actions.pod:2782 ../src/guestfs-actions.pod:4247
12384 "The value can have the special value \"unknown\", meaning the content of the "
12385 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12389 #: ../fish/guestfish-actions.pod:2786
12391 "This command runs other libguestfs commands, which might include L</mount> "
12392 "and L</umount>, and therefore you should use this soon after launch and only "
12393 "when nothing is mounted."
12397 #: ../fish/guestfish-actions.pod:2790
12399 "Not all of the filesystems returned will be mountable. In particular, swap "
12400 "partitions are returned in the list. Also this command does not check that "
12401 "each filesystem found is valid and mountable, and some filesystems might be "
12402 "mountable but require special options. Filesystems may not all belong to a "
12403 "single logical operating system (use L</inspect-os> to look for OSes)."
12407 #: ../fish/guestfish-actions.pod:2798
12408 msgid "list-partitions"
12412 #: ../fish/guestfish-actions.pod:2800
12415 " list-partitions\n"
12420 #: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4276
12421 msgid "List all the partitions detected on all block devices."
12425 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4278
12426 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12430 #: ../fish/guestfish-actions.pod:2806
12432 "This does not return logical volumes. For that you will need to call L</"
12437 #: ../fish/guestfish-actions.pod:2811
12442 #: ../fish/guestfish-actions.pod:2813
12450 #: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4297
12452 "List the files in C<directory> (relative to the root directory, there is no "
12453 "cwd) in the format of 'ls -la'."
12457 #: ../fish/guestfish-actions.pod:2818 ../src/guestfs-actions.pod:4300
12459 "This command is mostly useful for interactive sessions. It is I<not> "
12460 "intended that you try to parse the output string."
12464 #: ../fish/guestfish-actions.pod:2821
12469 #: ../fish/guestfish-actions.pod:2823
12472 " ln target linkname\n"
12477 #: ../fish/guestfish-actions.pod:2825 ../src/guestfs-actions.pod:4315
12478 msgid "This command creates a hard link using the C<ln> command."
12482 #: ../fish/guestfish-actions.pod:2827
12487 #: ../fish/guestfish-actions.pod:2829
12490 " ln-f target linkname\n"
12495 #: ../fish/guestfish-actions.pod:2831 ../src/guestfs-actions.pod:4328
12497 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12498 "option removes the link (C<linkname>) if it exists already."
12502 #: ../fish/guestfish-actions.pod:2834
12507 #: ../fish/guestfish-actions.pod:2836
12510 " ln-s target linkname\n"
12515 #: ../fish/guestfish-actions.pod:2838 ../src/guestfs-actions.pod:4342
12516 msgid "This command creates a symbolic link using the C<ln -s> command."
12520 #: ../fish/guestfish-actions.pod:2840
12525 #: ../fish/guestfish-actions.pod:2842
12528 " ln-sf target linkname\n"
12533 #: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4355
12535 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12536 "option removes the link (C<linkname>) if it exists already."
12540 #: ../fish/guestfish-actions.pod:2847
12541 msgid "lremovexattr"
12545 #: ../fish/guestfish-actions.pod:2849
12548 " lremovexattr xattr path\n"
12553 #: ../fish/guestfish-actions.pod:2851
12555 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
12556 "it removes an extended attribute of the link itself."
12560 #: ../fish/guestfish-actions.pod:2855
12565 #: ../fish/guestfish-actions.pod:2857
12573 #: ../fish/guestfish-actions.pod:2859 ../src/guestfs-actions.pod:4383
12575 "List the files in C<directory> (relative to the root directory, there is no "
12576 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12580 #: ../fish/guestfish-actions.pod:2863
12582 "This command is mostly useful for interactive sessions. Programs should "
12583 "probably use L</readdir> instead."
12587 #: ../fish/guestfish-actions.pod:2866
12592 #: ../fish/guestfish-actions.pod:2868
12595 " lsetxattr xattr val vallen path\n"
12600 #: ../fish/guestfish-actions.pod:2870
12602 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
12603 "sets an extended attribute of the link itself."
12607 #: ../fish/guestfish-actions.pod:2874
12612 #: ../fish/guestfish-actions.pod:2876
12620 #: ../fish/guestfish-actions.pod:2878 ../fish/guestfish-actions.pod:4678
12621 #: ../src/guestfs-actions.pod:4419 ../src/guestfs-actions.pod:7200
12622 msgid "Returns file information for the given C<path>."
12626 #: ../fish/guestfish-actions.pod:2880
12628 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
12629 "the link is stat-ed, not the file it refers to."
12633 #: ../fish/guestfish-actions.pod:2884 ../src/guestfs-actions.pod:4425
12634 msgid "This is the same as the C<lstat(2)> system call."
12638 #: ../fish/guestfish-actions.pod:2886
12643 #: ../fish/guestfish-actions.pod:2888
12646 " lstatlist path 'names ...'\n"
12651 #: ../fish/guestfish-actions.pod:2890
12653 "This call allows you to perform the L</lstat> operation on multiple files, "
12654 "where all files are in the directory C<path>. C<names> is the list of files "
12655 "from this directory."
12659 #: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4444
12661 "On return you get a list of stat structs, with a one-to-one correspondence "
12662 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12663 "then the C<ino> field of that structure is set to C<-1>."
12667 #: ../fish/guestfish-actions.pod:2899
12669 "This call is intended for programs that want to efficiently list a directory "
12670 "contents without making many round-trips. See also L</lxattrlist> for a "
12671 "similarly efficient call for getting extended attributes. Very long "
12672 "directory listings might cause the protocol message size to be exceeded, "
12673 "causing this call to fail. The caller must split up such requests into "
12674 "smaller groups of names."
12678 #: ../fish/guestfish-actions.pod:2907
12679 msgid "luks-add-key"
12683 #: ../fish/guestfish-actions.pod:2909
12686 " luks-add-key device keyslot\n"
12691 #: ../fish/guestfish-actions.pod:2911 ../src/guestfs-actions.pod:4472
12693 "This command adds a new key on LUKS device C<device>. C<key> is any "
12694 "existing key, and is used to access the device. C<newkey> is the new key to "
12695 "add. C<keyslot> is the key slot that will be replaced."
12699 #: ../fish/guestfish-actions.pod:2916
12701 "Note that if C<keyslot> already contains a key, then this command will "
12702 "fail. You have to use L</luks-kill-slot> first to remove that key."
12706 #: ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2942
12707 #: ../fish/guestfish-actions.pod:2952 ../fish/guestfish-actions.pod:2963
12708 #: ../fish/guestfish-actions.pod:2989 ../fish/guestfish-actions.pod:2999
12710 "This command has one or more key or passphrase parameters. Guestfish will "
12711 "prompt for these separately."
12715 #: ../fish/guestfish-actions.pod:2923
12720 #: ../fish/guestfish-actions.pod:2925
12723 " luks-close device\n"
12728 #: ../fish/guestfish-actions.pod:2927
12730 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
12731 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
12732 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
12737 #: ../fish/guestfish-actions.pod:2933
12738 msgid "luks-format"
12742 #: ../fish/guestfish-actions.pod:2935
12745 " luks-format device keyslot\n"
12750 #: ../fish/guestfish-actions.pod:2937 ../src/guestfs-actions.pod:4513
12752 "This command erases existing data on C<device> and formats the device as a "
12753 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12754 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12758 #: ../fish/guestfish-actions.pod:2945
12759 msgid "luks-format-cipher"
12763 #: ../fish/guestfish-actions.pod:2947
12766 " luks-format-cipher device keyslot cipher\n"
12771 #: ../fish/guestfish-actions.pod:2949
12773 "This command is the same as L</luks-format> but it also allows you to set "
12774 "the C<cipher> used."
12778 #: ../fish/guestfish-actions.pod:2955
12779 msgid "luks-kill-slot"
12783 #: ../fish/guestfish-actions.pod:2957
12786 " luks-kill-slot device keyslot\n"
12791 #: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4554
12793 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12794 "device C<device>. C<key> must be one of the I<other> keys."
12798 #: ../fish/guestfish-actions.pod:2966
12803 #: ../fish/guestfish-actions.pod:2968
12806 " luks-open device mapname\n"
12811 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4574
12813 "This command opens a block device which has been encrypted according to the "
12814 "Linux Unified Key Setup (LUKS) standard."
12818 #: ../fish/guestfish-actions.pod:2973 ../src/guestfs-actions.pod:4577
12819 msgid "C<device> is the encrypted block device or partition."
12823 #: ../fish/guestfish-actions.pod:2975 ../src/guestfs-actions.pod:4579
12825 "The caller must supply one of the keys associated with the LUKS block "
12826 "device, in the C<key> parameter."
12830 #: ../fish/guestfish-actions.pod:2978 ../src/guestfs-actions.pod:4582
12832 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12833 "writes to this block device are decrypted from and encrypted to the "
12834 "underlying C<device> respectively."
12838 #: ../fish/guestfish-actions.pod:2982
12840 "If this block device contains LVM volume groups, then calling L</vgscan> "
12841 "followed by L</vg-activate-all> will make them visible."
12845 #: ../fish/guestfish-actions.pod:2986
12846 msgid "Use L</list-dm-devices> to list all device mapper devices."
12850 #: ../fish/guestfish-actions.pod:2992
12851 msgid "luks-open-ro"
12855 #: ../fish/guestfish-actions.pod:2994
12858 " luks-open-ro device mapname\n"
12863 #: ../fish/guestfish-actions.pod:2996
12865 "This is the same as L</luks-open> except that a read-only mapping is created."
12869 #: ../fish/guestfish-actions.pod:3002
12874 #: ../fish/guestfish-actions.pod:3004
12877 " lvcreate logvol volgroup mbytes\n"
12882 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4628
12884 "This creates an LVM logical volume called C<logvol> on the volume group "
12885 "C<volgroup>, with C<size> megabytes."
12889 #: ../fish/guestfish-actions.pod:3009
12890 msgid "lvm-canonical-lv-name"
12894 #: ../fish/guestfish-actions.pod:3011
12897 " lvm-canonical-lv-name lvname\n"
12902 #: ../fish/guestfish-actions.pod:3013 ../src/guestfs-actions.pod:4641
12904 "This converts alternative naming schemes for LVs that you might find to the "
12905 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
12910 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4645
12912 "This command returns an error if the C<lvname> parameter does not refer to a "
12917 #: ../fish/guestfish-actions.pod:3020
12918 msgid "See also L</is-lv>."
12922 #: ../fish/guestfish-actions.pod:3022
12923 msgid "lvm-clear-filter"
12927 #: ../fish/guestfish-actions.pod:3024
12930 " lvm-clear-filter\n"
12935 #: ../fish/guestfish-actions.pod:3026
12937 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
12942 #: ../fish/guestfish-actions.pod:3029 ../fish/guestfish-actions.pod:3057
12943 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4702
12945 "This command also clears the LVM cache and performs a volume group scan."
12949 #: ../fish/guestfish-actions.pod:3032
12950 msgid "lvm-remove-all"
12954 #: ../fish/guestfish-actions.pod:3034
12957 " lvm-remove-all\n"
12962 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4675
12964 "This command removes all LVM logical volumes, volume groups and physical "
12969 #: ../fish/guestfish-actions.pod:3039
12970 msgid "lvm-set-filter"
12974 #: ../fish/guestfish-actions.pod:3041
12977 " lvm-set-filter 'devices ...'\n"
12982 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4688
12984 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12985 "block devices in the list C<devices>, and will ignore all other attached "
12990 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4692
12992 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12993 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12994 "there are two types of duplication possible: either cloned PVs/VGs which "
12995 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12996 "same name. In normal operation you cannot create this situation, but you "
12997 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12998 "inside the LVM metadata."
13002 #: ../fish/guestfish-actions.pod:3060 ../src/guestfs-actions.pod:4705
13003 msgid "You can filter whole block devices or individual partitions."
13007 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4707
13009 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13010 "filesystem), even if you are not filtering out that VG."
13014 #: ../fish/guestfish-actions.pod:3066
13019 #: ../fish/guestfish-actions.pod:3068
13022 " lvremove device\n"
13027 #: ../fish/guestfish-actions.pod:3070 ../src/guestfs-actions.pod:4721
13029 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13030 "LV, such as C</dev/VG/LV>."
13034 #: ../fish/guestfish-actions.pod:3073 ../src/guestfs-actions.pod:4724
13036 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13041 #: ../fish/guestfish-actions.pod:3076
13046 #: ../fish/guestfish-actions.pod:3078
13049 " lvrename logvol newlogvol\n"
13054 #: ../fish/guestfish-actions.pod:3080 ../src/guestfs-actions.pod:4738
13055 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13059 #: ../fish/guestfish-actions.pod:3082
13064 #: ../fish/guestfish-actions.pod:3084
13067 " lvresize device mbytes\n"
13072 #: ../fish/guestfish-actions.pod:3086 ../src/guestfs-actions.pod:4751
13074 "This resizes (expands or shrinks) an existing LVM logical volume to "
13075 "C<mbytes>. When reducing, data in the reduced part is lost."
13079 #: ../fish/guestfish-actions.pod:3090
13080 msgid "lvresize-free"
13084 #: ../fish/guestfish-actions.pod:3092
13087 " lvresize-free lv percent\n"
13092 #: ../fish/guestfish-actions.pod:3094 ../src/guestfs-actions.pod:4766
13094 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13095 "remaining free space in the volume group. Commonly you would call this with "
13096 "pc = 100 which expands the logical volume as much as possible, using all "
13097 "remaining free space in the volume group."
13101 #: ../fish/guestfish-actions.pod:3100
13106 #: ../fish/guestfish-actions.pod:3102
13114 #: ../fish/guestfish-actions.pod:3104 ../src/guestfs-actions.pod:4781
13116 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13121 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4784
13123 "This returns a list of the logical volume device names (eg. C</dev/"
13124 "VolGroup00/LogVol00>)."
13128 #: ../fish/guestfish-actions.pod:3110
13129 msgid "See also L</lvs-full>, L</list-filesystems>."
13133 #: ../fish/guestfish-actions.pod:3112
13138 #: ../fish/guestfish-actions.pod:3114
13146 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4800
13148 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13149 "(8)> command. The \"full\" version includes all fields."
13153 #: ../fish/guestfish-actions.pod:3119
13158 #: ../fish/guestfish-actions.pod:3121
13166 #: ../fish/guestfish-actions.pod:3123 ../src/guestfs-actions.pod:4815
13167 msgid "This command returns the UUID of the LVM LV C<device>."
13171 #: ../fish/guestfish-actions.pod:3125
13176 #: ../fish/guestfish-actions.pod:3127
13179 " lxattrlist path 'names ...'\n"
13184 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4829
13186 "This call allows you to get the extended attributes of multiple files, where "
13187 "all files are in the directory C<path>. C<names> is the list of files from "
13192 #: ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4833
13194 "On return you get a flat list of xattr structs which must be interpreted "
13195 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13196 "C<attrval> in this struct is zero-length to indicate there was an error "
13197 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13198 "number (the number of following attributes for this file, which could be C<"
13199 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13200 "for the first named file. This repeats for the second and subsequent files."
13204 #: ../fish/guestfish-actions.pod:3143
13206 "This call is intended for programs that want to efficiently list a directory "
13207 "contents without making many round-trips. See also L</lstatlist> for a "
13208 "similarly efficient call for getting standard stats. Very long directory "
13209 "listings might cause the protocol message size to be exceeded, causing this "
13210 "call to fail. The caller must split up such requests into smaller groups of "
13215 #: ../fish/guestfish-actions.pod:3151
13220 #: ../fish/guestfish-actions.pod:3153
13228 #: ../fish/guestfish-actions.pod:3155 ../src/guestfs-actions.pod:4863
13229 msgid "Create a directory named C<path>."
13233 #: ../fish/guestfish-actions.pod:3157
13238 #: ../fish/guestfish-actions.pod:3159
13241 " mkdir-mode path mode\n"
13246 #: ../fish/guestfish-actions.pod:3161 ../src/guestfs-actions.pod:4876
13248 "This command creates a directory, setting the initial permissions of the "
13249 "directory to C<mode>."
13253 #: ../fish/guestfish-actions.pod:3164 ../src/guestfs-actions.pod:4879
13255 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13256 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13261 #: ../fish/guestfish-actions.pod:3168
13262 msgid "See also L</mkdir>, L</umask>"
13266 #: ../fish/guestfish-actions.pod:3170
13271 #: ../fish/guestfish-actions.pod:3172
13279 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4895
13281 "Create a directory named C<path>, creating any parent directories as "
13282 "necessary. This is like the C<mkdir -p> shell command."
13286 #: ../fish/guestfish-actions.pod:3177
13291 #: ../fish/guestfish-actions.pod:3179
13294 " mkdtemp template\n"
13299 #: ../fish/guestfish-actions.pod:3181 ../src/guestfs-actions.pod:4908
13301 "This command creates a temporary directory. The C<template> parameter "
13302 "should be a full pathname for the temporary directory name with the final "
13303 "six characters being \"XXXXXX\"."
13307 #: ../fish/guestfish-actions.pod:3186 ../src/guestfs-actions.pod:4913
13309 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13310 "being suitable for Windows filesystems."
13314 #: ../fish/guestfish-actions.pod:3189 ../src/guestfs-actions.pod:4916
13315 msgid "The name of the temporary directory that was created is returned."
13319 #: ../fish/guestfish-actions.pod:3192 ../src/guestfs-actions.pod:4919
13320 msgid "The temporary directory is created with mode 0700 and is owned by root."
13324 #: ../fish/guestfish-actions.pod:3195 ../src/guestfs-actions.pod:4922
13326 "The caller is responsible for deleting the temporary directory and its "
13327 "contents after use."
13331 #: ../fish/guestfish-actions.pod:3198 ../src/guestfs-actions.pod:4925
13332 msgid "See also: L<mkdtemp(3)>"
13336 #: ../fish/guestfish-actions.pod:3200
13341 #: ../fish/guestfish-actions.pod:3202
13344 " mke2fs-J fstype blocksize device journal\n"
13349 #: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4941
13351 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13352 "C<journal>. It is equivalent to the command:"
13356 #: ../fish/guestfish-actions.pod:3208 ../src/guestfs-actions.pod:4945
13359 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13364 #: ../fish/guestfish-actions.pod:3210
13365 msgid "See also L</mke2journal>."
13369 #: ../fish/guestfish-actions.pod:3212
13374 #: ../fish/guestfish-actions.pod:3214
13377 " mke2fs-JL fstype blocksize device label\n"
13382 #: ../fish/guestfish-actions.pod:3216 ../src/guestfs-actions.pod:4962
13384 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13385 "the journal labeled C<label>."
13389 #: ../fish/guestfish-actions.pod:3219
13390 msgid "See also L</mke2journal-L>."
13394 #: ../fish/guestfish-actions.pod:3221
13399 #: ../fish/guestfish-actions.pod:3223
13402 " mke2fs-JU fstype blocksize device uuid\n"
13407 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4980
13409 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13410 "the journal with UUID C<uuid>."
13414 #: ../fish/guestfish-actions.pod:3228
13415 msgid "See also L</mke2journal-U>."
13419 #: ../fish/guestfish-actions.pod:3230
13420 msgid "mke2journal"
13424 #: ../fish/guestfish-actions.pod:3232
13427 " mke2journal blocksize device\n"
13432 #: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4996
13434 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13439 #: ../fish/guestfish-actions.pod:3237 ../src/guestfs-actions.pod:4999
13442 " mke2fs -O journal_dev -b blocksize device\n"
13447 #: ../fish/guestfish-actions.pod:3239
13448 msgid "mke2journal-L"
13452 #: ../fish/guestfish-actions.pod:3241
13455 " mke2journal-L blocksize label device\n"
13460 #: ../fish/guestfish-actions.pod:3243 ../src/guestfs-actions.pod:5013
13461 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13465 #: ../fish/guestfish-actions.pod:3245
13466 msgid "mke2journal-U"
13470 #: ../fish/guestfish-actions.pod:3247
13473 " mke2journal-U blocksize uuid device\n"
13478 #: ../fish/guestfish-actions.pod:3249 ../src/guestfs-actions.pod:5027
13479 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13483 #: ../fish/guestfish-actions.pod:3251
13488 #: ../fish/guestfish-actions.pod:3253
13491 " mkfifo mode path\n"
13496 #: ../fish/guestfish-actions.pod:3255
13498 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13499 "is just a convenient wrapper around L</mknod>."
13503 #: ../fish/guestfish-actions.pod:3261
13508 #: ../fish/guestfish-actions.pod:3263
13511 " mkfs fstype device\n"
13516 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:5057
13518 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13519 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13523 #: ../fish/guestfish-actions.pod:3269
13528 #: ../fish/guestfish-actions.pod:3271
13531 " mkfs-b fstype blocksize device\n"
13536 #: ../fish/guestfish-actions.pod:3273
13538 "This call is similar to L</mkfs>, but it allows you to control the block "
13539 "size of the resulting filesystem. Supported block sizes depend on the "
13540 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13544 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3305
13545 #: ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5123
13547 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13552 #: ../fish/guestfish-actions.pod:3281
13554 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
13559 #: ../fish/guestfish-actions.pod:3288
13564 #: ../fish/guestfish-actions.pod:3290
13567 " mkfs-opts fstype device [blocksize:N] [features:..] [inode:N] [sectorsize:N]\n"
13572 #: ../fish/guestfish-actions.pod:3292 ../src/guestfs-actions.pod:5110
13574 "This function creates a filesystem on C<device>. The filesystem type is "
13575 "C<fstype>, for example C<ext3>."
13579 #: ../fish/guestfish-actions.pod:3299 ../src/guestfs-actions.pod:5117
13580 msgid "C<blocksize>"
13584 #: ../fish/guestfish-actions.pod:3301 ../src/guestfs-actions.pod:5119
13586 "The filesystem block size. Supported block sizes depend on the filesystem "
13587 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13592 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:5126
13593 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13597 #: ../fish/guestfish-actions.pod:3310 ../src/guestfs-actions.pod:5128
13598 msgid "C<features>"
13602 #: ../fish/guestfish-actions.pod:3312 ../src/guestfs-actions.pod:5130
13603 msgid "This passes the I<-O> parameter to the external mkfs program."
13607 #: ../fish/guestfish-actions.pod:3314 ../src/guestfs-actions.pod:5132
13609 "For certain filesystem types, this allows extra filesystem features to be "
13610 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13614 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5136
13616 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13621 #: ../fish/guestfish-actions.pod:3321 ../src/guestfs-actions.pod:5139
13626 #: ../fish/guestfish-actions.pod:3323 ../src/guestfs-actions.pod:5141
13628 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
13629 "sets the inode size (only for ext2/3/4 filesystems at present)."
13633 #: ../fish/guestfish-actions.pod:3326 ../src/guestfs-actions.pod:5144
13634 msgid "C<sectorsize>"
13638 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5146
13640 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
13641 "sets sector size for ufs filesystem."
13645 #: ../fish/guestfish-actions.pod:3335
13646 msgid "mkmountpoint"
13650 #: ../fish/guestfish-actions.pod:3337
13653 " mkmountpoint exemptpath\n"
13658 #: ../fish/guestfish-actions.pod:3339
13660 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
13661 "to create extra mountpoints before mounting the first filesystem."
13665 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5189
13667 "These calls are I<only> necessary in some very limited circumstances, mainly "
13668 "the case where you want to mount a mix of unrelated and/or read-only "
13669 "filesystems together."
13673 #: ../fish/guestfish-actions.pod:3347 ../src/guestfs-actions.pod:5193
13675 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13676 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13677 "inside that. You can unpack this as follows in guestfish:"
13681 #: ../fish/guestfish-actions.pod:3352 ../src/guestfs-actions.pod:5198
13684 " add-ro Fedora-11-i686-Live.iso\n"
13686 " mkmountpoint /cd\n"
13687 " mkmountpoint /sqsh\n"
13688 " mkmountpoint /ext3fs\n"
13689 " mount /dev/sda /cd\n"
13690 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13691 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13696 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5207
13697 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13701 #: ../fish/guestfish-actions.pod:3363
13703 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
13704 "unexpected errors if you try to mix these calls. It is safest to manually "
13705 "unmount filesystems and remove mountpoints after use."
13709 #: ../fish/guestfish-actions.pod:3367
13711 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
13712 "for this to work for manual mountpoints, you must ensure that the innermost "
13713 "mountpoints have the longest pathnames, as in the example code above."
13717 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5218
13719 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13723 #: ../fish/guestfish-actions.pod:3374
13725 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
13726 "L</umount-all> to be called when the handle is closed which can also trigger "
13731 #: ../fish/guestfish-actions.pod:3378
13736 #: ../fish/guestfish-actions.pod:3380
13739 " mknod mode devmajor devminor path\n"
13744 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5237
13746 "This call creates block or character special devices, or named pipes (FIFOs)."
13750 #: ../fish/guestfish-actions.pod:3385 ../src/guestfs-actions.pod:5240
13752 "The C<mode> parameter should be the mode, using the standard constants. "
13753 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13754 "used when creating block and character special devices."
13758 #: ../fish/guestfish-actions.pod:3390
13760 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13761 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13762 "regular file). These constants are available in the standard Linux header "
13763 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
13764 "wrappers around this command which bitwise OR in the appropriate constant "
13769 #: ../fish/guestfish-actions.pod:3400
13774 #: ../fish/guestfish-actions.pod:3402
13777 " mknod-b mode devmajor devminor path\n"
13782 #: ../fish/guestfish-actions.pod:3404
13784 "This call creates a block device node called C<path> with mode C<mode> and "
13785 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13786 "wrapper around L</mknod>."
13790 #: ../fish/guestfish-actions.pod:3410
13795 #: ../fish/guestfish-actions.pod:3412
13798 " mknod-c mode devmajor devminor path\n"
13803 #: ../fish/guestfish-actions.pod:3414
13805 "This call creates a char device node called C<path> with mode C<mode> and "
13806 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13807 "wrapper around L</mknod>."
13811 #: ../fish/guestfish-actions.pod:3420
13816 #: ../fish/guestfish-actions.pod:3422
13824 #: ../fish/guestfish-actions.pod:3424 ../src/guestfs-actions.pod:5303
13825 msgid "Create a swap partition on C<device>."
13829 #: ../fish/guestfish-actions.pod:3426
13834 #: ../fish/guestfish-actions.pod:3428
13837 " mkswap-L label device\n"
13842 #: ../fish/guestfish-actions.pod:3430 ../src/guestfs-actions.pod:5316
13843 msgid "Create a swap partition on C<device> with label C<label>."
13847 #: ../fish/guestfish-actions.pod:3432 ../src/guestfs-actions.pod:5318
13849 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
13850 "sda>), just to a partition. This appears to be a limitation of the kernel "
13855 #: ../fish/guestfish-actions.pod:3436
13860 #: ../fish/guestfish-actions.pod:3438
13863 " mkswap-U uuid device\n"
13868 #: ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5333
13869 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13873 #: ../fish/guestfish-actions.pod:3442
13874 msgid "mkswap-file"
13878 #: ../fish/guestfish-actions.pod:3444
13881 " mkswap-file path\n"
13886 #: ../fish/guestfish-actions.pod:3446 ../src/guestfs-actions.pod:5345
13887 msgid "Create a swap file."
13891 #: ../fish/guestfish-actions.pod:3448
13893 "This command just writes a swap file signature to an existing file. To "
13894 "create the file itself, use something like L</fallocate>."
13898 #: ../fish/guestfish-actions.pod:3451
13903 #: ../fish/guestfish-actions.pod:3453
13906 " modprobe modulename\n"
13911 #: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5360
13912 msgid "This loads a kernel module in the appliance."
13916 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5362
13918 "The kernel module must have been whitelisted when libguestfs was built (see "
13919 "C<appliance/kmod.whitelist.in> in the source)."
13923 #: ../fish/guestfish-actions.pod:3460
13928 #: ../fish/guestfish-actions.pod:3462
13931 " mount device mountpoint\n"
13936 #: ../fish/guestfish-actions.pod:3464 ../src/guestfs-actions.pod:5376
13938 "Mount a guest disk at a position in the filesystem. Block devices are named "
13939 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13940 "those block devices contain partitions, they will have the usual names (eg. "
13941 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13945 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5382
13947 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13948 "mounted on C</> before others can be mounted. Other filesystems can only be "
13949 "mounted on directories which already exist."
13953 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5387
13955 "The mounted filesystem is writable, if we have sufficient permissions on the "
13956 "underlying device."
13960 #: ../fish/guestfish-actions.pod:3478
13962 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
13963 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
13964 "problems for users. If your program might need to work with older versions "
13965 "of libguestfs, use L</mount-options> instead (using an empty string for the "
13966 "first parameter if you don't want any options)."
13970 #: ../fish/guestfish-actions.pod:3485
13975 #: ../fish/guestfish-actions.pod:3487
13978 " mount-9p mounttag mountpoint [options:..]\n"
13983 #: ../fish/guestfish-actions.pod:3489 ../src/guestfs-actions.pod:5416
13985 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
13990 #: ../fish/guestfish-actions.pod:3492 ../src/guestfs-actions.pod:5419
13992 "If required, C<trans=virtio> will be automatically added to the options. "
13993 "Any other options required can be passed in the optional C<options> "
13998 #: ../fish/guestfish-actions.pod:3498
14003 #: ../fish/guestfish-actions.pod:3500
14006 " mount-loop file mountpoint\n"
14011 #: ../fish/guestfish-actions.pod:3502 ../src/guestfs-actions.pod:5458
14013 "This command lets you mount C<file> (a filesystem image in a file) on a "
14014 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14019 #: ../fish/guestfish-actions.pod:3506
14020 msgid "mount-options"
14024 #: ../fish/guestfish-actions.pod:3508
14027 " mount-options options device mountpoint\n"
14032 #: ../fish/guestfish-actions.pod:3510
14034 "This is the same as the L</mount> command, but it allows you to set the "
14035 "mount options as for the L<mount(8)> I<-o> flag."
14039 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5478
14041 "If the C<options> parameter is an empty string, then no options are passed "
14042 "(all options default to whatever the filesystem uses)."
14046 #: ../fish/guestfish-actions.pod:3518
14051 #: ../fish/guestfish-actions.pod:3520
14054 " mount-ro device mountpoint\n"
14059 #: ../fish/guestfish-actions.pod:3522
14061 "This is the same as the L</mount> command, but it mounts the filesystem with "
14062 "the read-only (I<-o ro>) flag."
14066 #: ../fish/guestfish-actions.pod:3525
14071 #: ../fish/guestfish-actions.pod:3527
14074 " mount-vfs options vfstype device mountpoint\n"
14079 #: ../fish/guestfish-actions.pod:3529
14081 "This is the same as the L</mount> command, but it allows you to set both the "
14082 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
14086 #: ../fish/guestfish-actions.pod:3533
14087 msgid "mountpoints"
14091 #: ../fish/guestfish-actions.pod:3535
14099 #: ../fish/guestfish-actions.pod:3537
14101 "This call is similar to L</mounts>. That call returns a list of devices. "
14102 "This one returns a hash table (map) of device name to directory where the "
14103 "device is mounted."
14107 #: ../fish/guestfish-actions.pod:3541
14112 #: ../fish/guestfish-actions.pod:3543
14120 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5539
14122 "This returns the list of currently mounted filesystems. It returns the list "
14123 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14127 #: ../fish/guestfish-actions.pod:3548 ../src/guestfs-actions.pod:5542
14128 msgid "Some internal mounts are not shown."
14132 #: ../fish/guestfish-actions.pod:3550
14133 msgid "See also: L</mountpoints>"
14137 #: ../fish/guestfish-actions.pod:3552
14142 #: ../fish/guestfish-actions.pod:3554
14150 #: ../fish/guestfish-actions.pod:3556 ../src/guestfs-actions.pod:5559
14152 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14153 "destination filename or destination directory."
14157 #: ../fish/guestfish-actions.pod:3559
14158 msgid "ntfs-3g-probe"
14162 #: ../fish/guestfish-actions.pod:3561
14165 " ntfs-3g-probe true|false device\n"
14170 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5573
14172 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14173 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14174 "write, and some cannot be mounted at all)."
14178 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5577
14180 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14181 "can be mounted read-write. Set it to false if you want to test if the "
14182 "volume can be mounted read-only."
14186 #: ../fish/guestfish-actions.pod:3571 ../src/guestfs-actions.pod:5581
14188 "The return value is an integer which C<0> if the operation would succeed, or "
14189 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14193 #: ../fish/guestfish-actions.pod:3575
14198 #: ../fish/guestfish-actions.pod:3577
14201 " ntfsresize device\n"
14206 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3603
14207 #: ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5634
14209 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14210 "size of the underlying device."
14214 #: ../fish/guestfish-actions.pod:3582 ../src/guestfs-actions.pod:5605
14216 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14217 "consistency check (for safety). You have to boot into Windows to perform "
14218 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14219 "resize filesystems which have been marked in this way. So in effect it is "
14220 "not possible to call ntfsresize multiple times on a single filesystem "
14221 "without booting into Windows between each resize."
14225 #: ../fish/guestfish-actions.pod:3590 ../fish/guestfish-actions.pod:3629
14226 #: ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5660
14227 msgid "See also L<ntfsresize(8)>."
14231 #: ../fish/guestfish-actions.pod:3592 ../fish/guestfish-actions.pod:3640
14233 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
14238 #: ../fish/guestfish-actions.pod:3599
14239 msgid "ntfsresize-opts"
14243 #: ../fish/guestfish-actions.pod:3601
14246 " ntfsresize-opts device [size:N] [force:true|false]\n"
14251 #: ../fish/guestfish-actions.pod:3612 ../src/guestfs-actions.pod:5643
14253 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14254 "resized to fit the container (eg. partition)."
14258 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5646
14263 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5648
14265 "If this option is true, then force the resize of the filesystem even if the "
14266 "filesystem is marked as requiring a consistency check."
14270 #: ../fish/guestfish-actions.pod:3620
14272 "After the resize operation, the filesystem is always marked as requiring a "
14273 "consistency check (for safety). You have to boot into Windows to perform "
14274 "this check and clear this condition. If you I<don't> set the C<force> "
14275 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
14276 "a single filesystem without booting into Windows between each resize."
14280 #: ../fish/guestfish-actions.pod:3633
14281 msgid "ntfsresize-size"
14285 #: ../fish/guestfish-actions.pod:3635
14288 " ntfsresize-size device size\n"
14293 #: ../fish/guestfish-actions.pod:3637
14295 "This command is the same as L</ntfsresize> except that it allows you to "
14296 "specify the new size (in bytes) explicitly."
14300 #: ../fish/guestfish-actions.pod:3647
14305 #: ../fish/guestfish-actions.pod:3649
14308 " part-add device prlogex startsect endsect\n"
14313 #: ../fish/guestfish-actions.pod:3651
14315 "This command adds a partition to C<device>. If there is no partition table "
14316 "on the device, call L</part-init> first."
14320 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5721
14322 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14323 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14324 "C<logical>) and C<e> (or C<extended>) partition types."
14328 #: ../fish/guestfish-actions.pod:3659 ../src/guestfs-actions.pod:5726
14330 "C<startsect> and C<endsect> are the start and end of the partition in "
14331 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14332 "from the end of the disk (C<-1> is the last sector)."
14336 #: ../fish/guestfish-actions.pod:3663
14338 "Creating a partition which covers the whole disk is not so easy. Use L</"
14339 "part-disk> to do that."
14343 #: ../fish/guestfish-actions.pod:3666
14348 #: ../fish/guestfish-actions.pod:3668
14351 " part-del device partnum\n"
14356 #: ../fish/guestfish-actions.pod:3670 ../src/guestfs-actions.pod:5744
14357 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14361 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5746
14363 "Note that in the case of MBR partitioning, deleting an extended partition "
14364 "also deletes any logical partitions it contains."
14368 #: ../fish/guestfish-actions.pod:3676
14373 #: ../fish/guestfish-actions.pod:3678
14376 " part-disk device parttype\n"
14381 #: ../fish/guestfish-actions.pod:3680
14383 "This command is simply a combination of L</part-init> followed by L</part-"
14384 "add> to create a single primary partition covering the whole disk."
14388 #: ../fish/guestfish-actions.pod:3684
14390 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14391 "possible values are described in L</part-init>."
14395 #: ../fish/guestfish-actions.pod:3687
14396 msgid "part-get-bootable"
14400 #: ../fish/guestfish-actions.pod:3689
14403 " part-get-bootable device partnum\n"
14408 #: ../fish/guestfish-actions.pod:3691 ../src/guestfs-actions.pod:5779
14410 "This command returns true if the partition C<partnum> on C<device> has the "
14411 "bootable flag set."
14415 #: ../fish/guestfish-actions.pod:3694
14416 msgid "See also L</part-set-bootable>."
14420 #: ../fish/guestfish-actions.pod:3696
14421 msgid "part-get-mbr-id"
14425 #: ../fish/guestfish-actions.pod:3698
14428 " part-get-mbr-id device partnum\n"
14433 #: ../fish/guestfish-actions.pod:3700 ../src/guestfs-actions.pod:5795
14435 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14436 "partition C<partnum>."
14440 #: ../fish/guestfish-actions.pod:3703 ../fish/guestfish-actions.pod:3847
14442 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14443 "undefined results for other partition table types (see L</part-get-"
14448 #: ../fish/guestfish-actions.pod:3707
14449 msgid "part-get-parttype"
14453 #: ../fish/guestfish-actions.pod:3709
14456 " part-get-parttype device\n"
14461 #: ../fish/guestfish-actions.pod:3711 ../src/guestfs-actions.pod:5812
14463 "This command examines the partition table on C<device> and returns the "
14464 "partition table type (format) being used."
14468 #: ../fish/guestfish-actions.pod:3714
14470 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14471 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14472 "possible, although unusual. See L</part-init> for a full list."
14476 #: ../fish/guestfish-actions.pod:3719
14481 #: ../fish/guestfish-actions.pod:3721
14484 " part-init device parttype\n"
14489 #: ../fish/guestfish-actions.pod:3723 ../src/guestfs-actions.pod:5832
14491 "This creates an empty partition table on C<device> of one of the partition "
14492 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14493 "(for large disks)."
14497 #: ../fish/guestfish-actions.pod:3727
14499 "Initially there are no partitions. Following this, you should call L</part-"
14500 "add> for each partition required."
14504 #: ../fish/guestfish-actions.pod:3730 ../src/guestfs-actions.pod:5839
14505 msgid "Possible values for C<parttype> are:"
14509 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5843
14514 #: ../fish/guestfish-actions.pod:3736 ../src/guestfs-actions.pod:5845
14519 #: ../fish/guestfish-actions.pod:3738 ../src/guestfs-actions.pod:5847
14520 msgid "Intel EFI / GPT partition table."
14524 #: ../fish/guestfish-actions.pod:3740 ../src/guestfs-actions.pod:5849
14526 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14527 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14528 "the C<mbr> format."
14532 #: ../fish/guestfish-actions.pod:3744 ../src/guestfs-actions.pod:5853
14537 #: ../fish/guestfish-actions.pod:3746 ../src/guestfs-actions.pod:5855
14542 #: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5857
14544 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14545 "Windows. This partition type will B<only> work for device sizes up to 2 "
14546 "TB. For large disks we recommend using C<gpt>."
14550 #: ../fish/guestfish-actions.pod:3755 ../src/guestfs-actions.pod:5864
14552 "Other partition table types that may work but are not supported include:"
14556 #: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5869
14561 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5871
14562 msgid "AIX disk labels."
14566 #: ../fish/guestfish-actions.pod:3764 ../src/guestfs-actions.pod:5873
14571 #: ../fish/guestfish-actions.pod:3766 ../src/guestfs-actions.pod:5875
14576 #: ../fish/guestfish-actions.pod:3768 ../src/guestfs-actions.pod:5877
14577 msgid "Amiga \"Rigid Disk Block\" format."
14581 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5879
14586 #: ../fish/guestfish-actions.pod:3772 ../src/guestfs-actions.pod:5881
14587 msgid "BSD disk labels."
14591 #: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5883
14596 #: ../fish/guestfish-actions.pod:3776 ../src/guestfs-actions.pod:5885
14597 msgid "DASD, used on IBM mainframes."
14601 #: ../fish/guestfish-actions.pod:3778 ../src/guestfs-actions.pod:5887
14606 #: ../fish/guestfish-actions.pod:3780 ../src/guestfs-actions.pod:5889
14607 msgid "MIPS/SGI volumes."
14611 #: ../fish/guestfish-actions.pod:3782 ../src/guestfs-actions.pod:5891
14616 #: ../fish/guestfish-actions.pod:3784 ../src/guestfs-actions.pod:5893
14617 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14621 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5895
14626 #: ../fish/guestfish-actions.pod:3788 ../src/guestfs-actions.pod:5897
14627 msgid "NEC PC-98 format, common in Japan apparently."
14631 #: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5899
14636 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5901
14637 msgid "Sun disk labels."
14641 #: ../fish/guestfish-actions.pod:3796
14646 #: ../fish/guestfish-actions.pod:3798
14649 " part-list device\n"
14654 #: ../fish/guestfish-actions.pod:3800 ../src/guestfs-actions.pod:5915
14656 "This command parses the partition table on C<device> and returns the list of "
14657 "partitions found."
14661 #: ../fish/guestfish-actions.pod:3803 ../src/guestfs-actions.pod:5918
14662 msgid "The fields in the returned structure are:"
14666 #: ../fish/guestfish-actions.pod:3807 ../src/guestfs-actions.pod:5922
14667 msgid "B<part_num>"
14671 #: ../fish/guestfish-actions.pod:3809 ../src/guestfs-actions.pod:5924
14672 msgid "Partition number, counting from 1."
14676 #: ../fish/guestfish-actions.pod:3811 ../src/guestfs-actions.pod:5926
14677 msgid "B<part_start>"
14681 #: ../fish/guestfish-actions.pod:3813
14683 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14684 "the device's sector size, see L</blockdev-getss>."
14688 #: ../fish/guestfish-actions.pod:3816 ../src/guestfs-actions.pod:5931
14689 msgid "B<part_end>"
14693 #: ../fish/guestfish-actions.pod:3818 ../src/guestfs-actions.pod:5933
14694 msgid "End of the partition in bytes."
14698 #: ../fish/guestfish-actions.pod:3820 ../src/guestfs-actions.pod:5935
14699 msgid "B<part_size>"
14703 #: ../fish/guestfish-actions.pod:3822 ../src/guestfs-actions.pod:5937
14704 msgid "Size of the partition in bytes."
14708 #: ../fish/guestfish-actions.pod:3826
14709 msgid "part-set-bootable"
14713 #: ../fish/guestfish-actions.pod:3828
14716 " part-set-bootable device partnum true|false\n"
14721 #: ../fish/guestfish-actions.pod:3830 ../src/guestfs-actions.pod:5955
14723 "This sets the bootable flag on partition numbered C<partnum> on device "
14724 "C<device>. Note that partitions are numbered from 1."
14728 #: ../fish/guestfish-actions.pod:3833 ../src/guestfs-actions.pod:5958
14730 "The bootable flag is used by some operating systems (notably Windows) to "
14731 "determine which partition to boot from. It is by no means universally "
14736 #: ../fish/guestfish-actions.pod:3837
14737 msgid "part-set-mbr-id"
14741 #: ../fish/guestfish-actions.pod:3839
14744 " part-set-mbr-id device partnum idbyte\n"
14749 #: ../fish/guestfish-actions.pod:3841 ../src/guestfs-actions.pod:5974
14751 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14752 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14753 "documentation are in fact hexadecimal numbers, but usually documented "
14754 "without any leading \"0x\" which might be confusing."
14758 #: ../fish/guestfish-actions.pod:3851
14759 msgid "part-set-name"
14763 #: ../fish/guestfish-actions.pod:3853
14766 " part-set-name device partnum name\n"
14771 #: ../fish/guestfish-actions.pod:3855 ../src/guestfs-actions.pod:5996
14773 "This sets the partition name on partition numbered C<partnum> on device "
14774 "C<device>. Note that partitions are numbered from 1."
14778 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5999
14780 "The partition name can only be set on certain types of partition table. "
14781 "This works on C<gpt> but not on C<mbr> partitions."
14785 #: ../fish/guestfish-actions.pod:3861
14786 msgid "part-to-dev"
14790 #: ../fish/guestfish-actions.pod:3863
14793 " part-to-dev partition\n"
14798 #: ../fish/guestfish-actions.pod:3865 ../src/guestfs-actions.pod:6012
14800 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14801 "partition number, returning the device name (eg. \"/dev/sdb\")."
14805 #: ../fish/guestfish-actions.pod:3869 ../fish/guestfish-actions.pod:3881
14807 "The named partition must exist, for example as a string returned from L</"
14808 "list-partitions>."
14812 #: ../fish/guestfish-actions.pod:3872
14813 msgid "See also L</part-to-partnum>."
14817 #: ../fish/guestfish-actions.pod:3874
14818 msgid "part-to-partnum"
14822 #: ../fish/guestfish-actions.pod:3876
14825 " part-to-partnum partition\n"
14830 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:6032
14832 "This function takes a partition name (eg. \"/dev/sdb1\") and returns the "
14833 "partition number (eg. C<1>)."
14837 #: ../fish/guestfish-actions.pod:3884
14838 msgid "See also L</part-to-dev>."
14842 #: ../fish/guestfish-actions.pod:3886
14843 msgid "ping-daemon"
14847 #: ../fish/guestfish-actions.pod:3888
14855 #: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:6049
14857 "This is a test probe into the guestfs daemon running inside the qemu "
14858 "subprocess. Calling this function checks that the daemon responds to the "
14859 "ping message, without affecting the daemon or attached block device(s) in "
14864 #: ../fish/guestfish-actions.pod:3895
14869 #: ../fish/guestfish-actions.pod:3897
14872 " pread path count offset\n"
14877 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:6067
14879 "This command lets you read part of a file. It reads C<count> bytes of the "
14880 "file, starting at C<offset>, from file C<path>."
14884 #: ../fish/guestfish-actions.pod:3902 ../fish/guestfish-actions.pod:3917
14885 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6096
14887 "This may read fewer bytes than requested. For further details see the "
14888 "L<pread(2)> system call."
14892 #: ../fish/guestfish-actions.pod:3905
14893 msgid "See also L</pwrite>, L</pread-device>."
14897 #: ../fish/guestfish-actions.pod:3910
14898 msgid "pread-device"
14902 #: ../fish/guestfish-actions.pod:3912
14905 " pread-device device count offset\n"
14910 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:6093
14912 "This command lets you read part of a file. It reads C<count> bytes of "
14913 "C<device>, starting at C<offset>."
14917 #: ../fish/guestfish-actions.pod:3920
14918 msgid "See also L</pread>."
14922 #: ../fish/guestfish-actions.pod:3925
14927 #: ../fish/guestfish-actions.pod:3927
14930 " pvcreate device\n"
14935 #: ../fish/guestfish-actions.pod:3929 ../src/guestfs-actions.pod:6116
14937 "This creates an LVM physical volume on the named C<device>, where C<device> "
14938 "should usually be a partition name such as C</dev/sda1>."
14942 #: ../fish/guestfish-actions.pod:3933
14947 #: ../fish/guestfish-actions.pod:3935
14950 " pvremove device\n"
14955 #: ../fish/guestfish-actions.pod:3937 ../src/guestfs-actions.pod:6130
14957 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14962 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:6133
14964 "The implementation uses the C<pvremove> command which refuses to wipe "
14965 "physical volumes that contain any volume groups, so you have to remove those "
14970 #: ../fish/guestfish-actions.pod:3944
14975 #: ../fish/guestfish-actions.pod:3946
14978 " pvresize device\n"
14983 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6147
14985 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14986 "the new size of the underlying device."
14990 #: ../fish/guestfish-actions.pod:3951
14991 msgid "pvresize-size"
14995 #: ../fish/guestfish-actions.pod:3953
14998 " pvresize-size device size\n"
15003 #: ../fish/guestfish-actions.pod:3955
15005 "This command is the same as L</pvresize> except that it allows you to "
15006 "specify the new size (in bytes) explicitly."
15010 #: ../fish/guestfish-actions.pod:3958
15015 #: ../fish/guestfish-actions.pod:3960
15023 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6173
15025 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15030 #: ../fish/guestfish-actions.pod:3965 ../src/guestfs-actions.pod:6176
15032 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15037 #: ../fish/guestfish-actions.pod:3968
15038 msgid "See also L</pvs-full>."
15042 #: ../fish/guestfish-actions.pod:3970
15047 #: ../fish/guestfish-actions.pod:3972
15055 #: ../fish/guestfish-actions.pod:3974 ../src/guestfs-actions.pod:6192
15057 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15058 "(8)> command. The \"full\" version includes all fields."
15062 #: ../fish/guestfish-actions.pod:3977
15067 #: ../fish/guestfish-actions.pod:3979
15075 #: ../fish/guestfish-actions.pod:3981 ../src/guestfs-actions.pod:6207
15076 msgid "This command returns the UUID of the LVM PV C<device>."
15080 #: ../fish/guestfish-actions.pod:3983
15085 #: ../fish/guestfish-actions.pod:3985
15088 " pwrite path content offset\n"
15093 #: ../fish/guestfish-actions.pod:3987 ../src/guestfs-actions.pod:6223
15095 "This command writes to part of a file. It writes the data buffer C<content> "
15096 "to the file C<path> starting at offset C<offset>."
15100 #: ../fish/guestfish-actions.pod:3990 ../src/guestfs-actions.pod:6226
15102 "This command implements the L<pwrite(2)> system call, and like that system "
15103 "call it may not write the full data requested. The return value is the "
15104 "number of bytes that were actually written to the file. This could even be "
15105 "0, although short writes are unlikely for regular files in ordinary "
15110 #: ../fish/guestfish-actions.pod:3996
15111 msgid "See also L</pread>, L</pwrite-device>."
15115 #: ../fish/guestfish-actions.pod:4001
15116 msgid "pwrite-device"
15120 #: ../fish/guestfish-actions.pod:4003
15123 " pwrite-device device content offset\n"
15128 #: ../fish/guestfish-actions.pod:4005 ../src/guestfs-actions.pod:6250
15130 "This command writes to part of a device. It writes the data buffer "
15131 "C<content> to C<device> starting at offset C<offset>."
15135 #: ../fish/guestfish-actions.pod:4008 ../src/guestfs-actions.pod:6253
15137 "This command implements the L<pwrite(2)> system call, and like that system "
15138 "call it may not write the full data requested (although short writes to disk "
15139 "devices and partitions are probably impossible with standard Linux kernels)."
15143 #: ../fish/guestfish-actions.pod:4013
15144 msgid "See also L</pwrite>."
15148 #: ../fish/guestfish-actions.pod:4018
15153 #: ../fish/guestfish-actions.pod:4020
15156 " read-file path\n"
15161 #: ../fish/guestfish-actions.pod:4022 ../src/guestfs-actions.pod:6274
15162 msgid "This calls returns the contents of the file C<path> as a buffer."
15166 #: ../fish/guestfish-actions.pod:4025
15168 "Unlike L</cat>, this function can correctly handle files that contain "
15169 "embedded ASCII NUL characters. However unlike L</download>, this function "
15170 "is limited in the total size of file that can be handled."
15174 #: ../fish/guestfish-actions.pod:4033
15179 #: ../fish/guestfish-actions.pod:4035
15182 " read-lines path\n"
15187 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6299
15189 "The file contents are returned as a list of lines. Trailing C<LF> and "
15190 "C<CRLF> character sequences are I<not> returned."
15194 #: ../fish/guestfish-actions.pod:4042
15196 "Note that this function cannot correctly handle binary files (specifically, "
15197 "files containing C<\\0> character which is treated as end of line). For "
15198 "those you need to use the L</read-file> function which has a more complex "
15203 #: ../fish/guestfish-actions.pod:4047
15208 #: ../fish/guestfish-actions.pod:4049
15216 #: ../fish/guestfish-actions.pod:4051 ../src/guestfs-actions.pod:6319
15217 msgid "This returns the list of directory entries in directory C<dir>."
15221 #: ../fish/guestfish-actions.pod:4053 ../src/guestfs-actions.pod:6321
15223 "All entries in the directory are returned, including C<.> and C<..>. The "
15224 "entries are I<not> sorted, but returned in the same order as the underlying "
15229 #: ../fish/guestfish-actions.pod:4057 ../src/guestfs-actions.pod:6325
15231 "Also this call returns basic file type information about each file. The "
15232 "C<ftyp> field will contain one of the following characters:"
15236 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6330
15241 #: ../fish/guestfish-actions.pod:4064 ../src/guestfs-actions.pod:6332
15242 msgid "Block special"
15246 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6334
15251 #: ../fish/guestfish-actions.pod:4068 ../src/guestfs-actions.pod:6336
15252 msgid "Char special"
15256 #: ../fish/guestfish-actions.pod:4070 ../src/guestfs-actions.pod:6338
15261 #: ../fish/guestfish-actions.pod:4072 ../src/guestfs-actions.pod:6340
15266 #: ../fish/guestfish-actions.pod:4074 ../src/guestfs-actions.pod:6342
15271 #: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6344
15272 msgid "FIFO (named pipe)"
15276 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6346
15281 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6348
15282 msgid "Symbolic link"
15286 #: ../fish/guestfish-actions.pod:4082 ../src/guestfs-actions.pod:6350
15291 #: ../fish/guestfish-actions.pod:4084 ../src/guestfs-actions.pod:6352
15292 msgid "Regular file"
15296 #: ../fish/guestfish-actions.pod:4086 ../src/guestfs-actions.pod:6354
15301 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6356
15306 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6358
15311 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6360
15312 msgid "Unknown file type"
15316 #: ../fish/guestfish-actions.pod:4094 ../src/guestfs-actions.pod:6362
15321 #: ../fish/guestfish-actions.pod:4096 ../src/guestfs-actions.pod:6364
15323 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15327 #: ../fish/guestfish-actions.pod:4101
15329 "This function is primarily intended for use by programs. To get a simple "
15330 "list of names, use L</ls>. To get a printable directory for human "
15331 "consumption, use L</ll>."
15335 #: ../fish/guestfish-actions.pod:4105
15340 #: ../fish/guestfish-actions.pod:4107
15348 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6385
15349 msgid "This command reads the target of a symbolic link."
15353 #: ../fish/guestfish-actions.pod:4111
15354 msgid "readlinklist"
15358 #: ../fish/guestfish-actions.pod:4113
15361 " readlinklist path 'names ...'\n"
15366 #: ../fish/guestfish-actions.pod:4115 ../src/guestfs-actions.pod:6399
15368 "This call allows you to do a C<readlink> operation on multiple files, where "
15369 "all files are in the directory C<path>. C<names> is the list of files from "
15374 #: ../fish/guestfish-actions.pod:4119 ../src/guestfs-actions.pod:6403
15376 "On return you get a list of strings, with a one-to-one correspondence to the "
15377 "C<names> list. Each string is the value of the symbolic link."
15381 #: ../fish/guestfish-actions.pod:4123 ../src/guestfs-actions.pod:6407
15383 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15384 "result string is the empty string C<\"\">. However the whole operation is "
15385 "completed even if there were C<readlink(2)> errors, and so you can call this "
15386 "function with names where you don't know if they are symbolic links already "
15387 "(albeit slightly less efficient)."
15391 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6414
15393 "This call is intended for programs that want to efficiently list a directory "
15394 "contents without making many round-trips. Very long directory listings "
15395 "might cause the protocol message size to be exceeded, causing this call to "
15396 "fail. The caller must split up such requests into smaller groups of names."
15400 #: ../fish/guestfish-actions.pod:4137
15405 #: ../fish/guestfish-actions.pod:4139
15413 #: ../fish/guestfish-actions.pod:4141 ../src/guestfs-actions.pod:6433
15415 "Return the canonicalized absolute pathname of C<path>. The returned path "
15416 "has no C<.>, C<..> or symbolic link path elements."
15420 #: ../fish/guestfish-actions.pod:4144
15421 msgid "removexattr"
15425 #: ../fish/guestfish-actions.pod:4146
15428 " removexattr xattr path\n"
15433 #: ../fish/guestfish-actions.pod:4148 ../src/guestfs-actions.pod:6448
15435 "This call removes the extended attribute named C<xattr> of the file C<path>."
15439 #: ../fish/guestfish-actions.pod:4151
15440 msgid "See also: L</lremovexattr>, L<attr(5)>."
15444 #: ../fish/guestfish-actions.pod:4153
15449 #: ../fish/guestfish-actions.pod:4155
15452 " resize2fs device\n"
15457 #: ../fish/guestfish-actions.pod:4157 ../src/guestfs-actions.pod:6463
15459 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15460 "underlying device."
15464 #: ../fish/guestfish-actions.pod:4160
15466 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
15467 "before calling this command. For unknown reasons C<resize2fs> sometimes "
15468 "gives an error about this and sometimes not. In any case, it is always safe "
15469 "to call L</e2fsck-f> before calling this function."
15473 #: ../fish/guestfish-actions.pod:4166
15474 msgid "resize2fs-M"
15478 #: ../fish/guestfish-actions.pod:4168
15481 " resize2fs-M device\n"
15486 #: ../fish/guestfish-actions.pod:4170
15488 "This command is the same as L</resize2fs>, but the filesystem is resized to "
15489 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
15494 #: ../fish/guestfish-actions.pod:4174
15496 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
15497 "and read the C<Block size> and C<Block count> values. These two numbers, "
15498 "multiplied together, give the resulting size of the minimal filesystem in "
15503 #: ../fish/guestfish-actions.pod:4179
15504 msgid "resize2fs-size"
15508 #: ../fish/guestfish-actions.pod:4181
15511 " resize2fs-size device size\n"
15516 #: ../fish/guestfish-actions.pod:4183
15518 "This command is the same as L</resize2fs> except that it allows you to "
15519 "specify the new size (in bytes) explicitly."
15523 #: ../fish/guestfish-actions.pod:4186
15528 #: ../fish/guestfish-actions.pod:4188
15536 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6515
15537 msgid "Remove the single file C<path>."
15541 #: ../fish/guestfish-actions.pod:4192
15546 #: ../fish/guestfish-actions.pod:4194
15554 #: ../fish/guestfish-actions.pod:4196 ../src/guestfs-actions.pod:6527
15556 "Remove the file or directory C<path>, recursively removing the contents if "
15557 "its a directory. This is like the C<rm -rf> shell command."
15561 #: ../fish/guestfish-actions.pod:4200
15566 #: ../fish/guestfish-actions.pod:4202
15574 #: ../fish/guestfish-actions.pod:4204 ../src/guestfs-actions.pod:6541
15575 msgid "Remove the single directory C<path>."
15579 #: ../fish/guestfish-actions.pod:4206
15580 msgid "rmmountpoint"
15584 #: ../fish/guestfish-actions.pod:4208
15587 " rmmountpoint exemptpath\n"
15592 #: ../fish/guestfish-actions.pod:4210
15594 "This calls removes a mountpoint that was previously created with L</"
15595 "mkmountpoint>. See L</mkmountpoint> for full details."
15599 #: ../fish/guestfish-actions.pod:4214
15600 msgid "scrub-device"
15604 #: ../fish/guestfish-actions.pod:4216
15607 " scrub-device device\n"
15612 #: ../fish/guestfish-actions.pod:4218 ../src/guestfs-actions.pod:6567
15614 "This command writes patterns over C<device> to make data retrieval more "
15619 #: ../fish/guestfish-actions.pod:4221 ../fish/guestfish-actions.pod:4233
15620 #: ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6570
15621 #: ../src/guestfs-actions.pod:6588 ../src/guestfs-actions.pod:6607
15623 "It is an interface to the L<scrub(1)> program. See that manual page for "
15628 #: ../fish/guestfish-actions.pod:4224
15633 #: ../fish/guestfish-actions.pod:4226
15636 " scrub-file file\n"
15641 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6583
15643 "This command writes patterns over a file to make data retrieval more "
15648 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6586
15649 msgid "The file is I<removed> after scrubbing."
15653 #: ../fish/guestfish-actions.pod:4236
15654 msgid "scrub-freespace"
15658 #: ../fish/guestfish-actions.pod:4238
15661 " scrub-freespace dir\n"
15666 #: ../fish/guestfish-actions.pod:4240
15668 "This command creates the directory C<dir> and then fills it with files until "
15669 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
15670 "deletes them. The intention is to scrub any free space on the partition "
15671 "containing C<dir>."
15675 #: ../fish/guestfish-actions.pod:4249
15680 #: ../fish/guestfish-actions.pod:4251
15685 #: ../fish/guestfish-actions.pod:4253
15688 " set-append append\n"
15693 #: ../fish/guestfish-actions.pod:4255 ../src/guestfs-actions.pod:6620
15695 "This function is used to add additional options to the guest kernel command "
15700 #: ../fish/guestfish-actions.pod:4258 ../src/guestfs-actions.pod:6623
15702 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15703 "environment variable."
15707 #: ../fish/guestfish-actions.pod:4261 ../src/guestfs-actions.pod:6626
15709 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15710 "(libguestfs always adds a few of its own)."
15714 #: ../fish/guestfish-actions.pod:4264
15715 msgid "set-attach-method"
15719 #: ../fish/guestfish-actions.pod:4266
15720 msgid "attach-method"
15724 #: ../fish/guestfish-actions.pod:4268
15727 " set-attach-method attachmethod\n"
15732 #: ../fish/guestfish-actions.pod:4270 ../src/guestfs-actions.pod:6639
15734 "Set the method that libguestfs uses to connect to the back end guestfsd "
15735 "daemon. Possible methods are:"
15739 #: ../fish/guestfish-actions.pod:4275 ../src/guestfs-actions.pod:6644
15740 #: ../src/guestfs.pod:2916
15741 msgid "C<appliance>"
15745 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6646
15747 "Launch an appliance and connect to it. This is the ordinary method and the "
15752 #: ../fish/guestfish-actions.pod:4280 ../src/guestfs-actions.pod:6649
15753 msgid "C<unix:I<path>>"
15757 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6651
15758 msgid "Connect to the Unix domain socket I<path>."
15762 #: ../fish/guestfish-actions.pod:4284 ../src/guestfs-actions.pod:6653
15764 "This method lets you connect to an existing daemon or (using virtio-serial) "
15765 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15766 "RUNNING DAEMONS>."
15770 #: ../fish/guestfish-actions.pod:4290
15771 msgid "set-autosync"
15775 #: ../fish/guestfish-actions.pod:4292
15780 #: ../fish/guestfish-actions.pod:4294
15783 " set-autosync true|false\n"
15788 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6669
15790 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15791 "effort attempt to make filesystems consistent and synchronized when the "
15792 "handle is closed (also if the program exits without closing handles)."
15796 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6674
15798 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15799 "disabled by default)."
15803 #: ../fish/guestfish-actions.pod:4304
15808 #: ../fish/guestfish-actions.pod:4306
15813 #: ../fish/guestfish-actions.pod:4308
15816 " set-direct true|false\n"
15821 #: ../fish/guestfish-actions.pod:4310 ../src/guestfs-actions.pod:6687
15823 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15824 "passed directly through to the appliance once it is launched."
15828 #: ../fish/guestfish-actions.pod:4314
15830 "One consequence of this is that log messages aren't caught by the library "
15831 "and handled by L</set-log-message-callback>, but go straight to stdout."
15835 #: ../fish/guestfish-actions.pod:4318 ../src/guestfs-actions.pod:6695
15836 msgid "You probably don't want to use this unless you know what you are doing."
15840 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6698
15841 msgid "The default is disabled."
15845 #: ../fish/guestfish-actions.pod:4323
15846 msgid "set-e2label"
15850 #: ../fish/guestfish-actions.pod:4325
15853 " set-e2label device label\n"
15858 #: ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:6711
15860 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15861 "C<label>. Filesystem labels are limited to 16 characters."
15865 #: ../fish/guestfish-actions.pod:4331
15867 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
15868 "label on a filesystem."
15872 #: ../fish/guestfish-actions.pod:4334
15877 #: ../fish/guestfish-actions.pod:4336
15880 " set-e2uuid device uuid\n"
15885 #: ../fish/guestfish-actions.pod:4338 ../src/guestfs-actions.pod:6729
15887 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15888 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15889 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15893 #: ../fish/guestfish-actions.pod:4343
15895 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
15896 "UUID of a filesystem."
15900 #: ../fish/guestfish-actions.pod:4346
15901 msgid "set-memsize"
15905 #: ../fish/guestfish-actions.pod:4348
15910 #: ../fish/guestfish-actions.pod:4350
15913 " set-memsize memsize\n"
15918 #: ../fish/guestfish-actions.pod:4352
15920 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15921 "This only has any effect if called before L</launch>."
15925 #: ../fish/guestfish-actions.pod:4356 ../src/guestfs-actions.pod:6751
15927 "You can also change this by setting the environment variable "
15928 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15932 #: ../fish/guestfish-actions.pod:4363
15933 msgid "set-network"
15937 #: ../fish/guestfish-actions.pod:4365
15942 #: ../fish/guestfish-actions.pod:4367
15945 " set-network true|false\n"
15950 #: ../fish/guestfish-actions.pod:4369 ../src/guestfs-actions.pod:6768
15952 "If C<network> is true, then the network is enabled in the libguestfs "
15953 "appliance. The default is false."
15957 #: ../fish/guestfish-actions.pod:4372 ../src/guestfs-actions.pod:6771
15959 "This affects whether commands are able to access the network (see L<guestfs"
15960 "(3)/RUNNING COMMANDS>)."
15964 #: ../fish/guestfish-actions.pod:4375
15966 "You must call this before calling L</launch>, otherwise it has no effect."
15970 #: ../fish/guestfish-actions.pod:4378
15975 #: ../fish/guestfish-actions.pod:4382
15978 " set-path searchpath\n"
15983 #: ../fish/guestfish-actions.pod:4384 ../src/guestfs-actions.pod:6787
15984 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15988 #: ../fish/guestfish-actions.pod:4386 ../src/guestfs-actions.pod:6789
15990 "The default is C<$libdir/guestfs> unless overridden by setting "
15991 "C<LIBGUESTFS_PATH> environment variable."
15995 #: ../fish/guestfish-actions.pod:4389 ../src/guestfs-actions.pod:6792
15996 msgid "Setting C<path> to C<NULL> restores the default path."
16000 #: ../fish/guestfish-actions.pod:4391
16005 #: ../fish/guestfish-actions.pod:4393
16010 #: ../fish/guestfish-actions.pod:4395
16013 " set-pgroup true|false\n"
16018 #: ../fish/guestfish-actions.pod:4397 ../src/guestfs-actions.pod:6804
16020 "If C<pgroup> is true, child processes are placed into their own process "
16025 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6807
16027 "The practical upshot of this is that signals like C<SIGINT> (from users "
16028 "pressing C<^C>) won't be received by the child process."
16032 #: ../fish/guestfish-actions.pod:4403 ../src/guestfs-actions.pod:6810
16034 "The default for this flag is false, because usually you want C<^C> to kill "
16039 #: ../fish/guestfish-actions.pod:4406
16044 #: ../fish/guestfish-actions.pod:4408
16049 #: ../fish/guestfish-actions.pod:4410
16057 #: ../fish/guestfish-actions.pod:4412 ../src/guestfs-actions.pod:6823
16058 msgid "Set the qemu binary that we will use."
16062 #: ../fish/guestfish-actions.pod:4414 ../src/guestfs-actions.pod:6825
16064 "The default is chosen when the library was compiled by the configure script."
16068 #: ../fish/guestfish-actions.pod:4417 ../src/guestfs-actions.pod:6828
16070 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16075 #: ../fish/guestfish-actions.pod:4420 ../src/guestfs-actions.pod:6831
16076 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16080 #: ../fish/guestfish-actions.pod:4422 ../src/guestfs-actions.pod:6833
16082 "Note that you should call this function as early as possible after creating "
16083 "the handle. This is because some pre-launch operations depend on testing "
16084 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16085 "don't retest features, and so you might see inconsistent results. Using the "
16086 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16087 "the qemu binary at the same time as the handle is created."
16091 #: ../fish/guestfish-actions.pod:4430
16092 msgid "set-recovery-proc"
16096 #: ../fish/guestfish-actions.pod:4432
16097 msgid "recovery-proc"
16101 #: ../fish/guestfish-actions.pod:4434
16104 " set-recovery-proc true|false\n"
16109 #: ../fish/guestfish-actions.pod:4436
16111 "If this is called with the parameter C<false> then L</launch> does not "
16112 "create a recovery process. The purpose of the recovery process is to stop "
16113 "runaway qemu processes in the case where the main program aborts abruptly."
16117 #: ../fish/guestfish-actions.pod:4441
16119 "This only has any effect if called before L</launch>, and the default is "
16124 #: ../fish/guestfish-actions.pod:4444 ../src/guestfs-actions.pod:6859
16126 "About the only time when you would want to disable this is if the main "
16127 "process will fork itself into the background (\"daemonize\" itself). In "
16128 "this case the recovery process thinks that the main program has disappeared "
16129 "and so kills qemu, which is not very helpful."
16133 #: ../fish/guestfish-actions.pod:4450
16134 msgid "set-selinux"
16138 #: ../fish/guestfish-actions.pod:4452
16143 #: ../fish/guestfish-actions.pod:4454
16146 " set-selinux true|false\n"
16151 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6875
16153 "This sets the selinux flag that is passed to the appliance at boot time. "
16154 "The default is C<selinux=0> (disabled)."
16158 #: ../fish/guestfish-actions.pod:4459 ../src/guestfs-actions.pod:6878
16160 "Note that if SELinux is enabled, it is always in Permissive mode "
16161 "(C<enforcing=0>)."
16165 #: ../fish/guestfish-actions.pod:4465
16170 #: ../fish/guestfish-actions.pod:4467
16175 #: ../fish/guestfish-actions.pod:4469
16183 #: ../fish/guestfish-actions.pod:4471 ../src/guestfs-actions.pod:6894
16185 "Change the number of virtual CPUs assigned to the appliance. The default is "
16186 "C<1>. Increasing this may improve performance, though often it has no "
16191 #: ../fish/guestfish-actions.pod:4475
16192 msgid "This function must be called before L</launch>."
16196 #: ../fish/guestfish-actions.pod:4477
16201 #: ../fish/guestfish-actions.pod:4479
16206 #: ../fish/guestfish-actions.pod:4481
16209 " set-trace true|false\n"
16214 #: ../fish/guestfish-actions.pod:4483 ../src/guestfs-actions.pod:6910
16216 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16217 "return values are traced."
16221 #: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6913
16223 "If you want to trace C API calls into libguestfs (and other libraries) then "
16224 "possibly a better way is to use the external ltrace(1) command."
16228 #: ../fish/guestfish-actions.pod:4490 ../src/guestfs-actions.pod:6917
16230 "Command traces are disabled unless the environment variable "
16231 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16235 #: ../fish/guestfish-actions.pod:4493
16237 "Trace messages are normally sent to C<stderr>, unless you register a "
16238 "callback to send them somewhere else (see L</set-event-callback>)."
16242 #: ../fish/guestfish-actions.pod:4497
16243 msgid "set-verbose"
16247 #: ../fish/guestfish-actions.pod:4499
16252 #: ../fish/guestfish-actions.pod:4501
16255 " set-verbose true|false\n"
16260 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6934
16261 msgid "If C<verbose> is true, this turns on verbose messages."
16265 #: ../fish/guestfish-actions.pod:4505 ../src/guestfs-actions.pod:6936
16267 "Verbose messages are disabled unless the environment variable "
16268 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16272 #: ../fish/guestfish-actions.pod:4508
16274 "Verbose messages are normally sent to C<stderr>, unless you register a "
16275 "callback to send them somewhere else (see L</set-event-callback>)."
16279 #: ../fish/guestfish-actions.pod:4512
16284 #: ../fish/guestfish-actions.pod:4514
16287 " setcon context\n"
16292 #: ../fish/guestfish-actions.pod:4516 ../src/guestfs-actions.pod:6953
16294 "This sets the SELinux security context of the daemon to the string "
16299 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6956
16300 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16304 #: ../fish/guestfish-actions.pod:4521
16309 #: ../fish/guestfish-actions.pod:4523
16312 " setxattr xattr val vallen path\n"
16317 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6971
16319 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16320 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16324 #: ../fish/guestfish-actions.pod:4529
16325 msgid "See also: L</lsetxattr>, L<attr(5)>."
16329 #: ../fish/guestfish-actions.pod:4531
16334 #: ../fish/guestfish-actions.pod:4533
16337 " sfdisk device cyls heads sectors 'lines ...'\n"
16342 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6998
16344 "This is a direct interface to the L<sfdisk(8)> program for creating "
16345 "partitions on block devices."
16349 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:7001
16350 msgid "C<device> should be a block device, for example C</dev/sda>."
16354 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:7003
16356 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16357 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16358 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16359 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16360 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16361 "the kernel) cannot work out the right geometry and you will need to tell it."
16365 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:7011
16367 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16368 "refer to the L<sfdisk(8)> manpage."
16372 #: ../fish/guestfish-actions.pod:4551 ../src/guestfs-actions.pod:7014
16374 "To create a single partition occupying the whole disk, you would pass "
16375 "C<lines> as a single element list, when the single element being the string "
16380 #: ../fish/guestfish-actions.pod:4555
16381 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
16385 #: ../fish/guestfish-actions.pod:4558 ../fish/guestfish-actions.pod:4578
16386 #: ../fish/guestfish-actions.pod:4597
16388 "I<This function is deprecated.> In new code, use the L</part_add> call "
16393 #: ../fish/guestfish-actions.pod:4565
16398 #: ../fish/guestfish-actions.pod:4567
16401 " sfdiskM device 'lines ...'\n"
16406 #: ../fish/guestfish-actions.pod:4569
16408 "This is a simplified interface to the L</sfdisk> command, where partition "
16409 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
16410 "you don't need to specify the cyls, heads and sectors parameters which were "
16411 "rarely if ever used anyway."
16415 #: ../fish/guestfish-actions.pod:4575
16416 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
16420 #: ../fish/guestfish-actions.pod:4585
16425 #: ../fish/guestfish-actions.pod:4587
16428 " sfdisk-N device partnum cyls heads sectors line\n"
16433 #: ../fish/guestfish-actions.pod:4589 ../src/guestfs-actions.pod:7070
16435 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16436 "(note: C<n> counts from 1)."
16440 #: ../fish/guestfish-actions.pod:4592
16442 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
16443 "cyls/heads/sectors parameters."
16447 #: ../fish/guestfish-actions.pod:4595
16448 msgid "See also: L</part-add>"
16452 #: ../fish/guestfish-actions.pod:4604
16453 msgid "sfdisk-disk-geometry"
16457 #: ../fish/guestfish-actions.pod:4606
16460 " sfdisk-disk-geometry device\n"
16465 #: ../fish/guestfish-actions.pod:4608
16467 "This displays the disk geometry of C<device> read from the partition table. "
16468 "Especially in the case where the underlying block device has been resized, "
16469 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
16470 "kernel-geometry>)."
16474 #: ../fish/guestfish-actions.pod:4613 ../fish/guestfish-actions.pod:4622
16475 #: ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7109
16476 msgid "The result is in human-readable format, and not designed to be parsed."
16480 #: ../fish/guestfish-actions.pod:4616
16481 msgid "sfdisk-kernel-geometry"
16485 #: ../fish/guestfish-actions.pod:4618
16488 " sfdisk-kernel-geometry device\n"
16493 #: ../fish/guestfish-actions.pod:4620 ../src/guestfs-actions.pod:7107
16494 msgid "This displays the kernel's idea of the geometry of C<device>."
16498 #: ../fish/guestfish-actions.pod:4625
16503 #: ../fish/guestfish-actions.pod:4627
16506 " sfdisk-l device\n"
16511 #: ../fish/guestfish-actions.pod:4629 ../src/guestfs-actions.pod:7130
16513 "This displays the partition table on C<device>, in the human-readable output "
16514 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16518 #: ../fish/guestfish-actions.pod:4633
16519 msgid "See also: L</part-list>"
16523 #: ../fish/guestfish-actions.pod:4635
16525 "I<This function is deprecated.> In new code, use the L</part_list> call "
16530 #: ../fish/guestfish-actions.pod:4642
16535 #: ../fish/guestfish-actions.pod:4644
16543 #: ../fish/guestfish-actions.pod:4646 ../src/guestfs-actions.pod:7147
16545 "This call runs a command from the guest filesystem via the guest's C</bin/"
16550 #: ../fish/guestfish-actions.pod:4649
16551 msgid "This is like L</command>, but passes the command to:"
16555 #: ../fish/guestfish-actions.pod:4651 ../src/guestfs-actions.pod:7152
16558 " /bin/sh -c \"command\"\n"
16563 #: ../fish/guestfish-actions.pod:4653 ../src/guestfs-actions.pod:7154
16565 "Depending on the guest's shell, this usually results in wildcards being "
16566 "expanded, shell expressions being interpolated and so on."
16570 #: ../fish/guestfish-actions.pod:4657
16571 msgid "All the provisos about L</command> apply to this call."
16575 #: ../fish/guestfish-actions.pod:4659
16580 #: ../fish/guestfish-actions.pod:4661
16583 " sh-lines command\n"
16588 #: ../fish/guestfish-actions.pod:4663
16589 msgid "This is the same as L</sh>, but splits the result into a list of lines."
16593 #: ../fish/guestfish-actions.pod:4666
16594 msgid "See also: L</command-lines>"
16598 #: ../fish/guestfish-actions.pod:4668
16603 #: ../fish/guestfish-actions.pod:4670
16611 #: ../fish/guestfish-actions.pod:4672 ../src/guestfs-actions.pod:7188
16612 msgid "Sleep for C<secs> seconds."
16616 #: ../fish/guestfish-actions.pod:4674
16621 #: ../fish/guestfish-actions.pod:4676
16629 #: ../fish/guestfish-actions.pod:4680 ../src/guestfs-actions.pod:7202
16630 msgid "This is the same as the C<stat(2)> system call."
16634 #: ../fish/guestfish-actions.pod:4682
16639 #: ../fish/guestfish-actions.pod:4684
16647 #: ../fish/guestfish-actions.pod:4686 ../src/guestfs-actions.pod:7216
16649 "Returns file system statistics for any mounted file system. C<path> should "
16650 "be a file or directory in the mounted file system (typically it is the mount "
16651 "point itself, but it doesn't need to be)."
16655 #: ../fish/guestfish-actions.pod:4690 ../src/guestfs-actions.pod:7220
16656 msgid "This is the same as the C<statvfs(2)> system call."
16660 #: ../fish/guestfish-actions.pod:4692
16665 #: ../fish/guestfish-actions.pod:4694
16673 #: ../fish/guestfish-actions.pod:4696 ../src/guestfs-actions.pod:7234
16675 "This runs the L<strings(1)> command on a file and returns the list of "
16676 "printable strings found."
16680 #: ../fish/guestfish-actions.pod:4702
16685 #: ../fish/guestfish-actions.pod:4704
16688 " strings-e encoding path\n"
16693 #: ../fish/guestfish-actions.pod:4706
16695 "This is like the L</strings> command, but allows you to specify the encoding "
16696 "of strings that are looked for in the source file C<path>."
16700 #: ../fish/guestfish-actions.pod:4710 ../src/guestfs-actions.pod:7257
16701 msgid "Allowed encodings are:"
16705 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7261
16710 #: ../fish/guestfish-actions.pod:4716
16712 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16713 "ISO-8859-X (this is what L</strings> uses)."
16717 #: ../fish/guestfish-actions.pod:4719 ../src/guestfs-actions.pod:7266
16722 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7268
16723 msgid "Single 8-bit-byte characters."
16727 #: ../fish/guestfish-actions.pod:4723 ../src/guestfs-actions.pod:7270
16732 #: ../fish/guestfish-actions.pod:4725 ../src/guestfs-actions.pod:7272
16733 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16737 #: ../fish/guestfish-actions.pod:4728 ../src/guestfs-actions.pod:7275
16738 msgid "l (lower case letter L)"
16742 #: ../fish/guestfish-actions.pod:4730 ../src/guestfs-actions.pod:7277
16744 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16745 "examining binaries in Windows guests."
16749 #: ../fish/guestfish-actions.pod:4733 ../src/guestfs-actions.pod:7280
16754 #: ../fish/guestfish-actions.pod:4735 ../src/guestfs-actions.pod:7282
16755 msgid "32-bit big endian such as UCS-4BE."
16759 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7284
16764 #: ../fish/guestfish-actions.pod:4739 ../src/guestfs-actions.pod:7286
16765 msgid "32-bit little endian such as UCS-4LE."
16769 #: ../fish/guestfish-actions.pod:4743 ../src/guestfs-actions.pod:7290
16770 msgid "The returned strings are transcoded to UTF-8."
16774 #: ../fish/guestfish-actions.pod:4748
16775 msgid "swapoff-device"
16779 #: ../fish/guestfish-actions.pod:4750
16782 " swapoff-device device\n"
16787 #: ../fish/guestfish-actions.pod:4752
16789 "This command disables the libguestfs appliance swap device or partition "
16790 "named C<device>. See L</swapon-device>."
16794 #: ../fish/guestfish-actions.pod:4756
16795 msgid "swapoff-file"
16799 #: ../fish/guestfish-actions.pod:4758
16802 " swapoff-file file\n"
16807 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7321
16808 msgid "This command disables the libguestfs appliance swap on file."
16812 #: ../fish/guestfish-actions.pod:4762
16813 msgid "swapoff-label"
16817 #: ../fish/guestfish-actions.pod:4764
16820 " swapoff-label label\n"
16825 #: ../fish/guestfish-actions.pod:4766 ../src/guestfs-actions.pod:7333
16827 "This command disables the libguestfs appliance swap on labeled swap "
16832 #: ../fish/guestfish-actions.pod:4769
16833 msgid "swapoff-uuid"
16837 #: ../fish/guestfish-actions.pod:4771
16840 " swapoff-uuid uuid\n"
16845 #: ../fish/guestfish-actions.pod:4773 ../src/guestfs-actions.pod:7346
16847 "This command disables the libguestfs appliance swap partition with the given "
16852 #: ../fish/guestfish-actions.pod:4776
16853 msgid "swapon-device"
16857 #: ../fish/guestfish-actions.pod:4778
16860 " swapon-device device\n"
16865 #: ../fish/guestfish-actions.pod:4780
16867 "This command enables the libguestfs appliance to use the swap device or "
16868 "partition named C<device>. The increased memory is made available for all "
16869 "commands, for example those run using L</command> or L</sh>."
16873 #: ../fish/guestfish-actions.pod:4785 ../src/guestfs-actions.pod:7364
16875 "Note that you should not swap to existing guest swap partitions unless you "
16876 "know what you are doing. They may contain hibernation information, or other "
16877 "information that the guest doesn't want you to trash. You also risk leaking "
16878 "information about the host to the guest this way. Instead, attach a new "
16879 "host device to the guest and swap on that."
16883 #: ../fish/guestfish-actions.pod:4792
16884 msgid "swapon-file"
16888 #: ../fish/guestfish-actions.pod:4794
16891 " swapon-file file\n"
16896 #: ../fish/guestfish-actions.pod:4796
16898 "This command enables swap to a file. See L</swapon-device> for other notes."
16902 #: ../fish/guestfish-actions.pod:4799
16903 msgid "swapon-label"
16907 #: ../fish/guestfish-actions.pod:4801
16910 " swapon-label label\n"
16915 #: ../fish/guestfish-actions.pod:4803
16917 "This command enables swap to a labeled swap partition. See L</swapon-"
16918 "device> for other notes."
16922 #: ../fish/guestfish-actions.pod:4806
16923 msgid "swapon-uuid"
16927 #: ../fish/guestfish-actions.pod:4808
16930 " swapon-uuid uuid\n"
16935 #: ../fish/guestfish-actions.pod:4810
16937 "This command enables swap to a swap partition with the given UUID. See L</"
16938 "swapon-device> for other notes."
16942 #: ../fish/guestfish-actions.pod:4813
16947 #: ../fish/guestfish-actions.pod:4815
16955 #: ../fish/guestfish-actions.pod:4817 ../src/guestfs-actions.pod:7419
16957 "This syncs the disk, so that any writes are flushed through to the "
16958 "underlying disk image."
16962 #: ../fish/guestfish-actions.pod:4820 ../src/guestfs-actions.pod:7422
16964 "You should always call this if you have modified a disk image, before "
16965 "closing the handle."
16969 #: ../fish/guestfish-actions.pod:4823
16974 #: ../fish/guestfish-actions.pod:4825
16982 #: ../fish/guestfish-actions.pod:4827 ../src/guestfs-actions.pod:7435
16984 "This command returns up to the last 10 lines of a file as a list of strings."
16988 #: ../fish/guestfish-actions.pod:4833
16993 #: ../fish/guestfish-actions.pod:4835
16996 " tail-n nrlines path\n"
17001 #: ../fish/guestfish-actions.pod:4837 ../src/guestfs-actions.pod:7454
17003 "If the parameter C<nrlines> is a positive number, this returns the last "
17004 "C<nrlines> lines of the file C<path>."
17008 #: ../fish/guestfish-actions.pod:4840 ../src/guestfs-actions.pod:7457
17010 "If the parameter C<nrlines> is a negative number, this returns lines from "
17011 "the file C<path>, starting with the C<-nrlines>th line."
17015 #: ../fish/guestfish-actions.pod:4848
17020 #: ../fish/guestfish-actions.pod:4850
17023 " tar-in (tarfile|-) directory\n"
17028 #: ../fish/guestfish-actions.pod:4852 ../src/guestfs-actions.pod:7478
17030 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17031 "tar file) into C<directory>."
17035 #: ../fish/guestfish-actions.pod:4855
17036 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
17040 #: ../fish/guestfish-actions.pod:4860
17045 #: ../fish/guestfish-actions.pod:4862
17048 " tar-out directory (tarfile|-)\n"
17053 #: ../fish/guestfish-actions.pod:4864 ../src/guestfs-actions.pod:7495
17055 "This command packs the contents of C<directory> and downloads it to local "
17060 #: ../fish/guestfish-actions.pod:4867
17061 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
17065 #: ../fish/guestfish-actions.pod:4872
17070 #: ../fish/guestfish-actions.pod:4874
17073 " tgz-in (tarball|-) directory\n"
17078 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7512
17080 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17081 "tar file) into C<directory>."
17085 #: ../fish/guestfish-actions.pod:4879
17086 msgid "To upload an uncompressed tarball, use L</tar-in>."
17090 #: ../fish/guestfish-actions.pod:4883
17095 #: ../fish/guestfish-actions.pod:4885
17098 " tgz-out directory (tarball|-)\n"
17103 #: ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:7528
17105 "This command packs the contents of C<directory> and downloads it to local "
17110 #: ../fish/guestfish-actions.pod:4890
17111 msgid "To download an uncompressed tarball, use L</tar-out>."
17115 #: ../fish/guestfish-actions.pod:4894
17120 #: ../fish/guestfish-actions.pod:4896
17128 #: ../fish/guestfish-actions.pod:4898 ../src/guestfs-actions.pod:7543
17130 "Touch acts like the L<touch(1)> command. It can be used to update the "
17131 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17136 #: ../fish/guestfish-actions.pod:4902 ../src/guestfs-actions.pod:7547
17138 "This command only works on regular files, and will fail on other file types "
17139 "such as directories, symbolic links, block special etc."
17143 #: ../fish/guestfish-actions.pod:4905
17148 #: ../fish/guestfish-actions.pod:4907
17156 #: ../fish/guestfish-actions.pod:4909 ../src/guestfs-actions.pod:7560
17158 "This command truncates C<path> to a zero-length file. The file must exist "
17163 #: ../fish/guestfish-actions.pod:4912
17164 msgid "truncate-size"
17168 #: ../fish/guestfish-actions.pod:4914
17171 " truncate-size path size\n"
17176 #: ../fish/guestfish-actions.pod:4916 ../src/guestfs-actions.pod:7574
17178 "This command truncates C<path> to size C<size> bytes. The file must exist "
17183 #: ../fish/guestfish-actions.pod:4919
17185 "If the current file size is less than C<size> then the file is extended to "
17186 "the required size with zero bytes. This creates a sparse file (ie. disk "
17187 "blocks are not allocated for the file until you write to it). To create a "
17188 "non-sparse file of zeroes, use L</fallocate64> instead."
17192 #: ../fish/guestfish-actions.pod:4925
17197 #: ../fish/guestfish-actions.pod:4927
17200 " tune2fs-l device\n"
17205 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7593
17207 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17212 #: ../fish/guestfish-actions.pod:4932 ../src/guestfs-actions.pod:7596
17214 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17215 "for more details. The list of fields returned isn't clearly defined, and "
17216 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17217 "and the filesystem itself."
17221 #: ../fish/guestfish-actions.pod:4937
17226 #: ../fish/guestfish-actions.pod:4939
17229 " txz-in (tarball|-) directory\n"
17234 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7616
17236 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17237 "tar file) into C<directory>."
17241 #: ../fish/guestfish-actions.pod:4946
17246 #: ../fish/guestfish-actions.pod:4948
17249 " txz-out directory (tarball|-)\n"
17254 #: ../fish/guestfish-actions.pod:4950 ../src/guestfs-actions.pod:7630
17256 "This command packs the contents of C<directory> and downloads it to local "
17257 "file C<tarball> (as an xz compressed tar archive)."
17261 #: ../fish/guestfish-actions.pod:4955
17266 #: ../fish/guestfish-actions.pod:4957
17274 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7643
17276 "This function sets the mask used for creating new files and device nodes to "
17281 #: ../fish/guestfish-actions.pod:4962 ../src/guestfs-actions.pod:7646
17283 "Typical umask values would be C<022> which creates new files with "
17284 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17285 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17289 #: ../fish/guestfish-actions.pod:4967 ../src/guestfs-actions.pod:7651
17291 "The default umask is C<022>. This is important because it means that "
17292 "directories and device nodes will be created with C<0644> or C<0755> mode "
17293 "even if you specify C<0777>."
17297 #: ../fish/guestfish-actions.pod:4971
17298 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
17302 #: ../fish/guestfish-actions.pod:4974 ../src/guestfs-actions.pod:7658
17303 msgid "This call returns the previous umask."
17307 #: ../fish/guestfish-actions.pod:4976
17312 #: ../fish/guestfish-actions.pod:4978
17317 #: ../fish/guestfish-actions.pod:4980
17320 " umount pathordevice\n"
17325 #: ../fish/guestfish-actions.pod:4982 ../src/guestfs-actions.pod:7670
17327 "This unmounts the given filesystem. The filesystem may be specified either "
17328 "by its mountpoint (path) or the device which contains the filesystem."
17332 #: ../fish/guestfish-actions.pod:4986
17337 #: ../fish/guestfish-actions.pod:4988
17338 msgid "unmount-all"
17342 #: ../fish/guestfish-actions.pod:4990
17350 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7683
17351 msgid "This unmounts all mounted filesystems."
17355 #: ../fish/guestfish-actions.pod:4994 ../src/guestfs-actions.pod:7685
17356 msgid "Some internal mounts are not unmounted by this call."
17360 #: ../fish/guestfish-actions.pod:4996
17365 #: ../fish/guestfish-actions.pod:4998
17368 " upload (filename|-) remotefilename\n"
17373 #: ../fish/guestfish-actions.pod:5000 ../fish/guestfish-actions.pod:5013
17374 #: ../src/guestfs-actions.pod:7698 ../src/guestfs-actions.pod:7722
17375 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17379 #: ../fish/guestfish-actions.pod:5005
17380 msgid "See also L</download>."
17384 #: ../fish/guestfish-actions.pod:5009
17385 msgid "upload-offset"
17389 #: ../fish/guestfish-actions.pod:5011
17392 " upload-offset (filename|-) remotefilename offset\n"
17397 #: ../fish/guestfish-actions.pod:5016 ../src/guestfs-actions.pod:7725
17399 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17400 "The intention is to overwrite parts of existing files or devices, although "
17401 "if a non-existant file is specified then it is created with a \"hole\" "
17402 "before C<offset>. The size of the data written is implicit in the size of "
17403 "the source C<filename>."
17407 #: ../fish/guestfish-actions.pod:5023
17409 "Note that there is no limit on the amount of data that can be uploaded with "
17410 "this call, unlike with L</pwrite>, and this call always writes the full "
17411 "amount unless an error occurs."
17415 #: ../fish/guestfish-actions.pod:5028
17416 msgid "See also L</upload>, L</pwrite>."
17420 #: ../fish/guestfish-actions.pod:5032
17425 #: ../fish/guestfish-actions.pod:5034
17428 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
17433 #: ../fish/guestfish-actions.pod:5036 ../src/guestfs-actions.pod:7758
17434 msgid "This command sets the timestamps of a file with nanosecond precision."
17438 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7761
17440 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17445 #: ../fish/guestfish-actions.pod:5042 ../src/guestfs-actions.pod:7764
17447 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17448 "nanoseconds from the epoch."
17452 #: ../fish/guestfish-actions.pod:5045 ../src/guestfs-actions.pod:7767
17454 "If the C<*nsecs> field contains the special value C<-1> then the "
17455 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17456 "ignored in this case)."
17460 #: ../fish/guestfish-actions.pod:5049 ../src/guestfs-actions.pod:7771
17462 "If the C<*nsecs> field contains the special value C<-2> then the "
17463 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17468 #: ../fish/guestfish-actions.pod:5053
17473 #: ../fish/guestfish-actions.pod:5055
17481 #: ../fish/guestfish-actions.pod:5057 ../src/guestfs-actions.pod:7784
17483 "Return the libguestfs version number that the program is linked against."
17487 #: ../fish/guestfish-actions.pod:5060 ../src/guestfs-actions.pod:7787
17489 "Note that because of dynamic linking this is not necessarily the version of "
17490 "libguestfs that you compiled against. You can compile the program, and then "
17491 "at runtime dynamically link against a completely different C<libguestfs.so> "
17496 #: ../fish/guestfish-actions.pod:5065 ../src/guestfs-actions.pod:7792
17498 "This call was added in version C<1.0.58>. In previous versions of "
17499 "libguestfs there was no way to get the version number. From C code you can "
17500 "use dynamic linker functions to find out if this symbol exists (if it "
17501 "doesn't, then it's an earlier version)."
17505 #: ../fish/guestfish-actions.pod:5071 ../src/guestfs-actions.pod:7798
17507 "The call returns a structure with four elements. The first three (C<major>, "
17508 "C<minor> and C<release>) are numbers and correspond to the usual version "
17509 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17510 "but may be used for distro-specific information."
17514 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7804
17516 "To construct the original version string: C<$major.$minor.$release$extra>"
17520 #: ../fish/guestfish-actions.pod:5080 ../src/guestfs-actions.pod:7807
17521 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17525 #: ../fish/guestfish-actions.pod:5082
17527 "I<Note:> Don't use this call to test for availability of features. In "
17528 "enterprise distributions we backport features from later versions into "
17529 "earlier versions, making this an unreliable way to test for features. Use "
17530 "L</available> instead."
17534 #: ../fish/guestfish-actions.pod:5088
17539 #: ../fish/guestfish-actions.pod:5090
17542 " vfs-label device\n"
17547 #: ../fish/guestfish-actions.pod:5092 ../src/guestfs-actions.pod:7827
17548 msgid "This returns the filesystem label of the filesystem on C<device>."
17552 #: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7830
17553 msgid "If the filesystem is unlabeled, this returns the empty string."
17557 #: ../fish/guestfish-actions.pod:5097
17558 msgid "To find a filesystem from the label, use L</findfs-label>."
17562 #: ../fish/guestfish-actions.pod:5099
17567 #: ../fish/guestfish-actions.pod:5101
17570 " vfs-type device\n"
17575 #: ../fish/guestfish-actions.pod:5103 ../src/guestfs-actions.pod:7845
17577 "This command gets the filesystem type corresponding to the filesystem on "
17582 #: ../fish/guestfish-actions.pod:5106 ../src/guestfs-actions.pod:7848
17584 "For most filesystems, the result is the name of the Linux VFS module which "
17585 "would be used to mount this filesystem if you mounted it without specifying "
17586 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17590 #: ../fish/guestfish-actions.pod:5111
17595 #: ../fish/guestfish-actions.pod:5113
17598 " vfs-uuid device\n"
17603 #: ../fish/guestfish-actions.pod:5115 ../src/guestfs-actions.pod:7864
17604 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17608 #: ../fish/guestfish-actions.pod:5118 ../src/guestfs-actions.pod:7867
17609 msgid "If the filesystem does not have a UUID, this returns the empty string."
17613 #: ../fish/guestfish-actions.pod:5120
17614 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
17618 #: ../fish/guestfish-actions.pod:5122
17619 msgid "vg-activate"
17623 #: ../fish/guestfish-actions.pod:5124
17626 " vg-activate true|false 'volgroups ...'\n"
17631 #: ../fish/guestfish-actions.pod:5126 ../src/guestfs-actions.pod:7883
17633 "This command activates or (if C<activate> is false) deactivates all logical "
17634 "volumes in the listed volume groups C<volgroups>."
17638 #: ../fish/guestfish-actions.pod:5129 ../src/guestfs-actions.pod:7886
17639 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17643 #: ../fish/guestfish-actions.pod:5131 ../src/guestfs-actions.pod:7888
17645 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17646 "activated or deactivated."
17650 #: ../fish/guestfish-actions.pod:5134
17651 msgid "vg-activate-all"
17655 #: ../fish/guestfish-actions.pod:5136
17658 " vg-activate-all true|false\n"
17663 #: ../fish/guestfish-actions.pod:5138 ../src/guestfs-actions.pod:7901
17665 "This command activates or (if C<activate> is false) deactivates all logical "
17666 "volumes in all volume groups."
17670 #: ../fish/guestfish-actions.pod:5141 ../src/guestfs-actions.pod:7904
17671 msgid "This command is the same as running C<vgchange -a y|n>"
17675 #: ../fish/guestfish-actions.pod:5143
17680 #: ../fish/guestfish-actions.pod:5145
17683 " vgcreate volgroup 'physvols ...'\n"
17688 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7917
17690 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17691 "of physical volumes C<physvols>."
17695 #: ../fish/guestfish-actions.pod:5150
17700 #: ../fish/guestfish-actions.pod:5152
17703 " vglvuuids vgname\n"
17708 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7930
17710 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17711 "volumes created in this volume group."
17715 #: ../fish/guestfish-actions.pod:5157
17717 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
17718 "logical volumes and volume groups."
17722 #: ../fish/guestfish-actions.pod:5160
17723 msgid "See also L</vgpvuuids>."
17727 #: ../fish/guestfish-actions.pod:5162
17732 #: ../fish/guestfish-actions.pod:5164
17735 " vgpvuuids vgname\n"
17740 #: ../fish/guestfish-actions.pod:5166 ../src/guestfs-actions.pod:7950
17742 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17743 "volumes that this volume group resides on."
17747 #: ../fish/guestfish-actions.pod:5169
17749 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
17750 "physical volumes and volume groups."
17754 #: ../fish/guestfish-actions.pod:5172
17755 msgid "See also L</vglvuuids>."
17759 #: ../fish/guestfish-actions.pod:5174
17764 #: ../fish/guestfish-actions.pod:5176
17767 " vgremove vgname\n"
17772 #: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7970
17773 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17777 #: ../fish/guestfish-actions.pod:5180 ../src/guestfs-actions.pod:7972
17779 "This also forcibly removes all logical volumes in the volume group (if any)."
17783 #: ../fish/guestfish-actions.pod:5183
17788 #: ../fish/guestfish-actions.pod:5185
17791 " vgrename volgroup newvolgroup\n"
17796 #: ../fish/guestfish-actions.pod:5187 ../src/guestfs-actions.pod:7986
17797 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17801 #: ../fish/guestfish-actions.pod:5189
17806 #: ../fish/guestfish-actions.pod:5191
17814 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7997
17816 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17821 #: ../fish/guestfish-actions.pod:5196 ../src/guestfs-actions.pod:8000
17823 "This returns a list of just the volume group names that were detected (eg. "
17828 #: ../fish/guestfish-actions.pod:5199
17829 msgid "See also L</vgs-full>."
17833 #: ../fish/guestfish-actions.pod:5201
17838 #: ../fish/guestfish-actions.pod:5203
17846 #: ../fish/guestfish-actions.pod:5205 ../src/guestfs-actions.pod:8016
17848 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
17849 "> command. The \"full\" version includes all fields."
17853 #: ../fish/guestfish-actions.pod:5208
17858 #: ../fish/guestfish-actions.pod:5210
17866 #: ../fish/guestfish-actions.pod:5212 ../src/guestfs-actions.pod:8030
17868 "This rescans all block devices and rebuilds the list of LVM physical "
17869 "volumes, volume groups and logical volumes."
17873 #: ../fish/guestfish-actions.pod:5215
17878 #: ../fish/guestfish-actions.pod:5217
17886 #: ../fish/guestfish-actions.pod:5219 ../src/guestfs-actions.pod:8043
17887 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17891 #: ../fish/guestfish-actions.pod:5221
17896 #: ../fish/guestfish-actions.pod:5223
17904 #: ../fish/guestfish-actions.pod:5225 ../src/guestfs-actions.pod:8083
17906 "This command counts the characters in a file, using the C<wc -c> external "
17911 #: ../fish/guestfish-actions.pod:5228
17916 #: ../fish/guestfish-actions.pod:5230
17924 #: ../fish/guestfish-actions.pod:5232 ../src/guestfs-actions.pod:8096
17926 "This command counts the lines in a file, using the C<wc -l> external command."
17930 #: ../fish/guestfish-actions.pod:5235
17935 #: ../fish/guestfish-actions.pod:5237
17943 #: ../fish/guestfish-actions.pod:5239 ../src/guestfs-actions.pod:8109
17945 "This command counts the words in a file, using the C<wc -w> external command."
17949 #: ../fish/guestfish-actions.pod:5242
17954 #: ../fish/guestfish-actions.pod:5244
17957 " write path content\n"
17962 #: ../fish/guestfish-actions.pod:5246 ../src/guestfs-actions.pod:8124
17964 "This call creates a file called C<path>. The content of the file is the "
17965 "string C<content> (which can contain any 8 bit data)."
17969 #: ../fish/guestfish-actions.pod:5249
17970 msgid "See also L</write-append>."
17974 #: ../fish/guestfish-actions.pod:5254
17975 msgid "write-append"
17979 #: ../fish/guestfish-actions.pod:5256
17982 " write-append path content\n"
17987 #: ../fish/guestfish-actions.pod:5258 ../src/guestfs-actions.pod:8144
17989 "This call appends C<content> to the end of file C<path>. If C<path> does "
17990 "not exist, then a new file is created."
17994 #: ../fish/guestfish-actions.pod:5261
17995 msgid "See also L</write>."
17999 #: ../fish/guestfish-actions.pod:5266
18004 #: ../fish/guestfish-actions.pod:5268
18007 " write-file path content size\n"
18012 #: ../fish/guestfish-actions.pod:5270 ../src/guestfs-actions.pod:8171
18014 "This call creates a file called C<path>. The contents of the file is the "
18015 "string C<content> (which can contain any 8 bit data), with length C<size>."
18019 #: ../fish/guestfish-actions.pod:5274 ../src/guestfs-actions.pod:8175
18021 "As a special case, if C<size> is C<0> then the length is calculated using "
18022 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18026 #: ../fish/guestfish-actions.pod:5278 ../src/guestfs-actions.pod:8179
18028 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18029 "I<not> work, even if the length is specified."
18033 #: ../fish/guestfish-actions.pod:5284
18035 "I<This function is deprecated.> In new code, use the L</write> call instead."
18039 #: ../fish/guestfish-actions.pod:5291
18044 #: ../fish/guestfish-actions.pod:5293
18047 " zegrep regex path\n"
18052 #: ../fish/guestfish-actions.pod:5295 ../src/guestfs-actions.pod:8196
18054 "This calls the external C<zegrep> program and returns the matching lines."
18058 #: ../fish/guestfish-actions.pod:5301
18063 #: ../fish/guestfish-actions.pod:5303
18066 " zegrepi regex path\n"
18071 #: ../fish/guestfish-actions.pod:5305 ../src/guestfs-actions.pod:8215
18073 "This calls the external C<zegrep -i> program and returns the matching lines."
18077 #: ../fish/guestfish-actions.pod:5311
18082 #: ../fish/guestfish-actions.pod:5313
18090 #: ../fish/guestfish-actions.pod:5315 ../src/guestfs-actions.pod:8233
18091 msgid "This command writes zeroes over the first few blocks of C<device>."
18095 #: ../fish/guestfish-actions.pod:5317 ../src/guestfs-actions.pod:8235
18097 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18098 "securely wipe the device). It should be sufficient to remove any partition "
18099 "tables, filesystem superblocks and so on."
18103 #: ../fish/guestfish-actions.pod:5321 ../fish/guestfish-actions.pod:5336
18104 #: ../src/guestfs-actions.pod:8239 ../src/guestfs-actions.pod:8265
18106 "If blocks are already zero, then this command avoids writing zeroes. This "
18107 "prevents the underlying device from becoming non-sparse or growing "
18112 #: ../fish/guestfish-actions.pod:5325
18113 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
18117 #: ../fish/guestfish-actions.pod:5328
18118 msgid "zero-device"
18122 #: ../fish/guestfish-actions.pod:5330
18125 " zero-device device\n"
18130 #: ../fish/guestfish-actions.pod:5332
18132 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
18133 "which just zeroes the first few blocks of a device."
18137 #: ../fish/guestfish-actions.pod:5340
18142 #: ../fish/guestfish-actions.pod:5342
18145 " zerofree device\n"
18150 #: ../fish/guestfish-actions.pod:5344 ../src/guestfs-actions.pod:8284
18152 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18153 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18154 "possible to compress the filesystem more effectively."
18158 #: ../fish/guestfish-actions.pod:5349 ../src/guestfs-actions.pod:8289
18159 msgid "You should B<not> run this program if the filesystem is mounted."
18163 #: ../fish/guestfish-actions.pod:5352 ../src/guestfs-actions.pod:8292
18165 "It is possible that using this program can damage the filesystem or data on "
18170 #: ../fish/guestfish-actions.pod:5355
18175 #: ../fish/guestfish-actions.pod:5357
18178 " zfgrep pattern path\n"
18183 #: ../fish/guestfish-actions.pod:5359 ../src/guestfs-actions.pod:8306
18185 "This calls the external C<zfgrep> program and returns the matching lines."
18189 #: ../fish/guestfish-actions.pod:5365
18194 #: ../fish/guestfish-actions.pod:5367
18197 " zfgrepi pattern path\n"
18202 #: ../fish/guestfish-actions.pod:5369 ../src/guestfs-actions.pod:8325
18204 "This calls the external C<zfgrep -i> program and returns the matching lines."
18208 #: ../fish/guestfish-actions.pod:5375
18213 #: ../fish/guestfish-actions.pod:5377
18216 " zfile meth path\n"
18221 #: ../fish/guestfish-actions.pod:5379 ../src/guestfs-actions.pod:8351
18223 "This command runs C<file> after first decompressing C<path> using C<method>."
18227 #: ../fish/guestfish-actions.pod:5382 ../src/guestfs-actions.pod:8354
18228 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18232 #: ../fish/guestfish-actions.pod:5384
18234 "Since 1.0.63, use L</file> instead which can now process compressed files."
18238 #: ../fish/guestfish-actions.pod:5387
18240 "I<This function is deprecated.> In new code, use the L</file> call instead."
18244 #: ../fish/guestfish-actions.pod:5394
18249 #: ../fish/guestfish-actions.pod:5396
18252 " zgrep regex path\n"
18257 #: ../fish/guestfish-actions.pod:5398 ../src/guestfs-actions.pod:8371
18259 "This calls the external C<zgrep> program and returns the matching lines."
18263 #: ../fish/guestfish-actions.pod:5404
18268 #: ../fish/guestfish-actions.pod:5406
18271 " zgrepi regex path\n"
18276 #: ../fish/guestfish-actions.pod:5408 ../src/guestfs-actions.pod:8390
18278 "This calls the external C<zgrep -i> program and returns the matching lines."
18282 #: ../fish/guestfish-commands.pod:1
18287 #: ../fish/guestfish-commands.pod:3
18292 #: ../fish/guestfish-commands.pod:5
18295 " alloc filename size\n"
18300 #: ../fish/guestfish-commands.pod:7
18302 "This creates an empty (zeroed) file of the given size, and then adds so it "
18303 "can be further examined."
18307 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
18308 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
18312 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
18313 msgid "Size can be specified using standard suffixes, eg. C<1M>."
18317 #: ../fish/guestfish-commands.pod:14
18319 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
18320 "image, see L</PREPARED DISK IMAGES>."
18324 #: ../fish/guestfish-commands.pod:17
18329 #: ../fish/guestfish-commands.pod:19
18332 " copy-in local [local ...] /remotedir\n"
18337 #: ../fish/guestfish-commands.pod:21
18339 "C<copy-in> copies local files or directories recursively into the disk "
18340 "image, placing them in the directory called C</remotedir> (which must "
18341 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
18342 "other commands as necessary."
18346 #: ../fish/guestfish-commands.pod:26
18348 "Multiple local files and directories can be specified, but the last "
18349 "parameter must always be a remote directory. Wildcards cannot be used."
18353 #: ../fish/guestfish-commands.pod:30
18358 #: ../fish/guestfish-commands.pod:32
18361 " copy-out remote [remote ...] localdir\n"
18366 #: ../fish/guestfish-commands.pod:34
18368 "C<copy-out> copies remote files or directories recursively out of the disk "
18369 "image, placing them on the host disk in a local directory called C<localdir> "
18370 "(which must exist). This guestfish meta-command turns into a sequence of L</"
18371 "download>, L</tar-out> and other commands as necessary."
18375 #: ../fish/guestfish-commands.pod:40
18377 "Multiple remote files and directories can be specified, but the last "
18378 "parameter must always be a local directory. To download to the current "
18379 "directory, use C<.> as in:"
18383 #: ../fish/guestfish-commands.pod:44
18386 " copy-out /home .\n"
18391 #: ../fish/guestfish-commands.pod:46
18393 "Wildcards cannot be used in the ordinary command, but you can use them with "
18394 "the help of L</glob> like this:"
18398 #: ../fish/guestfish-commands.pod:49
18401 " glob copy-out /home/* .\n"
18406 #: ../fish/guestfish-commands.pod:51
18411 #: ../fish/guestfish-commands.pod:53
18414 " display filename\n"
18419 #: ../fish/guestfish-commands.pod:55
18421 "Use C<display> (a graphical display program) to display an image file. It "
18422 "downloads the file, and runs C<display> on it."
18426 #: ../fish/guestfish-commands.pod:58
18428 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
18429 "environment variable. For example to use the GNOME display program:"
18433 #: ../fish/guestfish-commands.pod:61
18436 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
18441 #: ../fish/guestfish-commands.pod:63
18442 msgid "See also L<display(1)>."
18446 #: ../fish/guestfish-commands.pod:65
18451 #: ../fish/guestfish-commands.pod:67
18454 " echo [params ...]\n"
18459 #: ../fish/guestfish-commands.pod:69
18460 msgid "This echos the parameters to the terminal."
18464 #: ../fish/guestfish-commands.pod:71
18469 #: ../fish/guestfish-commands.pod:73
18474 #: ../fish/guestfish-commands.pod:75
18479 #: ../fish/guestfish-commands.pod:77
18487 #: ../fish/guestfish-commands.pod:79
18489 "This is used to edit a file. It downloads the file, edits it locally using "
18490 "your editor, then uploads the result."
18494 #: ../fish/guestfish-commands.pod:82
18496 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
18497 "or C<emacs> you will get those corresponding editors."
18501 #: ../fish/guestfish-commands.pod:86
18506 #: ../fish/guestfish-commands.pod:88
18509 " glob command args...\n"
18514 #: ../fish/guestfish-commands.pod:90
18516 "Expand wildcards in any paths in the args list, and run C<command> "
18517 "repeatedly on each matching path."
18521 #: ../fish/guestfish-commands.pod:93
18522 msgid "See L</WILDCARDS AND GLOBBING>."
18526 #: ../fish/guestfish-commands.pod:95
18531 #: ../fish/guestfish-commands.pod:97
18534 " hexedit <filename|device>\n"
18535 " hexedit <filename|device> <max>\n"
18536 " hexedit <filename|device> <start> <max>\n"
18541 #: ../fish/guestfish-commands.pod:101
18543 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
18548 #: ../fish/guestfish-commands.pod:104
18550 "This command works by downloading potentially the whole file or device, "
18551 "editing it locally, then uploading it. If the file or device is large, you "
18552 "have to specify which part you wish to edit by using C<max> and/or C<start> "
18553 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
18554 "usual modifiers allowed such as C<1M> (1 megabyte)."
18558 #: ../fish/guestfish-commands.pod:111
18559 msgid "For example to edit the first few sectors of a disk you might do:"
18563 #: ../fish/guestfish-commands.pod:114
18566 " hexedit /dev/sda 1M\n"
18571 #: ../fish/guestfish-commands.pod:116
18573 "which would allow you to edit anywhere within the first megabyte of the disk."
18577 #: ../fish/guestfish-commands.pod:119
18578 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
18582 #: ../fish/guestfish-commands.pod:121
18585 " hexedit /dev/sda1 0x400 0x400\n"
18590 #: ../fish/guestfish-commands.pod:123
18591 msgid "(assuming the superblock is in the standard location)."
18595 #: ../fish/guestfish-commands.pod:125
18597 "This command requires the external L<hexedit(1)> program. You can specify "
18598 "another program to use by setting the C<HEXEDITOR> environment variable."
18602 #: ../fish/guestfish-commands.pod:129
18603 msgid "See also L</hexdump>."
18607 #: ../fish/guestfish-commands.pod:131
18612 #: ../fish/guestfish-commands.pod:133
18620 #: ../fish/guestfish-commands.pod:135
18622 "Change the local directory, ie. the current directory of guestfish itself."
18626 #: ../fish/guestfish-commands.pod:138
18627 msgid "Note that C<!cd> won't do what you might expect."
18631 #: ../fish/guestfish-commands.pod:140
18636 #: ../fish/guestfish-commands.pod:142
18641 #: ../fish/guestfish-commands.pod:144
18649 #: ../fish/guestfish-commands.pod:146
18650 msgid "Opens the manual page for guestfish."
18654 #: ../fish/guestfish-commands.pod:148
18659 #: ../fish/guestfish-commands.pod:150
18664 #: ../fish/guestfish-commands.pod:152
18672 #: ../fish/guestfish-commands.pod:154
18680 #: ../fish/guestfish-commands.pod:156
18681 msgid "This is used to view a file."
18685 #: ../fish/guestfish-commands.pod:158
18687 "The default viewer is C<$PAGER>. However if you use the alternate command "
18688 "C<less> you will get the C<less> command specifically."
18692 #: ../fish/guestfish-commands.pod:161
18697 #: ../fish/guestfish-commands.pod:163
18705 #: ../fish/guestfish-commands.pod:165
18707 "Close and reopen the libguestfs handle. It is not necessary to use this "
18708 "normally, because the handle is closed properly when guestfish exits. "
18709 "However this is occasionally useful for testing."
18713 #: ../fish/guestfish-commands.pod:169
18718 #: ../fish/guestfish-commands.pod:171
18721 " setenv VAR value\n"
18726 #: ../fish/guestfish-commands.pod:173
18727 msgid "Set the environment variable C<VAR> to the string C<value>."
18731 #: ../fish/guestfish-commands.pod:175
18733 "To print the value of an environment variable use a shell command such as:"
18737 #: ../fish/guestfish-commands.pod:178
18745 #: ../fish/guestfish-commands.pod:180
18750 #: ../fish/guestfish-commands.pod:182
18753 " sparse filename size\n"
18758 #: ../fish/guestfish-commands.pod:184
18760 "This creates an empty sparse file of the given size, and then adds so it can "
18761 "be further examined."
18765 #: ../fish/guestfish-commands.pod:187
18767 "In all respects it works the same as the L</alloc> command, except that the "
18768 "image file is allocated sparsely, which means that disk blocks are not "
18769 "assigned to the file until they are needed. Sparse disk files only use "
18770 "space when written to, but they are slower and there is a danger you could "
18771 "run out of real disk space during a write operation."
18775 #: ../fish/guestfish-commands.pod:197
18780 #: ../fish/guestfish-commands.pod:199
18788 #: ../fish/guestfish-commands.pod:201
18790 "This command returns a list of the optional groups known to the daemon, and "
18791 "indicates which ones are supported by this build of the libguestfs appliance."
18795 #: ../fish/guestfish-commands.pod:205
18796 msgid "See also L<guestfs(3)/AVAILABILITY>."
18800 #: ../fish/guestfish-commands.pod:207
18805 #: ../fish/guestfish-commands.pod:209
18808 " time command args...\n"
18813 #: ../fish/guestfish-commands.pod:211
18815 "Run the command as usual, but print the elapsed time afterwards. This can "
18816 "be useful for benchmarking operations."
18820 #: ../fish/guestfish-commands.pod:214
18825 #: ../fish/guestfish-commands.pod:216
18833 #: ../fish/guestfish-commands.pod:218
18834 msgid "Remove C<VAR> from the environment."
18838 #: ../fish/guestfish.pod:5
18839 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
18843 #: ../fish/guestfish.pod:9
18846 " guestfish [--options] [commands]\n"
18851 #: ../fish/guestfish.pod:11
18859 #: ../fish/guestfish.pod:13
18862 " guestfish [--ro|--rw] -a disk.img\n"
18867 #: ../fish/guestfish.pod:15
18870 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
18875 #: ../fish/guestfish.pod:17
18878 " guestfish -d libvirt-domain\n"
18883 #: ../fish/guestfish.pod:19
18886 " guestfish [--ro|--rw] -a disk.img -i\n"
18891 #: ../fish/guestfish.pod:21
18894 " guestfish -d libvirt-domain -i\n"
18899 #: ../fish/guestfish.pod:25
18901 "Using guestfish in read/write mode on live virtual machines can be "
18902 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
18903 "option to use guestfish safely if the disk image or virtual machine might be "
18908 #: ../fish/guestfish.pod:32
18910 "Guestfish is a shell and command-line tool for examining and modifying "
18911 "virtual machine filesystems. It uses libguestfs and exposes all of the "
18912 "functionality of the guestfs API, see L<guestfs(3)>."
18916 #: ../fish/guestfish.pod:36
18918 "Guestfish gives you structured access to the libguestfs API, from shell "
18919 "scripts or the command line or interactively. If you want to rescue a "
18920 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
18925 #: ../fish/guestfish.pod:43
18926 msgid "As an interactive shell"
18930 #: ../fish/guestfish.pod:45
18938 #: ../fish/guestfish.pod:47
18941 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
18942 " editing virtual machine filesystems.\n"
18947 #: ../fish/guestfish.pod:50
18950 " Type: 'help' for a list of commands\n"
18951 " 'man' to read the manual\n"
18952 " 'quit' to quit the shell\n"
18957 #: ../fish/guestfish.pod:54
18960 " ><fs> add-ro disk.img\n"
18962 " ><fs> list-filesystems\n"
18963 " /dev/sda1: ext4\n"
18964 " /dev/vg_guest/lv_root: ext4\n"
18965 " /dev/vg_guest/lv_swap: swap\n"
18966 " ><fs> mount /dev/vg_guest/lv_root /\n"
18967 " ><fs> cat /etc/fstab\n"
18969 " # Created by anaconda\n"
18976 #: ../fish/guestfish.pod:67
18977 msgid "From shell scripts"
18981 #: ../fish/guestfish.pod:69
18982 msgid "Create a new C</etc/motd> file in a guest or disk image:"
18986 #: ../fish/guestfish.pod:71
18989 " guestfish <<_EOF_\n"
18992 " mount /dev/vg_guest/lv_root /\n"
18993 " write /etc/motd \"Welcome, new users\"\n"
18999 #: ../fish/guestfish.pod:78
19000 msgid "List the LVM logical volumes in a disk image:"
19004 #: ../fish/guestfish.pod:80
19007 " guestfish -a disk.img --ro <<_EOF_\n"
19015 #: ../fish/guestfish.pod:85
19016 msgid "List all the filesystems in a disk image:"
19020 #: ../fish/guestfish.pod:87
19023 " guestfish -a disk.img --ro <<_EOF_\n"
19025 " list-filesystems\n"
19031 #: ../fish/guestfish.pod:92
19032 msgid "On one command line"
19036 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
19037 msgid "Update C</etc/resolv.conf> in a guest:"
19041 #: ../fish/guestfish.pod:96
19045 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19046 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19051 #: ../fish/guestfish.pod:100
19052 msgid "Edit C</boot/grub/grub.conf> interactively:"
19056 #: ../fish/guestfish.pod:102
19059 " guestfish --rw --add disk.img \\\n"
19060 " --mount /dev/vg_guest/lv_root \\\n"
19061 " --mount /dev/sda1:/boot \\\n"
19062 " edit /boot/grub/grub.conf\n"
19067 #: ../fish/guestfish.pod:107
19068 msgid "Mount disks automatically"
19072 #: ../fish/guestfish.pod:109
19074 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19078 #: ../fish/guestfish.pod:112
19081 " guestfish --ro -a disk.img -i cat /etc/group\n"
19086 #: ../fish/guestfish.pod:114
19089 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19094 #: ../fish/guestfish.pod:116
19095 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19099 #: ../fish/guestfish.pod:118
19102 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19107 #: ../fish/guestfish.pod:120
19108 msgid "As a script interpreter"
19112 #: ../fish/guestfish.pod:122
19113 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19117 #: ../fish/guestfish.pod:124
19120 " #!/usr/bin/guestfish -f\n"
19121 " sparse test1.img 100M\n"
19123 " part-disk /dev/sda mbr\n"
19124 " mkfs ext2 /dev/sda1\n"
19129 #: ../fish/guestfish.pod:130
19130 msgid "Start with a prepared disk"
19134 #: ../fish/guestfish.pod:132
19136 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19137 "single ext2-formatted partition:"
19141 #: ../fish/guestfish.pod:135 ../src/guestfs.pod:2243
19144 " guestfish -N fs\n"
19149 #: ../fish/guestfish.pod:137
19150 msgid "To list what is available do:"
19154 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1042
19157 " guestfish -N help | less\n"
19162 #: ../fish/guestfish.pod:141
19163 msgid "Remote control"
19167 #: ../fish/guestfish.pod:143
19170 " eval \"`guestfish --listen`\"\n"
19171 " guestfish --remote add-ro disk.img\n"
19172 " guestfish --remote run\n"
19173 " guestfish --remote lvs\n"
19178 #: ../fish/guestfish.pod:154
19179 msgid "Displays general help on options."
19183 #: ../fish/guestfish.pod:158
19184 msgid "B<--cmd-help>"
19188 #: ../fish/guestfish.pod:160
19189 msgid "Lists all available guestfish commands."
19193 #: ../fish/guestfish.pod:162
19198 #: ../fish/guestfish.pod:164
19199 msgid "B<--cmd-help cmd>"
19203 #: ../fish/guestfish.pod:166
19204 msgid "Displays detailed help on a single command C<cmd>."
19208 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
19209 msgid "B<-a image>"
19213 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
19214 msgid "B<--add image>"
19218 #: ../fish/guestfish.pod:172
19219 msgid "Add a block device or virtual machine image to the shell."
19223 #: ../fish/guestfish.pod:177
19225 "Using this flag is mostly equivalent to using the C<add> command, with "
19226 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19227 "the I<--format=...> flag was given."
19231 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
19233 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19234 "URI to use. The default is to use the default libvirt connection."
19238 #: ../fish/guestfish.pod:189
19243 #: ../fish/guestfish.pod:191
19245 "If using the I<--listen> option and a csh-like shell, use this option. See "
19246 "section L</REMOTE CONTROL AND CSH> below."
19250 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
19251 msgid "B<-d libvirt-domain>"
19255 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
19256 msgid "B<--domain libvirt-domain>"
19260 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
19262 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19263 "used, then any libvirt domain can be used. However in write mode, only "
19264 "libvirt domains which are shut down can be named here."
19268 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
19269 msgid "Domain UUIDs can be used instead of names."
19273 #: ../fish/guestfish.pod:204
19275 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19276 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19277 "if the I<--format:...> flag was given."
19281 #: ../fish/guestfish.pod:208
19286 #: ../fish/guestfish.pod:210
19287 msgid "B<--no-dest-paths>"
19291 #: ../fish/guestfish.pod:212
19293 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19294 "to hit the tab key to complete paths on the guest filesystem, but this "
19295 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19296 "allow this feature to be disabled."
19300 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
19302 "When prompting for keys and passphrases, guestfish normally turns echoing "
19303 "off so you cannot see what you are typing. If you are not worried about "
19304 "Tempest attacks and there is no one else in the room you can specify this "
19305 "flag to see what you are typing."
19309 #: ../fish/guestfish.pod:224
19314 #: ../fish/guestfish.pod:226
19315 msgid "B<--file file>"
19319 #: ../fish/guestfish.pod:228
19320 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19324 #: ../fish/guestfish.pod:231
19327 " #!/usr/bin/guestfish -f\n"
19332 #: ../fish/guestfish.pod:244
19335 " guestfish --format=raw -a disk.img\n"
19340 #: ../fish/guestfish.pod:248
19343 " guestfish --format=raw -a disk.img --format -a another.img\n"
19348 #: ../fish/guestfish.pod:253
19350 "If you have untrusted raw-format guest disk images, you should use this "
19351 "option to specify the disk format. This avoids a possible security problem "
19352 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19356 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
19357 msgid "B<--inspector>"
19361 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
19363 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19364 "system and mount filesystems as they would be mounted on the real virtual "
19369 #: ../fish/guestfish.pod:266
19370 msgid "Typical usage is either:"
19374 #: ../fish/guestfish.pod:268
19377 " guestfish -d myguest -i\n"
19382 #: ../fish/guestfish.pod:270
19383 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19387 #: ../fish/guestfish.pod:272
19390 " guestfish --ro -d myguest -i\n"
19395 #: ../fish/guestfish.pod:274
19396 msgid "(for active domains, readonly), or specify the block device directly:"
19400 #: ../fish/guestfish.pod:276
19403 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19408 #: ../fish/guestfish.pod:278
19410 "Note that the command line syntax changed slightly over older versions of "
19411 "guestfish. You can still use the old syntax:"
19415 #: ../fish/guestfish.pod:281
19418 " guestfish [--ro] -i disk.img\n"
19423 #: ../fish/guestfish.pod:283
19426 " guestfish [--ro] -i libvirt-domain\n"
19431 #: ../fish/guestfish.pod:285
19433 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19434 "then using other commands to mount the filesystems that were found."
19438 #: ../fish/guestfish.pod:294
19439 msgid "B<--listen>"
19443 #: ../fish/guestfish.pod:296
19445 "Fork into the background and listen for remote commands. See section L</"
19446 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19450 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
19455 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
19457 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19458 "ATTACHING TO RUNNING DAEMONS>)."
19462 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
19463 msgid "B<-m dev[:mountpoint[:options]]>"
19467 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
19468 msgid "B<--mount dev[:mountpoint[:options]]>"
19472 #: ../fish/guestfish.pod:308
19473 msgid "Mount the named partition or logical volume on the given mountpoint."
19477 #: ../fish/guestfish.pod:310
19478 msgid "If the mountpoint is omitted, it defaults to C</>."
19482 #: ../fish/guestfish.pod:312
19483 msgid "You have to mount something on C</> before most commands will work."
19487 #: ../fish/guestfish.pod:314
19489 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19494 #: ../fish/guestfish.pod:317
19496 "If you don't know what filesystems a disk image contains, you can either run "
19497 "guestfish without this option, then list the partitions, filesystems and LVs "
19498 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19499 "commands), or you can use the L<virt-filesystems(1)> program."
19503 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
19505 "The third (and rarely used) part of the mount parameter is the list of mount "
19506 "options used to mount the underlying filesystem. If this is not given, then "
19507 "the mount options are either the empty string or C<ro> (the latter if the "
19508 "I<--ro> flag is used). By specifying the mount options, you override this "
19509 "default choice. Probably the only time you would use this is to enable ACLs "
19510 "and/or extended attributes if the filesystem can support them:"
19514 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
19517 " -m /dev/sda1:/:acl,user_xattr\n"
19522 #: ../fish/guestfish.pod:333
19523 msgid "Using this flag is equivalent to using the C<mount-options> command."
19527 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202
19528 #: ../resize/virt-resize.pod:435
19533 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
19534 msgid "B<--no-sync>"
19538 #: ../fish/guestfish.pod:339
19540 "Disable autosync. This is enabled by default. See the discussion of "
19541 "autosync in the L<guestfs(3)> manpage."
19545 #: ../fish/guestfish.pod:342
19550 #: ../fish/guestfish.pod:344
19551 msgid "B<--new type>"
19555 #: ../fish/guestfish.pod:346
19560 #: ../fish/guestfish.pod:348
19562 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19563 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19564 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19569 #: ../fish/guestfish.pod:353
19570 msgid "B<--progress-bars>"
19574 #: ../fish/guestfish.pod:355
19575 msgid "Enable progress bars, even when guestfish is used non-interactively."
19579 #: ../fish/guestfish.pod:357
19581 "Progress bars are enabled by default when guestfish is used as an "
19582 "interactive shell."
19586 #: ../fish/guestfish.pod:360
19587 msgid "B<--no-progress-bars>"
19591 #: ../fish/guestfish.pod:362
19592 msgid "Disable progress bars."
19596 #: ../fish/guestfish.pod:364
19597 msgid "B<--remote[=pid]>"
19601 #: ../fish/guestfish.pod:366
19603 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19604 "CONTROL GUESTFISH OVER A SOCKET> below."
19608 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248
19609 #: ../rescue/virt-rescue.pod:161
19614 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250
19615 #: ../rescue/virt-rescue.pod:163
19620 #: ../fish/guestfish.pod:373
19622 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19623 "mounts are done read-only."
19627 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
19629 "The option must always be used if the disk image or virtual machine might be "
19630 "running, and is generally recommended in cases where you don't need write "
19631 "access to the disk."
19635 #: ../fish/guestfish.pod:380
19637 "Note that prepared disk images created with I<-N> are not affected by this "
19638 "option. Also commands like C<add> are not affected - you have to specify "
19639 "the C<readonly:true> option explicitly if you need it."
19643 #: ../fish/guestfish.pod:384
19644 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19648 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262
19649 #: ../rescue/virt-rescue.pod:173
19650 msgid "B<--selinux>"
19654 #: ../fish/guestfish.pod:388
19655 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19659 #: ../fish/guestfish.pod:394
19661 "Enable very verbose messages. This is particularly useful if you find a bug."
19665 #: ../fish/guestfish.pod:401
19666 msgid "Display the guestfish / libguestfs version number and exit."
19670 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278
19671 #: ../rescue/virt-rescue.pod:194
19676 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280
19677 #: ../rescue/virt-rescue.pod:196
19682 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
19684 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19685 "mounts are done read-write."
19689 #: ../fish/guestfish.pod:410
19690 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19694 #: ../fish/guestfish.pod:414
19695 msgid "Echo each command before executing it."
19699 #: ../fish/guestfish.pod:418
19700 msgid "COMMANDS ON COMMAND LINE"
19704 #: ../fish/guestfish.pod:420
19706 "Any additional (non-option) arguments are treated as commands to execute."
19710 #: ../fish/guestfish.pod:423
19712 "Commands to execute should be separated by a colon (C<:>), where the colon "
19713 "is a separate parameter. Thus:"
19717 #: ../fish/guestfish.pod:426
19720 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
19725 #: ../fish/guestfish.pod:428
19727 "If there are no additional arguments, then we enter a shell, either an "
19728 "interactive shell with a prompt (if the input is a terminal) or a non-"
19729 "interactive shell."
19733 #: ../fish/guestfish.pod:432
19735 "In either command line mode or non-interactive shell, the first command that "
19736 "gives an error causes the whole shell to exit. In interactive mode (with a "
19737 "prompt) if a command fails, you can continue to enter commands."
19741 #: ../fish/guestfish.pod:437
19742 msgid "USING launch (OR run)"
19746 #: ../fish/guestfish.pod:439
19748 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
19749 "then launch it, then mount any disks you need, and finally issue actions/"
19750 "commands. So the general order of the day is:"
19754 #: ../fish/guestfish.pod:447
19755 msgid "add or -a/--add"
19759 #: ../fish/guestfish.pod:451
19760 msgid "launch (aka run)"
19764 #: ../fish/guestfish.pod:455
19765 msgid "mount or -m/--mount"
19769 #: ../fish/guestfish.pod:459
19770 msgid "any other commands"
19774 #: ../fish/guestfish.pod:463
19776 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
19777 "guest before mounting or performing any other commands."
19781 #: ../fish/guestfish.pod:466
19783 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
19784 "I<--new> options were given then C<run> is done automatically, simply "
19785 "because guestfish can't perform the action you asked for without doing this."
19789 #: ../fish/guestfish.pod:471
19790 msgid "OPENING DISKS FOR READ AND WRITE"
19794 #: ../fish/guestfish.pod:473
19796 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
19797 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
19798 "I<-i> and I<-m> open disk images read-only or for writing."
19802 #: ../fish/guestfish.pod:478
19804 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
19805 "opening disk images supplied on the command line for write. To open a disk "
19806 "image read-only you have to do I<-a image --ro>."
19810 #: ../fish/guestfish.pod:482
19812 "This matters: If you accidentally open a live VM disk image writable then "
19813 "you will cause irreversible disk corruption."
19817 #: ../fish/guestfish.pod:485
19819 "In a future libguestfs we intend to change the default the other way. Disk "
19820 "images will be opened read-only. You will have to either specify "
19821 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
19822 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
19823 "access for disk images specified by those other command line options."
19827 #: ../fish/guestfish.pod:492
19829 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
19830 "which does nothing (it is already the default). However it is highly "
19831 "recommended that you use this option to indicate that you need write access, "
19832 "and prepare your scripts for the day when this option will be required for "
19837 #: ../fish/guestfish.pod:498
19839 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
19840 "other libguestfs program apart from guestfish and guestmount."
19844 #: ../fish/guestfish.pod:501
19849 #: ../fish/guestfish.pod:503
19851 "You can quote ordinary parameters using either single or double quotes. For "
19856 #: ../fish/guestfish.pod:506
19859 " add \"file with a space.img\"\n"
19864 #: ../fish/guestfish.pod:508
19867 " rm '/file name'\n"
19872 #: ../fish/guestfish.pod:510
19880 #: ../fish/guestfish.pod:512
19882 "A few commands require a list of strings to be passed. For these, use a "
19883 "whitespace-separated list, enclosed in quotes. Strings containing "
19884 "whitespace to be passed through must be enclosed in single quotes. A "
19885 "literal single quote must be escaped with a backslash."
19889 #: ../fish/guestfish.pod:517
19892 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
19893 " command \"/bin/echo 'foo bar'\"\n"
19894 " command \"/bin/echo \\'foo\\'\"\n"
19899 #: ../fish/guestfish.pod:521
19900 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
19904 #: ../fish/guestfish.pod:523
19906 "In double-quoted arguments (only) use backslash to insert special characters:"
19910 #: ../fish/guestfish.pod:528
19915 #: ../fish/guestfish.pod:530
19916 msgid "Alert (bell) character."
19920 #: ../fish/guestfish.pod:532
19925 #: ../fish/guestfish.pod:534
19926 msgid "Backspace character."
19930 #: ../fish/guestfish.pod:536
19935 #: ../fish/guestfish.pod:538
19936 msgid "Form feed character."
19940 #: ../fish/guestfish.pod:540
19945 #: ../fish/guestfish.pod:542
19946 msgid "Newline character."
19950 #: ../fish/guestfish.pod:544
19955 #: ../fish/guestfish.pod:546
19956 msgid "Carriage return character."
19960 #: ../fish/guestfish.pod:548
19965 #: ../fish/guestfish.pod:550
19966 msgid "Horizontal tab character."
19970 #: ../fish/guestfish.pod:552
19975 #: ../fish/guestfish.pod:554
19976 msgid "Vertical tab character."
19980 #: ../fish/guestfish.pod:556
19985 #: ../fish/guestfish.pod:558
19986 msgid "A literal double quote character."
19990 #: ../fish/guestfish.pod:560
19995 #: ../fish/guestfish.pod:562
19997 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
20002 #: ../fish/guestfish.pod:565
20007 #: ../fish/guestfish.pod:567
20009 "A character with hex value I<hh>. There must be precisely 2 hex digits."
20013 #: ../fish/guestfish.pod:570
20015 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
20020 #: ../fish/guestfish.pod:573
20025 #: ../fish/guestfish.pod:575
20026 msgid "A literal backslash character."
20030 #: ../fish/guestfish.pod:579
20031 msgid "OPTIONAL ARGUMENTS"
20035 #: ../fish/guestfish.pod:581
20037 "Some commands take optional arguments. These arguments appear in this "
20038 "documentation as C<[argname:..]>. You can use them as in these examples:"
20042 #: ../fish/guestfish.pod:585
20045 " add-drive-opts filename\n"
20050 #: ../fish/guestfish.pod:587
20053 " add-drive-opts filename readonly:true\n"
20058 #: ../fish/guestfish.pod:589
20061 " add-drive-opts filename format:qcow2 readonly:false\n"
20066 #: ../fish/guestfish.pod:591
20068 "Each optional argument can appear at most once. All optional arguments must "
20069 "appear after the required ones."
20073 #: ../fish/guestfish.pod:594
20078 #: ../fish/guestfish.pod:596
20080 "This section applies to all commands which can take integers as parameters."
20084 #: ../fish/guestfish.pod:599
20085 msgid "SIZE SUFFIX"
20089 #: ../fish/guestfish.pod:601
20091 "When the command takes a parameter measured in bytes, you can use one of the "
20092 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20096 #: ../fish/guestfish.pod:607
20097 msgid "B<k> or B<K> or B<KiB>"
20101 #: ../fish/guestfish.pod:609
20102 msgid "The size in kilobytes (multiplied by 1024)."
20106 #: ../fish/guestfish.pod:611
20111 #: ../fish/guestfish.pod:613
20112 msgid "The size in SI 1000 byte units."
20116 #: ../fish/guestfish.pod:615
20117 msgid "B<M> or B<MiB>"
20121 #: ../fish/guestfish.pod:617
20122 msgid "The size in megabytes (multiplied by 1048576)."
20126 #: ../fish/guestfish.pod:619
20131 #: ../fish/guestfish.pod:621
20132 msgid "The size in SI 1000000 byte units."
20136 #: ../fish/guestfish.pod:623
20137 msgid "B<G> or B<GiB>"
20141 #: ../fish/guestfish.pod:625
20142 msgid "The size in gigabytes (multiplied by 2**30)."
20146 #: ../fish/guestfish.pod:627
20151 #: ../fish/guestfish.pod:629
20152 msgid "The size in SI 10**9 byte units."
20156 #: ../fish/guestfish.pod:631
20157 msgid "B<T> or B<TiB>"
20161 #: ../fish/guestfish.pod:633
20162 msgid "The size in terabytes (multiplied by 2**40)."
20166 #: ../fish/guestfish.pod:635
20171 #: ../fish/guestfish.pod:637
20172 msgid "The size in SI 10**12 byte units."
20176 #: ../fish/guestfish.pod:639
20177 msgid "B<P> or B<PiB>"
20181 #: ../fish/guestfish.pod:641
20182 msgid "The size in petabytes (multiplied by 2**50)."
20186 #: ../fish/guestfish.pod:643
20191 #: ../fish/guestfish.pod:645
20192 msgid "The size in SI 10**15 byte units."
20196 #: ../fish/guestfish.pod:647
20197 msgid "B<E> or B<EiB>"
20201 #: ../fish/guestfish.pod:649
20202 msgid "The size in exabytes (multiplied by 2**60)."
20206 #: ../fish/guestfish.pod:651
20211 #: ../fish/guestfish.pod:653
20212 msgid "The size in SI 10**18 byte units."
20216 #: ../fish/guestfish.pod:655
20217 msgid "B<Z> or B<ZiB>"
20221 #: ../fish/guestfish.pod:657
20222 msgid "The size in zettabytes (multiplied by 2**70)."
20226 #: ../fish/guestfish.pod:659
20231 #: ../fish/guestfish.pod:661
20232 msgid "The size in SI 10**21 byte units."
20236 #: ../fish/guestfish.pod:663
20237 msgid "B<Y> or B<YiB>"
20241 #: ../fish/guestfish.pod:665
20242 msgid "The size in yottabytes (multiplied by 2**80)."
20246 #: ../fish/guestfish.pod:667
20251 #: ../fish/guestfish.pod:669
20252 msgid "The size in SI 10**24 byte units."
20256 #: ../fish/guestfish.pod:675
20259 " truncate-size /file 1G\n"
20264 #: ../fish/guestfish.pod:677
20265 msgid "would truncate the file to 1 gigabyte."
20269 #: ../fish/guestfish.pod:679
20271 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20272 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20273 "suffix will probably not do what you expect."
20277 #: ../fish/guestfish.pod:683
20278 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20282 #: ../fish/guestfish.pod:685
20284 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20285 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20289 #: ../fish/guestfish.pod:688
20292 " 1234 decimal number 1234\n"
20293 " 02322 octal number, equivalent to decimal 1234\n"
20294 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20299 #: ../fish/guestfish.pod:692
20301 "When using the C<chmod> command, you almost always want to specify an octal "
20302 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20303 "L<chmod(1)> program):"
20307 #: ../fish/guestfish.pod:696
20310 " chmod 0777 /public # OK\n"
20311 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20316 #: ../fish/guestfish.pod:699
20318 "Commands that return numbers usually print them in decimal, but some "
20319 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20320 "octal, preceeded by C<0>)."
20324 #: ../fish/guestfish.pod:703
20325 msgid "WILDCARDS AND GLOBBING"
20329 #: ../fish/guestfish.pod:705
20331 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20332 "(globbing) by default. So for example the following will not do what you "
20337 #: ../fish/guestfish.pod:709
20345 #: ../fish/guestfish.pod:711
20347 "Assuming you don't have a directory called literally C</home/*> then the "
20348 "above command will return an error."
20352 #: ../fish/guestfish.pod:714
20353 msgid "To perform wildcard expansion, use the C<glob> command."
20357 #: ../fish/guestfish.pod:716
20360 " glob rm-rf /home/*\n"
20365 #: ../fish/guestfish.pod:718
20367 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20368 "many times), equivalent to:"
20372 #: ../fish/guestfish.pod:721
20375 " rm-rf /home/jim\n"
20376 " rm-rf /home/joe\n"
20377 " rm-rf /home/mary\n"
20382 #: ../fish/guestfish.pod:725
20383 msgid "C<glob> only works on simple guest paths and not on device names."
20387 #: ../fish/guestfish.pod:727
20389 "If you have several parameters, each containing a wildcard, then glob will "
20390 "perform a Cartesian product."
20394 #: ../fish/guestfish.pod:730
20399 #: ../fish/guestfish.pod:732
20401 "Any line which starts with a I<#> character is treated as a comment and "
20402 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20403 "a command. For example:"
20407 #: ../fish/guestfish.pod:736
20410 " # this is a comment\n"
20411 " # this is a comment\n"
20412 " foo # NOT a comment\n"
20417 #: ../fish/guestfish.pod:740
20418 msgid "Blank lines are also ignored."
20422 #: ../fish/guestfish.pod:742
20423 msgid "RUNNING COMMANDS LOCALLY"
20427 #: ../fish/guestfish.pod:744
20429 "Any line which starts with a I<!> character is treated as a command sent to "
20430 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20434 #: ../fish/guestfish.pod:748
20438 " tgz-out /remote local/remote-data.tar.gz\n"
20443 #: ../fish/guestfish.pod:751
20445 "will create a directory C<local> on the host, and then export the contents "
20446 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20447 "(See C<tgz-out>)."
20451 #: ../fish/guestfish.pod:755
20453 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20454 "effect, due to the way that subprocesses work in Unix."
20458 #: ../fish/guestfish.pod:758
20459 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20463 #: ../fish/guestfish.pod:760
20465 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20466 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20467 "and executed as guestfish commands."
20471 #: ../fish/guestfish.pod:764
20473 "Thus you can use shell script to construct arbitrary guestfish commands "
20474 "which are then parsed by guestfish."
20478 #: ../fish/guestfish.pod:767
20480 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20481 "through C</foo.100>) using guestfish commands alone. However this is simple "
20482 "if we use a shell script to create the guestfish commands for us:"
20486 #: ../fish/guestfish.pod:772
20489 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20494 #: ../fish/guestfish.pod:774
20495 msgid "or with names like C</foo.001>:"
20499 #: ../fish/guestfish.pod:776
20502 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20507 #: ../fish/guestfish.pod:778
20509 "When using guestfish interactively it can be helpful to just run the shell "
20510 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20511 "ordinary I<!> local command), see what guestfish commands it would run, and "
20512 "when you are happy with those prepend the C<E<lt>> character to run the "
20513 "guestfish commands for real."
20517 #: ../fish/guestfish.pod:784
20522 #: ../fish/guestfish.pod:786
20524 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20525 "command (a guestfish command) to the second command (any host command). For "
20530 #: ../fish/guestfish.pod:790
20533 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20538 #: ../fish/guestfish.pod:792
20540 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20541 "program). The above command would list all accounts in the guest filesystem "
20542 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20546 #: ../fish/guestfish.pod:797
20549 " hexdump /bin/ls | head\n"
20550 " list-devices | tail -1\n"
20551 " tgz-out / - | tar ztf -\n"
20556 #: ../fish/guestfish.pod:801
20558 "The space before the pipe symbol is required, any space after the pipe "
20559 "symbol is optional. Everything after the pipe symbol is just passed "
20560 "straight to the host shell, so it can contain redirections, globs and "
20561 "anything else that makes sense on the host side."
20565 #: ../fish/guestfish.pod:806
20567 "To use a literal argument which begins with a pipe symbol, you have to quote "
20572 #: ../fish/guestfish.pod:809
20580 #: ../fish/guestfish.pod:811
20581 msgid "HOME DIRECTORIES"
20585 #: ../fish/guestfish.pod:813
20587 "If a parameter starts with the character C<~> then the tilde may be expanded "
20588 "as a home directory path (either C<~> for the current user's home directory, "
20589 "or C<~user> for another user)."
20593 #: ../fish/guestfish.pod:817
20595 "Note that home directory expansion happens for users known I<on the host>, "
20596 "not in the guest filesystem."
20600 #: ../fish/guestfish.pod:820
20602 "To use a literal argument which begins with a tilde, you have to quote it, "
20607 #: ../fish/guestfish.pod:823
20615 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:534
20616 msgid "ENCRYPTED DISKS"
20620 #: ../fish/guestfish.pod:827
20622 "Libguestfs has some support for Linux guests encrypted according to the "
20623 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20624 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
20625 "LUKS is supported."
20629 #: ../fish/guestfish.pod:832
20630 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20634 #: ../fish/guestfish.pod:834
20637 " ><fs> vfs-type /dev/sda2\n"
20643 #: ../fish/guestfish.pod:837
20645 "Then open those devices using L</luks-open>. This creates a device-mapper "
20646 "device called C</dev/mapper/luksdev>."
20650 #: ../fish/guestfish.pod:840
20653 " ><fs> luks-open /dev/sda2 luksdev\n"
20654 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20659 #: ../fish/guestfish.pod:843
20661 "Finally you have to tell LVM to scan for volume groups on the newly created "
20666 #: ../fish/guestfish.pod:846
20670 " vg-activate-all true\n"
20675 #: ../fish/guestfish.pod:849
20676 msgid "The logical volume(s) can now be mounted in the usual way."
20680 #: ../fish/guestfish.pod:851
20682 "Before closing a LUKS device you must unmount any logical volumes on it and "
20683 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20684 "one. Then you can close the mapper device:"
20688 #: ../fish/guestfish.pod:855
20691 " vg-activate false /dev/VG\n"
20692 " luks-close /dev/mapper/luksdev\n"
20697 #: ../fish/guestfish.pod:860
20699 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20700 "letters and paths (with some limitations). The following commands are "
20705 #: ../fish/guestfish.pod:864
20708 " file /WINDOWS/system32/config/system.LOG\n"
20713 #: ../fish/guestfish.pod:866
20716 " file win:\\windows\\system32\\config\\system.log\n"
20721 #: ../fish/guestfish.pod:868
20724 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20729 #: ../fish/guestfish.pod:870
20731 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20732 "where the drive is mounted, prepending that to the path, changing all "
20733 "backslash characters to forward slash, then resolving the result using L</"
20734 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
20735 "the parameter might be rewritten like this:"
20739 #: ../fish/guestfish.pod:876
20742 " win:e:\\foo\\bar => /e/FOO/bar\n"
20747 #: ../fish/guestfish.pod:878
20748 msgid "This only works in argument positions that expect a path."
20752 #: ../fish/guestfish.pod:880
20753 msgid "UPLOADING AND DOWNLOADING FILES"
20757 #: ../fish/guestfish.pod:882
20759 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20760 "others which upload from or download to a local file, you can use the "
20761 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20765 #: ../fish/guestfish.pod:886
20773 #: ../fish/guestfish.pod:888
20775 "reads stdin and creates from that a file C</foo> in the disk image, and:"
20779 #: ../fish/guestfish.pod:891
20782 " tar-out /etc - | tar tf -\n"
20787 #: ../fish/guestfish.pod:893
20789 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20790 "command (see L</PIPES>)."
20794 #: ../fish/guestfish.pod:896
20796 "When using C<-> to read from stdin, the input is read up to the end of "
20797 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20798 "some arbitrary end marker:"
20802 #: ../fish/guestfish.pod:900
20805 " upload -<<END /foo\n"
20814 #: ../fish/guestfish.pod:906
20816 "Any string of characters can be used instead of C<END>. The end marker must "
20817 "appear on a line of its own, without any preceeding or following characters "
20818 "(not even spaces)."
20822 #: ../fish/guestfish.pod:910
20824 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20825 "upload local files (so-called \"FileIn\" parameters in the generator)."
20829 #: ../fish/guestfish.pod:913
20830 msgid "EXIT ON ERROR BEHAVIOUR"
20834 #: ../fish/guestfish.pod:915
20836 "By default, guestfish will ignore any errors when in interactive mode (ie. "
20837 "taking commands from a human over a tty), and will exit on the first error "
20838 "in non-interactive mode (scripts, commands given on the command line)."
20842 #: ../fish/guestfish.pod:920
20844 "If you prefix a command with a I<-> character, then that command will not "
20845 "cause guestfish to exit, even if that (one) command returns an error."
20849 #: ../fish/guestfish.pod:924
20850 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
20854 #: ../fish/guestfish.pod:926
20856 "Guestfish can be remote-controlled over a socket. This is useful "
20857 "particularly in shell scripts where you want to make several different "
20858 "changes to a filesystem, but you don't want the overhead of starting up a "
20859 "guestfish process each time."
20863 #: ../fish/guestfish.pod:931
20864 msgid "Start a guestfish server process using:"
20868 #: ../fish/guestfish.pod:933
20871 " eval \"`guestfish --listen`\"\n"
20876 #: ../fish/guestfish.pod:935
20877 msgid "and then send it commands by doing:"
20881 #: ../fish/guestfish.pod:937
20884 " guestfish --remote cmd [...]\n"
20889 #: ../fish/guestfish.pod:939
20890 msgid "To cause the server to exit, send it the exit command:"
20894 #: ../fish/guestfish.pod:943
20896 "Note that the server will normally exit if there is an error in a command. "
20897 "You can change this in the usual way. See section L</EXIT ON ERROR "
20902 #: ../fish/guestfish.pod:947
20903 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
20907 #: ../fish/guestfish.pod:949
20909 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
20910 "is how the I<--remote> option knows where to send the commands. You can "
20911 "have several guestfish listener processes running using:"
20915 #: ../fish/guestfish.pod:953
20918 " eval \"`guestfish --listen`\"\n"
20919 " pid1=$GUESTFISH_PID\n"
20920 " eval \"`guestfish --listen`\"\n"
20921 " pid2=$GUESTFISH_PID\n"
20923 " guestfish --remote=$pid1 cmd\n"
20924 " guestfish --remote=$pid2 cmd\n"
20929 #: ../fish/guestfish.pod:961
20930 msgid "REMOTE CONTROL AND CSH"
20934 #: ../fish/guestfish.pod:963
20936 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
20941 #: ../fish/guestfish.pod:966
20944 " eval \"`guestfish --listen --csh`\"\n"
20949 #: ../fish/guestfish.pod:968
20950 msgid "REMOTE CONTROL DETAILS"
20954 #: ../fish/guestfish.pod:970
20956 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
20957 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
20958 "and C<$PID> is the process ID of the server."
20962 #: ../fish/guestfish.pod:974
20963 msgid "Guestfish client and server versions must match exactly."
20967 #: ../fish/guestfish.pod:976
20968 msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
20972 #: ../fish/guestfish.pod:978
20974 "From Bash, you can use the following code which creates a guestfish "
20975 "instance, correctly quotes the command line, handles failure to start, and "
20976 "cleans up guestfish when the script exits:"
20980 #: ../fish/guestfish.pod:982 ../src/guestfs.pod:980
20988 #: ../fish/guestfish.pod:986
20991 " guestfish[0]=\"guestfish\"\n"
20992 " guestfish[1]=\"--listen\"\n"
20993 " guestfish[2]=\"--ro\"\n"
20994 " guestfish[3]=\"-a\"\n"
20995 " guestfish[4]=\"disk.img\"\n"
21000 #: ../fish/guestfish.pod:992
21003 " GUESTFISH_PID=\n"
21004 " eval $(\"${guestfish[@]}\")\n"
21005 " if [ -z \"$GUESTFISH_PID\" ]; then\n"
21006 " echo \"error: guestfish didn't start up, see error messages above\"\n"
21013 #: ../fish/guestfish.pod:999
21016 " cleanup_guestfish ()\n"
21018 " guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
21020 " trap cleanup_guestfish EXIT ERR\n"
21025 #: ../fish/guestfish.pod:1005
21028 " guestfish --remote -- run\n"
21033 #: ../fish/guestfish.pod:1007
21041 #: ../fish/guestfish.pod:1009
21042 msgid "REMOTE CONTROL RUN COMMAND HANGING"
21046 #: ../fish/guestfish.pod:1011
21048 "Using the C<run> (or C<launch>) command remotely in a command substitution "
21049 "context hangs, ie. don't do (note the backquotes):"
21053 #: ../fish/guestfish.pod:1014
21056 " a=`guestfish --remote run`\n"
21061 #: ../fish/guestfish.pod:1016
21063 "Since the C<run> command produces no output on stdout, this is not useful "
21064 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
21069 #: ../fish/guestfish.pod:1020
21070 msgid "PREPARED DISK IMAGES"
21074 #: ../fish/guestfish.pod:1022
21076 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21077 "preformatted disk images that guestfish can make for you to save typing. "
21078 "This is particularly useful for testing purposes. This option is used "
21079 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21080 "can be mixed with I<-a>)."
21084 #: ../fish/guestfish.pod:1028
21086 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21087 "the second and so on. Existing files in the current directory are "
21092 #: ../fish/guestfish.pod:1032
21094 "The type briefly describes how the disk should be sized, partitioned, how "
21095 "filesystem(s) should be created, and how content should be added. "
21096 "Optionally the type can be followed by extra parameters, separated by C<:> "
21097 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21098 "allocated disk, containing a single partition, with the partition formatted "
21099 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21104 #: ../fish/guestfish.pod:1040
21105 msgid "To list the available types and any extra parameters they take, run:"
21109 #: ../fish/guestfish.pod:1044
21111 "Note that the prepared filesystem is not mounted. You would usually have to "
21112 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21116 #: ../fish/guestfish.pod:1048
21118 "If any I<-N> or I<--new> options are given, the guest is automatically "
21123 #: ../fish/guestfish.pod:1053
21124 msgid "Create a 100MB disk with an ext4-formatted partition:"
21128 #: ../fish/guestfish.pod:1055
21131 " guestfish -N fs:ext4\n"
21136 #: ../fish/guestfish.pod:1057
21137 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21141 #: ../fish/guestfish.pod:1059
21144 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21149 #: ../fish/guestfish.pod:1061
21150 msgid "Create a blank 200MB disk:"
21154 #: ../fish/guestfish.pod:1063
21157 " guestfish -N disk:200M\n"
21162 #: ../fish/guestfish.pod:1065
21163 msgid "PROGRESS BARS"
21167 #: ../fish/guestfish.pod:1067
21169 "Some (not all) long-running commands send progress notification messages as "
21170 "they are running. Guestfish turns these messages into progress bars."
21174 #: ../fish/guestfish.pod:1071
21176 "When a command that supports progress bars takes longer than two seconds to "
21177 "run, and if progress bars are enabled, then you will see one appearing below "
21182 #: ../fish/guestfish.pod:1075
21185 " ><fs> copy-size /large-file /another-file 2048M\n"
21186 " / 10% [#####-----------------------------------------] 00:30\n"
21191 #: ../fish/guestfish.pod:1078
21193 "The spinner on the left hand side moves round once for every progress "
21194 "notification received from the backend. This is a (reasonably) golden "
21195 "assurance that the command is \"doing something\" even if the progress bar "
21196 "is not moving, because the command is able to send the progress "
21197 "notifications. When the bar reaches 100% and the command finishes, the "
21198 "spinner disappears."
21202 #: ../fish/guestfish.pod:1085
21204 "Progress bars are enabled by default when guestfish is used interactively. "
21205 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21206 "and you can disable them completely using I<--no-progress-bars>."
21210 #: ../fish/guestfish.pod:1090
21211 msgid "GUESTFISH COMMANDS"
21215 #: ../fish/guestfish.pod:1092
21217 "The commands in this section are guestfish convenience commands, in other "
21218 "words, they are not part of the L<guestfs(3)> API."
21222 #: ../fish/guestfish.pod:1095
21227 #: ../fish/guestfish.pod:1097
21236 #: ../fish/guestfish.pod:1100
21237 msgid "Without any parameter, this provides general help."
21241 #: ../fish/guestfish.pod:1102
21242 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21246 #: ../fish/guestfish.pod:1104
21247 msgid "quit | exit"
21251 #: ../fish/guestfish.pod:1106
21252 msgid "This exits guestfish. You can also use C<^D> key."
21256 #: ../fish/guestfish.pod:1108
21257 msgid "@FISH_COMMANDS@"
21261 #: ../fish/guestfish.pod:1110
21266 #: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1520
21271 #: ../fish/guestfish.pod:1116
21273 "guestfish returns 0 if the commands completed without error, or 1 if there "
21278 #: ../fish/guestfish.pod:1123
21283 #: ../fish/guestfish.pod:1125
21285 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21290 #: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3218
21291 msgid "FEBOOTSTRAP_KERNEL"
21295 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3220
21296 msgid "FEBOOTSTRAP_MODULES"
21300 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3222
21302 "These two environment variables allow the kernel that libguestfs uses in the "
21303 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
21304 "most recent host kernel is chosen. For more information about kernel "
21305 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
21306 "available in febootstrap E<ge> 3.8."
21310 #: ../fish/guestfish.pod:1138
21311 msgid "GUESTFISH_DISPLAY_IMAGE"
21315 #: ../fish/guestfish.pod:1140
21317 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
21318 "If not set, it uses L<display(1)>."
21322 #: ../fish/guestfish.pod:1143
21323 msgid "GUESTFISH_PID"
21327 #: ../fish/guestfish.pod:1145
21329 "Used with the I<--remote> option to specify the remote guestfish process to "
21330 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21334 #: ../fish/guestfish.pod:1149
21339 #: ../fish/guestfish.pod:1151
21341 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21342 "not specified, the external L<hexedit(1)> program is used."
21346 #: ../fish/guestfish.pod:1155
21351 #: ../fish/guestfish.pod:1157
21353 "If compiled with GNU readline support, various files in the home directory "
21354 "can be used. See L</FILES>."
21358 #: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3228
21359 msgid "LIBGUESTFS_APPEND"
21363 #: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3230
21364 msgid "Pass additional options to the guest kernel."
21368 #: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3232
21369 msgid "LIBGUESTFS_DEBUG"
21373 #: ../fish/guestfish.pod:1166
21375 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21376 "effect as using the B<-v> option."
21380 #: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3237
21381 msgid "LIBGUESTFS_MEMSIZE"
21385 #: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3239
21387 "Set the memory allocated to the qemu process, in megabytes. For example:"
21391 #: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3242
21394 " LIBGUESTFS_MEMSIZE=700\n"
21399 #: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3244
21400 msgid "LIBGUESTFS_PATH"
21404 #: ../fish/guestfish.pod:1178
21406 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21407 "the discussion of paths in L<guestfs(3)>."
21411 #: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3249
21412 msgid "LIBGUESTFS_QEMU"
21416 #: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3251
21418 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
21419 "which was found at compile time by the configure script is used."
21423 #: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3257
21424 msgid "LIBGUESTFS_TRACE"
21428 #: ../fish/guestfish.pod:1189
21429 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21433 #: ../fish/guestfish.pod:1191
21438 #: ../fish/guestfish.pod:1193
21440 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21445 #: ../fish/guestfish.pod:1196 ../sparsify/virt-sparsify.pod:235
21446 #: ../src/guestfs.pod:3262
21451 #: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3264
21453 "Location of temporary directory, defaults to C</tmp> except for the cached "
21454 "supermin appliance which defaults to C</var/tmp>."
21458 #: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3267
21460 "If libguestfs was compiled to use the supermin appliance then the real "
21461 "appliance is cached in this directory, shared between all handles belonging "
21462 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
21463 "use in case C</var/tmp> is not large enough."
21467 #: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297
21468 #: ../rescue/virt-rescue.pod:273
21473 #: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301
21474 #: ../rescue/virt-rescue.pod:277
21475 msgid "$HOME/.libguestfs-tools.rc"
21479 #: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303
21480 #: ../rescue/virt-rescue.pod:279
21481 msgid "/etc/libguestfs-tools.conf"
21485 #: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305
21486 #: ../rescue/virt-rescue.pod:281
21488 "This configuration file controls the default read-only or read-write mode "
21489 "(I<--ro> or I<--rw>)."
21493 #: ../fish/guestfish.pod:1220
21494 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21498 #: ../fish/guestfish.pod:1222
21499 msgid "$HOME/.guestfish"
21503 #: ../fish/guestfish.pod:1224
21505 "If compiled with GNU readline support, then the command history is saved in "
21510 #: ../fish/guestfish.pod:1227
21511 msgid "$HOME/.inputrc"
21515 #: ../fish/guestfish.pod:1229
21516 msgid "/etc/inputrc"
21520 #: ../fish/guestfish.pod:1231
21522 "If compiled with GNU readline support, then these files can be used to "
21523 "configure readline. For further information, please see L<readline(3)/"
21524 "INITIALIZATION FILE>."
21528 #: ../fish/guestfish.pod:1235
21529 msgid "To write rules which only apply to guestfish, use:"
21533 #: ../fish/guestfish.pod:1237
21543 #: ../fish/guestfish.pod:1241
21545 "Variables that you can set in inputrc that change the behaviour of guestfish "
21546 "in useful ways include:"
21550 #: ../fish/guestfish.pod:1246
21551 msgid "completion-ignore-case (default: on)"
21555 #: ../fish/guestfish.pod:1248
21557 "By default, guestfish will ignore case when tab-completing paths on the "
21562 #: ../fish/guestfish.pod:1251
21565 " set completion-ignore-case off\n"
21570 #: ../fish/guestfish.pod:1253
21571 msgid "to make guestfish case sensitive."
21575 #: ../fish/guestfish.pod:1257
21580 #: ../fish/guestfish.pod:1259
21581 msgid "test2.img (etc)"
21585 #: ../fish/guestfish.pod:1261
21587 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21588 "will be created in the file C<test1.img> in the current directory. The "
21589 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21590 "the same name will be overwritten."
21594 #: ../fish/guestfish.pod:1270
21596 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-alignment-scan(1)>, L<virt-"
21597 "cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit"
21598 "(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems"
21599 "(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
21600 "rescue(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, L<virt-sysprep(1)>, "
21601 "L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, "
21602 "L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
21606 #: ../fish/guestfish.pod:1302 ../src/guestfs.pod:3360
21607 #: ../test-tool/libguestfs-test-tool.pod:112
21608 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
21612 #: ../fish/virt-copy-in.pod:5
21614 "virt-copy-in - Copy files and directories into a virtual machine disk image."
21618 #: ../fish/virt-copy-in.pod:9
21621 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
21626 #: ../fish/virt-copy-in.pod:11
21629 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
21634 #: ../fish/virt-copy-in.pod:15
21636 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
21637 "causing disk corruption. The virtual machine must be shut down before you "
21638 "use this command."
21642 #: ../fish/virt-copy-in.pod:21
21644 "C<virt-copy-in> copies files and directories from the local disk into a "
21645 "virtual machine disk image or named libvirt domain."
21649 #: ../fish/virt-copy-in.pod:24
21651 "You can give one of more filenames and directories on the command line. "
21652 "Directories are copied in recursively. The final parameter must be the "
21653 "destination directory in the disk image which must be an absolute path "
21654 "starting with a C</> character."
21658 #: ../fish/virt-copy-in.pod:33
21661 " virt-copy-in -d MyGuest resolv.conf /etc\n"
21666 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
21667 msgid "Upload a home directory to a guest:"
21671 #: ../fish/virt-copy-in.pod:37
21674 " virt-copy-in -d MyGuest skel /home\n"
21679 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
21680 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
21681 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
21685 #: ../fish/virt-copy-in.pod:41
21687 "This command is just a simple shell script wrapper around the L<guestfish(1)"
21688 "> C<copy-in> command. For anything more complex than a trivial copy, you "
21689 "are probably better off using guestfish directly."
21693 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
21694 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
21696 "Since the shell script just passes options straight to guestfish, read "
21697 "L<guestfish(1)> to see the full list of options."
21701 #: ../fish/virt-copy-in.pod:52
21703 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
21704 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
21708 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
21709 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
21710 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
21714 #: ../fish/virt-copy-out.pod:5
21716 "virt-copy-out - Copy files and directories out of a virtual machine disk "
21721 #: ../fish/virt-copy-out.pod:9
21724 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
21729 #: ../fish/virt-copy-out.pod:11
21732 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
21737 #: ../fish/virt-copy-out.pod:15
21739 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
21740 "image or named libvirt domain."
21744 #: ../fish/virt-copy-out.pod:18
21746 "You can give one of more filenames and directories on the command line. "
21747 "Directories are copied out recursively."
21751 #: ../fish/virt-copy-out.pod:23
21752 msgid "Download the home directories from a virtual machine:"
21756 #: ../fish/virt-copy-out.pod:25
21760 " virt-copy-out -d MyGuest /home homes\n"
21765 #: ../fish/virt-copy-out.pod:30
21767 "This command is just a simple shell script wrapper around the L<guestfish(1)"
21768 "> C<copy-out> command. For anything more complex than a trivial copy, you "
21769 "are probably better off using guestfish directly."
21773 #: ../fish/virt-copy-out.pod:41
21775 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
21776 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
21780 #: ../fish/virt-tar-in.pod:5
21781 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
21785 #: ../fish/virt-tar-in.pod:9
21788 " virt-tar-in -a disk.img data.tar /destination\n"
21793 #: ../fish/virt-tar-in.pod:11
21796 " virt-tar-in -d domain data.tar /destination\n"
21801 #: ../fish/virt-tar-in.pod:13
21804 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
21809 #: ../fish/virt-tar-in.pod:17
21811 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
21812 "causing disk corruption. The virtual machine must be shut down before you "
21813 "use this command."
21817 #: ../fish/virt-tar-in.pod:23
21819 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
21820 "image or named libvirt domain."
21824 #: ../fish/virt-tar-in.pod:26
21826 "The first parameter is the tar file. Use C<-> to read the tar file from "
21827 "standard input. The second parameter is the absolute target directory to "
21832 #: ../fish/virt-tar-in.pod:34
21835 " virt-tar-in -d MyGuest homes.tar /home\n"
21840 #: ../fish/virt-tar-in.pod:38
21842 "This command is just a simple shell script wrapper around the L<guestfish(1)"
21843 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
21844 "probably better off using guestfish directly."
21848 #: ../fish/virt-tar-in.pod:49
21850 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
21851 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
21856 #: ../fish/virt-tar-out.pod:5
21858 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
21862 #: ../fish/virt-tar-out.pod:9
21865 " virt-tar-out -a disk.img /dir files.tar\n"
21870 #: ../fish/virt-tar-out.pod:11
21873 " virt-tar-out -d domain /dir files.tar\n"
21878 #: ../fish/virt-tar-out.pod:13
21881 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
21886 #: ../fish/virt-tar-out.pod:17
21888 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
21892 #: ../fish/virt-tar-out.pod:20
21894 "The first parameter is the absolute path of the virtual machine directory. "
21895 "The second parameter is the tar file to write. Use C<-> to write to "
21900 #: ../fish/virt-tar-out.pod:26
21901 msgid "Download the home directories from a guest:"
21905 #: ../fish/virt-tar-out.pod:28
21908 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
21913 #: ../fish/virt-tar-out.pod:32
21915 "This command is just a simple shell script wrapper around the L<guestfish(1)"
21916 "> C<tar-out> command. For anything more complex than a trivial copy, you "
21917 "are probably better off using guestfish directly."
21921 #: ../fish/virt-tar-out.pod:43
21923 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
21924 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
21928 #: ../fuse/guestmount.pod:5
21930 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
21934 #: ../fuse/guestmount.pod:9
21937 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
21942 #: ../fuse/guestmount.pod:11
21945 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
21950 #: ../fuse/guestmount.pod:13
21953 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
21958 #: ../fuse/guestmount.pod:17
21960 "You must I<not> use C<guestmount> in read-write mode on live virtual "
21961 "machines. If you do this, you risk disk corruption in the VM."
21965 #: ../fuse/guestmount.pod:22
21967 "The guestmount program can be used to mount virtual machine filesystems and "
21968 "other disk images on the host. It uses libguestfs for access to the guest "
21969 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
21970 "a mountable device."
21974 #: ../fuse/guestmount.pod:27
21976 "Along with other options, you have to give at least one device (I<-a> "
21977 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
21978 "option) or use the I<-i> inspection option or the I<--live> option. How "
21979 "this works is better explained in the L<guestfish(1)> manual page, or by "
21980 "looking at the examples below."
21984 #: ../fuse/guestmount.pod:33
21986 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
21987 "by you, and the filesystem will not be visible to any other users unless you "
21988 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
21989 "the filesystem, use the C<fusermount -u> command."
21993 #: ../fuse/guestmount.pod:41
21995 "For a typical Windows guest which has its main filesystem on the first "
22000 #: ../fuse/guestmount.pod:44
22003 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
22008 #: ../fuse/guestmount.pod:46
22010 "For a typical Linux guest which has a /boot filesystem on the first "
22011 "partition, and the root filesystem on a logical volume:"
22015 #: ../fuse/guestmount.pod:49
22018 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
22023 #: ../fuse/guestmount.pod:51
22024 msgid "To get libguestfs to detect guest mountpoints for you:"
22028 #: ../fuse/guestmount.pod:53
22031 " guestmount -a guest.img -i --ro /mnt\n"
22036 #: ../fuse/guestmount.pod:55
22037 msgid "For a libvirt guest called \"Guest\" you could do:"
22041 #: ../fuse/guestmount.pod:57
22044 " guestmount -d Guest -i --ro /mnt\n"
22049 #: ../fuse/guestmount.pod:59
22051 "If you don't know what filesystems are contained in a guest or disk image, "
22052 "use L<virt-filesystems(1)> first:"
22056 #: ../fuse/guestmount.pod:62
22059 " virt-filesystems MyGuest\n"
22064 #: ../fuse/guestmount.pod:64
22066 "If you want to trace the libguestfs calls but without excessive debugging "
22067 "information, we recommend:"
22071 #: ../fuse/guestmount.pod:67
22074 " guestmount [...] --trace /mnt\n"
22079 #: ../fuse/guestmount.pod:69
22080 msgid "If you want to debug the program, we recommend:"
22084 #: ../fuse/guestmount.pod:71
22087 " guestmount [...] --trace --verbose /mnt\n"
22092 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
22093 #: ../resize/virt-resize.pod:621
22098 #: ../fuse/guestmount.pod:75
22099 msgid "Other users cannot see the filesystem by default"
22103 #: ../fuse/guestmount.pod:77
22105 "If you mount a filesystem as one user (eg. root), then other users will not "
22106 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
22107 "option when mounting:"
22111 #: ../fuse/guestmount.pod:81
22114 " sudo guestmount [...] -o allow_other /mnt\n"
22119 #: ../fuse/guestmount.pod:83
22120 msgid "Enabling FUSE"
22124 #: ../fuse/guestmount.pod:85
22126 "On some distros, you may need to add yourself to a special group (eg. "
22127 "C<fuse>) before you can use any FUSE filesystem. This is necessary on "
22128 "Debian and derivatives."
22132 #: ../fuse/guestmount.pod:89
22134 "On other distros, no special group is required. It is not necessary on "
22135 "Fedora or Red Hat Enterprise Linux."
22139 #: ../fuse/guestmount.pod:100
22140 msgid "Add a block device or virtual machine image."
22144 #: ../fuse/guestmount.pod:123
22145 msgid "B<--dir-cache-timeout N>"
22149 #: ../fuse/guestmount.pod:125
22151 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
22152 "seconds. The readdir cache [actually, there are several semi-independent "
22153 "caches] is populated after a readdir(2) call with the stat and extended "
22154 "attributes of the files in the directory, in anticipation that they will be "
22155 "requested soon after."
22159 #: ../fuse/guestmount.pod:131
22161 "There is also a different attribute cache implemented by FUSE (see the FUSE "
22162 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
22163 "requests, only cache existing ones."
22167 #: ../fuse/guestmount.pod:151
22169 "If you have untrusted raw-format guest disk images, you should use this "
22170 "option to specify the disk format. This avoids a possible security problem "
22171 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
22172 "guestfs_add_drive_opts>."
22176 #: ../fuse/guestmount.pod:156
22177 msgid "B<--fuse-help>"
22181 #: ../fuse/guestmount.pod:158
22182 msgid "Display help on special FUSE options (see I<-o> below)."
22186 #: ../fuse/guestmount.pod:162
22187 msgid "Display brief help and exit."
22191 #: ../fuse/guestmount.pod:186
22193 "Mount the named partition or logical volume on the given mountpoint B<in the "
22194 "guest> (this has nothing to do with mountpoints in the host)."
22198 #: ../fuse/guestmount.pod:189
22200 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
22201 "something on C</>."
22205 #: ../fuse/guestmount.pod:206
22207 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
22208 "unmounted. If you specify this option, then we don't attempt to sync the "
22209 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
22213 #: ../fuse/guestmount.pod:211
22214 msgid "B<-o option>"
22218 #: ../fuse/guestmount.pod:213
22219 msgid "B<--option option>"
22223 #: ../fuse/guestmount.pod:215
22224 msgid "Pass extra options to FUSE."
22228 #: ../fuse/guestmount.pod:217
22230 "To get a list of all the extra options supported by FUSE, use the command "
22231 "below. Note that only the FUSE I<-o> options can be passed, and only some "
22232 "of them are a good idea."
22236 #: ../fuse/guestmount.pod:221
22239 " guestmount --fuse-help\n"
22244 #: ../fuse/guestmount.pod:223
22245 msgid "Some potentially useful FUSE options:"
22249 #: ../fuse/guestmount.pod:227
22250 msgid "B<-o allow_other>"
22254 #: ../fuse/guestmount.pod:229
22255 msgid "Allow other users to see the filesystem."
22259 #: ../fuse/guestmount.pod:231
22260 msgid "B<-o attr_timeout=N>"
22264 #: ../fuse/guestmount.pod:233
22265 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
22269 #: ../fuse/guestmount.pod:235
22270 msgid "B<-o kernel_cache>"
22274 #: ../fuse/guestmount.pod:237
22276 "Allow the kernel to cache files (reduces the number of reads that have to go "
22277 "through the L<guestfs(3)> API). This is generally a good idea if you can "
22278 "afford the extra memory usage."
22282 #: ../fuse/guestmount.pod:241
22283 msgid "B<-o uid=N> B<-o gid=N>"
22287 #: ../fuse/guestmount.pod:243
22289 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
22290 "the chosen values."
22294 #: ../fuse/guestmount.pod:252
22296 "Add devices and mount everything read-only. Also disallow writes and make "
22297 "the disk appear read-only to FUSE."
22301 #: ../fuse/guestmount.pod:255
22303 "This is highly recommended if you are not going to edit the guest disk. If "
22304 "the guest is running and this option is I<not> supplied, then there is a "
22305 "strong risk of disk corruption in the guest. We try to prevent this from "
22306 "happening, but it is not always possible."
22310 #: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:171
22311 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
22315 #: ../fuse/guestmount.pod:264
22316 msgid "Enable SELinux support for the guest."
22320 #: ../fuse/guestmount.pod:270
22321 msgid "Enable verbose messages from underlying libguestfs."
22325 #: ../fuse/guestmount.pod:276
22326 msgid "Display the program version and exit."
22330 #: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308
22331 #: ../rescue/virt-rescue.pod:201 ../rescue/virt-rescue.pod:284
22332 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
22336 #: ../fuse/guestmount.pod:289
22341 #: ../fuse/guestmount.pod:291
22342 msgid "Trace libguestfs calls and entry into each FUSE function."
22346 #: ../fuse/guestmount.pod:293
22347 msgid "This also stops the daemon from forking into the background."
22351 #: ../fuse/guestmount.pod:319
22353 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
22354 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
22359 #: ../fuse/guestmount.pod:334
22360 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
22364 #: ../inspector/virt-inspector.pod:5
22366 "virt-inspector - Display operating system version and other information "
22367 "about a virtual machine"
22371 #: ../inspector/virt-inspector.pod:9
22374 " virt-inspector [--options] -d domname\n"
22379 #: ../inspector/virt-inspector.pod:11
22382 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
22387 #: ../inspector/virt-inspector.pod:15
22390 " virt-inspector domname\n"
22395 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:148
22398 " virt-inspector disk.img [disk.img ...]\n"
22403 #: ../inspector/virt-inspector.pod:21
22405 "B<virt-inspector> examines a virtual machine or disk image and tries to "
22406 "determine the version of the operating system and other information about "
22407 "the virtual machine."
22411 #: ../inspector/virt-inspector.pod:25
22412 msgid "Virt-inspector produces XML output for feeding into other programs."
22416 #: ../inspector/virt-inspector.pod:27
22418 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
22419 "the libvirt domain (see: C<virsh list --all>)."
22423 #: ../inspector/virt-inspector.pod:30
22425 "You can also run virt-inspector directly on disk images from a single "
22426 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
22427 "has several block devices, in which case you should list several I<-a> "
22428 "options one after another, with the first corresponding to the guest's C</"
22429 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
22433 #: ../inspector/virt-inspector.pod:37
22435 "You can also run virt-inspector on install disks, live CDs, bootable USB "
22436 "keys and similar."
22440 #: ../inspector/virt-inspector.pod:40
22442 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
22443 "inspect several virtual machines, you have to run virt-inspector several "
22444 "times (for example, from a shell script for-loop)."
22448 #: ../inspector/virt-inspector.pod:45
22450 "Because virt-inspector needs direct access to guest images, it won't "
22451 "normally work over remote libvirt connections."
22455 #: ../inspector/virt-inspector.pod:48
22457 "All of the information available from virt-inspector is also available "
22458 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
22459 "The same information can also be fetched using guestfish or via libguestfs "
22460 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
22461 "WITH OTHER PROGRAMMING LANGUAGES>)."
22465 #: ../inspector/virt-inspector.pod:81
22467 "Libvirt is only used if you specify a C<domname> on the command line. If "
22468 "you specify guest block devices directly (I<-a>), then libvirt is not used "
22473 #: ../inspector/virt-inspector.pod:94
22475 "When prompting for keys and passphrases, virt-inspector normally turns "
22476 "echoing off so you cannot see what you are typing. If you are not worried "
22477 "about Tempest attacks and there is no one else in the room you can specify "
22478 "this flag to see what you are typing."
22482 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
22483 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
22484 #: ../tools/virt-win-reg.pl:144
22486 "Specify the format of disk images given on the command line. If this is "
22487 "omitted then the format is autodetected from the content of the disk image."
22491 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
22492 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
22493 #: ../tools/virt-win-reg.pl:148
22495 "If disk images are requested from libvirt, then this program asks libvirt "
22496 "for this information. In this case, the value of the format parameter is "
22501 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:391
22502 #: ../resize/virt-resize.pod:483 ../sparsify/virt-sparsify.pod:131
22503 #: ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102
22504 #: ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
22506 "If working with untrusted raw-format guest disk images, you should ensure "
22507 "the format is always specified."
22511 #: ../inspector/virt-inspector.pod:135
22512 msgid "B<--xpath> query"
22516 #: ../inspector/virt-inspector.pod:137
22518 "Perform an XPath query on the XML on stdin, and print the result on stdout. "
22519 "In this mode virt-inspector simply runs an XPath query; all other inspection "
22520 "functions are disabled. See L</XPATH QUERIES> below for some examples."
22524 #: ../inspector/virt-inspector.pod:146
22525 msgid "Previous versions of virt-inspector allowed you to write either:"
22529 #: ../inspector/virt-inspector.pod:152
22532 " virt-inspector guestname\n"
22537 #: ../inspector/virt-inspector.pod:160
22542 #: ../inspector/virt-inspector.pod:162
22544 "The virt-inspector XML is described precisely in a RELAX NG schema file "
22545 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
22546 "just an overview."
22550 #: ../inspector/virt-inspector.pod:166
22552 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
22553 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
22554 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
22555 "which is vanishingly rare in real world VMs."
22559 #: ../inspector/virt-inspector.pod:171
22560 msgid "E<lt>operatingsystemE<gt>"
22564 #: ../inspector/virt-inspector.pod:173
22566 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
22567 "describe the operating system, its architecture, the descriptive \"product "
22568 "name\" string, the type of OS and so on, as in this example:"
22572 #: ../inspector/virt-inspector.pod:177
22575 " <operatingsystems>\n"
22576 " <operatingsystem>\n"
22577 " <root>/dev/sda2</root>\n"
22578 " <name>windows</name>\n"
22579 " <arch>i386</arch>\n"
22580 " <distro>windows</distro>\n"
22581 " <product_name>Windows 7 Enterprise</product_name>\n"
22582 " <product_variant>Client</product_variant>\n"
22583 " <major_version>6</major_version>\n"
22584 " <minor_version>1</minor_version>\n"
22585 " <windows_systemroot>/Windows</windows_systemroot>\n"
22586 " <format>installed</format>\n"
22591 #: ../inspector/virt-inspector.pod:190
22593 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
22594 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
22595 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
22596 "architecture. The other fields are fairly self-explanatory, but because "
22597 "these fields are taken directly from the libguestfs inspection API you can "
22598 "find precise information from L<guestfs(3)/INSPECTION>."
22602 #: ../inspector/virt-inspector.pod:198
22604 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
22605 "of view of libguestfs (block devices may have completely different names "
22606 "inside the VM itself)."
22610 #: ../inspector/virt-inspector.pod:202
22611 msgid "E<lt>mountpointsE<gt>"
22615 #: ../inspector/virt-inspector.pod:204
22617 "Un*x-like guests typically have multiple filesystems which are mounted at "
22618 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
22619 "element which looks like this:"
22623 #: ../inspector/virt-inspector.pod:208
22626 " <operatingsystems>\n"
22627 " <operatingsystem>\n"
22630 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
22631 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
22632 " </mountpoints>\n"
22637 #: ../inspector/virt-inspector.pod:216
22639 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
22640 "and may have completely different names inside the guest. Only mountable "
22641 "filesystems appear in this list, not things like swap devices."
22645 #: ../inspector/virt-inspector.pod:221
22646 msgid "E<lt>filesystemsE<gt>"
22650 #: ../inspector/virt-inspector.pod:223
22652 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
22653 "filesystems belonging to the guest, including swap and empty partitions. "
22654 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
22655 "this OS or shared with this OS and other OSes)."
22659 #: ../inspector/virt-inspector.pod:229
22660 msgid "You might see something like this:"
22664 #: ../inspector/virt-inspector.pod:231
22667 " <operatingsystems>\n"
22668 " <operatingsystem>\n"
22671 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
22672 " <type>ext4</type>\n"
22673 " <label>Fedora-13-x86_64</label>\n"
22674 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
22680 #: ../inspector/virt-inspector.pod:241
22682 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
22683 "the label, and the UUID."
22687 #: ../inspector/virt-inspector.pod:244
22688 msgid "E<lt>applicationsE<gt>"
22692 #: ../inspector/virt-inspector.pod:246
22694 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
22695 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
22700 #: ../inspector/virt-inspector.pod:250
22702 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
22703 "Typical values would be C<rpm> and C<deb>."
22707 #: ../inspector/virt-inspector.pod:253
22709 "E<lt>package_managementE<gt>, if present, describes the package manager. "
22710 "Typical values include C<yum>, C<up2date> and C<apt>"
22714 #: ../inspector/virt-inspector.pod:256
22715 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
22719 #: ../inspector/virt-inspector.pod:259
22722 " <operatingsystems>\n"
22723 " <operatingsystem>\n"
22725 " <applications>\n"
22727 " <name>coreutils</name>\n"
22728 " <version>8.5</version>\n"
22729 " <release>1</release>\n"
22730 " </application>\n"
22735 #: ../inspector/virt-inspector.pod:269
22737 "The version and release fields may not be available for some types guests. "
22738 "Other fields are possible, see L<guestfs(3)/"
22739 "guestfs_inspect_list_applications>."
22743 #: ../inspector/virt-inspector.pod:273
22744 msgid "E<lt>drive_mappingsE<gt>"
22748 #: ../inspector/virt-inspector.pod:275
22750 "For operating systems like Windows which use drive letters, virt-inspector "
22751 "is able to find out how drive letters map to filesystems."
22755 #: ../inspector/virt-inspector.pod:279
22758 " <operatingsystems>\n"
22759 " <operatingsystem>\n"
22761 " <drive_mappings>\n"
22762 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
22763 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
22764 " </drive_mappings>\n"
22769 #: ../inspector/virt-inspector.pod:287
22771 "In the example above, drive C maps to the filesystem on the second partition "
22772 "on the first disk, and drive E maps to the filesystem on the first partition "
22773 "on the second disk."
22777 #: ../inspector/virt-inspector.pod:291
22779 "Note that this only covers permanent local filesystem mappings, not things "
22780 "like network shares. Furthermore NTFS volume mount points may not be listed "
22785 #: ../inspector/virt-inspector.pod:295
22786 msgid "E<lt>iconE<gt>"
22790 #: ../inspector/virt-inspector.pod:297
22792 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
22793 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
22794 "very large and high quality."
22798 #: ../inspector/virt-inspector.pod:301
22801 " <operatingsystems>\n"
22802 " <operatingsystem>\n"
22805 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
22806 " [... many lines of base64 data ...]\n"
22812 #: ../inspector/virt-inspector.pod:309
22814 "To display the icon, you have to extract it and convert the base64 data back "
22815 "to a binary file. Use an XPath query or simply an editor to extract the "
22816 "data, then use the coreutils L<base64(1)> program to do the conversion back "
22821 #: ../inspector/virt-inspector.pod:314
22824 " base64 -i -d < icon.data > icon.png\n"
22829 #: ../inspector/virt-inspector.pod:316
22830 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
22834 #: ../inspector/virt-inspector.pod:318
22836 "Virt-inspector can detect some operating system installers on install disks, "
22837 "live CDs, bootable USB keys and more."
22841 #: ../inspector/virt-inspector.pod:321
22843 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
22844 "fields may be present to indicate a live CD, network installer, or one part "
22845 "of a multipart CD. For example:"
22849 #: ../inspector/virt-inspector.pod:325
22852 " <operatingsystems>\n"
22853 " <operatingsystem>\n"
22854 " <root>/dev/sda</root>\n"
22855 " <name>linux</name>\n"
22856 " <arch>i386</arch>\n"
22857 " <distro>ubuntu</distro>\n"
22858 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
22859 " <major_version>10</major_version>\n"
22860 " <minor_version>10</minor_version>\n"
22861 " <format>installer</format>\n"
22867 #: ../inspector/virt-inspector.pod:337
22868 msgid "XPATH QUERIES"
22872 #: ../inspector/virt-inspector.pod:339
22874 "Virt-inspector includes built in support for running XPath queries. The "
22875 "reason for including XPath support directly in virt-inspector is simply that "
22876 "there are no good and widely available command line programs that can do "
22877 "XPath queries. The only good one is L<xmlstarlet(1)> and that is not "
22878 "available on Red Hat Enterprise Linux."
22882 #: ../inspector/virt-inspector.pod:346
22884 "To perform an XPath query, use the I<--xpath> option. Note that in this "
22885 "mode, virt-inspector simply reads XML from stdin and outputs the query "
22886 "result on stdout. All other inspection features are disabled in this mode."
22890 #: ../inspector/virt-inspector.pod:353
22893 " $ virt-inspector -d Guest | virt-inspector --xpath '//filesystems'\n"
22895 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
22896 " <type>ext4</type>\n"
22902 #: ../inspector/virt-inspector.pod:359
22905 " $ virt-inspector -d Guest | \\\n"
22906 " virt-inspector --xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
22912 #: ../inspector/virt-inspector.pod:363
22915 " $ virt-inspector -d Guest | \\\n"
22916 " virt-inspector --xpath 'string(//icon)' | base64 -i -d | display -\n"
22917 " [displays the guest icon, if there is one]\n"
22922 #: ../inspector/virt-inspector.pod:374
22923 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
22927 #: ../inspector/virt-inspector.pod:376
22929 "Early versions of libguestfs shipped with a different virt-inspector program "
22930 "written in Perl (the current version is written in C). The XML output of "
22931 "the Perl virt-inspector was different and it could also output in other "
22932 "formats like text."
22936 #: ../inspector/virt-inspector.pod:381
22938 "The old virt-inspector is no longer supported or shipped with libguestfs."
22942 #: ../inspector/virt-inspector.pod:384
22944 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
22945 "versions of virt-inspector with different names:"
22949 #: ../inspector/virt-inspector.pod:387
22952 " virt-inspector Old Perl version.\n"
22953 " virt-inspector2 New C version.\n"
22958 #: ../inspector/virt-inspector.pod:397
22960 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
22961 ">, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
22965 #: ../inspector/virt-inspector.pod:414
22966 msgid "Matthew Booth L<mbooth@redhat.com>"
22970 #: ../java/examples/guestfs-java.pod:5
22971 msgid "guestfs-java - How to use libguestfs from Java"
22975 #: ../java/examples/guestfs-java.pod:9
22978 " import com.redhat.et.libguestfs.*;\n"
22983 #: ../java/examples/guestfs-java.pod:11
22986 " GuestFS g = new GuestFS ();\n"
22987 " g.add_drive_opts (\"disk.img\", null);\n"
22993 #: ../java/examples/guestfs-java.pod:17
22995 "This manual page documents how to call libguestfs from the Java programming "
22996 "language. This page just documents the differences from the C API and gives "
22997 "some examples. If you are not familiar with using libguestfs, you also need "
22998 "to read L<guestfs(3)>."
23002 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
23003 msgid "CLOSING THE HANDLE"
23007 #: ../java/examples/guestfs-java.pod:24
23009 "The handle is closed when it is reaped by the garbage collector. Because "
23010 "libguestfs handles include a lot of state, it is also possible to close (and "
23011 "hence free) them explicitly by calling the C<close> method."
23015 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
23016 #: ../python/examples/guestfs-python.pod:21
23017 #: ../ruby/examples/guestfs-ruby.pod:22
23022 #: ../java/examples/guestfs-java.pod:31
23024 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
23025 "exception. This has a single parameter which is the error message (a "
23030 #: ../java/examples/guestfs-java.pod:35
23031 msgid "Calling any method on a closed handle raises the same exception."
23035 #: ../java/examples/guestfs-java.pod:47
23037 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-ocaml"
23038 "(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
23039 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
23043 #: ../ocaml/examples/guestfs-ocaml.pod:5
23044 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
23048 #: ../ocaml/examples/guestfs-ocaml.pod:9
23049 msgid "Module style:"
23053 #: ../ocaml/examples/guestfs-ocaml.pod:11
23056 " let g = Guestfs.create () in\n"
23057 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
23058 " Guestfs.launch g;\n"
23063 #: ../ocaml/examples/guestfs-ocaml.pod:15
23064 msgid "Object-oriented style:"
23068 #: ../ocaml/examples/guestfs-ocaml.pod:17
23071 " let g = new Guestfs.guestfs () in\n"
23072 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
23078 #: ../ocaml/examples/guestfs-ocaml.pod:21
23081 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
23083 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
23088 #: ../ocaml/examples/guestfs-ocaml.pod:27
23090 "This manual page documents how to call libguestfs from the OCaml programming "
23091 "language. This page just documents the differences from the C API and gives "
23092 "some examples. If you are not familiar with using libguestfs, you also need "
23093 "to read L<guestfs(3)>."
23097 #: ../ocaml/examples/guestfs-ocaml.pod:32
23098 msgid "PROGRAMMING STYLES"
23102 #: ../ocaml/examples/guestfs-ocaml.pod:34
23104 "There are two different programming styles supported by the OCaml bindings. "
23105 "You can use a module style, with each C function mapped to an OCaml function:"
23109 #: ../ocaml/examples/guestfs-ocaml.pod:38
23112 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
23117 #: ../ocaml/examples/guestfs-ocaml.pod:40
23122 #: ../ocaml/examples/guestfs-ocaml.pod:42
23125 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
23130 #: ../ocaml/examples/guestfs-ocaml.pod:44
23132 "Alternately you can use an object-oriented style, calling methods on the "
23133 "class C<Guestfs.guestfs>:"
23137 #: ../ocaml/examples/guestfs-ocaml.pod:47
23140 " method set_verbose : bool -> unit\n"
23145 #: ../ocaml/examples/guestfs-ocaml.pod:49
23147 "The object-oriented style is usually briefer, and the minor performance "
23148 "penalty isn't noticable in the general overhead of performing libguestfs "
23153 #: ../ocaml/examples/guestfs-ocaml.pod:55
23155 "The handle is closed when it is reaped by the garbage collector. Because "
23156 "libguestfs handles include a lot of state, it is also possible to close (and "
23157 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
23162 #: ../ocaml/examples/guestfs-ocaml.pod:62
23164 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
23165 "exception. This has a single parameter which is the error message (a "
23170 #: ../ocaml/examples/guestfs-ocaml.pod:66
23172 "Calling any function/method on a closed handle raises C<Guestfs."
23173 "Handle_closed>. The single parameter is the name of the function that you "
23178 #: ../ocaml/examples/guestfs-ocaml.pod:80
23180 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
23181 "(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
23182 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
23186 #: ../perl/examples/guestfs-perl.pod:5
23187 msgid "guestfs-perl - How to use libguestfs from Perl"
23191 #: ../perl/examples/guestfs-perl.pod:9
23194 " use Sys::Guestfs;\n"
23199 #: ../perl/examples/guestfs-perl.pod:11
23202 " my $h = Sys::Guestfs->new ();\n"
23203 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
23204 " $h->launch ();\n"
23205 " $h->mount_options ('', '/dev/sda1', '/');\n"
23206 " $h->touch ('/hello');\n"
23212 #: ../perl/examples/guestfs-perl.pod:20
23214 "This manual page documents how to call libguestfs from the Perl programming "
23215 "language. This page just documents the differences from the C API and gives "
23216 "some examples. If you are not familiar with using libguestfs, you also need "
23217 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
23221 #: ../perl/examples/guestfs-perl.pod:26
23226 #: ../perl/examples/guestfs-perl.pod:28
23228 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
23233 #: ../perl/examples/guestfs-perl.pod:41
23235 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang"
23236 "(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
23237 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
23241 #: ../python/examples/guestfs-python.pod:5
23242 msgid "guestfs-python - How to use libguestfs from Python"
23246 #: ../python/examples/guestfs-python.pod:9
23249 " import guestfs\n"
23250 " g = guestfs.GuestFS ()\n"
23251 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
23257 #: ../python/examples/guestfs-python.pod:16
23259 "This manual page documents how to call libguestfs from the Python "
23260 "programming language. This page just documents the differences from the C "
23261 "API and gives some examples. If you are not familiar with using libguestfs, "
23262 "you also need to read L<guestfs(3)>."
23266 #: ../python/examples/guestfs-python.pod:23
23268 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
23269 "single string argument which is the error message."
23273 #: ../python/examples/guestfs-python.pod:26
23274 msgid "MORE DOCUMENTATION"
23278 #: ../python/examples/guestfs-python.pod:28
23283 #: ../python/examples/guestfs-python.pod:30
23287 " >>> import guestfs\n"
23288 " >>> help (guestfs)\n"
23293 #: ../python/examples/guestfs-python.pod:44
23295 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
23296 "(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
23297 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
23301 #: ../rescue/virt-rescue.pod:5
23302 msgid "virt-rescue - Run a rescue shell on a virtual machine"
23306 #: ../rescue/virt-rescue.pod:9
23309 " virt-rescue [--options] -d domname\n"
23314 #: ../rescue/virt-rescue.pod:11
23317 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
23322 #: ../rescue/virt-rescue.pod:15
23325 " virt-rescue [--options] domname\n"
23330 #: ../rescue/virt-rescue.pod:17
23333 " virt-rescue [--options] disk.img [disk.img ...]\n"
23338 #: ../rescue/virt-rescue.pod:21
23340 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
23341 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
23342 "you from doing this, but doesn't catch all cases."
23346 #: ../rescue/virt-rescue.pod:25
23348 "However if you use the I<--ro> (read only) option, then you can attach a "
23349 "shell to a live virtual machine. The results might be strange or "
23350 "inconsistent at times but you won't get disk corruption."
23354 #: ../rescue/virt-rescue.pod:31
23356 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
23357 "need for a CD. virt-rescue gives you a rescue shell and some simple "
23358 "recovery tools which you can use to examine or rescue a virtual machine or "
23363 #: ../rescue/virt-rescue.pod:36
23365 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
23366 "on disk image(s):"
23370 #: ../rescue/virt-rescue.pod:39
23373 " virt-rescue -d GuestName\n"
23378 #: ../rescue/virt-rescue.pod:41
23381 " virt-rescue --ro -a /path/to/disk.img\n"
23386 #: ../rescue/virt-rescue.pod:43
23389 " virt-rescue -a /dev/sdc\n"
23394 #: ../rescue/virt-rescue.pod:45
23395 msgid "For live VMs you I<must> use the --ro option."
23399 #: ../rescue/virt-rescue.pod:47
23401 "When you run virt-rescue on a virtual machine or disk image, you are placed "
23402 "in an interactive bash shell where you can use many ordinary Linux "
23403 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
23404 "appliance. You must mount the virtual machine's filesystems by hand. There "
23405 "is an empty directory called C</sysroot> where you can mount filesystems."
23409 #: ../rescue/virt-rescue.pod:54
23411 "In the example below, we list logical volumes, then choose one to mount "
23412 "under C</sysroot>:"
23416 #: ../rescue/virt-rescue.pod:57
23420 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
23421 " lv_root vg_f11x64 -wi-a- 8.83G\n"
23422 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
23423 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
23424 " ><rescue> ls /sysroot\n"
23429 #: ../rescue/virt-rescue.pod:64
23431 "If you don't know what filesystems are available on the virtual machine then "
23432 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
23436 #: ../rescue/virt-rescue.pod:70
23438 "Virt-rescue can be used on I<any> disk image file or device, not just a "
23439 "virtual machine. For example you can use it on a blank file if you want to "
23440 "partition that file (although we would recommend using L<guestfish(1)> "
23441 "instead as it is more suitable for this purpose). You can even use virt-"
23442 "rescue on things like SD cards."
23446 #: ../rescue/virt-rescue.pod:76
23448 "Virt-rescue does not require root. You only need to run it as root if you "
23449 "need root to open the disk image."
23453 #: ../rescue/virt-rescue.pod:79
23455 "This tool is just designed for quick interactive hacking on a virtual "
23456 "machine. For more structured access to a virtual machine disk image, you "
23457 "should use L<guestfs(3)>. To get a structured shell that you can use to "
23458 "make scripted changes to guests, use L<guestfish(1)>."
23462 #: ../rescue/virt-rescue.pod:103
23463 msgid "B<--append kernelopts>"
23467 #: ../rescue/virt-rescue.pod:105
23468 msgid "Pass additional options to the rescue kernel."
23472 #: ../rescue/virt-rescue.pod:135
23475 " virt-rescue --format=raw -a disk.img\n"
23480 #: ../rescue/virt-rescue.pod:139
23483 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
23488 #: ../rescue/virt-rescue.pod:148
23493 #: ../rescue/virt-rescue.pod:150
23494 msgid "B<--memsize MB>"
23498 #: ../rescue/virt-rescue.pod:152
23500 "Change the amount of memory allocated to the rescue system. The default is "
23501 "set by libguestfs and is small but adequate for running system tools. The "
23502 "occasional program might need more memory. The parameter is specified in "
23507 #: ../rescue/virt-rescue.pod:157
23508 msgid "B<--network>"
23512 #: ../rescue/virt-rescue.pod:159
23513 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
23517 #: ../rescue/virt-rescue.pod:165
23518 msgid "Open the image read-only."
23522 #: ../rescue/virt-rescue.pod:175
23524 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
23525 "SELINUX> before using this option."
23529 #: ../rescue/virt-rescue.pod:178
23534 #: ../rescue/virt-rescue.pod:180
23535 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
23539 #: ../rescue/virt-rescue.pod:198
23541 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
23542 "are done read-write."
23546 #: ../rescue/virt-rescue.pod:211
23547 msgid "Previous versions of virt-rescue allowed you to write either:"
23551 #: ../rescue/virt-rescue.pod:213
23554 " virt-rescue disk.img [disk.img ...]\n"
23559 #: ../rescue/virt-rescue.pod:217
23562 " virt-rescue guestname\n"
23567 #: ../rescue/virt-rescue.pod:225
23572 #: ../rescue/virt-rescue.pod:227
23574 "Adding the I<--network> option enables QEMU user networking in the rescue "
23575 "appliance. There are some differences between user networking and ordinary "
23580 #: ../rescue/virt-rescue.pod:233
23581 msgid "ping does not work"
23585 #: ../rescue/virt-rescue.pod:235
23587 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
23588 "send the ping packets, and because virt-rescue must be able to run as non-"
23589 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
23590 "The ping command will appear to resolve addresses but will not be able to "
23591 "send or receive any packets. This does not mean that the network is not "
23596 #: ../rescue/virt-rescue.pod:242
23597 msgid "cannot receive connections"
23601 #: ../rescue/virt-rescue.pod:244
23602 msgid "QEMU user networking cannot receive incoming connections."
23606 #: ../rescue/virt-rescue.pod:246
23607 msgid "making TCP connections"
23611 #: ../rescue/virt-rescue.pod:248
23613 "The virt-rescue appliance needs to be small and so does not include many "
23614 "network tools. In particular there is no L<telnet(1)> command. You can "
23615 "make TCP connections from the shell using the magical C</dev/tcp/"
23616 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
23620 #: ../rescue/virt-rescue.pod:253
23623 " exec 3<>/dev/tcp/redhat.com/80\n"
23624 " echo \"GET /\" >&3\n"
23630 #: ../rescue/virt-rescue.pod:257
23631 msgid "See L<bash(1)> for more details."
23635 #: ../rescue/virt-rescue.pod:263
23637 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
23638 "ENVIRONMENT VARIABLES> for the complete list."
23642 #: ../rescue/virt-rescue.pod:290
23644 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
23645 "libguestfs.org/>."
23649 #: ../resize/virt-resize.pod:5
23650 msgid "virt-resize - Resize a virtual machine disk"
23654 #: ../resize/virt-resize.pod:9
23657 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
23658 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
23659 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
23664 #: ../resize/virt-resize.pod:15
23666 "Virt-resize is a tool which can resize a virtual machine disk, making it "
23667 "larger or smaller overall, and resizing or deleting any partitions contained "
23672 #: ../resize/virt-resize.pod:19
23674 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
23675 "not> be used on live virtual machines - for consistent results, shut the "
23676 "virtual machine down before resizing it."
23680 #: ../resize/virt-resize.pod:23
23682 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
23683 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
23687 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:597
23688 #: ../sparsify/virt-sparsify.pod:202 ../src/guestfs.pod:484
23689 #: ../src/guestfs.pod:1302 ../src/guestfs.pod:1441 ../src/guestfs.pod:2690
23694 #: ../resize/virt-resize.pod:33
23696 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
23697 "fill the extra 5GB of space."
23701 #: ../resize/virt-resize.pod:36
23704 " virt-filesystems --long -h --all -a olddisk\n"
23709 #: ../resize/virt-resize.pod:38
23712 " truncate -r olddisk newdisk\n"
23713 " truncate -s +5G newdisk\n"
23718 #: ../resize/virt-resize.pod:41
23721 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
23722 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
23727 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:604
23728 #: ../sparsify/virt-sparsify.pod:209 ../src/guestfs.pod:490
23729 #: ../src/guestfs.pod:1306 ../src/guestfs.pod:1445 ../src/guestfs.pod:2715
23734 #: ../resize/virt-resize.pod:46
23736 "As above, but make the /boot partition 200MB bigger, while giving the "
23737 "remaining space to /dev/sda2:"
23741 #: ../resize/virt-resize.pod:49
23744 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
23745 " olddisk newdisk\n"
23750 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:610
23751 #: ../sparsify/virt-sparsify.pod:215 ../src/guestfs.pod:501
23752 #: ../src/guestfs.pod:1451
23757 #: ../resize/virt-resize.pod:54
23759 "As in the first example, but expand a logical volume as the final step. "
23760 "This is what you would typically use for Linux guests that use LVM:"
23764 #: ../resize/virt-resize.pod:58
23767 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
23768 " olddisk newdisk\n"
23773 #: ../resize/virt-resize.pod:61
23778 #: ../resize/virt-resize.pod:63
23780 "As in the first example, but the output format will be qcow2 instead of a "
23785 #: ../resize/virt-resize.pod:66
23788 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
23789 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
23794 #: ../resize/virt-resize.pod:71
23795 msgid "DETAILED USAGE"
23799 #: ../resize/virt-resize.pod:73
23800 msgid "EXPANDING A VIRTUAL MACHINE DISK"
23804 #: ../resize/virt-resize.pod:77
23805 msgid "1. Shut down the virtual machine"
23809 #: ../resize/virt-resize.pod:79
23810 msgid "2. Locate input disk image"
23814 #: ../resize/virt-resize.pod:81
23816 "Locate the input disk image (ie. the file or device on the host containing "
23817 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
23818 "dumpxml> like this to find the disk image name:"
23822 #: ../resize/virt-resize.pod:85
23825 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
23826 " Found 1 nodes:\n"
23828 " <source dev=\"/dev/vg/lv_guest\" />\n"
23833 #: ../resize/virt-resize.pod:90
23834 msgid "3. Look at current sizing"
23838 #: ../resize/virt-resize.pod:92
23839 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
23843 #: ../resize/virt-resize.pod:95
23846 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
23847 " Name Type Size Parent\n"
23848 " /dev/sda1 partition 101M /dev/sda\n"
23849 " /dev/sda2 partition 7.9G /dev/sda\n"
23850 " /dev/sda device 8.0G -\n"
23855 #: ../resize/virt-resize.pod:101
23857 "(This example is a virtual machine with an 8 GB disk which we would like to "
23858 "expand up to 10 GB)."
23862 #: ../resize/virt-resize.pod:104
23863 msgid "4. Create output disk"
23867 #: ../resize/virt-resize.pod:106
23869 "Virt-resize cannot do in-place disk modifications. You have to have space "
23870 "to store the resized output disk."
23874 #: ../resize/virt-resize.pod:109
23876 "To store the resized disk image in a file, create a file of a suitable size:"
23880 #: ../resize/virt-resize.pod:112
23883 " # rm -f outdisk\n"
23884 " # truncate -s 10G outdisk\n"
23889 #: ../resize/virt-resize.pod:115
23890 msgid "Or use L<lvcreate(1)> to create a logical volume:"
23894 #: ../resize/virt-resize.pod:117
23897 " # lvcreate -L 10G -n lv_name vg_name\n"
23902 #: ../resize/virt-resize.pod:119
23903 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
23907 #: ../resize/virt-resize.pod:121
23910 " # virsh pool-list\n"
23911 " # virsh vol-create-as poolname newvol 10G\n"
23916 #: ../resize/virt-resize.pod:124
23921 #: ../resize/virt-resize.pod:126
23923 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
23924 "file) and the output disk. The output disk is the one created in the "
23929 #: ../resize/virt-resize.pod:130
23932 " # virt-resize indisk outdisk\n"
23937 #: ../resize/virt-resize.pod:132
23939 "This command just copies disk image C<indisk> to disk image C<outdisk> "
23940 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
23941 "larger, then an extra, empty partition is created at the end of the disk "
23942 "covering the extra space. If C<outdisk> is smaller, then it will give an "
23947 #: ../resize/virt-resize.pod:138
23949 "More realistically you'd want to expand existing partitions in the disk "
23950 "image by passing extra options (for the full list see the L</OPTIONS> "
23955 #: ../resize/virt-resize.pod:142
23957 "L</--expand> is the most useful option. It expands the named partition "
23958 "within the disk to fill any extra space:"
23962 #: ../resize/virt-resize.pod:145
23965 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
23970 #: ../resize/virt-resize.pod:147
23972 "(In this case, an extra partition is I<not> created at the end of the disk, "
23973 "because there will be no unused space)."
23977 #: ../resize/virt-resize.pod:150
23979 "L</--resize> is the other commonly used option. The following would "
23980 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
23981 "rest of the available space:"
23985 #: ../resize/virt-resize.pod:154
23988 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
23989 " indisk outdisk\n"
23994 #: ../resize/virt-resize.pod:157
23996 "If the expanded partition in the image contains a filesystem or LVM PV, then "
23997 "if virt-resize knows how, it will resize the contents, the equivalent of "
23998 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
23999 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
24000 "filesystems, so you would have to online resize them after booting the guest."
24004 #: ../resize/virt-resize.pod:164
24005 msgid "Other options are covered below."
24009 #: ../resize/virt-resize.pod:166
24014 #: ../resize/virt-resize.pod:168
24015 msgid "Thoroughly test the new disk image I<before> discarding the old one."
24019 #: ../resize/virt-resize.pod:170
24020 msgid "If you are using libvirt, edit the XML to point at the new disk:"
24024 #: ../resize/virt-resize.pod:172
24027 " # virsh edit guestname\n"
24032 #: ../resize/virt-resize.pod:174
24034 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
24035 "html#elementsDisks>"
24039 #: ../resize/virt-resize.pod:177
24040 msgid "Then start up the domain with the new, resized disk:"
24044 #: ../resize/virt-resize.pod:179
24047 " # virsh start guestname\n"
24052 #: ../resize/virt-resize.pod:181
24054 "and check that it still works. See also the L</NOTES> section below for "
24055 "additional information."
24059 #: ../resize/virt-resize.pod:184
24060 msgid "7. Resize LVs etc inside the guest"
24064 #: ../resize/virt-resize.pod:186
24065 msgid "(This can also be done offline using L<guestfish(1)>)"
24069 #: ../resize/virt-resize.pod:188
24071 "Once the guest has booted you should see the new space available, at least "
24072 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
24073 "may need to resize LVs inside PVs, and also resize filesystem types that "
24074 "virt-resize does not know how to expand."
24078 #: ../resize/virt-resize.pod:195
24079 msgid "SHRINKING A VIRTUAL MACHINE DISK"
24083 #: ../resize/virt-resize.pod:197
24085 "Shrinking is somewhat more complex than expanding, and only an overview is "
24090 #: ../resize/virt-resize.pod:200
24092 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
24093 "filesystems). The user has to shrink content before passing the disk image "
24094 "to virt-resize, and virt-resize will check that the content has been shrunk "
24099 #: ../resize/virt-resize.pod:205
24100 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
24104 #: ../resize/virt-resize.pod:207
24106 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
24107 "steps 3 and 4 above to allocate a new disk image."
24111 #: ../resize/virt-resize.pod:210
24113 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
24117 #: ../resize/virt-resize.pod:213
24118 msgid "IGNORING OR DELETING PARTITIONS"
24122 #: ../resize/virt-resize.pod:215
24124 "virt-resize also gives a convenient way to ignore or delete partitions when "
24125 "copying from the input disk to the output disk. Ignoring a partition speeds "
24126 "up the copy where you don't care about the existing contents of a "
24127 "partition. Deleting a partition removes it completely, but note that it "
24128 "also renumbers any partitions after the one which is deleted, which can "
24129 "leave some guests unbootable."
24133 #: ../resize/virt-resize.pod:222
24134 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
24138 #: ../resize/virt-resize.pod:224
24140 "If the input disk is in qcow2 format, then you may prefer that the output is "
24141 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
24142 "the fly. The output format is simply determined by the format of the empty "
24143 "output container that you provide. Thus to create qcow2 output, use:"
24147 #: ../resize/virt-resize.pod:230
24150 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
24155 #: ../resize/virt-resize.pod:232
24156 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
24160 #: ../resize/virt-resize.pod:234
24161 msgid "Similarly, to get non-sparse raw output use:"
24165 #: ../resize/virt-resize.pod:236
24168 " fallocate -l size outdisk\n"
24173 #: ../resize/virt-resize.pod:238
24175 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
24176 "dev/zero of=outdisk bs=1M count=..>)"
24180 #: ../resize/virt-resize.pod:241
24181 msgid "LOGICAL PARTITIONS"
24185 #: ../resize/virt-resize.pod:243
24187 "Logical partitions (a.k.a. C</dev/sda5+> on disks using DOS partition "
24188 "tables) cannot be resized."
24192 #: ../resize/virt-resize.pod:246
24194 "To understand what is going on, firstly one of the four partitions C</dev/"
24195 "sda1-4> will have MBR partition type C<05> or C<0f>. This is called the "
24196 "B<extended partition>. Use L<virt-filesystems(1)> to see the MBR partition "
24201 #: ../resize/virt-resize.pod:251
24202 msgid "Logical partitions live inside the extended partition."
24206 #: ../resize/virt-resize.pod:253
24208 "The extended partition can be expanded, but not shrunk (unless you force it, "
24209 "which is not advisable). When the extended partition is copied across, all "
24210 "the logical partitions contained inside are copied over implicitly. Virt-"
24211 "resize does not look inside the extended partition, so it copies the logical "
24212 "partitions blindly."
24216 #: ../resize/virt-resize.pod:259
24218 "You cannot specify a logical partition (C</dev/sda5+>) at all on the command "
24219 "line. Doing so will give an error."
24223 #: ../resize/virt-resize.pod:268 ../sparsify/virt-sparsify.pod:105
24224 msgid "Display help."
24228 #: ../resize/virt-resize.pod:270
24229 msgid "B<--align-first auto>"
24233 #: ../resize/virt-resize.pod:272
24234 msgid "B<--align-first never>"
24238 #: ../resize/virt-resize.pod:274
24239 msgid "B<--align-first always>"
24243 #: ../resize/virt-resize.pod:276
24245 "Align the first partition for improved performance (see also the I<--"
24246 "alignment> option)."
24250 #: ../resize/virt-resize.pod:279
24252 "The default is I<--align-first auto> which only aligns the first partition "
24253 "if it is safe to do so. That is, only when we know how to fix the "
24254 "bootloader automatically, and at the moment that can only be done for "
24259 #: ../resize/virt-resize.pod:284
24261 "I<--align-first never> means we never move the first partition. This is the "
24262 "safest option. Try this if the guest does not boot after resizing."
24266 #: ../resize/virt-resize.pod:288
24268 "I<--align-first always> means we always align the first partition (if it "
24269 "needs to be aligned). For some guests this will break the bootloader, "
24270 "making the guest unbootable."
24274 #: ../resize/virt-resize.pod:292
24275 msgid "B<--alignment N>"
24279 #: ../resize/virt-resize.pod:294
24281 "Set the alignment of partitions to C<N> sectors. The default in virt-resize "
24282 "E<lt> 1.13.19 was 64 sectors, and after that is 128 sectors."
24286 #: ../resize/virt-resize.pod:298
24288 "Assuming 512 byte sector size inside the guest, here are some suitable "
24293 #: ../resize/virt-resize.pod:303
24294 msgid "I<--alignment 1> (512 bytes)"
24298 #: ../resize/virt-resize.pod:305
24300 "The partitions would be packed together as closely as possible, but would be "
24301 "completely unaligned. In some cases this can cause very poor performance. "
24302 "See L<virt-alignment-scan(1)> for further details."
24306 #: ../resize/virt-resize.pod:309
24307 msgid "I<--alignment 8> (4K)"
24311 #: ../resize/virt-resize.pod:311
24313 "This would be the minimum acceptable alignment for reasonable performance on "
24318 #: ../resize/virt-resize.pod:314
24319 msgid "I<--alignment 128> (64K)"
24323 #: ../resize/virt-resize.pod:316
24325 "This alignment provides good performance when the host is using high end "
24330 #: ../resize/virt-resize.pod:319
24331 msgid "I<--alignment 2048> (1M)"
24335 #: ../resize/virt-resize.pod:321
24337 "This is the standard alignment used by all newly installed guests since "
24342 #: ../resize/virt-resize.pod:326
24347 #: ../resize/virt-resize.pod:328 ../tools/virt-make-fs.pl:177
24348 #: ../tools/virt-win-reg.pl:120
24353 #: ../resize/virt-resize.pod:330 ../tools/virt-win-reg.pl:122
24354 msgid "Enable debugging messages."
24358 #: ../resize/virt-resize.pod:332
24359 msgid "B<--delete part>"
24363 #: ../resize/virt-resize.pod:334
24365 "Delete the named partition. It would be more accurate to describe this as "
24366 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
24367 "the original disk image is left intact."
24371 #: ../resize/virt-resize.pod:338
24373 "Note that when you delete a partition, then anything contained in the "
24374 "partition is also deleted. Furthermore, this causes any partitions that "
24375 "come after to be I<renumbered>, which can easily make your guest unbootable."
24379 #: ../resize/virt-resize.pod:343 ../resize/virt-resize.pod:404
24380 #: ../resize/virt-resize.pod:531 ../sparsify/virt-sparsify.pod:144
24381 msgid "You can give this option multiple times."
24385 #: ../resize/virt-resize.pod:345
24386 msgid "B<--expand part>"
24390 #: ../resize/virt-resize.pod:347
24392 "Expand the named partition so it uses up all extra space (space left over "
24393 "after any other resize changes that you request have been done)."
24397 #: ../resize/virt-resize.pod:350
24399 "If virt-resize knows how, it will expand the direct content of the "
24400 "partition. For example, if the partition is an LVM PV, it will expand the "
24401 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
24402 "content it doesn't know about alone."
24406 #: ../resize/virt-resize.pod:355
24407 msgid "Currently virt-resize can resize:"
24411 #: ../resize/virt-resize.pod:361
24412 msgid "ext2, ext3 and ext4 filesystems."
24416 #: ../resize/virt-resize.pod:365
24417 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
24421 #: ../resize/virt-resize.pod:367
24423 "The filesystem must have been shut down consistently last time it was used. "
24424 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
24425 "consistency check, so at the first boot after resizing Windows will check "
24430 #: ../resize/virt-resize.pod:374
24432 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
24433 "inside the PV, but see the I<--LV-expand> option. The user could also "
24434 "resize LVs as desired after boot."
24438 #: ../resize/virt-resize.pod:380
24439 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
24443 #: ../resize/virt-resize.pod:384 ../resize/virt-resize.pod:559
24444 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
24448 #: ../resize/virt-resize.pod:386 ../sparsify/virt-sparsify.pod:124
24449 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92
24450 #: ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
24451 msgid "B<--format> raw"
24455 #: ../resize/virt-resize.pod:388 ../sparsify/virt-sparsify.pod:128
24457 "Specify the format of the input disk image. If this flag is not given then "
24458 "it is auto-detected from the image itself."
24462 #: ../resize/virt-resize.pod:394
24464 "Note that this option I<does not> affect the output format. See L</QCOW2 "
24465 "AND NON-SPARSE RAW FORMATS>."
24469 #: ../resize/virt-resize.pod:397
24470 msgid "B<--ignore part>"
24474 #: ../resize/virt-resize.pod:399
24476 "Ignore the named partition. Effectively this means the partition is "
24477 "allocated on the destination disk, but the content is not copied across from "
24478 "the source disk. The content of the partition will be blank (all zero "
24483 #: ../resize/virt-resize.pod:406
24484 msgid "B<--LV-expand logvol>"
24488 #: ../resize/virt-resize.pod:408
24490 "This takes the logical volume and, as a final step, expands it to fill all "
24491 "the space available in its volume group. A typical usage, assuming a Linux "
24492 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
24493 "lv_root> would be:"
24497 #: ../resize/virt-resize.pod:413
24500 " virt-resize indisk outdisk \\\n"
24501 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
24506 #: ../resize/virt-resize.pod:416
24508 "This would first expand the partition (and PV), and then expand the root "
24509 "device to fill the extra space in the PV."
24513 #: ../resize/virt-resize.pod:419
24515 "The contents of the LV are also resized if virt-resize knows how to do "
24516 "that. You can stop virt-resize from trying to expand the content by using "
24517 "the option I<--no-expand-content>."
24521 #: ../resize/virt-resize.pod:423
24522 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
24526 #: ../resize/virt-resize.pod:425
24528 "You can give this option multiple times, I<but> it doesn't make sense to do "
24529 "this unless the logical volumes you specify are all in different volume "
24534 #: ../resize/virt-resize.pod:429 ../sparsify/virt-sparsify.pod:146
24535 msgid "B<--machine-readable>"
24539 #: ../resize/virt-resize.pod:431 ../sparsify/virt-sparsify.pod:148
24541 "This option is used to make the output more machine friendly when being "
24542 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
24546 #: ../resize/virt-resize.pod:437
24547 msgid "B<--dryrun>"
24551 #: ../resize/virt-resize.pod:439
24552 msgid "Print a summary of what would be done, but don't do anything."
24556 #: ../resize/virt-resize.pod:441
24557 msgid "B<--no-copy-boot-loader>"
24561 #: ../resize/virt-resize.pod:443
24563 "By default, virt-resize copies over some sectors at the start of the disk "
24564 "(up to the beginning of the first partition). Commonly these sectors "
24565 "contain the Master Boot Record (MBR) and the boot loader, and are required "
24566 "in order for the guest to boot correctly."
24570 #: ../resize/virt-resize.pod:448
24572 "If you specify this flag, then this initial copy is not done. You may need "
24573 "to reinstall the boot loader in this case."
24577 #: ../resize/virt-resize.pod:451
24578 msgid "B<--no-extra-partition>"
24582 #: ../resize/virt-resize.pod:453
24584 "By default, virt-resize creates an extra partition if there is any extra, "
24585 "unused space after all resizing has happened. Use this option to prevent "
24586 "the extra partition from being created. If you do this then the extra space "
24587 "will be inaccessible until you run fdisk, parted, or some other partitioning "
24588 "tool in the guest."
24592 #: ../resize/virt-resize.pod:459
24594 "Note that if the surplus space is smaller than 10 MB, no extra partition "
24599 #: ../resize/virt-resize.pod:462
24600 msgid "B<--no-expand-content>"
24604 #: ../resize/virt-resize.pod:464
24606 "By default, virt-resize will try to expand the direct contents of "
24607 "partitions, if it knows how (see I<--expand> option above)."
24611 #: ../resize/virt-resize.pod:467
24613 "If you give the I<--no-expand-content> option then virt-resize will not "
24618 #: ../resize/virt-resize.pod:470
24619 msgid "B<--ntfsresize-force>"
24623 #: ../resize/virt-resize.pod:472
24625 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
24626 "the NTFS disk is marked as needing a consistency check. You have to use "
24627 "this option if you want to resize a Windows guest multiple times without "
24628 "booting into Windows between each resize."
24632 #: ../resize/virt-resize.pod:478
24633 msgid "B<--output-format> raw"
24637 #: ../resize/virt-resize.pod:480
24639 "Specify the format of the output disk image. If this flag is not given then "
24640 "it is auto-detected from the image itself."
24644 #: ../resize/virt-resize.pod:486
24646 "Note that this option I<does not create> the output format. This option "
24647 "just tells libguestfs what it is so it doesn't try to guess it. You still "
24648 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
24649 "SPARSE RAW FORMATS>."
24653 #: ../resize/virt-resize.pod:495
24654 msgid "Don't print the summary."
24658 #: ../resize/virt-resize.pod:497
24659 msgid "B<--resize part=size>"
24663 #: ../resize/virt-resize.pod:499
24665 "Resize the named partition (expanding or shrinking it) so that it has the "
24670 #: ../resize/virt-resize.pod:502
24672 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
24673 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
24674 "size; or as a relative number or percentage. For example:"
24678 #: ../resize/virt-resize.pod:508
24681 " --resize /dev/sda2=10G\n"
24686 #: ../resize/virt-resize.pod:510
24689 " --resize /dev/sda4=90%\n"
24694 #: ../resize/virt-resize.pod:512
24697 " --resize /dev/sda2=+1G\n"
24702 #: ../resize/virt-resize.pod:514
24705 " --resize /dev/sda2=-200M\n"
24710 #: ../resize/virt-resize.pod:516
24713 " --resize /dev/sda1=+128K\n"
24718 #: ../resize/virt-resize.pod:518
24721 " --resize /dev/sda1=+10%\n"
24726 #: ../resize/virt-resize.pod:520
24729 " --resize /dev/sda1=-10%\n"
24734 #: ../resize/virt-resize.pod:522
24736 "You can increase the size of any partition. Virt-resize will expand the "
24737 "direct content of the partition if it knows how (see I<--expand> below)."
24741 #: ../resize/virt-resize.pod:526
24743 "You can only I<decrease> the size of partitions that contain filesystems or "
24744 "PVs which have already been shrunk. Virt-resize will check this has been "
24745 "done before proceeding, or else will print an error (see also I<--resize-"
24750 #: ../resize/virt-resize.pod:533
24751 msgid "B<--resize-force part=size>"
24755 #: ../resize/virt-resize.pod:535
24757 "This is the same as I<--resize> except that it will let you decrease the "
24758 "size of any partition. Generally this means you will lose any data which "
24759 "was at the end of the partition you shrink, but you may not care about that "
24760 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
24761 "as a swap partition)."
24765 #: ../resize/virt-resize.pod:541
24766 msgid "See also the I<--ignore> option."
24770 #: ../resize/virt-resize.pod:543
24771 msgid "B<--shrink part>"
24775 #: ../resize/virt-resize.pod:545
24777 "Shrink the named partition until the overall disk image fits in the "
24778 "destination. The named partition B<must> contain a filesystem or PV which "
24779 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
24780 "online tools). Virt-resize will check this and give an error if it has not "
24785 #: ../resize/virt-resize.pod:551
24787 "The amount by which the overall disk must be shrunk (after carrying out all "
24788 "other operations requested by the user) is called the \"deficit\". For "
24789 "example, a straight copy (assume no other operations) from a 5GB disk image "
24790 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
24791 "would give an error unless the user specified a partition to shrink and that "
24792 "partition had more than a gigabyte of free space."
24796 #: ../resize/virt-resize.pod:569 ../sparsify/virt-sparsify.pod:176
24797 msgid "MACHINE READABLE OUTPUT"
24801 #: ../resize/virt-resize.pod:571
24803 "The I<--machine-readable> option can be used to make the output more machine "
24804 "friendly, which is useful when calling virt-resize from other programs, GUIs "
24809 #: ../resize/virt-resize.pod:575 ../sparsify/virt-sparsify.pod:182
24810 msgid "There are two ways to use this option."
24814 #: ../resize/virt-resize.pod:577
24816 "Firstly use the option on its own to query the capabilities of the virt-"
24817 "resize binary. Typical output looks like this:"
24821 #: ../resize/virt-resize.pod:580
24824 " $ virt-resize --machine-readable\n"
24826 " ntfsresize-force\n"
24834 #: ../resize/virt-resize.pod:587 ../sparsify/virt-sparsify.pod:192
24836 "A list of features is printed, one per line, and the program exits with "
24841 #: ../resize/virt-resize.pod:590 ../sparsify/virt-sparsify.pod:195
24843 "Secondly use the option in conjunction with other options to make the "
24844 "regular program output more machine friendly."
24848 #: ../resize/virt-resize.pod:593 ../sparsify/virt-sparsify.pod:198
24849 msgid "At the moment this means:"
24853 #: ../resize/virt-resize.pod:599 ../sparsify/virt-sparsify.pod:204
24855 "Progress bar messages can be parsed from stdout by looking for this regular "
24860 #: ../resize/virt-resize.pod:602 ../sparsify/virt-sparsify.pod:207
24863 " ^[0-9]+/[0-9]+$\n"
24868 #: ../resize/virt-resize.pod:606 ../sparsify/virt-sparsify.pod:211
24870 "The calling program should treat messages sent to stdout (except for "
24871 "progress bar messages) as status messages. They can be logged and/or "
24872 "displayed to the user."
24876 #: ../resize/virt-resize.pod:612
24878 "The calling program should treat messages sent to stderr as error messages. "
24879 "In addition, virt-resize exits with a non-zero status code if there was a "
24884 #: ../resize/virt-resize.pod:618
24886 "Versions of the program prior to 1.13.9 did not support the I<--machine-"
24887 "readable> option and will return an error."
24891 #: ../resize/virt-resize.pod:623
24892 msgid "\"Partition 1 does not end on cylinder boundary.\""
24896 #: ../resize/virt-resize.pod:625
24898 "Virt-resize aligns partitions to multiples of 128 sectors (see the I<--"
24899 "alignment> parameter). Usually this means the partitions will not be "
24900 "aligned to the ancient CHS geometry. However CHS geometry is meaningless "
24901 "for disks manufactured since the early 1990s, and doubly so for virtual hard "
24902 "drives. Alignment of partitions to cylinders is not required by any modern "
24903 "operating system."
24907 #: ../resize/virt-resize.pod:632
24908 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
24912 #: ../resize/virt-resize.pod:634
24914 "In Windows Vista and later versions, Microsoft switched to using a separate "
24915 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
24916 "and C</dev/sda2> is the main (C:) drive. Resizing the first (boot) "
24917 "partition causes the bootloader to fail with C<0xC0000225> error. Resizing "
24918 "the second partition (ie. C: drive) should work."
24922 #: ../resize/virt-resize.pod:641
24924 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
24925 "NTFS partitions have been expanded. This is just a safety check and (unless "
24926 "it find errors) is nothing to worry about."
24930 #: ../resize/virt-resize.pod:645
24931 msgid "GUEST BOOT STUCK AT \"GRUB\""
24935 #: ../resize/virt-resize.pod:647
24937 "If a Linux guest does not boot after resizing, and the boot is stuck after "
24938 "printing C<GRUB> on the console, try reinstalling grub."
24942 #: ../resize/virt-resize.pod:650
24945 " guestfish -i -a newdisk\n"
24946 " ><fs> cat /boot/grub/device.map\n"
24947 " # check the contents of this file are sensible or\n"
24948 " # edit the file if necessary\n"
24949 " ><fs> grub-install / /dev/vda\n"
24955 #: ../resize/virt-resize.pod:657
24957 "For more flexible guest reconfiguration, including if you need to specify "
24958 "other parameters to grub-install, use L<virt-rescue(1)>."
24962 #: ../resize/virt-resize.pod:660
24963 msgid "ALTERNATIVE TOOLS"
24967 #: ../resize/virt-resize.pod:662
24969 "There are several proprietary tools for resizing partitions. We won't "
24970 "mention any here."
24974 #: ../resize/virt-resize.pod:665
24976 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
24977 "operations on disk images. They can resize and move partitions, but I don't "
24978 "think they can do anything with the contents, and they certainly don't "
24983 #: ../resize/virt-resize.pod:670
24985 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
24986 "but at a much lower level. You will probably end up hand-calculating sector "
24987 "offsets, which is something that virt-resize was designed to avoid. If you "
24988 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
24993 #: ../resize/virt-resize.pod:690
24995 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
24996 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
24997 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
24998 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<virt-sparsify(1)>, "
24999 "L<virt-alignment-scan(1)>, L<http://libguestfs.org/>."
25003 #: ../ruby/examples/guestfs-ruby.pod:5
25004 msgid "guestfs-ruby - How to use libguestfs from Ruby"
25008 #: ../ruby/examples/guestfs-ruby.pod:9
25011 " require 'guestfs'\n"
25012 " g = Guestfs::Guestfs.new()\n"
25013 " g.add_drive_opts(\"disk.img\",\n"
25014 " :readonly => 1, :format => \"raw\")\n"
25020 #: ../ruby/examples/guestfs-ruby.pod:17
25022 "This manual page documents how to call libguestfs from the Ruby programming "
25023 "language. This page just documents the differences from the C API and gives "
25024 "some examples. If you are not familiar with using libguestfs, you also need "
25025 "to read L<guestfs(3)>."
25029 #: ../ruby/examples/guestfs-ruby.pod:24
25031 "Errors from libguestfs functions are mapped into the C<Error> exception. "
25032 "This has a single parameter which is the error message (a string)."
25036 #: ../ruby/examples/guestfs-ruby.pod:38
25038 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
25039 "(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
25040 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
25044 #: ../sparsify/virt-sparsify.pod:5
25045 msgid "virt-sparsify - Make a virtual machine disk sparse"
25049 #: ../sparsify/virt-sparsify.pod:9
25052 " virt-sparsify [--options] indisk outdisk\n"
25057 #: ../sparsify/virt-sparsify.pod:13
25059 "Virt-sparsify is a tool which can make a virtual machine disk (or any disk "
25060 "image) sparse a.k.a. thin-provisioned. This means that free space within "
25061 "the disk image can be converted back to free space on the host."
25065 #: ../sparsify/virt-sparsify.pod:18
25067 "Virt-sparsify can locate and sparsify free space in most filesystems (eg. "
25068 "ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes."
25072 #: ../sparsify/virt-sparsify.pod:21
25074 "Virt-sparsify can also convert between some disk formats, for example "
25075 "converting a raw disk image to a thin-provisioned qcow2 image."
25079 #: ../sparsify/virt-sparsify.pod:24
25081 "Virt-sparsify can operate on any disk image, not just ones from virtual "
25082 "machines. If a virtual machine has more than one attached disk, you must "
25083 "sparsify each one separately."
25087 #: ../sparsify/virt-sparsify.pod:28
25088 msgid "IMPORTANT LIMITATIONS"
25092 #: ../sparsify/virt-sparsify.pod:34
25094 "Virt-sparsify does not do in-place modifications. It copies from a source "
25095 "image to a destination image, leaving the source unchanged. I<Check that "
25096 "the sparsification was successful before deleting the source image>."
25100 #: ../sparsify/virt-sparsify.pod:41
25101 msgid "The virtual machine I<must be shut down> before using this tool."
25105 #: ../sparsify/virt-sparsify.pod:45
25107 "Virt-sparsify may require up to 2x the virtual size of the source disk image "
25108 "(1 temporary copy + 1 destination image). This is in the worst case and "
25109 "usually much less space is required."
25113 #: ../sparsify/virt-sparsify.pod:51
25115 "Virt-sparsify cannot resize disk images. To do that, use L<virt-resize(1)>."
25119 #: ../sparsify/virt-sparsify.pod:56
25120 msgid "Virt-sparsify cannot handle encrypted disks."
25124 #: ../sparsify/virt-sparsify.pod:60
25126 "Virt-sparsify cannot yet sparsify the space between partitions. Note that "
25127 "this space is often used for critical items like bootloaders so it's not "
25132 #: ../sparsify/virt-sparsify.pod:66
25134 "Virt-sparsify does not yet know how to sparsify swapspace. It is not safe "
25135 "to do this unless we can be sure there is no hibernation data, so at the "
25136 "moment swap partitions are ignored."
25140 #: ../sparsify/virt-sparsify.pod:72
25142 "You may also want to read the manual pages for the associated tools L<virt-"
25143 "filesystems(1)> and L<virt-df(1)> before starting."
25147 #: ../sparsify/virt-sparsify.pod:77
25148 msgid "Typical usage is:"
25152 #: ../sparsify/virt-sparsify.pod:79
25155 " virt-sparsify indisk outdisk\n"
25160 #: ../sparsify/virt-sparsify.pod:81
25162 "which copies C<indisk> to C<outdisk>, making the output sparse. C<outdisk> "
25163 "is created, or overwritten if it already exists. The format of the input "
25164 "disk is detected (eg. qcow2) and the same format is used for the output disk."
25168 #: ../sparsify/virt-sparsify.pod:86
25169 msgid "To convert between formats, use the I<--convert> option:"
25173 #: ../sparsify/virt-sparsify.pod:88
25176 " virt-sparsify disk.raw --convert qcow2 disk.qcow2\n"
25181 #: ../sparsify/virt-sparsify.pod:90
25183 "Virt-sparsify tries to zero and sparsify free space on every filesystem it "
25184 "can find within the source disk image. You can get it to ignore (don't zero "
25185 "free space on) certain filesystems by doing:"
25189 #: ../sparsify/virt-sparsify.pod:94
25192 " virt-sparsify --ignore /dev/sda1 indisk outdisk\n"
25197 #: ../sparsify/virt-sparsify.pod:96
25199 "See L<virt-filesystems(1)> to get a list of filesystems within a disk image."
25203 #: ../sparsify/virt-sparsify.pod:107
25204 msgid "B<--convert> raw"
25208 #: ../sparsify/virt-sparsify.pod:109
25209 msgid "B<--convert> qcow2"
25213 #: ../sparsify/virt-sparsify.pod:111
25214 msgid "B<--convert> [other formats]"
25218 #: ../sparsify/virt-sparsify.pod:113
25220 "Use C<output-format> as the format for the destination image. If this is "
25221 "not specified, then the input format is used."
25225 #: ../sparsify/virt-sparsify.pod:116
25227 "Supported and known-working output formats are: C<raw>, C<qcow2>, C<vdi>."
25231 #: ../sparsify/virt-sparsify.pod:118
25233 "You can also use any format supported by the L<qemu-img(1)> program, eg. "
25234 "C<vmdk>, but support for other formats is reliant on qemu."
25238 #: ../sparsify/virt-sparsify.pod:121
25240 "Specifying the I<--convert> option is usually a good idea, because then virt-"
25241 "sparsify doesn't need to try to guess the input format."
25245 #: ../sparsify/virt-sparsify.pod:126
25246 msgid "B<--format> qcow2"
25250 #: ../sparsify/virt-sparsify.pod:134
25251 msgid "B<--ignore> filesystem"
25255 #: ../sparsify/virt-sparsify.pod:136
25256 msgid "B<--ignore> volgroup"
25260 #: ../sparsify/virt-sparsify.pod:138
25262 "Ignore the named filesystem. Free space on the filesystem will not be "
25263 "zeroed, but existing blocks of zeroes will still be sparsified."
25267 #: ../sparsify/virt-sparsify.pod:141
25269 "In the second form, this ignores the named volume group. Use the volume "
25270 "group name without the C</dev/> prefix, eg. I<--ignore vg_foo>"
25274 #: ../sparsify/virt-sparsify.pod:156
25275 msgid "This disables progress bars and other unnecessary output."
25279 #: ../sparsify/virt-sparsify.pod:178
25281 "The I<--machine-readable> option can be used to make the output more machine "
25282 "friendly, which is useful when calling virt-sparsify from other programs, "
25287 #: ../sparsify/virt-sparsify.pod:184
25289 "Firstly use the option on its own to query the capabilities of the virt-"
25290 "sparsify binary. Typical output looks like this:"
25294 #: ../sparsify/virt-sparsify.pod:187
25297 " $ virt-sparsify --machine-readable\n"
25305 #: ../sparsify/virt-sparsify.pod:217
25307 "The calling program should treat messages sent to stderr as error messages. "
25308 "In addition, virt-sparsify exits with a non-zero status code if there was a "
25313 #: ../sparsify/virt-sparsify.pod:223
25315 "All versions of virt-sparsify have supported the I<--machine-readable> "
25320 #: ../sparsify/virt-sparsify.pod:237
25322 "Location of the temporary directory used for the potentially large temporary "
25327 #: ../sparsify/virt-sparsify.pod:240
25329 "You should ensure there is enough free space in the worst case for a full "
25330 "copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point "
25331 "to another directory that has enough space."
25335 #: ../sparsify/virt-sparsify.pod:244
25336 msgid "This defaults to C</tmp>."
25340 #: ../sparsify/virt-sparsify.pod:248
25342 "For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>."
25346 #: ../sparsify/virt-sparsify.pod:252
25348 "L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>, "
25349 "L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>, L<qemu-img"
25350 "(1)>, L<http://libguestfs.org/>."
25354 #: ../src/guestfs-actions.pod:1
25355 msgid "guestfs_add_cdrom"
25359 #: ../src/guestfs-actions.pod:3
25363 " guestfs_add_cdrom (guestfs_h *g,\n"
25364 " const char *filename);\n"
25369 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:302
25370 #: ../src/guestfs-actions.pod:323
25372 "I<This function is deprecated.> In new code, use the L</"
25373 "guestfs_add_drive_opts> call instead."
25377 #: ../src/guestfs-actions.pod:24
25379 "This call checks for the existence of C<filename>. This stops you from "
25380 "specifying other types of drive which are supported by qemu such as C<nbd:> "
25381 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
25386 #: ../src/guestfs-actions.pod:31
25388 "If you just want to add an ISO file (often you use this as an efficient way "
25389 "to transfer large files into the guest), then you should probably use "
25390 "C<guestfs_add_drive_ro> instead."
25394 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:187
25395 #: ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:291
25396 #: ../src/guestfs-actions.pod:312 ../src/guestfs-actions.pod:333
25397 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
25398 #: ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:500
25399 #: ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:559
25400 #: ../src/guestfs-actions.pod:587 ../src/guestfs-actions.pod:605
25401 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:705
25402 #: ../src/guestfs-actions.pod:719 ../src/guestfs-actions.pod:734
25403 #: ../src/guestfs-actions.pod:833 ../src/guestfs-actions.pod:851
25404 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:879
25405 #: ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:1099
25406 #: ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1137
25407 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:1286
25408 #: ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1372
25409 #: ../src/guestfs-actions.pod:1425 ../src/guestfs-actions.pod:1478
25410 #: ../src/guestfs-actions.pod:1536 ../src/guestfs-actions.pod:1590
25411 #: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1623
25412 #: ../src/guestfs-actions.pod:1651 ../src/guestfs-actions.pod:1721
25413 #: ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:1777
25414 #: ../src/guestfs-actions.pod:1819 ../src/guestfs-actions.pod:1932
25415 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2174
25416 #: ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2283
25417 #: ../src/guestfs-actions.pod:2791 ../src/guestfs-actions.pod:2935
25418 #: ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3031
25419 #: ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4103
25420 #: ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4317
25421 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:4344
25422 #: ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4373
25423 #: ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4481
25424 #: ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4518
25425 #: ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4558
25426 #: ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4612
25427 #: ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4666
25428 #: ../src/guestfs-actions.pod:4678 ../src/guestfs-actions.pod:4711
25429 #: ../src/guestfs-actions.pod:4727 ../src/guestfs-actions.pod:4740
25430 #: ../src/guestfs-actions.pod:4755 ../src/guestfs-actions.pod:4772
25431 #: ../src/guestfs-actions.pod:4865 ../src/guestfs-actions.pod:4885
25432 #: ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4949
25433 #: ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4985
25434 #: ../src/guestfs-actions.pod:5001 ../src/guestfs-actions.pod:5015
25435 #: ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5046
25436 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5088
25437 #: ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5224
25438 #: ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5274
25439 #: ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5305
25440 #: ../src/guestfs-actions.pod:5322 ../src/guestfs-actions.pod:5335
25441 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5365
25442 #: ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:5423
25443 #: ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5482
25444 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5513
25445 #: ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5615
25446 #: ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:5705
25447 #: ../src/guestfs-actions.pod:5733 ../src/guestfs-actions.pod:5750
25448 #: ../src/guestfs-actions.pod:5768 ../src/guestfs-actions.pod:5905
25449 #: ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5984
25450 #: ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6054
25451 #: ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6137
25452 #: ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6164
25453 #: ../src/guestfs-actions.pod:6453 ../src/guestfs-actions.pod:6472
25454 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:6505
25455 #: ../src/guestfs-actions.pod:6517 ../src/guestfs-actions.pod:6531
25456 #: ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6557
25457 #: ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6591
25458 #: ../src/guestfs-actions.pod:6610 ../src/guestfs-actions.pod:6629
25459 #: ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6677
25460 #: ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6718
25461 #: ../src/guestfs-actions.pod:6737 ../src/guestfs-actions.pod:6758
25462 #: ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6794
25463 #: ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6841
25464 #: ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6884
25465 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6924
25466 #: ../src/guestfs-actions.pod:6943 ../src/guestfs-actions.pod:6958
25467 #: ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7021
25468 #: ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7078
25469 #: ../src/guestfs-actions.pod:7190 ../src/guestfs-actions.pod:7311
25470 #: ../src/guestfs-actions.pod:7323 ../src/guestfs-actions.pod:7336
25471 #: ../src/guestfs-actions.pod:7349 ../src/guestfs-actions.pod:7371
25472 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7397
25473 #: ../src/guestfs-actions.pod:7410 ../src/guestfs-actions.pod:7425
25474 #: ../src/guestfs-actions.pod:7484 ../src/guestfs-actions.pod:7501
25475 #: ../src/guestfs-actions.pod:7517 ../src/guestfs-actions.pod:7533
25476 #: ../src/guestfs-actions.pod:7550 ../src/guestfs-actions.pod:7563
25477 #: ../src/guestfs-actions.pod:7583 ../src/guestfs-actions.pod:7619
25478 #: ../src/guestfs-actions.pod:7633 ../src/guestfs-actions.pod:7674
25479 #: ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7705
25480 #: ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7775
25481 #: ../src/guestfs-actions.pod:7891 ../src/guestfs-actions.pod:7906
25482 #: ../src/guestfs-actions.pod:7920 ../src/guestfs-actions.pod:7975
25483 #: ../src/guestfs-actions.pod:7988 ../src/guestfs-actions.pod:8033
25484 #: ../src/guestfs-actions.pod:8073 ../src/guestfs-actions.pod:8129
25485 #: ../src/guestfs-actions.pod:8149 ../src/guestfs-actions.pod:8182
25486 #: ../src/guestfs-actions.pod:8246 ../src/guestfs-actions.pod:8269
25487 #: ../src/guestfs-actions.pod:8295
25488 msgid "This function returns 0 on success or -1 on error."
25492 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:189
25493 #: ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:2397
25494 #: ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2620
25495 #: ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4110
25496 #: ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:6679
25497 #: ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6945
25498 #: ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7552
25499 #: ../src/guestfs-actions.pod:8075
25500 msgid "(Added in 0.3)"
25504 #: ../src/guestfs-actions.pod:41
25505 msgid "guestfs_add_domain"
25509 #: ../src/guestfs-actions.pod:43
25513 " guestfs_add_domain (guestfs_h *g,\n"
25514 " const char *dom,\n"
25520 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:198
25521 #: ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:1214
25522 #: ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1344
25523 #: ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1466
25524 #: ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:3288
25525 #: ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5409
25526 #: ../src/guestfs-actions.pod:5626
25528 "You may supply a list of optional arguments to this call. Use zero or more "
25529 "of the following pairs of parameters, and terminate the list with C<-1> on "
25530 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
25534 #: ../src/guestfs-actions.pod:53
25537 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
25538 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
25539 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
25540 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
25541 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
25542 " GUESTFS_ADD_DOMAIN_READONLYDISK, const char *readonlydisk,\n"
25547 #: ../src/guestfs-actions.pod:60
25549 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
25550 "It works by connecting to libvirt, requesting the domain and domain XML from "
25551 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
25556 #: ../src/guestfs-actions.pod:141
25558 "The other optional parameters are passed directly through to "
25559 "C<guestfs_add_drive_opts>."
25563 #: ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:403
25564 #: ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:751
25565 #: ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800
25566 #: ../src/guestfs-actions.pod:819 ../src/guestfs-actions.pod:1797
25567 #: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:2356
25568 #: ../src/guestfs-actions.pod:2467 ../src/guestfs-actions.pod:2518
25569 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2584
25570 #: ../src/guestfs-actions.pod:2607 ../src/guestfs-actions.pod:2922
25571 #: ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3424
25572 #: ../src/guestfs-actions.pod:5585 ../src/guestfs-actions.pod:5802
25573 #: ../src/guestfs-actions.pod:6040 ../src/guestfs-actions.pod:6234
25574 #: ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:7660
25575 #: ../src/guestfs-actions.pod:8086 ../src/guestfs-actions.pod:8099
25576 #: ../src/guestfs-actions.pod:8112
25577 msgid "On error this function returns -1."
25581 #: ../src/guestfs-actions.pod:146
25582 msgid "(Added in 1.7.4)"
25586 #: ../src/guestfs-actions.pod:148
25587 msgid "guestfs_add_domain_va"
25591 #: ../src/guestfs-actions.pod:150
25595 " guestfs_add_domain_va (guestfs_h *g,\n"
25596 " const char *dom,\n"
25597 " va_list args);\n"
25602 #: ../src/guestfs-actions.pod:155
25603 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
25607 #: ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:168
25608 #: ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:278
25609 #: ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:940
25610 #: ../src/guestfs-actions.pod:1242 ../src/guestfs-actions.pod:1255
25611 #: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1314
25612 #: ../src/guestfs-actions.pod:1391 ../src/guestfs-actions.pod:1403
25613 #: ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1456
25614 #: ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1509
25615 #: ../src/guestfs-actions.pod:1555 ../src/guestfs-actions.pod:1567
25616 #: ../src/guestfs-actions.pod:3372 ../src/guestfs-actions.pod:3384
25617 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5177
25618 #: ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5449
25619 #: ../src/guestfs-actions.pod:5675 ../src/guestfs-actions.pod:5686
25620 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
25624 #: ../src/guestfs-actions.pod:159
25625 msgid "guestfs_add_domain_argv"
25629 #: ../src/guestfs-actions.pod:161
25633 " guestfs_add_domain_argv (guestfs_h *g,\n"
25634 " const char *dom,\n"
25635 " const struct guestfs_add_domain_argv *optargs);\n"
25640 #: ../src/guestfs-actions.pod:166
25641 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
25645 #: ../src/guestfs-actions.pod:170
25646 msgid "guestfs_add_drive"
25650 #: ../src/guestfs-actions.pod:172
25654 " guestfs_add_drive (guestfs_h *g,\n"
25655 " const char *filename);\n"
25660 #: ../src/guestfs-actions.pod:176
25662 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
25663 "optional parameters, so the disk is added writable, with the format being "
25664 "detected automatically."
25668 #: ../src/guestfs-actions.pod:180
25670 "Automatic detection of the format opens you up to a potential security hole "
25671 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
25672 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
25673 "you should think about replacing calls to this function with calls to "
25674 "C<guestfs_add_drive_opts>, and specifying the format."
25678 #: ../src/guestfs-actions.pod:191
25679 msgid "guestfs_add_drive_opts"
25683 #: ../src/guestfs-actions.pod:193
25687 " guestfs_add_drive_opts (guestfs_h *g,\n"
25688 " const char *filename,\n"
25694 #: ../src/guestfs-actions.pod:203
25697 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
25698 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
25699 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
25700 " GUESTFS_ADD_DRIVE_OPTS_NAME, const char *name,\n"
25705 #: ../src/guestfs-actions.pod:233
25707 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
25708 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
25709 "Possible formats include C<raw> and C<qcow2>."
25713 #: ../src/guestfs-actions.pod:244
25715 "This rarely-used option lets you emulate the behaviour of the deprecated "
25716 "C<guestfs_add_drive_with_if> call (q.v.)"
25720 #: ../src/guestfs-actions.pod:256
25721 msgid "(Added in 1.5.23)"
25725 #: ../src/guestfs-actions.pod:258
25726 msgid "guestfs_add_drive_opts_va"
25730 #: ../src/guestfs-actions.pod:260
25734 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
25735 " const char *filename,\n"
25736 " va_list args);\n"
25741 #: ../src/guestfs-actions.pod:265
25742 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
25746 #: ../src/guestfs-actions.pod:269
25747 msgid "guestfs_add_drive_opts_argv"
25751 #: ../src/guestfs-actions.pod:271
25755 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
25756 " const char *filename,\n"
25757 " const struct guestfs_add_drive_opts_argv *optargs);\n"
25762 #: ../src/guestfs-actions.pod:276
25763 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
25767 #: ../src/guestfs-actions.pod:280
25768 msgid "guestfs_add_drive_ro"
25772 #: ../src/guestfs-actions.pod:282
25776 " guestfs_add_drive_ro (guestfs_h *g,\n"
25777 " const char *filename);\n"
25782 #: ../src/guestfs-actions.pod:286
25784 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
25785 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
25786 "disk is added read-only, with the format being detected automatically."
25790 #: ../src/guestfs-actions.pod:293
25791 msgid "(Added in 1.0.38)"
25795 #: ../src/guestfs-actions.pod:295
25796 msgid "guestfs_add_drive_ro_with_if"
25800 #: ../src/guestfs-actions.pod:297
25804 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
25805 " const char *filename,\n"
25806 " const char *iface);\n"
25811 #: ../src/guestfs-actions.pod:309
25813 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
25814 "QEMU interface emulation to use at run time."
25818 #: ../src/guestfs-actions.pod:314 ../src/guestfs-actions.pod:335
25819 #: ../src/guestfs-actions.pod:2881
25820 msgid "(Added in 1.0.84)"
25824 #: ../src/guestfs-actions.pod:316
25825 msgid "guestfs_add_drive_with_if"
25829 #: ../src/guestfs-actions.pod:318
25833 " guestfs_add_drive_with_if (guestfs_h *g,\n"
25834 " const char *filename,\n"
25835 " const char *iface);\n"
25840 #: ../src/guestfs-actions.pod:330
25842 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
25843 "QEMU interface emulation to use at run time."
25847 #: ../src/guestfs-actions.pod:337
25848 msgid "guestfs_aug_clear"
25852 #: ../src/guestfs-actions.pod:339
25856 " guestfs_aug_clear (guestfs_h *g,\n"
25857 " const char *augpath);\n"
25862 #: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:2609
25863 msgid "(Added in 1.3.4)"
25867 #: ../src/guestfs-actions.pod:350
25868 msgid "guestfs_aug_close"
25872 #: ../src/guestfs-actions.pod:352
25876 " guestfs_aug_close (guestfs_h *g);\n"
25881 #: ../src/guestfs-actions.pod:355
25883 "Close the current Augeas handle and free up any resources used by it. After "
25884 "calling this, you have to call C<guestfs_aug_init> again before you can use "
25885 "any other Augeas functions."
25889 #: ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:387
25890 #: ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:419
25891 #: ../src/guestfs-actions.pod:482 ../src/guestfs-actions.pod:502
25892 #: ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:547
25893 #: ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:575
25894 #: ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:607
25895 #: ../src/guestfs-actions.pod:6311
25896 msgid "(Added in 0.7)"
25900 #: ../src/guestfs-actions.pod:364
25901 msgid "guestfs_aug_defnode"
25905 #: ../src/guestfs-actions.pod:366
25908 " struct guestfs_int_bool *\n"
25909 " guestfs_aug_defnode (guestfs_h *g,\n"
25910 " const char *name,\n"
25911 " const char *expr,\n"
25912 " const char *val);\n"
25917 #: ../src/guestfs-actions.pod:375
25919 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
25920 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
25921 "containing that single node."
25925 #: ../src/guestfs-actions.pod:383
25927 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
25928 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
25932 #: ../src/guestfs-actions.pod:389
25933 msgid "guestfs_aug_defvar"
25937 #: ../src/guestfs-actions.pod:391
25941 " guestfs_aug_defvar (guestfs_h *g,\n"
25942 " const char *name,\n"
25943 " const char *expr);\n"
25948 #: ../src/guestfs-actions.pod:407
25949 msgid "guestfs_aug_get"
25953 #: ../src/guestfs-actions.pod:409
25957 " guestfs_aug_get (guestfs_h *g,\n"
25958 " const char *augpath);\n"
25963 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:980
25964 #: ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1058
25965 #: ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1177
25966 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1683
25967 #: ../src/guestfs-actions.pod:1702 ../src/guestfs-actions.pod:1836
25968 #: ../src/guestfs-actions.pod:2024 ../src/guestfs-actions.pod:2136
25969 #: ../src/guestfs-actions.pod:2299 ../src/guestfs-actions.pod:2316
25970 #: ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2426
25971 #: ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2632
25972 #: ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3050
25973 #: ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3256
25974 #: ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3490
25975 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3539
25976 #: ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3636
25977 #: ../src/guestfs-actions.pod:3656 ../src/guestfs-actions.pod:3676
25978 #: ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4650
25979 #: ../src/guestfs-actions.pod:4817 ../src/guestfs-actions.pod:4927
25980 #: ../src/guestfs-actions.pod:5820 ../src/guestfs-actions.pod:6021
25981 #: ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6387
25982 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:7096
25983 #: ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7136
25984 #: ../src/guestfs-actions.pod:7160 ../src/guestfs-actions.pod:7834
25985 #: ../src/guestfs-actions.pod:7853 ../src/guestfs-actions.pod:7871
25986 #: ../src/guestfs-actions.pod:8045 ../src/guestfs-actions.pod:8359
25988 "This function returns a string, or NULL on error. I<The caller must free "
25989 "the returned string after use>."
25993 #: ../src/guestfs-actions.pod:421
25994 msgid "guestfs_aug_init"
25998 #: ../src/guestfs-actions.pod:423
26002 " guestfs_aug_init (guestfs_h *g,\n"
26003 " const char *root,\n"
26009 #: ../src/guestfs-actions.pod:432
26010 msgid "You must call this before using any other C<guestfs_aug_*> commands."
26014 #: ../src/guestfs-actions.pod:457
26016 "This option is only useful when debugging Augeas lenses. Use of this option "
26017 "may require additional memory for the libguestfs appliance. You may need to "
26018 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
26019 "C<guestfs_set_memsize>."
26023 #: ../src/guestfs-actions.pod:472
26024 msgid "Do not load the tree in C<guestfs_aug_init>."
26028 #: ../src/guestfs-actions.pod:476
26029 msgid "To close the handle, you can call C<guestfs_aug_close>."
26033 #: ../src/guestfs-actions.pod:484
26034 msgid "guestfs_aug_insert"
26038 #: ../src/guestfs-actions.pod:486
26042 " guestfs_aug_insert (guestfs_h *g,\n"
26043 " const char *augpath,\n"
26044 " const char *label,\n"
26050 #: ../src/guestfs-actions.pod:504
26051 msgid "guestfs_aug_load"
26055 #: ../src/guestfs-actions.pod:506
26059 " guestfs_aug_load (guestfs_h *g);\n"
26064 #: ../src/guestfs-actions.pod:518
26065 msgid "guestfs_aug_ls"
26069 #: ../src/guestfs-actions.pod:520
26073 " guestfs_aug_ls (guestfs_h *g,\n"
26074 " const char *augpath);\n"
26079 #: ../src/guestfs-actions.pod:524
26081 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
26082 "sorting the resulting nodes into alphabetical order."
26086 #: ../src/guestfs-actions.pod:527 ../src/guestfs-actions.pod:543
26087 #: ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:1196
26088 #: ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1870
26089 #: ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:1992
26090 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2704
26091 #: ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:2739
26092 #: ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2828
26093 #: ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:2948
26094 #: ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3592
26095 #: ../src/guestfs-actions.pod:3872 ../src/guestfs-actions.pod:4186
26096 #: ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4223
26097 #: ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:4390
26098 #: ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5546
26099 #: ../src/guestfs-actions.pod:6181 ../src/guestfs-actions.pod:6307
26100 #: ../src/guestfs-actions.pod:6421 ../src/guestfs-actions.pod:7176
26101 #: ../src/guestfs-actions.pod:7237 ../src/guestfs-actions.pod:7292
26102 #: ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7462
26103 #: ../src/guestfs-actions.pod:7938 ../src/guestfs-actions.pod:7958
26104 #: ../src/guestfs-actions.pod:8005 ../src/guestfs-actions.pod:8199
26105 #: ../src/guestfs-actions.pod:8218 ../src/guestfs-actions.pod:8309
26106 #: ../src/guestfs-actions.pod:8328 ../src/guestfs-actions.pod:8374
26107 #: ../src/guestfs-actions.pod:8393
26109 "This function returns a NULL-terminated array of strings (like L<environ(3)"
26110 ">), or NULL if there was an error. I<The caller must free the strings and "
26111 "the array after use>."
26115 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:1121
26116 #: ../src/guestfs-actions.pod:1139 ../src/guestfs-actions.pod:1908
26117 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:3981
26118 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4680
26119 #: ../src/guestfs-actions.pod:4867 ../src/guestfs-actions.pod:4900
26120 #: ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5550
26121 #: ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6519
26122 #: ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6545
26123 #: ../src/guestfs-actions.pod:7023 ../src/guestfs-actions.pod:7676
26124 #: ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7922
26125 #: ../src/guestfs-actions.pod:8187
26126 msgid "(Added in 0.8)"
26130 #: ../src/guestfs-actions.pod:533
26131 msgid "guestfs_aug_match"
26135 #: ../src/guestfs-actions.pod:535
26139 " guestfs_aug_match (guestfs_h *g,\n"
26140 " const char *augpath);\n"
26145 #: ../src/guestfs-actions.pod:549
26146 msgid "guestfs_aug_mv"
26150 #: ../src/guestfs-actions.pod:551
26154 " guestfs_aug_mv (guestfs_h *g,\n"
26155 " const char *src,\n"
26156 " const char *dest);\n"
26161 #: ../src/guestfs-actions.pod:563
26162 msgid "guestfs_aug_rm"
26166 #: ../src/guestfs-actions.pod:565
26170 " guestfs_aug_rm (guestfs_h *g,\n"
26171 " const char *augpath);\n"
26176 #: ../src/guestfs-actions.pod:577
26177 msgid "guestfs_aug_save"
26181 #: ../src/guestfs-actions.pod:579
26185 " guestfs_aug_save (guestfs_h *g);\n"
26190 #: ../src/guestfs-actions.pod:584
26192 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
26197 #: ../src/guestfs-actions.pod:591
26198 msgid "guestfs_aug_set"
26202 #: ../src/guestfs-actions.pod:593
26206 " guestfs_aug_set (guestfs_h *g,\n"
26207 " const char *augpath,\n"
26208 " const char *val);\n"
26213 #: ../src/guestfs-actions.pod:600
26215 "In the Augeas API, it is possible to clear a node by setting the value to "
26216 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
26217 "this call. Instead you must use the C<guestfs_aug_clear> call."
26221 #: ../src/guestfs-actions.pod:609
26222 msgid "guestfs_available"
26226 #: ../src/guestfs-actions.pod:611
26230 " guestfs_available (guestfs_h *g,\n"
26231 " char *const *groups);\n"
26236 #: ../src/guestfs-actions.pod:619
26238 "The libguestfs groups, and the functions that those groups correspond to, "
26239 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
26240 "runtime by calling C<guestfs_available_all_groups>."
26244 #: ../src/guestfs-actions.pod:643
26245 msgid "You must call C<guestfs_launch> before calling this function."
26249 #: ../src/guestfs-actions.pod:665
26251 "This call was added in version C<1.0.80>. In previous versions of "
26252 "libguestfs all you could do would be to speculatively execute a command to "
26253 "find out if the daemon implemented it. See also C<guestfs_version>."
26257 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:1653
26258 msgid "(Added in 1.0.80)"
26262 #: ../src/guestfs-actions.pod:676
26263 msgid "guestfs_available_all_groups"
26267 #: ../src/guestfs-actions.pod:678
26271 " guestfs_available_all_groups (guestfs_h *g);\n"
26276 #: ../src/guestfs-actions.pod:681
26278 "This command returns a list of all optional groups that this daemon knows "
26279 "about. Note this returns both supported and unsupported groups. To find "
26280 "out which ones the daemon can actually support you have to call "
26281 "C<guestfs_available> on each member of the returned list."
26285 #: ../src/guestfs-actions.pod:687
26286 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
26290 #: ../src/guestfs-actions.pod:693
26291 msgid "(Added in 1.3.15)"
26295 #: ../src/guestfs-actions.pod:695
26296 msgid "guestfs_base64_in"
26300 #: ../src/guestfs-actions.pod:697
26304 " guestfs_base64_in (guestfs_h *g,\n"
26305 " const char *base64file,\n"
26306 " const char *filename);\n"
26311 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:721
26312 msgid "(Added in 1.3.5)"
26316 #: ../src/guestfs-actions.pod:709
26317 msgid "guestfs_base64_out"
26321 #: ../src/guestfs-actions.pod:711
26325 " guestfs_base64_out (guestfs_h *g,\n"
26326 " const char *filename,\n"
26327 " const char *base64file);\n"
26332 #: ../src/guestfs-actions.pod:723
26333 msgid "guestfs_blockdev_flushbufs"
26337 #: ../src/guestfs-actions.pod:725
26341 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
26342 " const char *device);\n"
26347 #: ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:753
26348 #: ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:784
26349 #: ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:821
26350 #: ../src/guestfs-actions.pod:835 ../src/guestfs-actions.pod:853
26351 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:881
26352 msgid "(Added in 0.9.3)"
26356 #: ../src/guestfs-actions.pod:738
26357 msgid "guestfs_blockdev_getbsz"
26361 #: ../src/guestfs-actions.pod:740
26365 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
26366 " const char *device);\n"
26371 #: ../src/guestfs-actions.pod:755
26372 msgid "guestfs_blockdev_getro"
26376 #: ../src/guestfs-actions.pod:757
26380 " guestfs_blockdev_getro (guestfs_h *g,\n"
26381 " const char *device);\n"
26386 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1891
26387 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:2395
26388 #: ../src/guestfs-actions.pod:2406 ../src/guestfs-actions.pod:2478
26389 #: ../src/guestfs-actions.pod:2504 ../src/guestfs-actions.pod:2544
26390 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2595
26391 #: ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:3693
26392 #: ../src/guestfs-actions.pod:3709 ../src/guestfs-actions.pod:3727
26393 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3903
26394 #: ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:3932
26395 #: ../src/guestfs-actions.pod:3948 ../src/guestfs-actions.pod:3963
26396 #: ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:3993
26397 #: ../src/guestfs-actions.pod:4006 ../src/guestfs-actions.pod:4020
26398 #: ../src/guestfs-actions.pod:4035 ../src/guestfs-actions.pod:4050
26399 #: ../src/guestfs-actions.pod:4063 ../src/guestfs-actions.pod:4077
26400 #: ../src/guestfs-actions.pod:5784
26401 msgid "This function returns a C truth value on success or -1 on error."
26405 #: ../src/guestfs-actions.pod:770
26406 msgid "guestfs_blockdev_getsize64"
26410 #: ../src/guestfs-actions.pod:772
26414 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
26415 " const char *device);\n"
26420 #: ../src/guestfs-actions.pod:778
26421 msgid "See also C<guestfs_blockdev_getsz>."
26425 #: ../src/guestfs-actions.pod:786
26426 msgid "guestfs_blockdev_getss"
26430 #: ../src/guestfs-actions.pod:788
26434 " guestfs_blockdev_getss (guestfs_h *g,\n"
26435 " const char *device);\n"
26440 #: ../src/guestfs-actions.pod:795
26442 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
26447 #: ../src/guestfs-actions.pod:804
26448 msgid "guestfs_blockdev_getsz"
26452 #: ../src/guestfs-actions.pod:806
26456 " guestfs_blockdev_getsz (guestfs_h *g,\n"
26457 " const char *device);\n"
26462 #: ../src/guestfs-actions.pod:813
26464 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
26465 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
26469 #: ../src/guestfs-actions.pod:823
26470 msgid "guestfs_blockdev_rereadpt"
26474 #: ../src/guestfs-actions.pod:825
26478 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
26479 " const char *device);\n"
26484 #: ../src/guestfs-actions.pod:837
26485 msgid "guestfs_blockdev_setbsz"
26489 #: ../src/guestfs-actions.pod:839
26493 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
26494 " const char *device,\n"
26495 " int blocksize);\n"
26500 #: ../src/guestfs-actions.pod:855
26501 msgid "guestfs_blockdev_setro"
26505 #: ../src/guestfs-actions.pod:857
26509 " guestfs_blockdev_setro (guestfs_h *g,\n"
26510 " const char *device);\n"
26515 #: ../src/guestfs-actions.pod:869
26516 msgid "guestfs_blockdev_setrw"
26520 #: ../src/guestfs-actions.pod:871
26524 " guestfs_blockdev_setrw (guestfs_h *g,\n"
26525 " const char *device);\n"
26530 #: ../src/guestfs-actions.pod:883
26531 msgid "guestfs_btrfs_filesystem_resize"
26535 #: ../src/guestfs-actions.pod:885
26539 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
26540 " const char *mountpoint,\n"
26546 #: ../src/guestfs-actions.pod:895
26549 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
26554 #: ../src/guestfs-actions.pod:918
26555 msgid "(Added in 1.11.17)"
26559 #: ../src/guestfs-actions.pod:920
26560 msgid "guestfs_btrfs_filesystem_resize_va"
26564 #: ../src/guestfs-actions.pod:922
26568 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
26569 " const char *mountpoint,\n"
26570 " va_list args);\n"
26575 #: ../src/guestfs-actions.pod:927
26576 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
26580 #: ../src/guestfs-actions.pod:931
26581 msgid "guestfs_btrfs_filesystem_resize_argv"
26585 #: ../src/guestfs-actions.pod:933
26589 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
26590 " const char *mountpoint,\n"
26591 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
26596 #: ../src/guestfs-actions.pod:938
26597 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
26601 #: ../src/guestfs-actions.pod:942
26602 msgid "guestfs_case_sensitive_path"
26606 #: ../src/guestfs-actions.pod:944
26610 " guestfs_case_sensitive_path (guestfs_h *g,\n"
26611 " const char *path);\n"
26616 #: ../src/guestfs-actions.pod:970
26618 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
26619 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
26620 "how the directories were originally created under Windows)."
26624 #: ../src/guestfs-actions.pod:978
26625 msgid "See also C<guestfs_realpath>."
26629 #: ../src/guestfs-actions.pod:983 ../src/guestfs-actions.pod:7856
26630 msgid "(Added in 1.0.75)"
26634 #: ../src/guestfs-actions.pod:985
26635 msgid "guestfs_cat"
26639 #: ../src/guestfs-actions.pod:987
26643 " guestfs_cat (guestfs_h *g,\n"
26644 " const char *path);\n"
26649 #: ../src/guestfs-actions.pod:993
26651 "Note that this function cannot correctly handle binary files (specifically, "
26652 "files containing C<\\0> character which is treated as end of string). For "
26653 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
26654 "functions which have a more complex interface."
26658 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:4207
26659 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4306
26660 #: ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4793
26661 #: ../src/guestfs-actions.pod:4807 ../src/guestfs-actions.pod:6185
26662 #: ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:8009
26663 #: ../src/guestfs-actions.pod:8023
26664 msgid "(Added in 0.4)"
26668 #: ../src/guestfs-actions.pod:1006
26669 msgid "guestfs_checksum"
26673 #: ../src/guestfs-actions.pod:1008
26677 " guestfs_checksum (guestfs_h *g,\n"
26678 " const char *csumtype,\n"
26679 " const char *path);\n"
26684 #: ../src/guestfs-actions.pod:1054
26685 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
26689 #: ../src/guestfs-actions.pod:1056
26690 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
26694 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1728
26695 #: ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:3905
26696 #: ../src/guestfs-actions.pod:3934 ../src/guestfs-actions.pod:3995
26697 #: ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:7712
26698 msgid "(Added in 1.0.2)"
26702 #: ../src/guestfs-actions.pod:1063
26703 msgid "guestfs_checksum_device"
26707 #: ../src/guestfs-actions.pod:1065
26711 " guestfs_checksum_device (guestfs_h *g,\n"
26712 " const char *csumtype,\n"
26713 " const char *device);\n"
26718 #: ../src/guestfs-actions.pod:1070
26720 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
26721 "device named C<device>. For the types of checksums supported see the "
26722 "C<guestfs_checksum> command."
26726 #: ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:5617
26727 #: ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5786
26728 #: ../src/guestfs-actions.pod:5804 ../src/guestfs-actions.pod:5986
26729 #: ../src/guestfs-actions.pod:7621 ../src/guestfs-actions.pod:7635
26730 #: ../src/guestfs-actions.pod:8035
26731 msgid "(Added in 1.3.2)"
26735 #: ../src/guestfs-actions.pod:1079
26736 msgid "guestfs_checksums_out"
26740 #: ../src/guestfs-actions.pod:1081
26744 " guestfs_checksums_out (guestfs_h *g,\n"
26745 " const char *csumtype,\n"
26746 " const char *directory,\n"
26747 " const char *sumsfile);\n"
26752 #: ../src/guestfs-actions.pod:1101
26753 msgid "(Added in 1.3.7)"
26757 #: ../src/guestfs-actions.pod:1103
26758 msgid "guestfs_chmod"
26762 #: ../src/guestfs-actions.pod:1105
26766 " guestfs_chmod (guestfs_h *g,\n"
26768 " const char *path);\n"
26773 #: ../src/guestfs-actions.pod:1123
26774 msgid "guestfs_chown"
26778 #: ../src/guestfs-actions.pod:1125
26782 " guestfs_chown (guestfs_h *g,\n"
26785 " const char *path);\n"
26790 #: ../src/guestfs-actions.pod:1141
26791 msgid "guestfs_command"
26795 #: ../src/guestfs-actions.pod:1143
26799 " guestfs_command (guestfs_h *g,\n"
26800 " char *const *arguments);\n"
26805 #: ../src/guestfs-actions.pod:1152
26807 "The single parameter is an argv-style list of arguments. The first element "
26808 "is the name of the program to run. Subsequent elements are parameters. The "
26809 "list must be non-empty (ie. must contain a program name). Note that the "
26810 "command runs directly, and is I<not> invoked via the shell (see "
26815 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1203
26816 #: ../src/guestfs-actions.pod:2027
26817 msgid "(Added in 0.9.1)"
26821 #: ../src/guestfs-actions.pod:1185
26822 msgid "guestfs_command_lines"
26826 #: ../src/guestfs-actions.pod:1187
26830 " guestfs_command_lines (guestfs_h *g,\n"
26831 " char *const *arguments);\n"
26836 #: ../src/guestfs-actions.pod:1191
26838 "This is the same as C<guestfs_command>, but splits the result into a list of "
26843 #: ../src/guestfs-actions.pod:1194
26844 msgid "See also: C<guestfs_sh_lines>"
26848 #: ../src/guestfs-actions.pod:1205
26849 msgid "guestfs_compress_device_out"
26853 #: ../src/guestfs-actions.pod:1207
26857 " guestfs_compress_device_out (guestfs_h *g,\n"
26858 " const char *ctype,\n"
26859 " const char *device,\n"
26860 " const char *zdevice,\n"
26866 #: ../src/guestfs-actions.pod:1219
26869 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
26874 #: ../src/guestfs-actions.pod:1224
26876 "The C<ctype> and optional C<level> parameters have the same meaning as in "
26877 "C<guestfs_compress_out>."
26881 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1288
26882 #: ../src/guestfs-actions.pod:2572 ../src/guestfs-actions.pod:6902
26883 msgid "(Added in 1.13.15)"
26887 #: ../src/guestfs-actions.pod:1231
26888 msgid "guestfs_compress_device_out_va"
26892 #: ../src/guestfs-actions.pod:1233
26896 " guestfs_compress_device_out_va (guestfs_h *g,\n"
26897 " const char *ctype,\n"
26898 " const char *device,\n"
26899 " const char *zdevice,\n"
26900 " va_list args);\n"
26905 #: ../src/guestfs-actions.pod:1240
26906 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
26910 #: ../src/guestfs-actions.pod:1244
26911 msgid "guestfs_compress_device_out_argv"
26915 #: ../src/guestfs-actions.pod:1246
26919 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
26920 " const char *ctype,\n"
26921 " const char *device,\n"
26922 " const char *zdevice,\n"
26923 " const struct guestfs_compress_device_out_argv *optargs);\n"
26928 #: ../src/guestfs-actions.pod:1253
26929 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
26933 #: ../src/guestfs-actions.pod:1257
26934 msgid "guestfs_compress_out"
26938 #: ../src/guestfs-actions.pod:1259
26942 " guestfs_compress_out (guestfs_h *g,\n"
26943 " const char *ctype,\n"
26944 " const char *file,\n"
26945 " const char *zfile,\n"
26951 #: ../src/guestfs-actions.pod:1271
26954 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
26959 #: ../src/guestfs-actions.pod:1290
26960 msgid "guestfs_compress_out_va"
26964 #: ../src/guestfs-actions.pod:1292
26968 " guestfs_compress_out_va (guestfs_h *g,\n"
26969 " const char *ctype,\n"
26970 " const char *file,\n"
26971 " const char *zfile,\n"
26972 " va_list args);\n"
26977 #: ../src/guestfs-actions.pod:1299
26978 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
26982 #: ../src/guestfs-actions.pod:1303
26983 msgid "guestfs_compress_out_argv"
26987 #: ../src/guestfs-actions.pod:1305
26991 " guestfs_compress_out_argv (guestfs_h *g,\n"
26992 " const char *ctype,\n"
26993 " const char *file,\n"
26994 " const char *zfile,\n"
26995 " const struct guestfs_compress_out_argv *optargs);\n"
27000 #: ../src/guestfs-actions.pod:1312
27001 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
27005 #: ../src/guestfs-actions.pod:1316
27006 msgid "guestfs_config"
27010 #: ../src/guestfs-actions.pod:1318
27014 " guestfs_config (guestfs_h *g,\n"
27015 " const char *qemuparam,\n"
27016 " const char *qemuvalue);\n"
27021 #: ../src/guestfs-actions.pod:1336
27022 msgid "guestfs_copy_device_to_device"
27026 #: ../src/guestfs-actions.pod:1338
27030 " guestfs_copy_device_to_device (guestfs_h *g,\n"
27031 " const char *src,\n"
27032 " const char *dest,\n"
27038 #: ../src/guestfs-actions.pod:1349
27041 " GUESTFS_COPY_DEVICE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
27042 " GUESTFS_COPY_DEVICE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
27043 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, int64_t size,\n"
27048 #: ../src/guestfs-actions.pod:1353
27050 "The four calls C<guestfs_copy_device_to_device>, "
27051 "C<guestfs_copy_device_to_file>, C<guestfs_copy_file_to_device>, and "
27052 "C<guestfs_copy_file_to_file> let you copy from a source (device|file) to a "
27053 "destination (device|file)."
27057 #: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1427
27058 #: ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1538
27059 #: ../src/guestfs-actions.pod:1592 ../src/guestfs-actions.pod:1723
27060 #: ../src/guestfs-actions.pod:1754 ../src/guestfs-actions.pod:1799
27061 #: ../src/guestfs-actions.pod:2176 ../src/guestfs-actions.pod:2198
27062 #: ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:7707
27063 #: ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:8248
27064 #: ../src/guestfs-actions.pod:8271
27066 "This long-running command can generate progress notification messages so "
27067 "that the caller can display a progress bar or indicator. To receive these "
27068 "messages, the caller must register a progress event callback. See L<guestfs"
27069 "(3)/GUESTFS_EVENT_PROGRESS>."
27073 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1432
27074 #: ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1543
27075 #: ../src/guestfs-actions.pod:6042
27076 msgid "(Added in 1.13.25)"
27080 #: ../src/guestfs-actions.pod:1381
27081 msgid "guestfs_copy_device_to_device_va"
27085 #: ../src/guestfs-actions.pod:1383
27089 " guestfs_copy_device_to_device_va (guestfs_h *g,\n"
27090 " const char *src,\n"
27091 " const char *dest,\n"
27092 " va_list args);\n"
27097 #: ../src/guestfs-actions.pod:1389
27098 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_device>."
27102 #: ../src/guestfs-actions.pod:1393
27103 msgid "guestfs_copy_device_to_device_argv"
27107 #: ../src/guestfs-actions.pod:1395
27111 " guestfs_copy_device_to_device_argv (guestfs_h *g,\n"
27112 " const char *src,\n"
27113 " const char *dest,\n"
27114 " const struct guestfs_copy_device_to_device_argv *optargs);\n"
27119 #: ../src/guestfs-actions.pod:1401
27120 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_device>."
27124 #: ../src/guestfs-actions.pod:1405
27125 msgid "guestfs_copy_device_to_file"
27129 #: ../src/guestfs-actions.pod:1407
27133 " guestfs_copy_device_to_file (guestfs_h *g,\n"
27134 " const char *src,\n"
27135 " const char *dest,\n"
27141 #: ../src/guestfs-actions.pod:1418
27144 " GUESTFS_COPY_DEVICE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
27145 " GUESTFS_COPY_DEVICE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
27146 " GUESTFS_COPY_DEVICE_TO_FILE_SIZE, int64_t size,\n"
27151 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1475
27152 #: ../src/guestfs-actions.pod:1528
27154 "See C<guestfs_copy_device_to_device> for a general overview of this call."
27158 #: ../src/guestfs-actions.pod:1434
27159 msgid "guestfs_copy_device_to_file_va"
27163 #: ../src/guestfs-actions.pod:1436
27167 " guestfs_copy_device_to_file_va (guestfs_h *g,\n"
27168 " const char *src,\n"
27169 " const char *dest,\n"
27170 " va_list args);\n"
27175 #: ../src/guestfs-actions.pod:1442
27176 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_file>."
27180 #: ../src/guestfs-actions.pod:1446
27181 msgid "guestfs_copy_device_to_file_argv"
27185 #: ../src/guestfs-actions.pod:1448
27189 " guestfs_copy_device_to_file_argv (guestfs_h *g,\n"
27190 " const char *src,\n"
27191 " const char *dest,\n"
27192 " const struct guestfs_copy_device_to_file_argv *optargs);\n"
27197 #: ../src/guestfs-actions.pod:1454
27198 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_file>."
27202 #: ../src/guestfs-actions.pod:1458
27203 msgid "guestfs_copy_file_to_device"
27207 #: ../src/guestfs-actions.pod:1460
27211 " guestfs_copy_file_to_device (guestfs_h *g,\n"
27212 " const char *src,\n"
27213 " const char *dest,\n"
27219 #: ../src/guestfs-actions.pod:1471
27222 " GUESTFS_COPY_FILE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
27223 " GUESTFS_COPY_FILE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
27224 " GUESTFS_COPY_FILE_TO_DEVICE_SIZE, int64_t size,\n"
27229 #: ../src/guestfs-actions.pod:1487
27230 msgid "guestfs_copy_file_to_device_va"
27234 #: ../src/guestfs-actions.pod:1489
27238 " guestfs_copy_file_to_device_va (guestfs_h *g,\n"
27239 " const char *src,\n"
27240 " const char *dest,\n"
27241 " va_list args);\n"
27246 #: ../src/guestfs-actions.pod:1495
27247 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_device>."
27251 #: ../src/guestfs-actions.pod:1499
27252 msgid "guestfs_copy_file_to_device_argv"
27256 #: ../src/guestfs-actions.pod:1501
27260 " guestfs_copy_file_to_device_argv (guestfs_h *g,\n"
27261 " const char *src,\n"
27262 " const char *dest,\n"
27263 " const struct guestfs_copy_file_to_device_argv *optargs);\n"
27268 #: ../src/guestfs-actions.pod:1507
27269 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_device>."
27273 #: ../src/guestfs-actions.pod:1511
27274 msgid "guestfs_copy_file_to_file"
27278 #: ../src/guestfs-actions.pod:1513
27282 " guestfs_copy_file_to_file (guestfs_h *g,\n"
27283 " const char *src,\n"
27284 " const char *dest,\n"
27290 #: ../src/guestfs-actions.pod:1524
27293 " GUESTFS_COPY_FILE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
27294 " GUESTFS_COPY_FILE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
27295 " GUESTFS_COPY_FILE_TO_FILE_SIZE, int64_t size,\n"
27300 #: ../src/guestfs-actions.pod:1531
27302 "This is B<not> the function you want for copying files. This is for copying "
27303 "blocks within existing files. See C<guestfs_cp>, C<guestfs_cp_a> and "
27304 "C<guestfs_mv> for general file copying and moving functions."
27308 #: ../src/guestfs-actions.pod:1545
27309 msgid "guestfs_copy_file_to_file_va"
27313 #: ../src/guestfs-actions.pod:1547
27317 " guestfs_copy_file_to_file_va (guestfs_h *g,\n"
27318 " const char *src,\n"
27319 " const char *dest,\n"
27320 " va_list args);\n"
27325 #: ../src/guestfs-actions.pod:1553
27326 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_file>."
27330 #: ../src/guestfs-actions.pod:1557
27331 msgid "guestfs_copy_file_to_file_argv"
27335 #: ../src/guestfs-actions.pod:1559
27339 " guestfs_copy_file_to_file_argv (guestfs_h *g,\n"
27340 " const char *src,\n"
27341 " const char *dest,\n"
27342 " const struct guestfs_copy_file_to_file_argv *optargs);\n"
27347 #: ../src/guestfs-actions.pod:1565
27348 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_file>."
27352 #: ../src/guestfs-actions.pod:1569
27353 msgid "guestfs_copy_size"
27357 #: ../src/guestfs-actions.pod:1571
27361 " guestfs_copy_size (guestfs_h *g,\n"
27362 " const char *src,\n"
27363 " const char *dest,\n"
27364 " int64_t size);\n"
27369 #: ../src/guestfs-actions.pod:1577 ../src/guestfs-actions.pod:1634
27371 "I<This function is deprecated.> In new code, use the L</"
27372 "guestfs_copy_device_to_device> call instead."
27376 #: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:4820
27377 #: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:7942
27378 #: ../src/guestfs-actions.pod:7962 ../src/guestfs-actions.pod:8048
27379 msgid "(Added in 1.0.87)"
27383 #: ../src/guestfs-actions.pod:1599
27388 #: ../src/guestfs-actions.pod:1601
27392 " guestfs_cp (guestfs_h *g,\n"
27393 " const char *src,\n"
27394 " const char *dest);\n"
27399 #: ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1625
27400 #: ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1779
27401 #: ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:5564
27402 #: ../src/guestfs-actions.pod:6056
27403 msgid "(Added in 1.0.18)"
27407 #: ../src/guestfs-actions.pod:1613
27408 msgid "guestfs_cp_a"
27412 #: ../src/guestfs-actions.pod:1615
27416 " guestfs_cp_a (guestfs_h *g,\n"
27417 " const char *src,\n"
27418 " const char *dest);\n"
27423 #: ../src/guestfs-actions.pod:1627
27428 #: ../src/guestfs-actions.pod:1629
27432 " guestfs_dd (guestfs_h *g,\n"
27433 " const char *src,\n"
27434 " const char *dest);\n"
27439 #: ../src/guestfs-actions.pod:1646
27441 "If the destination is a device, it must be as large or larger than the "
27442 "source file or device, otherwise the copy will fail. This command cannot do "
27443 "partial copies (see C<guestfs_copy_device_to_device>)."
27447 #: ../src/guestfs-actions.pod:1655
27452 #: ../src/guestfs-actions.pod:1657
27456 " guestfs_df (guestfs_h *g);\n"
27461 #: ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1679
27463 "This command is mostly useful for interactive sessions. It is I<not> "
27464 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
27469 #: ../src/guestfs-actions.pod:1669 ../src/guestfs-actions.pod:1686
27470 #: ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:2811
27471 #: ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2903
27472 #: ../src/guestfs-actions.pod:4930 ../src/guestfs-actions.pod:5464
27473 #: ../src/guestfs-actions.pod:7445 ../src/guestfs-actions.pod:7469
27474 #: ../src/guestfs-actions.pod:8088 ../src/guestfs-actions.pod:8101
27475 #: ../src/guestfs-actions.pod:8114
27476 msgid "(Added in 1.0.54)"
27480 #: ../src/guestfs-actions.pod:1671
27481 msgid "guestfs_df_h"
27485 #: ../src/guestfs-actions.pod:1673
27489 " guestfs_df_h (guestfs_h *g);\n"
27494 #: ../src/guestfs-actions.pod:1688
27495 msgid "guestfs_dmesg"
27499 #: ../src/guestfs-actions.pod:1690
27503 " guestfs_dmesg (guestfs_h *g);\n"
27508 #: ../src/guestfs-actions.pod:1697
27510 "Another way to get the same information is to enable verbose messages with "
27511 "C<guestfs_set_verbose> or by setting the environment variable "
27512 "C<LIBGUESTFS_DEBUG=1> before running the program."
27516 #: ../src/guestfs-actions.pod:1707
27517 msgid "guestfs_download"
27521 #: ../src/guestfs-actions.pod:1709
27525 " guestfs_download (guestfs_h *g,\n"
27526 " const char *remotefilename,\n"
27527 " const char *filename);\n"
27532 #: ../src/guestfs-actions.pod:1719
27533 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
27537 #: ../src/guestfs-actions.pod:1730
27538 msgid "guestfs_download_offset"
27542 #: ../src/guestfs-actions.pod:1732
27546 " guestfs_download_offset (guestfs_h *g,\n"
27547 " const char *remotefilename,\n"
27548 " const char *filename,\n"
27549 " int64_t offset,\n"
27550 " int64_t size);\n"
27555 #: ../src/guestfs-actions.pod:1745
27557 "Note that there is no limit on the amount of data that can be downloaded "
27558 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
27559 "full amount unless an error occurs."
27563 #: ../src/guestfs-actions.pod:1750
27564 msgid "See also C<guestfs_download>, C<guestfs_pread>."
27568 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:7746
27569 msgid "(Added in 1.5.17)"
27573 #: ../src/guestfs-actions.pod:1761
27574 msgid "guestfs_drop_caches"
27578 #: ../src/guestfs-actions.pod:1763
27582 " guestfs_drop_caches (guestfs_h *g,\n"
27583 " int whattodrop);\n"
27588 #: ../src/guestfs-actions.pod:1781
27593 #: ../src/guestfs-actions.pod:1783
27597 " guestfs_du (guestfs_h *g,\n"
27598 " const char *path);\n"
27603 #: ../src/guestfs-actions.pod:1806
27604 msgid "guestfs_e2fsck_f"
27608 #: ../src/guestfs-actions.pod:1808
27612 " guestfs_e2fsck_f (guestfs_h *g,\n"
27613 " const char *device);\n"
27618 #: ../src/guestfs-actions.pod:1816
27620 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
27621 "Normally you should use C<guestfs_fsck>."
27625 #: ../src/guestfs-actions.pod:1821
27626 msgid "(Added in 1.0.29)"
27630 #: ../src/guestfs-actions.pod:1823
27631 msgid "guestfs_echo_daemon"
27635 #: ../src/guestfs-actions.pod:1825
27639 " guestfs_echo_daemon (guestfs_h *g,\n"
27640 " char *const *words);\n"
27645 #: ../src/guestfs-actions.pod:1834
27646 msgid "See also C<guestfs_ping_daemon>."
27650 #: ../src/guestfs-actions.pod:1839 ../src/guestfs-actions.pod:2597
27651 #: ../src/guestfs-actions.pod:6926
27652 msgid "(Added in 1.0.69)"
27656 #: ../src/guestfs-actions.pod:1841
27657 msgid "guestfs_egrep"
27661 #: ../src/guestfs-actions.pod:1843
27665 " guestfs_egrep (guestfs_h *g,\n"
27666 " const char *regex,\n"
27667 " const char *path);\n"
27672 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1877
27673 #: ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:1980
27674 #: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:2727
27675 #: ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2924
27676 #: ../src/guestfs-actions.pod:2937 ../src/guestfs-actions.pod:2952
27677 #: ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3020
27678 #: ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:4319
27679 #: ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4346
27680 #: ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:5352
27681 #: ../src/guestfs-actions.pod:6390 ../src/guestfs-actions.pod:6439
27682 #: ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7325
27683 #: ../src/guestfs-actions.pod:7338 ../src/guestfs-actions.pod:7351
27684 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386
27685 #: ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7412
27686 #: ../src/guestfs-actions.pod:8206 ../src/guestfs-actions.pod:8225
27687 #: ../src/guestfs-actions.pod:8316 ../src/guestfs-actions.pod:8335
27688 #: ../src/guestfs-actions.pod:8381 ../src/guestfs-actions.pod:8400
27689 msgid "(Added in 1.0.66)"
27693 #: ../src/guestfs-actions.pod:1860
27694 msgid "guestfs_egrepi"
27698 #: ../src/guestfs-actions.pod:1862
27702 " guestfs_egrepi (guestfs_h *g,\n"
27703 " const char *regex,\n"
27704 " const char *path);\n"
27709 #: ../src/guestfs-actions.pod:1879
27710 msgid "guestfs_equal"
27714 #: ../src/guestfs-actions.pod:1881
27718 " guestfs_equal (guestfs_h *g,\n"
27719 " const char *file1,\n"
27720 " const char *file2);\n"
27725 #: ../src/guestfs-actions.pod:1895
27726 msgid "guestfs_exists"
27730 #: ../src/guestfs-actions.pod:1897
27734 " guestfs_exists (guestfs_h *g,\n"
27735 " const char *path);\n"
27740 #: ../src/guestfs-actions.pod:1904
27741 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
27745 #: ../src/guestfs-actions.pod:1910
27746 msgid "guestfs_fallocate"
27750 #: ../src/guestfs-actions.pod:1912
27754 " guestfs_fallocate (guestfs_h *g,\n"
27755 " const char *path,\n"
27761 #: ../src/guestfs-actions.pod:1917
27763 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
27768 #: ../src/guestfs-actions.pod:1936
27769 msgid "guestfs_fallocate64"
27773 #: ../src/guestfs-actions.pod:1938
27777 " guestfs_fallocate64 (guestfs_h *g,\n"
27778 " const char *path,\n"
27784 #: ../src/guestfs-actions.pod:1947
27786 "Note that this call allocates disk blocks for the file. To create a sparse "
27787 "file use C<guestfs_truncate_size> instead."
27791 #: ../src/guestfs-actions.pod:1950
27793 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
27794 "oversight it only allowed 30 bit lengths to be specified, effectively "
27795 "limiting the maximum size of files created through that call to 1GB."
27799 #: ../src/guestfs-actions.pod:1961
27800 msgid "(Added in 1.3.17)"
27804 #: ../src/guestfs-actions.pod:1963
27805 msgid "guestfs_fgrep"
27809 #: ../src/guestfs-actions.pod:1965
27813 " guestfs_fgrep (guestfs_h *g,\n"
27814 " const char *pattern,\n"
27815 " const char *path);\n"
27820 #: ../src/guestfs-actions.pod:1982
27821 msgid "guestfs_fgrepi"
27825 #: ../src/guestfs-actions.pod:1984
27829 " guestfs_fgrepi (guestfs_h *g,\n"
27830 " const char *pattern,\n"
27831 " const char *path);\n"
27836 #: ../src/guestfs-actions.pod:2001
27837 msgid "guestfs_file"
27841 #: ../src/guestfs-actions.pod:2003
27845 " guestfs_file (guestfs_h *g,\n"
27846 " const char *path);\n"
27851 #: ../src/guestfs-actions.pod:2021
27853 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
27854 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
27858 #: ../src/guestfs-actions.pod:2029
27859 msgid "guestfs_file_architecture"
27863 #: ../src/guestfs-actions.pod:2031
27867 " guestfs_file_architecture (guestfs_h *g,\n"
27868 " const char *filename);\n"
27873 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:2302
27874 #: ../src/guestfs-actions.pod:2319 ../src/guestfs-actions.pod:3053
27875 #: ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:3221
27876 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3426
27877 #: ../src/guestfs-actions.pod:3466 ../src/guestfs-actions.pod:3542
27878 #: ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3876
27879 #: ../src/guestfs-actions.pod:4008
27880 msgid "(Added in 1.5.3)"
27884 #: ../src/guestfs-actions.pod:2141
27885 msgid "guestfs_filesize"
27889 #: ../src/guestfs-actions.pod:2143
27893 " guestfs_filesize (guestfs_h *g,\n"
27894 " const char *file);\n"
27899 #: ../src/guestfs-actions.pod:2149
27901 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
27902 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
27903 "devices, use C<guestfs_blockdev_getsize64>."
27907 #: ../src/guestfs-actions.pod:2155
27908 msgid "(Added in 1.0.82)"
27912 #: ../src/guestfs-actions.pod:2157
27913 msgid "guestfs_fill"
27917 #: ../src/guestfs-actions.pod:2159
27921 " guestfs_fill (guestfs_h *g,\n"
27924 " const char *path);\n"
27929 #: ../src/guestfs-actions.pod:2169
27931 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
27932 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
27933 "bytes use C<guestfs_fill_pattern>."
27937 #: ../src/guestfs-actions.pod:2181
27938 msgid "(Added in 1.0.79)"
27942 #: ../src/guestfs-actions.pod:2183
27943 msgid "guestfs_fill_pattern"
27947 #: ../src/guestfs-actions.pod:2185
27951 " guestfs_fill_pattern (guestfs_h *g,\n"
27952 " const char *pattern,\n"
27954 " const char *path);\n"
27959 #: ../src/guestfs-actions.pod:2191
27961 "This function is like C<guestfs_fill> except that it creates a new file of "
27962 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
27963 "pattern is truncated if necessary to ensure the length of the file is "
27964 "exactly C<len> bytes."
27968 #: ../src/guestfs-actions.pod:2203
27969 msgid "(Added in 1.3.12)"
27973 #: ../src/guestfs-actions.pod:2205
27974 msgid "guestfs_find"
27978 #: ../src/guestfs-actions.pod:2207
27982 " guestfs_find (guestfs_h *g,\n"
27983 " const char *directory);\n"
27988 #: ../src/guestfs-actions.pod:2223
27990 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
27994 #: ../src/guestfs-actions.pod:2236
27995 msgid "See also C<guestfs_find0>."
27999 #: ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:4757
28000 #: ../src/guestfs-actions.pod:6474
28001 msgid "(Added in 1.0.27)"
28005 #: ../src/guestfs-actions.pod:2247
28006 msgid "guestfs_find0"
28010 #: ../src/guestfs-actions.pod:2249
28014 " guestfs_find0 (guestfs_h *g,\n"
28015 " const char *directory,\n"
28016 " const char *files);\n"
28021 #: ../src/guestfs-actions.pod:2258
28023 "This command works the same way as C<guestfs_find> with the following "
28028 #: ../src/guestfs-actions.pod:2285
28029 msgid "(Added in 1.0.74)"
28033 #: ../src/guestfs-actions.pod:2287
28034 msgid "guestfs_findfs_label"
28038 #: ../src/guestfs-actions.pod:2289
28042 " guestfs_findfs_label (guestfs_h *g,\n"
28043 " const char *label);\n"
28048 #: ../src/guestfs-actions.pod:2297
28049 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
28053 #: ../src/guestfs-actions.pod:2304
28054 msgid "guestfs_findfs_uuid"
28058 #: ../src/guestfs-actions.pod:2306
28062 " guestfs_findfs_uuid (guestfs_h *g,\n"
28063 " const char *uuid);\n"
28068 #: ../src/guestfs-actions.pod:2314
28069 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
28073 #: ../src/guestfs-actions.pod:2321
28074 msgid "guestfs_fsck"
28078 #: ../src/guestfs-actions.pod:2323
28082 " guestfs_fsck (guestfs_h *g,\n"
28083 " const char *fstype,\n"
28084 " const char *device);\n"
28089 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:8253
28090 msgid "(Added in 1.0.16)"
28094 #: ../src/guestfs-actions.pod:2360
28095 msgid "guestfs_get_append"
28099 #: ../src/guestfs-actions.pod:2362
28103 " guestfs_get_append (guestfs_h *g);\n"
28108 #: ../src/guestfs-actions.pod:2370
28110 "This function returns a string which may be NULL. There is no way to return "
28111 "an error from this function. The string is owned by the guest handle and "
28112 "must I<not> be freed."
28116 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6152
28117 #: ../src/guestfs-actions.pod:6631 ../src/guestfs-actions.pod:7080
28118 #: ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7115
28119 #: ../src/guestfs-actions.pod:7139 ../src/guestfs-actions.pod:7893
28120 #: ../src/guestfs-actions.pod:7908 ../src/guestfs-actions.pod:8297
28121 msgid "(Added in 1.0.26)"
28125 #: ../src/guestfs-actions.pod:2376
28126 msgid "guestfs_get_attach_method"
28130 #: ../src/guestfs-actions.pod:2378
28134 " guestfs_get_attach_method (guestfs_h *g);\n"
28139 #: ../src/guestfs-actions.pod:2381
28140 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
28144 #: ../src/guestfs-actions.pod:2386 ../src/guestfs-actions.pod:6661
28145 msgid "(Added in 1.9.8)"
28149 #: ../src/guestfs-actions.pod:2388
28150 msgid "guestfs_get_autosync"
28154 #: ../src/guestfs-actions.pod:2390
28158 " guestfs_get_autosync (guestfs_h *g);\n"
28163 #: ../src/guestfs-actions.pod:2399
28164 msgid "guestfs_get_direct"
28168 #: ../src/guestfs-actions.pod:2401
28172 " guestfs_get_direct (guestfs_h *g);\n"
28177 #: ../src/guestfs-actions.pod:2408 ../src/guestfs-actions.pod:6702
28178 msgid "(Added in 1.0.72)"
28182 #: ../src/guestfs-actions.pod:2410
28183 msgid "guestfs_get_e2label"
28187 #: ../src/guestfs-actions.pod:2412
28191 " guestfs_get_e2label (guestfs_h *g,\n"
28192 " const char *device);\n"
28197 #: ../src/guestfs-actions.pod:2416
28199 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
28204 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2450
28205 #: ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6739
28206 msgid "(Added in 1.0.15)"
28210 #: ../src/guestfs-actions.pod:2431
28211 msgid "guestfs_get_e2uuid"
28215 #: ../src/guestfs-actions.pod:2433
28219 " guestfs_get_e2uuid (guestfs_h *g,\n"
28220 " const char *device);\n"
28225 #: ../src/guestfs-actions.pod:2437
28227 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
28232 #: ../src/guestfs-actions.pod:2452
28233 msgid "guestfs_get_memsize"
28237 #: ../src/guestfs-actions.pod:2454
28241 " guestfs_get_memsize (guestfs_h *g);\n"
28246 #: ../src/guestfs-actions.pod:2460
28248 "If C<guestfs_set_memsize> was not called on this handle, and if "
28249 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
28250 "value for memsize."
28254 #: ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:5048
28255 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5276
28256 #: ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5307
28257 #: ../src/guestfs-actions.pod:5324 ../src/guestfs-actions.pod:5337
28258 #: ../src/guestfs-actions.pod:6377 ../src/guestfs-actions.pod:6760
28259 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7662
28260 msgid "(Added in 1.0.55)"
28264 #: ../src/guestfs-actions.pod:2471
28265 msgid "guestfs_get_network"
28269 #: ../src/guestfs-actions.pod:2473
28273 " guestfs_get_network (guestfs_h *g);\n"
28278 #: ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:6779
28279 msgid "(Added in 1.5.4)"
28283 #: ../src/guestfs-actions.pod:2482
28284 msgid "guestfs_get_path"
28288 #: ../src/guestfs-actions.pod:2484
28292 " guestfs_get_path (guestfs_h *g);\n"
28297 #: ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2532
28299 "This function returns a string, or NULL on error. The string is owned by "
28300 "the guest handle and must I<not> be freed."
28304 #: ../src/guestfs-actions.pod:2497
28305 msgid "guestfs_get_pgroup"
28309 #: ../src/guestfs-actions.pod:2499
28313 " guestfs_get_pgroup (guestfs_h *g);\n"
28318 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:6815
28319 #: ../src/guestfs-actions.pod:8154
28320 msgid "(Added in 1.11.18)"
28324 #: ../src/guestfs-actions.pod:2508
28325 msgid "guestfs_get_pid"
28329 #: ../src/guestfs-actions.pod:2510
28333 " guestfs_get_pid (guestfs_h *g);\n"
28338 #: ../src/guestfs-actions.pod:2520
28339 msgid "(Added in 1.0.56)"
28343 #: ../src/guestfs-actions.pod:2522
28344 msgid "guestfs_get_qemu"
28348 #: ../src/guestfs-actions.pod:2524
28352 " guestfs_get_qemu (guestfs_h *g);\n"
28357 #: ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:6843
28358 msgid "(Added in 1.0.6)"
28362 #: ../src/guestfs-actions.pod:2537
28363 msgid "guestfs_get_recovery_proc"
28367 #: ../src/guestfs-actions.pod:2539
28371 " guestfs_get_recovery_proc (guestfs_h *g);\n"
28376 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:4130
28377 #: ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4855
28378 #: ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:6082
28379 #: ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6867
28380 #: ../src/guestfs-actions.pod:7565 ../src/guestfs-actions.pod:7585
28381 #: ../src/guestfs-actions.pod:7777
28382 msgid "(Added in 1.0.77)"
28386 #: ../src/guestfs-actions.pod:2548
28387 msgid "guestfs_get_selinux"
28391 #: ../src/guestfs-actions.pod:2550
28395 " guestfs_get_selinux (guestfs_h *g);\n"
28400 #: ../src/guestfs-actions.pod:2553
28402 "This returns the current setting of the selinux flag which is passed to the "
28403 "appliance at boot time. See C<guestfs_set_selinux>."
28407 #: ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2635
28408 #: ../src/guestfs-actions.pod:6886 ../src/guestfs-actions.pod:6960
28409 msgid "(Added in 1.0.67)"
28413 #: ../src/guestfs-actions.pod:2563
28414 msgid "guestfs_get_smp"
28418 #: ../src/guestfs-actions.pod:2565
28422 " guestfs_get_smp (guestfs_h *g);\n"
28427 #: ../src/guestfs-actions.pod:2574
28428 msgid "guestfs_get_state"
28432 #: ../src/guestfs-actions.pod:2576
28436 " guestfs_get_state (guestfs_h *g);\n"
28441 #: ../src/guestfs-actions.pod:2588
28442 msgid "guestfs_get_trace"
28446 #: ../src/guestfs-actions.pod:2590
28450 " guestfs_get_trace (guestfs_h *g);\n"
28455 #: ../src/guestfs-actions.pod:2599
28456 msgid "guestfs_get_umask"
28460 #: ../src/guestfs-actions.pod:2601
28464 " guestfs_get_umask (guestfs_h *g);\n"
28469 #: ../src/guestfs-actions.pod:2604
28471 "Return the current umask. By default the umask is C<022> unless it has been "
28472 "set by calling C<guestfs_umask>."
28476 #: ../src/guestfs-actions.pod:2611
28477 msgid "guestfs_get_verbose"
28481 #: ../src/guestfs-actions.pod:2613
28485 " guestfs_get_verbose (guestfs_h *g);\n"
28490 #: ../src/guestfs-actions.pod:2622
28491 msgid "guestfs_getcon"
28495 #: ../src/guestfs-actions.pod:2624
28499 " guestfs_getcon (guestfs_h *g);\n"
28504 #: ../src/guestfs-actions.pod:2629
28506 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
28510 #: ../src/guestfs-actions.pod:2637
28511 msgid "guestfs_getxattr"
28515 #: ../src/guestfs-actions.pod:2639
28519 " guestfs_getxattr (guestfs_h *g,\n"
28520 " const char *path,\n"
28521 " const char *name,\n"
28522 " size_t *size_r);\n"
28527 #: ../src/guestfs-actions.pod:2645
28529 "Get a single extended attribute from file C<path> named C<name>. This call "
28530 "follows symlinks. If you want to lookup an extended attribute for the "
28531 "symlink itself, use C<guestfs_lgetxattr>."
28535 #: ../src/guestfs-actions.pod:2649 ../src/guestfs-actions.pod:4144
28537 "Normally it is better to get all extended attributes from a file in one go "
28538 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
28539 "implementations are buggy and do not provide a way to list out attributes. "
28540 "For these filesystems (notably ntfs-3g) you have to know the names of the "
28541 "extended attributes you want in advance and call this function."
28545 #: ../src/guestfs-actions.pod:2659
28546 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
28550 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2874
28551 #: ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:4156
28552 #: ../src/guestfs-actions.pod:6075 ../src/guestfs-actions.pod:6101
28553 #: ../src/guestfs-actions.pod:6282
28555 "This function returns a buffer, or NULL on error. The size of the returned "
28556 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
28561 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:4160
28562 msgid "(Added in 1.7.24)"
28566 #: ../src/guestfs-actions.pod:2667
28567 msgid "guestfs_getxattrs"
28571 #: ../src/guestfs-actions.pod:2669
28574 " struct guestfs_xattr_list *\n"
28575 " guestfs_getxattrs (guestfs_h *g,\n"
28576 " const char *path);\n"
28581 #: ../src/guestfs-actions.pod:2679
28582 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
28586 #: ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:4172
28587 #: ../src/guestfs-actions.pod:4851
28589 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
28590 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
28594 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:4176
28595 #: ../src/guestfs-actions.pod:4375 ../src/guestfs-actions.pod:4411
28596 #: ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6979
28597 #: ../src/guestfs-actions.pod:8362
28598 msgid "(Added in 1.0.59)"
28602 #: ../src/guestfs-actions.pod:2687
28603 msgid "guestfs_glob_expand"
28607 #: ../src/guestfs-actions.pod:2689
28611 " guestfs_glob_expand (guestfs_h *g,\n"
28612 " const char *pattern);\n"
28617 #: ../src/guestfs-actions.pod:2708 ../src/guestfs-actions.pod:7163
28618 #: ../src/guestfs-actions.pod:7180
28619 msgid "(Added in 1.0.50)"
28623 #: ../src/guestfs-actions.pod:2710
28624 msgid "guestfs_grep"
28628 #: ../src/guestfs-actions.pod:2712
28632 " guestfs_grep (guestfs_h *g,\n"
28633 " const char *regex,\n"
28634 " const char *path);\n"
28639 #: ../src/guestfs-actions.pod:2729
28640 msgid "guestfs_grepi"
28644 #: ../src/guestfs-actions.pod:2731
28648 " guestfs_grepi (guestfs_h *g,\n"
28649 " const char *regex,\n"
28650 " const char *path);\n"
28655 #: ../src/guestfs-actions.pod:2748
28656 msgid "guestfs_grub_install"
28660 #: ../src/guestfs-actions.pod:2750
28664 " guestfs_grub_install (guestfs_h *g,\n"
28665 " const char *root,\n"
28666 " const char *device);\n"
28671 #: ../src/guestfs-actions.pod:2793
28672 msgid "(Added in 1.0.17)"
28676 #: ../src/guestfs-actions.pod:2795
28677 msgid "guestfs_head"
28681 #: ../src/guestfs-actions.pod:2797
28685 " guestfs_head (guestfs_h *g,\n"
28686 " const char *path);\n"
28691 #: ../src/guestfs-actions.pod:2813
28692 msgid "guestfs_head_n"
28696 #: ../src/guestfs-actions.pod:2815
28700 " guestfs_head_n (guestfs_h *g,\n"
28702 " const char *path);\n"
28707 #: ../src/guestfs-actions.pod:2837
28708 msgid "guestfs_hexdump"
28712 #: ../src/guestfs-actions.pod:2839
28716 " guestfs_hexdump (guestfs_h *g,\n"
28717 " const char *path);\n"
28722 #: ../src/guestfs-actions.pod:2852 ../src/guestfs-actions.pod:7244
28723 #: ../src/guestfs-actions.pod:7299
28724 msgid "(Added in 1.0.22)"
28728 #: ../src/guestfs-actions.pod:2854
28729 msgid "guestfs_initrd_cat"
28733 #: ../src/guestfs-actions.pod:2856
28737 " guestfs_initrd_cat (guestfs_h *g,\n"
28738 " const char *initrdpath,\n"
28739 " const char *filename,\n"
28740 " size_t *size_r);\n"
28745 #: ../src/guestfs-actions.pod:2872
28746 msgid "See also C<guestfs_initrd_list>."
28750 #: ../src/guestfs-actions.pod:2883
28751 msgid "guestfs_initrd_list"
28755 #: ../src/guestfs-actions.pod:2885
28759 " guestfs_initrd_list (guestfs_h *g,\n"
28760 " const char *path);\n"
28765 #: ../src/guestfs-actions.pod:2905
28766 msgid "guestfs_inotify_add_watch"
28770 #: ../src/guestfs-actions.pod:2907
28774 " guestfs_inotify_add_watch (guestfs_h *g,\n"
28775 " const char *path,\n"
28781 #: ../src/guestfs-actions.pod:2926
28782 msgid "guestfs_inotify_close"
28786 #: ../src/guestfs-actions.pod:2928
28790 " guestfs_inotify_close (guestfs_h *g);\n"
28795 #: ../src/guestfs-actions.pod:2939
28796 msgid "guestfs_inotify_files"
28800 #: ../src/guestfs-actions.pod:2941
28804 " guestfs_inotify_files (guestfs_h *g);\n"
28809 #: ../src/guestfs-actions.pod:2944
28811 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
28812 "returns a list of pathnames of objects that were touched. The returned "
28813 "pathnames are sorted and deduplicated."
28817 #: ../src/guestfs-actions.pod:2954
28818 msgid "guestfs_inotify_init"
28822 #: ../src/guestfs-actions.pod:2956
28826 " guestfs_inotify_init (guestfs_h *g,\n"
28827 " int maxevents);\n"
28832 #: ../src/guestfs-actions.pod:2964
28834 "C<maxevents> is the maximum number of events which will be queued up between "
28835 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
28836 "passed as C<0>, then the kernel (or previously set) default is used. For "
28837 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
28838 "throws away events, but records the fact that it threw them away by setting "
28839 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
28840 "C<guestfs_inotify_read>)."
28844 #: ../src/guestfs-actions.pod:2974
28846 "Before any events are generated, you have to add some watches to the "
28847 "internal watch list. See: C<guestfs_inotify_add_watch>, "
28848 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
28852 #: ../src/guestfs-actions.pod:2980
28854 "Queued up events should be read periodically by calling "
28855 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
28856 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
28857 "often enough then you risk the internal queue overflowing."
28861 #: ../src/guestfs-actions.pod:2987
28863 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
28864 "This also removes any watches automatically."
28868 #: ../src/guestfs-actions.pod:3000
28869 msgid "guestfs_inotify_read"
28873 #: ../src/guestfs-actions.pod:3002
28876 " struct guestfs_inotify_event_list *\n"
28877 " guestfs_inotify_read (guestfs_h *g);\n"
28882 #: ../src/guestfs-actions.pod:3016
28884 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
28885 "there was an error. I<The caller must call "
28886 "C<guestfs_free_inotify_event_list> after use>."
28890 #: ../src/guestfs-actions.pod:3022
28891 msgid "guestfs_inotify_rm_watch"
28895 #: ../src/guestfs-actions.pod:3024
28899 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
28905 #: ../src/guestfs-actions.pod:3028
28907 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
28911 #: ../src/guestfs-actions.pod:3035
28912 msgid "guestfs_inspect_get_arch"
28916 #: ../src/guestfs-actions.pod:3037
28920 " guestfs_inspect_get_arch (guestfs_h *g,\n"
28921 " const char *root);\n"
28926 #: ../src/guestfs-actions.pod:3041
28928 "This returns the architecture of the inspected operating system. The "
28929 "possible return values are listed under C<guestfs_file_architecture>."
28933 #: ../src/guestfs-actions.pod:3055
28934 msgid "guestfs_inspect_get_distro"
28938 #: ../src/guestfs-actions.pod:3057
28942 " guestfs_inspect_get_distro (guestfs_h *g,\n"
28943 " const char *root);\n"
28948 #: ../src/guestfs-actions.pod:3157
28949 msgid "guestfs_inspect_get_drive_mappings"
28953 #: ../src/guestfs-actions.pod:3159
28957 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
28958 " const char *root);\n"
28963 #: ../src/guestfs-actions.pod:3188
28965 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
28966 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
28970 #: ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3460
28971 #: ../src/guestfs-actions.pod:4263 ../src/guestfs-actions.pod:5526
28972 #: ../src/guestfs-actions.pod:7601
28974 "This function returns a NULL-terminated array of strings, or NULL if there "
28975 "was an error. The array of strings will always have length C<2n+1>, where "
28976 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
28977 "caller must free the strings and the array after use>."
28981 #: ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3659
28982 msgid "(Added in 1.9.17)"
28986 #: ../src/guestfs-actions.pod:3200
28987 msgid "guestfs_inspect_get_filesystems"
28991 #: ../src/guestfs-actions.pod:3202
28995 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
28996 " const char *root);\n"
29001 #: ../src/guestfs-actions.pod:3214
29003 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29004 "C<guestfs_inspect_get_mountpoints>."
29008 #: ../src/guestfs-actions.pod:3223
29009 msgid "guestfs_inspect_get_format"
29013 #: ../src/guestfs-actions.pod:3225
29017 " guestfs_inspect_get_format (guestfs_h *g,\n"
29018 " const char *root);\n"
29023 #: ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:3695
29024 #: ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3729
29025 #: ../src/guestfs-actions.pod:6493
29026 msgid "(Added in 1.9.4)"
29030 #: ../src/guestfs-actions.pod:3261
29031 msgid "guestfs_inspect_get_hostname"
29035 #: ../src/guestfs-actions.pod:3263
29039 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
29040 " const char *root);\n"
29045 #: ../src/guestfs-actions.pod:3278
29046 msgid "(Added in 1.7.9)"
29050 #: ../src/guestfs-actions.pod:3280
29051 msgid "guestfs_inspect_get_icon"
29055 #: ../src/guestfs-actions.pod:3282
29059 " guestfs_inspect_get_icon (guestfs_h *g,\n"
29060 " const char *root,\n"
29061 " size_t *size_r,\n"
29067 #: ../src/guestfs-actions.pod:3293
29070 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
29071 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
29076 #: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:4190
29077 #: ../src/guestfs-actions.pod:5425
29078 msgid "(Added in 1.11.12)"
29082 #: ../src/guestfs-actions.pod:3362
29083 msgid "guestfs_inspect_get_icon_va"
29087 #: ../src/guestfs-actions.pod:3364
29091 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
29092 " const char *root,\n"
29093 " size_t *size_r,\n"
29094 " va_list args);\n"
29099 #: ../src/guestfs-actions.pod:3370
29100 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
29104 #: ../src/guestfs-actions.pod:3374
29105 msgid "guestfs_inspect_get_icon_argv"
29109 #: ../src/guestfs-actions.pod:3376
29113 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
29114 " const char *root,\n"
29115 " size_t *size_r,\n"
29116 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
29121 #: ../src/guestfs-actions.pod:3382
29122 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
29126 #: ../src/guestfs-actions.pod:3386
29127 msgid "guestfs_inspect_get_major_version"
29131 #: ../src/guestfs-actions.pod:3388
29135 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
29136 " const char *root);\n"
29141 #: ../src/guestfs-actions.pod:3410
29142 msgid "guestfs_inspect_get_minor_version"
29146 #: ../src/guestfs-actions.pod:3412
29150 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
29151 " const char *root);\n"
29156 #: ../src/guestfs-actions.pod:3421
29158 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29159 "C<guestfs_inspect_get_major_version>."
29163 #: ../src/guestfs-actions.pod:3428
29164 msgid "guestfs_inspect_get_mountpoints"
29168 #: ../src/guestfs-actions.pod:3430
29172 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
29173 " const char *root);\n"
29178 #: ../src/guestfs-actions.pod:3451
29180 "For operating systems like Windows which still use drive letters, this call "
29181 "will only return an entry for the first drive \"mounted on\" C</>. For "
29182 "information about the mapping of drive letters to partitions, see "
29183 "C<guestfs_inspect_get_drive_mappings>."
29187 #: ../src/guestfs-actions.pod:3457
29189 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29190 "C<guestfs_inspect_get_filesystems>."
29194 #: ../src/guestfs-actions.pod:3468
29195 msgid "guestfs_inspect_get_package_format"
29199 #: ../src/guestfs-actions.pod:3470
29203 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
29204 " const char *root);\n"
29209 #: ../src/guestfs-actions.pod:3474
29211 "This function and C<guestfs_inspect_get_package_management> return the "
29212 "package format and package management tool used by the inspected operating "
29213 "system. For example for Fedora these functions would return C<rpm> (package "
29214 "format) and C<yum> (package management)."
29218 #: ../src/guestfs-actions.pod:3493 ../src/guestfs-actions.pod:3521
29219 msgid "(Added in 1.7.5)"
29223 #: ../src/guestfs-actions.pod:3495
29224 msgid "guestfs_inspect_get_package_management"
29228 #: ../src/guestfs-actions.pod:3497
29232 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
29233 " const char *root);\n"
29238 #: ../src/guestfs-actions.pod:3501
29240 "C<guestfs_inspect_get_package_format> and this function return the package "
29241 "format and package management tool used by the inspected operating system. "
29242 "For example for Fedora these functions would return C<rpm> (package format) "
29243 "and C<yum> (package management)."
29247 #: ../src/guestfs-actions.pod:3523
29248 msgid "guestfs_inspect_get_product_name"
29252 #: ../src/guestfs-actions.pod:3525
29256 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
29257 " const char *root);\n"
29262 #: ../src/guestfs-actions.pod:3544
29263 msgid "guestfs_inspect_get_product_variant"
29267 #: ../src/guestfs-actions.pod:3546
29271 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
29272 " const char *root);\n"
29277 #: ../src/guestfs-actions.pod:3569
29279 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29280 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
29284 #: ../src/guestfs-actions.pod:3576
29285 msgid "(Added in 1.9.13)"
29289 #: ../src/guestfs-actions.pod:3578
29290 msgid "guestfs_inspect_get_roots"
29294 #: ../src/guestfs-actions.pod:3580
29298 " guestfs_inspect_get_roots (guestfs_h *g);\n"
29303 #: ../src/guestfs-actions.pod:3583
29305 "This function is a convenient way to get the list of root devices, as "
29306 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
29307 "the whole inspection process."
29311 #: ../src/guestfs-actions.pod:3587
29313 "This returns an empty list if either no root devices were found or the "
29314 "caller has not called C<guestfs_inspect_os>."
29318 #: ../src/guestfs-actions.pod:3596
29319 msgid "(Added in 1.7.3)"
29323 #: ../src/guestfs-actions.pod:3598
29324 msgid "guestfs_inspect_get_type"
29328 #: ../src/guestfs-actions.pod:3600
29332 " guestfs_inspect_get_type (guestfs_h *g,\n"
29333 " const char *root);\n"
29338 #: ../src/guestfs-actions.pod:3641
29339 msgid "guestfs_inspect_get_windows_current_control_set"
29343 #: ../src/guestfs-actions.pod:3643
29347 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
29348 " const char *root);\n"
29353 #: ../src/guestfs-actions.pod:3661
29354 msgid "guestfs_inspect_get_windows_systemroot"
29358 #: ../src/guestfs-actions.pod:3663
29362 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
29363 " const char *root);\n"
29368 #: ../src/guestfs-actions.pod:3679
29369 msgid "(Added in 1.5.25)"
29373 #: ../src/guestfs-actions.pod:3681
29374 msgid "guestfs_inspect_is_live"
29378 #: ../src/guestfs-actions.pod:3683
29382 " guestfs_inspect_is_live (guestfs_h *g,\n"
29383 " const char *root);\n"
29388 #: ../src/guestfs-actions.pod:3687
29390 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
29391 "disk), then this returns true if a live image was detected on the disk."
29395 #: ../src/guestfs-actions.pod:3697
29396 msgid "guestfs_inspect_is_multipart"
29400 #: ../src/guestfs-actions.pod:3699
29404 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
29405 " const char *root);\n"
29410 #: ../src/guestfs-actions.pod:3703
29412 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
29413 "disk), then this returns true if the disk is part of a set."
29417 #: ../src/guestfs-actions.pod:3713
29418 msgid "guestfs_inspect_is_netinst"
29422 #: ../src/guestfs-actions.pod:3715
29426 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
29427 " const char *root);\n"
29432 #: ../src/guestfs-actions.pod:3719
29434 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
29435 "disk), then this returns true if the disk is a network installer, ie. not a "
29436 "self-contained install CD but one which is likely to require network access "
29437 "to complete the install."
29441 #: ../src/guestfs-actions.pod:3731
29442 msgid "guestfs_inspect_list_applications"
29446 #: ../src/guestfs-actions.pod:3733
29449 " struct guestfs_application_list *\n"
29450 " guestfs_inspect_list_applications (guestfs_h *g,\n"
29451 " const char *root);\n"
29456 #: ../src/guestfs-actions.pod:3739
29458 "I<Note:> This call works differently from other parts of the inspection "
29459 "API. You have to call C<guestfs_inspect_os>, then "
29460 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
29461 "this. Listing applications is a significantly more difficult operation "
29462 "which requires access to the full filesystem. Also note that unlike the "
29463 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
29464 "the libguestfs handle, this call actually reads parts of the mounted "
29465 "filesystems during the call."
29469 #: ../src/guestfs-actions.pod:3829
29471 "This function returns a C<struct guestfs_application_list *>, or NULL if "
29472 "there was an error. I<The caller must call C<guestfs_free_application_list> "
29477 #: ../src/guestfs-actions.pod:3833
29478 msgid "(Added in 1.7.8)"
29482 #: ../src/guestfs-actions.pod:3835
29483 msgid "guestfs_inspect_os"
29487 #: ../src/guestfs-actions.pod:3837
29491 " guestfs_inspect_os (guestfs_h *g);\n"
29496 #: ../src/guestfs-actions.pod:3853
29498 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
29499 "functions in order to query further information about each operating system, "
29500 "such as the name and version."
29504 #: ../src/guestfs-actions.pod:3858
29506 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
29507 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
29508 "the contents. This should be called with no disks currently mounted. The "
29509 "function may also use Augeas, so any existing Augeas handle will be closed."
29513 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:4201
29514 #: ../src/guestfs-actions.pod:4283
29515 msgid "See also C<guestfs_list_filesystems>."
29519 #: ../src/guestfs-actions.pod:3878
29520 msgid "guestfs_is_blockdev"
29524 #: ../src/guestfs-actions.pod:3880
29528 " guestfs_is_blockdev (guestfs_h *g,\n"
29529 " const char *path);\n"
29534 #: ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3916
29535 #: ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3961
29536 #: ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4033
29537 #: ../src/guestfs-actions.pod:4048
29538 msgid "See also C<guestfs_stat>."
29542 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3920
29543 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4037
29544 #: ../src/guestfs-actions.pod:4052
29545 msgid "(Added in 1.5.10)"
29549 #: ../src/guestfs-actions.pod:3893
29550 msgid "guestfs_is_busy"
29554 #: ../src/guestfs-actions.pod:3895
29558 " guestfs_is_busy (guestfs_h *g);\n"
29563 #: ../src/guestfs-actions.pod:3907
29564 msgid "guestfs_is_chardev"
29568 #: ../src/guestfs-actions.pod:3909
29572 " guestfs_is_chardev (guestfs_h *g,\n"
29573 " const char *path);\n"
29578 #: ../src/guestfs-actions.pod:3922
29579 msgid "guestfs_is_config"
29583 #: ../src/guestfs-actions.pod:3924
29587 " guestfs_is_config (guestfs_h *g);\n"
29592 #: ../src/guestfs-actions.pod:3936
29593 msgid "guestfs_is_dir"
29597 #: ../src/guestfs-actions.pod:3938
29601 " guestfs_is_dir (guestfs_h *g,\n"
29602 " const char *path);\n"
29607 #: ../src/guestfs-actions.pod:3952
29608 msgid "guestfs_is_fifo"
29612 #: ../src/guestfs-actions.pod:3954
29616 " guestfs_is_fifo (guestfs_h *g,\n"
29617 " const char *path);\n"
29622 #: ../src/guestfs-actions.pod:3967
29623 msgid "guestfs_is_file"
29627 #: ../src/guestfs-actions.pod:3969
29631 " guestfs_is_file (guestfs_h *g,\n"
29632 " const char *path);\n"
29637 #: ../src/guestfs-actions.pod:3983
29638 msgid "guestfs_is_launching"
29642 #: ../src/guestfs-actions.pod:3985
29646 " guestfs_is_launching (guestfs_h *g);\n"
29651 #: ../src/guestfs-actions.pod:3997
29652 msgid "guestfs_is_lv"
29656 #: ../src/guestfs-actions.pod:3999
29660 " guestfs_is_lv (guestfs_h *g,\n"
29661 " const char *device);\n"
29666 #: ../src/guestfs-actions.pod:4010
29667 msgid "guestfs_is_ready"
29671 #: ../src/guestfs-actions.pod:4012
29675 " guestfs_is_ready (guestfs_h *g);\n"
29680 #: ../src/guestfs-actions.pod:4024
29681 msgid "guestfs_is_socket"
29685 #: ../src/guestfs-actions.pod:4026
29689 " guestfs_is_socket (guestfs_h *g,\n"
29690 " const char *path);\n"
29695 #: ../src/guestfs-actions.pod:4039
29696 msgid "guestfs_is_symlink"
29700 #: ../src/guestfs-actions.pod:4041
29704 " guestfs_is_symlink (guestfs_h *g,\n"
29705 " const char *path);\n"
29710 #: ../src/guestfs-actions.pod:4054
29711 msgid "guestfs_is_zero"
29715 #: ../src/guestfs-actions.pod:4056
29719 " guestfs_is_zero (guestfs_h *g,\n"
29720 " const char *path);\n"
29725 #: ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4079
29726 msgid "(Added in 1.11.8)"
29730 #: ../src/guestfs-actions.pod:4067
29731 msgid "guestfs_is_zero_device"
29735 #: ../src/guestfs-actions.pod:4069
29739 " guestfs_is_zero_device (guestfs_h *g,\n"
29740 " const char *device);\n"
29745 #: ../src/guestfs-actions.pod:4081
29746 msgid "guestfs_kill_subprocess"
29750 #: ../src/guestfs-actions.pod:4083
29754 " guestfs_kill_subprocess (guestfs_h *g);\n"
29759 #: ../src/guestfs-actions.pod:4092
29760 msgid "guestfs_launch"
29764 #: ../src/guestfs-actions.pod:4094
29768 " guestfs_launch (guestfs_h *g);\n"
29773 #: ../src/guestfs-actions.pod:4112
29774 msgid "guestfs_lchown"
29778 #: ../src/guestfs-actions.pod:4114
29782 " guestfs_lchown (guestfs_h *g,\n"
29785 " const char *path);\n"
29790 #: ../src/guestfs-actions.pod:4120
29792 "Change the file owner to C<owner> and group to C<group>. This is like "
29793 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
29794 "changed, not the target."
29798 #: ../src/guestfs-actions.pod:4132
29799 msgid "guestfs_lgetxattr"
29803 #: ../src/guestfs-actions.pod:4134
29807 " guestfs_lgetxattr (guestfs_h *g,\n"
29808 " const char *path,\n"
29809 " const char *name,\n"
29810 " size_t *size_r);\n"
29815 #: ../src/guestfs-actions.pod:4154
29816 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
29820 #: ../src/guestfs-actions.pod:4162
29821 msgid "guestfs_lgetxattrs"
29825 #: ../src/guestfs-actions.pod:4164
29828 " struct guestfs_xattr_list *\n"
29829 " guestfs_lgetxattrs (guestfs_h *g,\n"
29830 " const char *path);\n"
29835 #: ../src/guestfs-actions.pod:4168
29837 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
29838 "then it returns the extended attributes of the link itself."
29842 #: ../src/guestfs-actions.pod:4178
29843 msgid "guestfs_list_9p"
29847 #: ../src/guestfs-actions.pod:4180
29851 " guestfs_list_9p (guestfs_h *g);\n"
29856 #: ../src/guestfs-actions.pod:4192
29857 msgid "guestfs_list_devices"
29861 #: ../src/guestfs-actions.pod:4194
29865 " guestfs_list_devices (guestfs_h *g);\n"
29870 #: ../src/guestfs-actions.pod:4209
29871 msgid "guestfs_list_dm_devices"
29875 #: ../src/guestfs-actions.pod:4211
29879 " guestfs_list_dm_devices (guestfs_h *g);\n"
29884 #: ../src/guestfs-actions.pod:4216
29886 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
29887 "previous call to C<guestfs_luks_open>."
29891 #: ../src/guestfs-actions.pod:4219
29893 "Device mapper devices which correspond to logical volumes are I<not> "
29894 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
29899 #: ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:5664
29900 msgid "(Added in 1.11.15)"
29904 #: ../src/guestfs-actions.pod:4229
29905 msgid "guestfs_list_filesystems"
29909 #: ../src/guestfs-actions.pod:4231
29913 " guestfs_list_filesystems (guestfs_h *g);\n"
29918 #: ../src/guestfs-actions.pod:4251
29920 "This command runs other libguestfs commands, which might include "
29921 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
29922 "soon after launch and only when nothing is mounted."
29926 #: ../src/guestfs-actions.pod:4255
29928 "Not all of the filesystems returned will be mountable. In particular, swap "
29929 "partitions are returned in the list. Also this command does not check that "
29930 "each filesystem found is valid and mountable, and some filesystems might be "
29931 "mountable but require special options. Filesystems may not all belong to a "
29932 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
29936 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:6024
29937 msgid "(Added in 1.5.15)"
29941 #: ../src/guestfs-actions.pod:4271
29942 msgid "guestfs_list_partitions"
29946 #: ../src/guestfs-actions.pod:4273
29950 " guestfs_list_partitions (guestfs_h *g);\n"
29955 #: ../src/guestfs-actions.pod:4280
29957 "This does not return logical volumes. For that you will need to call "
29962 #: ../src/guestfs-actions.pod:4291
29967 #: ../src/guestfs-actions.pod:4293
29971 " guestfs_ll (guestfs_h *g,\n"
29972 " const char *directory);\n"
29977 #: ../src/guestfs-actions.pod:4308
29982 #: ../src/guestfs-actions.pod:4310
29986 " guestfs_ln (guestfs_h *g,\n"
29987 " const char *target,\n"
29988 " const char *linkname);\n"
29993 #: ../src/guestfs-actions.pod:4321
29994 msgid "guestfs_ln_f"
29998 #: ../src/guestfs-actions.pod:4323
30002 " guestfs_ln_f (guestfs_h *g,\n"
30003 " const char *target,\n"
30004 " const char *linkname);\n"
30009 #: ../src/guestfs-actions.pod:4335
30010 msgid "guestfs_ln_s"
30014 #: ../src/guestfs-actions.pod:4337
30018 " guestfs_ln_s (guestfs_h *g,\n"
30019 " const char *target,\n"
30020 " const char *linkname);\n"
30025 #: ../src/guestfs-actions.pod:4348
30026 msgid "guestfs_ln_sf"
30030 #: ../src/guestfs-actions.pod:4350
30034 " guestfs_ln_sf (guestfs_h *g,\n"
30035 " const char *target,\n"
30036 " const char *linkname);\n"
30041 #: ../src/guestfs-actions.pod:4362
30042 msgid "guestfs_lremovexattr"
30046 #: ../src/guestfs-actions.pod:4364
30050 " guestfs_lremovexattr (guestfs_h *g,\n"
30051 " const char *xattr,\n"
30052 " const char *path);\n"
30057 #: ../src/guestfs-actions.pod:4369
30059 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
30060 "link, then it removes an extended attribute of the link itself."
30064 #: ../src/guestfs-actions.pod:4377
30069 #: ../src/guestfs-actions.pod:4379
30073 " guestfs_ls (guestfs_h *g,\n"
30074 " const char *directory);\n"
30079 #: ../src/guestfs-actions.pod:4387
30081 "This command is mostly useful for interactive sessions. Programs should "
30082 "probably use C<guestfs_readdir> instead."
30086 #: ../src/guestfs-actions.pod:4396
30087 msgid "guestfs_lsetxattr"
30091 #: ../src/guestfs-actions.pod:4398
30095 " guestfs_lsetxattr (guestfs_h *g,\n"
30096 " const char *xattr,\n"
30097 " const char *val,\n"
30099 " const char *path);\n"
30104 #: ../src/guestfs-actions.pod:4405
30106 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
30107 "then it sets an extended attribute of the link itself."
30111 #: ../src/guestfs-actions.pod:4413
30112 msgid "guestfs_lstat"
30116 #: ../src/guestfs-actions.pod:4415
30119 " struct guestfs_stat *\n"
30120 " guestfs_lstat (guestfs_h *g,\n"
30121 " const char *path);\n"
30126 #: ../src/guestfs-actions.pod:4421
30128 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
30129 "link, then the link is stat-ed, not the file it refers to."
30133 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:7204
30135 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
30136 "error. I<The caller must call C<guestfs_free_stat> after use>."
30140 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:7208
30141 #: ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7607
30142 msgid "(Added in 0.9.2)"
30146 #: ../src/guestfs-actions.pod:4433
30147 msgid "guestfs_lstatlist"
30151 #: ../src/guestfs-actions.pod:4435
30154 " struct guestfs_stat_list *\n"
30155 " guestfs_lstatlist (guestfs_h *g,\n"
30156 " const char *path,\n"
30157 " char *const *names);\n"
30162 #: ../src/guestfs-actions.pod:4440
30164 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
30165 "files, where all files are in the directory C<path>. C<names> is the list "
30166 "of files from this directory."
30170 #: ../src/guestfs-actions.pod:4449
30172 "This call is intended for programs that want to efficiently list a directory "
30173 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
30174 "for a similarly efficient call for getting extended attributes. Very long "
30175 "directory listings might cause the protocol message size to be exceeded, "
30176 "causing this call to fail. The caller must split up such requests into "
30177 "smaller groups of names."
30181 #: ../src/guestfs-actions.pod:4457
30183 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
30184 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
30188 #: ../src/guestfs-actions.pod:4463
30189 msgid "guestfs_luks_add_key"
30193 #: ../src/guestfs-actions.pod:4465
30197 " guestfs_luks_add_key (guestfs_h *g,\n"
30198 " const char *device,\n"
30199 " const char *key,\n"
30200 " const char *newkey,\n"
30206 #: ../src/guestfs-actions.pod:4477
30208 "Note that if C<keyslot> already contains a key, then this command will "
30209 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
30213 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:4520
30214 #: ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4560
30215 #: ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4614
30217 "This function takes a key or passphrase parameter which could contain "
30218 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
30223 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:4524
30224 #: ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4564
30225 msgid "(Added in 1.5.2)"
30229 #: ../src/guestfs-actions.pod:4489
30230 msgid "guestfs_luks_close"
30234 #: ../src/guestfs-actions.pod:4491
30238 " guestfs_luks_close (guestfs_h *g,\n"
30239 " const char *device);\n"
30244 #: ../src/guestfs-actions.pod:4495
30246 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
30247 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
30248 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
30249 "underlying block device."
30253 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4599
30254 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4668
30255 #: ../src/guestfs-actions.pod:4713
30256 msgid "(Added in 1.5.1)"
30260 #: ../src/guestfs-actions.pod:4505
30261 msgid "guestfs_luks_format"
30265 #: ../src/guestfs-actions.pod:4507
30269 " guestfs_luks_format (guestfs_h *g,\n"
30270 " const char *device,\n"
30271 " const char *key,\n"
30277 #: ../src/guestfs-actions.pod:4526
30278 msgid "guestfs_luks_format_cipher"
30282 #: ../src/guestfs-actions.pod:4528
30286 " guestfs_luks_format_cipher (guestfs_h *g,\n"
30287 " const char *device,\n"
30288 " const char *key,\n"
30290 " const char *cipher);\n"
30295 #: ../src/guestfs-actions.pod:4535
30297 "This command is the same as C<guestfs_luks_format> but it also allows you to "
30298 "set the C<cipher> used."
30302 #: ../src/guestfs-actions.pod:4546
30303 msgid "guestfs_luks_kill_slot"
30307 #: ../src/guestfs-actions.pod:4548
30311 " guestfs_luks_kill_slot (guestfs_h *g,\n"
30312 " const char *device,\n"
30313 " const char *key,\n"
30319 #: ../src/guestfs-actions.pod:4566
30320 msgid "guestfs_luks_open"
30324 #: ../src/guestfs-actions.pod:4568
30328 " guestfs_luks_open (guestfs_h *g,\n"
30329 " const char *device,\n"
30330 " const char *key,\n"
30331 " const char *mapname);\n"
30336 #: ../src/guestfs-actions.pod:4586
30338 "If this block device contains LVM volume groups, then calling "
30339 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
30344 #: ../src/guestfs-actions.pod:4590
30345 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
30349 #: ../src/guestfs-actions.pod:4601
30350 msgid "guestfs_luks_open_ro"
30354 #: ../src/guestfs-actions.pod:4603
30358 " guestfs_luks_open_ro (guestfs_h *g,\n"
30359 " const char *device,\n"
30360 " const char *key,\n"
30361 " const char *mapname);\n"
30366 #: ../src/guestfs-actions.pod:4609
30368 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
30373 #: ../src/guestfs-actions.pod:4620
30374 msgid "guestfs_lvcreate"
30378 #: ../src/guestfs-actions.pod:4622
30382 " guestfs_lvcreate (guestfs_h *g,\n"
30383 " const char *logvol,\n"
30384 " const char *volgroup,\n"
30390 #: ../src/guestfs-actions.pod:4635
30391 msgid "guestfs_lvm_canonical_lv_name"
30395 #: ../src/guestfs-actions.pod:4637
30399 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
30400 " const char *lvname);\n"
30405 #: ../src/guestfs-actions.pod:4648
30406 msgid "See also C<guestfs_is_lv>."
30410 #: ../src/guestfs-actions.pod:4653
30411 msgid "(Added in 1.5.24)"
30415 #: ../src/guestfs-actions.pod:4655
30416 msgid "guestfs_lvm_clear_filter"
30420 #: ../src/guestfs-actions.pod:4657
30424 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
30429 #: ../src/guestfs-actions.pod:4660
30431 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
30432 "see every block device."
30436 #: ../src/guestfs-actions.pod:4670
30437 msgid "guestfs_lvm_remove_all"
30441 #: ../src/guestfs-actions.pod:4672
30445 " guestfs_lvm_remove_all (guestfs_h *g);\n"
30450 #: ../src/guestfs-actions.pod:4682
30451 msgid "guestfs_lvm_set_filter"
30455 #: ../src/guestfs-actions.pod:4684
30459 " guestfs_lvm_set_filter (guestfs_h *g,\n"
30460 " char *const *devices);\n"
30465 #: ../src/guestfs-actions.pod:4715
30466 msgid "guestfs_lvremove"
30470 #: ../src/guestfs-actions.pod:4717
30474 " guestfs_lvremove (guestfs_h *g,\n"
30475 " const char *device);\n"
30480 #: ../src/guestfs-actions.pod:4729 ../src/guestfs-actions.pod:6139
30481 #: ../src/guestfs-actions.pod:7977
30482 msgid "(Added in 1.0.13)"
30486 #: ../src/guestfs-actions.pod:4731
30487 msgid "guestfs_lvrename"
30491 #: ../src/guestfs-actions.pod:4733
30495 " guestfs_lvrename (guestfs_h *g,\n"
30496 " const char *logvol,\n"
30497 " const char *newlogvol);\n"
30502 #: ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:7990
30503 msgid "(Added in 1.0.83)"
30507 #: ../src/guestfs-actions.pod:4744
30508 msgid "guestfs_lvresize"
30512 #: ../src/guestfs-actions.pod:4746
30516 " guestfs_lvresize (guestfs_h *g,\n"
30517 " const char *device,\n"
30523 #: ../src/guestfs-actions.pod:4759
30524 msgid "guestfs_lvresize_free"
30528 #: ../src/guestfs-actions.pod:4761
30532 " guestfs_lvresize_free (guestfs_h *g,\n"
30533 " const char *lv,\n"
30539 #: ../src/guestfs-actions.pod:4774
30540 msgid "(Added in 1.3.3)"
30544 #: ../src/guestfs-actions.pod:4776
30545 msgid "guestfs_lvs"
30549 #: ../src/guestfs-actions.pod:4778
30553 " guestfs_lvs (guestfs_h *g);\n"
30558 #: ../src/guestfs-actions.pod:4787
30559 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
30563 #: ../src/guestfs-actions.pod:4795
30564 msgid "guestfs_lvs_full"
30568 #: ../src/guestfs-actions.pod:4797
30571 " struct guestfs_lvm_lv_list *\n"
30572 " guestfs_lvs_full (guestfs_h *g);\n"
30577 #: ../src/guestfs-actions.pod:4803
30579 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
30580 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
30584 #: ../src/guestfs-actions.pod:4809
30585 msgid "guestfs_lvuuid"
30589 #: ../src/guestfs-actions.pod:4811
30593 " guestfs_lvuuid (guestfs_h *g,\n"
30594 " const char *device);\n"
30599 #: ../src/guestfs-actions.pod:4822
30600 msgid "guestfs_lxattrlist"
30604 #: ../src/guestfs-actions.pod:4824
30607 " struct guestfs_xattr_list *\n"
30608 " guestfs_lxattrlist (guestfs_h *g,\n"
30609 " const char *path,\n"
30610 " char *const *names);\n"
30615 #: ../src/guestfs-actions.pod:4843
30617 "This call is intended for programs that want to efficiently list a directory "
30618 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
30619 "a similarly efficient call for getting standard stats. Very long directory "
30620 "listings might cause the protocol message size to be exceeded, causing this "
30621 "call to fail. The caller must split up such requests into smaller groups of "
30626 #: ../src/guestfs-actions.pod:4857
30627 msgid "guestfs_mkdir"
30631 #: ../src/guestfs-actions.pod:4859
30635 " guestfs_mkdir (guestfs_h *g,\n"
30636 " const char *path);\n"
30641 #: ../src/guestfs-actions.pod:4869
30642 msgid "guestfs_mkdir_mode"
30646 #: ../src/guestfs-actions.pod:4871
30650 " guestfs_mkdir_mode (guestfs_h *g,\n"
30651 " const char *path,\n"
30657 #: ../src/guestfs-actions.pod:4883
30658 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
30662 #: ../src/guestfs-actions.pod:4889
30663 msgid "guestfs_mkdir_p"
30667 #: ../src/guestfs-actions.pod:4891
30671 " guestfs_mkdir_p (guestfs_h *g,\n"
30672 " const char *path);\n"
30677 #: ../src/guestfs-actions.pod:4902
30678 msgid "guestfs_mkdtemp"
30682 #: ../src/guestfs-actions.pod:4904
30686 " guestfs_mkdtemp (guestfs_h *g,\n"
30687 " const char *template);\n"
30692 #: ../src/guestfs-actions.pod:4932
30693 msgid "guestfs_mke2fs_J"
30697 #: ../src/guestfs-actions.pod:4934
30701 " guestfs_mke2fs_J (guestfs_h *g,\n"
30702 " const char *fstype,\n"
30703 " int blocksize,\n"
30704 " const char *device,\n"
30705 " const char *journal);\n"
30710 #: ../src/guestfs-actions.pod:4947
30711 msgid "See also C<guestfs_mke2journal>."
30715 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:4969
30716 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:5003
30717 #: ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5031
30718 #: ../src/guestfs-actions.pod:5090 ../src/guestfs-actions.pod:5367
30719 msgid "(Added in 1.0.68)"
30723 #: ../src/guestfs-actions.pod:4953
30724 msgid "guestfs_mke2fs_JL"
30728 #: ../src/guestfs-actions.pod:4955
30732 " guestfs_mke2fs_JL (guestfs_h *g,\n"
30733 " const char *fstype,\n"
30734 " int blocksize,\n"
30735 " const char *device,\n"
30736 " const char *label);\n"
30741 #: ../src/guestfs-actions.pod:4965
30742 msgid "See also C<guestfs_mke2journal_L>."
30746 #: ../src/guestfs-actions.pod:4971
30747 msgid "guestfs_mke2fs_JU"
30751 #: ../src/guestfs-actions.pod:4973
30755 " guestfs_mke2fs_JU (guestfs_h *g,\n"
30756 " const char *fstype,\n"
30757 " int blocksize,\n"
30758 " const char *device,\n"
30759 " const char *uuid);\n"
30764 #: ../src/guestfs-actions.pod:4983
30765 msgid "See also C<guestfs_mke2journal_U>."
30769 #: ../src/guestfs-actions.pod:4989
30770 msgid "guestfs_mke2journal"
30774 #: ../src/guestfs-actions.pod:4991
30778 " guestfs_mke2journal (guestfs_h *g,\n"
30779 " int blocksize,\n"
30780 " const char *device);\n"
30785 #: ../src/guestfs-actions.pod:5005
30786 msgid "guestfs_mke2journal_L"
30790 #: ../src/guestfs-actions.pod:5007
30794 " guestfs_mke2journal_L (guestfs_h *g,\n"
30795 " int blocksize,\n"
30796 " const char *label,\n"
30797 " const char *device);\n"
30802 #: ../src/guestfs-actions.pod:5019
30803 msgid "guestfs_mke2journal_U"
30807 #: ../src/guestfs-actions.pod:5021
30811 " guestfs_mke2journal_U (guestfs_h *g,\n"
30812 " int blocksize,\n"
30813 " const char *uuid,\n"
30814 " const char *device);\n"
30819 #: ../src/guestfs-actions.pod:5033
30820 msgid "guestfs_mkfifo"
30824 #: ../src/guestfs-actions.pod:5035
30828 " guestfs_mkfifo (guestfs_h *g,\n"
30830 " const char *path);\n"
30835 #: ../src/guestfs-actions.pod:5040
30837 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
30838 "is just a convenient wrapper around C<guestfs_mknod>."
30842 #: ../src/guestfs-actions.pod:5050
30843 msgid "guestfs_mkfs"
30847 #: ../src/guestfs-actions.pod:5052
30851 " guestfs_mkfs (guestfs_h *g,\n"
30852 " const char *fstype,\n"
30853 " const char *device);\n"
30858 #: ../src/guestfs-actions.pod:5065
30859 msgid "guestfs_mkfs_b"
30863 #: ../src/guestfs-actions.pod:5067
30867 " guestfs_mkfs_b (guestfs_h *g,\n"
30868 " const char *fstype,\n"
30869 " int blocksize,\n"
30870 " const char *device);\n"
30875 #: ../src/guestfs-actions.pod:5073
30877 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
30882 #: ../src/guestfs-actions.pod:5080
30884 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
30885 "block size of the resulting filesystem. Supported block sizes depend on the "
30886 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
30890 #: ../src/guestfs-actions.pod:5092
30891 msgid "guestfs_mkfs_opts"
30895 #: ../src/guestfs-actions.pod:5094
30899 " guestfs_mkfs_opts (guestfs_h *g,\n"
30900 " const char *fstype,\n"
30901 " const char *device,\n"
30907 #: ../src/guestfs-actions.pod:5105
30910 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
30911 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
30912 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
30913 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
30918 #: ../src/guestfs-actions.pod:5153
30919 msgid "(Added in 1.7.19)"
30923 #: ../src/guestfs-actions.pod:5155
30924 msgid "guestfs_mkfs_opts_va"
30928 #: ../src/guestfs-actions.pod:5157
30932 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
30933 " const char *fstype,\n"
30934 " const char *device,\n"
30935 " va_list args);\n"
30940 #: ../src/guestfs-actions.pod:5163
30941 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
30945 #: ../src/guestfs-actions.pod:5167
30946 msgid "guestfs_mkfs_opts_argv"
30950 #: ../src/guestfs-actions.pod:5169
30954 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
30955 " const char *fstype,\n"
30956 " const char *device,\n"
30957 " const struct guestfs_mkfs_opts_argv *optargs);\n"
30962 #: ../src/guestfs-actions.pod:5175
30963 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
30967 #: ../src/guestfs-actions.pod:5179
30968 msgid "guestfs_mkmountpoint"
30972 #: ../src/guestfs-actions.pod:5181
30976 " guestfs_mkmountpoint (guestfs_h *g,\n"
30977 " const char *exemptpath);\n"
30982 #: ../src/guestfs-actions.pod:5185
30984 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
30985 "that can be used to create extra mountpoints before mounting the first "
30990 #: ../src/guestfs-actions.pod:5209
30992 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
30993 "may get unexpected errors if you try to mix these calls. It is safest to "
30994 "manually unmount filesystems and remove mountpoints after use."
30998 #: ../src/guestfs-actions.pod:5213
31000 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
31001 "first, so for this to work for manual mountpoints, you must ensure that the "
31002 "innermost mountpoints have the longest pathnames, as in the example code "
31007 #: ../src/guestfs-actions.pod:5220
31009 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
31010 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
31011 "can also trigger these issues."
31015 #: ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5532
31016 #: ../src/guestfs-actions.pod:6559
31017 msgid "(Added in 1.0.62)"
31021 #: ../src/guestfs-actions.pod:5228
31022 msgid "guestfs_mknod"
31026 #: ../src/guestfs-actions.pod:5230
31030 " guestfs_mknod (guestfs_h *g,\n"
31034 " const char *path);\n"
31039 #: ../src/guestfs-actions.pod:5245
31041 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
31042 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
31043 "regular file). These constants are available in the standard Linux header "
31044 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
31045 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
31046 "the appropriate constant for you."
31050 #: ../src/guestfs-actions.pod:5259
31051 msgid "guestfs_mknod_b"
31055 #: ../src/guestfs-actions.pod:5261
31059 " guestfs_mknod_b (guestfs_h *g,\n"
31063 " const char *path);\n"
31068 #: ../src/guestfs-actions.pod:5268
31070 "This call creates a block device node called C<path> with mode C<mode> and "
31071 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
31072 "wrapper around C<guestfs_mknod>."
31076 #: ../src/guestfs-actions.pod:5278
31077 msgid "guestfs_mknod_c"
31081 #: ../src/guestfs-actions.pod:5280
31085 " guestfs_mknod_c (guestfs_h *g,\n"
31089 " const char *path);\n"
31094 #: ../src/guestfs-actions.pod:5287
31096 "This call creates a char device node called C<path> with mode C<mode> and "
31097 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
31098 "wrapper around C<guestfs_mknod>."
31102 #: ../src/guestfs-actions.pod:5297
31103 msgid "guestfs_mkswap"
31107 #: ../src/guestfs-actions.pod:5299
31111 " guestfs_mkswap (guestfs_h *g,\n"
31112 " const char *device);\n"
31117 #: ../src/guestfs-actions.pod:5309
31118 msgid "guestfs_mkswap_L"
31122 #: ../src/guestfs-actions.pod:5311
31126 " guestfs_mkswap_L (guestfs_h *g,\n"
31127 " const char *label,\n"
31128 " const char *device);\n"
31133 #: ../src/guestfs-actions.pod:5326
31134 msgid "guestfs_mkswap_U"
31138 #: ../src/guestfs-actions.pod:5328
31142 " guestfs_mkswap_U (guestfs_h *g,\n"
31143 " const char *uuid,\n"
31144 " const char *device);\n"
31149 #: ../src/guestfs-actions.pod:5339
31150 msgid "guestfs_mkswap_file"
31154 #: ../src/guestfs-actions.pod:5341
31158 " guestfs_mkswap_file (guestfs_h *g,\n"
31159 " const char *path);\n"
31164 #: ../src/guestfs-actions.pod:5347
31166 "This command just writes a swap file signature to an existing file. To "
31167 "create the file itself, use something like C<guestfs_fallocate>."
31171 #: ../src/guestfs-actions.pod:5354
31172 msgid "guestfs_modprobe"
31176 #: ../src/guestfs-actions.pod:5356
31180 " guestfs_modprobe (guestfs_h *g,\n"
31181 " const char *modulename);\n"
31186 #: ../src/guestfs-actions.pod:5369
31187 msgid "guestfs_mount"
31191 #: ../src/guestfs-actions.pod:5371
31195 " guestfs_mount (guestfs_h *g,\n"
31196 " const char *device,\n"
31197 " const char *mountpoint);\n"
31202 #: ../src/guestfs-actions.pod:5390
31204 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
31205 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
31206 "problems for users. If your program might need to work with older versions "
31207 "of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
31208 "for the first parameter if you don't want any options)."
31212 #: ../src/guestfs-actions.pod:5401
31213 msgid "guestfs_mount_9p"
31217 #: ../src/guestfs-actions.pod:5403
31221 " guestfs_mount_9p (guestfs_h *g,\n"
31222 " const char *mounttag,\n"
31223 " const char *mountpoint,\n"
31229 #: ../src/guestfs-actions.pod:5414
31232 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
31237 #: ../src/guestfs-actions.pod:5427
31238 msgid "guestfs_mount_9p_va"
31242 #: ../src/guestfs-actions.pod:5429
31246 " guestfs_mount_9p_va (guestfs_h *g,\n"
31247 " const char *mounttag,\n"
31248 " const char *mountpoint,\n"
31249 " va_list args);\n"
31254 #: ../src/guestfs-actions.pod:5435
31255 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
31259 #: ../src/guestfs-actions.pod:5439
31260 msgid "guestfs_mount_9p_argv"
31264 #: ../src/guestfs-actions.pod:5441
31268 " guestfs_mount_9p_argv (guestfs_h *g,\n"
31269 " const char *mounttag,\n"
31270 " const char *mountpoint,\n"
31271 " const struct guestfs_mount_9p_argv *optargs);\n"
31276 #: ../src/guestfs-actions.pod:5447
31277 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
31281 #: ../src/guestfs-actions.pod:5451
31282 msgid "guestfs_mount_loop"
31286 #: ../src/guestfs-actions.pod:5453
31290 " guestfs_mount_loop (guestfs_h *g,\n"
31291 " const char *file,\n"
31292 " const char *mountpoint);\n"
31297 #: ../src/guestfs-actions.pod:5466
31298 msgid "guestfs_mount_options"
31302 #: ../src/guestfs-actions.pod:5468
31306 " guestfs_mount_options (guestfs_h *g,\n"
31307 " const char *options,\n"
31308 " const char *device,\n"
31309 " const char *mountpoint);\n"
31314 #: ../src/guestfs-actions.pod:5474
31316 "This is the same as the C<guestfs_mount> command, but it allows you to set "
31317 "the mount options as for the L<mount(8)> I<-o> flag."
31321 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5498
31322 #: ../src/guestfs-actions.pod:5515
31323 msgid "(Added in 1.0.10)"
31327 #: ../src/guestfs-actions.pod:5486
31328 msgid "guestfs_mount_ro"
31332 #: ../src/guestfs-actions.pod:5488
31336 " guestfs_mount_ro (guestfs_h *g,\n"
31337 " const char *device,\n"
31338 " const char *mountpoint);\n"
31343 #: ../src/guestfs-actions.pod:5493
31345 "This is the same as the C<guestfs_mount> command, but it mounts the "
31346 "filesystem with the read-only (I<-o ro>) flag."
31350 #: ../src/guestfs-actions.pod:5500
31351 msgid "guestfs_mount_vfs"
31355 #: ../src/guestfs-actions.pod:5502
31359 " guestfs_mount_vfs (guestfs_h *g,\n"
31360 " const char *options,\n"
31361 " const char *vfstype,\n"
31362 " const char *device,\n"
31363 " const char *mountpoint);\n"
31368 #: ../src/guestfs-actions.pod:5509
31370 "This is the same as the C<guestfs_mount> command, but it allows you to set "
31371 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
31376 #: ../src/guestfs-actions.pod:5517
31377 msgid "guestfs_mountpoints"
31381 #: ../src/guestfs-actions.pod:5519
31385 " guestfs_mountpoints (guestfs_h *g);\n"
31390 #: ../src/guestfs-actions.pod:5522
31392 "This call is similar to C<guestfs_mounts>. That call returns a list of "
31393 "devices. This one returns a hash table (map) of device name to directory "
31394 "where the device is mounted."
31398 #: ../src/guestfs-actions.pod:5534
31399 msgid "guestfs_mounts"
31403 #: ../src/guestfs-actions.pod:5536
31407 " guestfs_mounts (guestfs_h *g);\n"
31412 #: ../src/guestfs-actions.pod:5544
31413 msgid "See also: C<guestfs_mountpoints>"
31417 #: ../src/guestfs-actions.pod:5552
31422 #: ../src/guestfs-actions.pod:5554
31426 " guestfs_mv (guestfs_h *g,\n"
31427 " const char *src,\n"
31428 " const char *dest);\n"
31433 #: ../src/guestfs-actions.pod:5566
31434 msgid "guestfs_ntfs_3g_probe"
31438 #: ../src/guestfs-actions.pod:5568
31442 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
31444 " const char *device);\n"
31449 #: ../src/guestfs-actions.pod:5587
31450 msgid "(Added in 1.0.43)"
31454 #: ../src/guestfs-actions.pod:5589
31455 msgid "guestfs_ntfsresize"
31459 #: ../src/guestfs-actions.pod:5591
31463 " guestfs_ntfsresize (guestfs_h *g,\n"
31464 " const char *device);\n"
31469 #: ../src/guestfs-actions.pod:5595 ../src/guestfs-actions.pod:5695
31471 "I<This function is deprecated.> In new code, use the L</"
31472 "guestfs_ntfsresize_opts> call instead."
31476 #: ../src/guestfs-actions.pod:5619
31477 msgid "guestfs_ntfsresize_opts"
31481 #: ../src/guestfs-actions.pod:5621
31485 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
31486 " const char *device,\n"
31492 #: ../src/guestfs-actions.pod:5631
31495 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
31496 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
31501 #: ../src/guestfs-actions.pod:5651
31503 "After the resize operation, the filesystem is always marked as requiring a "
31504 "consistency check (for safety). You have to boot into Windows to perform "
31505 "this check and clear this condition. If you I<don't> set the C<force> "
31506 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
31507 "times on a single filesystem without booting into Windows between each "
31512 #: ../src/guestfs-actions.pod:5666
31513 msgid "guestfs_ntfsresize_opts_va"
31517 #: ../src/guestfs-actions.pod:5668
31521 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
31522 " const char *device,\n"
31523 " va_list args);\n"
31528 #: ../src/guestfs-actions.pod:5673
31529 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
31533 #: ../src/guestfs-actions.pod:5677
31534 msgid "guestfs_ntfsresize_opts_argv"
31538 #: ../src/guestfs-actions.pod:5679
31542 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
31543 " const char *device,\n"
31544 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
31549 #: ../src/guestfs-actions.pod:5684
31550 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
31554 #: ../src/guestfs-actions.pod:5688
31555 msgid "guestfs_ntfsresize_size"
31559 #: ../src/guestfs-actions.pod:5690
31563 " guestfs_ntfsresize_size (guestfs_h *g,\n"
31564 " const char *device,\n"
31565 " int64_t size);\n"
31570 #: ../src/guestfs-actions.pod:5702
31572 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
31573 "to specify the new size (in bytes) explicitly."
31577 #: ../src/guestfs-actions.pod:5707 ../src/guestfs-actions.pod:6166
31578 #: ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6507
31579 #: ../src/guestfs-actions.pod:8134
31580 msgid "(Added in 1.3.14)"
31584 #: ../src/guestfs-actions.pod:5709
31585 msgid "guestfs_part_add"
31589 #: ../src/guestfs-actions.pod:5711
31593 " guestfs_part_add (guestfs_h *g,\n"
31594 " const char *device,\n"
31595 " const char *prlogex,\n"
31596 " int64_t startsect,\n"
31597 " int64_t endsect);\n"
31602 #: ../src/guestfs-actions.pod:5718
31604 "This command adds a partition to C<device>. If there is no partition table "
31605 "on the device, call C<guestfs_part_init> first."
31609 #: ../src/guestfs-actions.pod:5730
31611 "Creating a partition which covers the whole disk is not so easy. Use "
31612 "C<guestfs_part_disk> to do that."
31616 #: ../src/guestfs-actions.pod:5735 ../src/guestfs-actions.pod:5770
31617 #: ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5907
31618 #: ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5964
31619 #: ../src/guestfs-actions.pod:6004
31620 msgid "(Added in 1.0.78)"
31624 #: ../src/guestfs-actions.pod:5737
31625 msgid "guestfs_part_del"
31629 #: ../src/guestfs-actions.pod:5739
31633 " guestfs_part_del (guestfs_h *g,\n"
31634 " const char *device,\n"
31640 #: ../src/guestfs-actions.pod:5754
31641 msgid "guestfs_part_disk"
31645 #: ../src/guestfs-actions.pod:5756
31649 " guestfs_part_disk (guestfs_h *g,\n"
31650 " const char *device,\n"
31651 " const char *parttype);\n"
31656 #: ../src/guestfs-actions.pod:5761
31658 "This command is simply a combination of C<guestfs_part_init> followed by "
31659 "C<guestfs_part_add> to create a single primary partition covering the whole "
31664 #: ../src/guestfs-actions.pod:5765
31666 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
31667 "possible values are described in C<guestfs_part_init>."
31671 #: ../src/guestfs-actions.pod:5772
31672 msgid "guestfs_part_get_bootable"
31676 #: ../src/guestfs-actions.pod:5774
31680 " guestfs_part_get_bootable (guestfs_h *g,\n"
31681 " const char *device,\n"
31687 #: ../src/guestfs-actions.pod:5782
31688 msgid "See also C<guestfs_part_set_bootable>."
31692 #: ../src/guestfs-actions.pod:5788
31693 msgid "guestfs_part_get_mbr_id"
31697 #: ../src/guestfs-actions.pod:5790
31701 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
31702 " const char *device,\n"
31708 #: ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5980
31710 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
31711 "undefined results for other partition table types (see "
31712 "C<guestfs_part_get_parttype>)."
31716 #: ../src/guestfs-actions.pod:5806
31717 msgid "guestfs_part_get_parttype"
31721 #: ../src/guestfs-actions.pod:5808
31725 " guestfs_part_get_parttype (guestfs_h *g,\n"
31726 " const char *device);\n"
31731 #: ../src/guestfs-actions.pod:5815
31733 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
31734 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
31735 "possible, although unusual. See C<guestfs_part_init> for a full list."
31739 #: ../src/guestfs-actions.pod:5825
31740 msgid "guestfs_part_init"
31744 #: ../src/guestfs-actions.pod:5827
31748 " guestfs_part_init (guestfs_h *g,\n"
31749 " const char *device,\n"
31750 " const char *parttype);\n"
31755 #: ../src/guestfs-actions.pod:5836
31757 "Initially there are no partitions. Following this, you should call "
31758 "C<guestfs_part_add> for each partition required."
31762 #: ../src/guestfs-actions.pod:5909
31763 msgid "guestfs_part_list"
31767 #: ../src/guestfs-actions.pod:5911
31770 " struct guestfs_partition_list *\n"
31771 " guestfs_part_list (guestfs_h *g,\n"
31772 " const char *device);\n"
31777 #: ../src/guestfs-actions.pod:5928
31779 "Start of the partition I<in bytes>. To get sectors you have to divide by "
31780 "the device's sector size, see C<guestfs_blockdev_getss>."
31784 #: ../src/guestfs-actions.pod:5941
31786 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
31787 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
31792 #: ../src/guestfs-actions.pod:5947
31793 msgid "guestfs_part_set_bootable"
31797 #: ../src/guestfs-actions.pod:5949
31801 " guestfs_part_set_bootable (guestfs_h *g,\n"
31802 " const char *device,\n"
31804 " int bootable);\n"
31809 #: ../src/guestfs-actions.pod:5966
31810 msgid "guestfs_part_set_mbr_id"
31814 #: ../src/guestfs-actions.pod:5968
31818 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
31819 " const char *device,\n"
31826 #: ../src/guestfs-actions.pod:5988
31827 msgid "guestfs_part_set_name"
31831 #: ../src/guestfs-actions.pod:5990
31835 " guestfs_part_set_name (guestfs_h *g,\n"
31836 " const char *device,\n"
31838 " const char *name);\n"
31843 #: ../src/guestfs-actions.pod:6006
31844 msgid "guestfs_part_to_dev"
31848 #: ../src/guestfs-actions.pod:6008
31852 " guestfs_part_to_dev (guestfs_h *g,\n"
31853 " const char *partition);\n"
31858 #: ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6035
31860 "The named partition must exist, for example as a string returned from "
31861 "C<guestfs_list_partitions>."
31865 #: ../src/guestfs-actions.pod:6019
31866 msgid "See also C<guestfs_part_to_partnum>."
31870 #: ../src/guestfs-actions.pod:6026
31871 msgid "guestfs_part_to_partnum"
31875 #: ../src/guestfs-actions.pod:6028
31879 " guestfs_part_to_partnum (guestfs_h *g,\n"
31880 " const char *partition);\n"
31885 #: ../src/guestfs-actions.pod:6038
31886 msgid "See also C<guestfs_part_to_dev>."
31890 #: ../src/guestfs-actions.pod:6044
31891 msgid "guestfs_ping_daemon"
31895 #: ../src/guestfs-actions.pod:6046
31899 " guestfs_ping_daemon (guestfs_h *g);\n"
31904 #: ../src/guestfs-actions.pod:6058
31905 msgid "guestfs_pread"
31909 #: ../src/guestfs-actions.pod:6060
31913 " guestfs_pread (guestfs_h *g,\n"
31914 " const char *path,\n"
31916 " int64_t offset,\n"
31917 " size_t *size_r);\n"
31922 #: ../src/guestfs-actions.pod:6073
31923 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
31927 #: ../src/guestfs-actions.pod:6084
31928 msgid "guestfs_pread_device"
31932 #: ../src/guestfs-actions.pod:6086
31936 " guestfs_pread_device (guestfs_h *g,\n"
31937 " const char *device,\n"
31939 " int64_t offset,\n"
31940 " size_t *size_r);\n"
31945 #: ../src/guestfs-actions.pod:6099
31946 msgid "See also C<guestfs_pread>."
31950 #: ../src/guestfs-actions.pod:6108
31951 msgid "(Added in 1.5.21)"
31955 #: ../src/guestfs-actions.pod:6110
31956 msgid "guestfs_pvcreate"
31960 #: ../src/guestfs-actions.pod:6112
31964 " guestfs_pvcreate (guestfs_h *g,\n"
31965 " const char *device);\n"
31970 #: ../src/guestfs-actions.pod:6124
31971 msgid "guestfs_pvremove"
31975 #: ../src/guestfs-actions.pod:6126
31979 " guestfs_pvremove (guestfs_h *g,\n"
31980 " const char *device);\n"
31985 #: ../src/guestfs-actions.pod:6141
31986 msgid "guestfs_pvresize"
31990 #: ../src/guestfs-actions.pod:6143
31994 " guestfs_pvresize (guestfs_h *g,\n"
31995 " const char *device);\n"
32000 #: ../src/guestfs-actions.pod:6154
32001 msgid "guestfs_pvresize_size"
32005 #: ../src/guestfs-actions.pod:6156
32009 " guestfs_pvresize_size (guestfs_h *g,\n"
32010 " const char *device,\n"
32011 " int64_t size);\n"
32016 #: ../src/guestfs-actions.pod:6161
32018 "This command is the same as C<guestfs_pvresize> except that it allows you to "
32019 "specify the new size (in bytes) explicitly."
32023 #: ../src/guestfs-actions.pod:6168
32024 msgid "guestfs_pvs"
32028 #: ../src/guestfs-actions.pod:6170
32032 " guestfs_pvs (guestfs_h *g);\n"
32037 #: ../src/guestfs-actions.pod:6179
32038 msgid "See also C<guestfs_pvs_full>."
32042 #: ../src/guestfs-actions.pod:6187
32043 msgid "guestfs_pvs_full"
32047 #: ../src/guestfs-actions.pod:6189
32050 " struct guestfs_lvm_pv_list *\n"
32051 " guestfs_pvs_full (guestfs_h *g);\n"
32056 #: ../src/guestfs-actions.pod:6195
32058 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
32059 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
32063 #: ../src/guestfs-actions.pod:6201
32064 msgid "guestfs_pvuuid"
32068 #: ../src/guestfs-actions.pod:6203
32072 " guestfs_pvuuid (guestfs_h *g,\n"
32073 " const char *device);\n"
32078 #: ../src/guestfs-actions.pod:6214
32079 msgid "guestfs_pwrite"
32083 #: ../src/guestfs-actions.pod:6216
32087 " guestfs_pwrite (guestfs_h *g,\n"
32088 " const char *path,\n"
32089 " const char *content,\n"
32090 " size_t content_size,\n"
32091 " int64_t offset);\n"
32096 #: ../src/guestfs-actions.pod:6232
32097 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
32101 #: ../src/guestfs-actions.pod:6241
32102 msgid "guestfs_pwrite_device"
32106 #: ../src/guestfs-actions.pod:6243
32110 " guestfs_pwrite_device (guestfs_h *g,\n"
32111 " const char *device,\n"
32112 " const char *content,\n"
32113 " size_t content_size,\n"
32114 " int64_t offset);\n"
32119 #: ../src/guestfs-actions.pod:6258
32120 msgid "See also C<guestfs_pwrite>."
32124 #: ../src/guestfs-actions.pod:6265
32125 msgid "(Added in 1.5.20)"
32129 #: ../src/guestfs-actions.pod:6267
32130 msgid "guestfs_read_file"
32134 #: ../src/guestfs-actions.pod:6269
32138 " guestfs_read_file (guestfs_h *g,\n"
32139 " const char *path,\n"
32140 " size_t *size_r);\n"
32145 #: ../src/guestfs-actions.pod:6277
32147 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
32148 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
32149 "function is limited in the total size of file that can be handled."
32153 #: ../src/guestfs-actions.pod:6289
32154 msgid "(Added in 1.0.63)"
32158 #: ../src/guestfs-actions.pod:6291
32159 msgid "guestfs_read_lines"
32163 #: ../src/guestfs-actions.pod:6293
32167 " guestfs_read_lines (guestfs_h *g,\n"
32168 " const char *path);\n"
32173 #: ../src/guestfs-actions.pod:6302
32175 "Note that this function cannot correctly handle binary files (specifically, "
32176 "files containing C<\\0> character which is treated as end of line). For "
32177 "those you need to use the C<guestfs_read_file> function which has a more "
32178 "complex interface."
32182 #: ../src/guestfs-actions.pod:6313
32183 msgid "guestfs_readdir"
32187 #: ../src/guestfs-actions.pod:6315
32190 " struct guestfs_dirent_list *\n"
32191 " guestfs_readdir (guestfs_h *g,\n"
32192 " const char *dir);\n"
32197 #: ../src/guestfs-actions.pod:6369
32199 "This function is primarily intended for use by programs. To get a simple "
32200 "list of names, use C<guestfs_ls>. To get a printable directory for human "
32201 "consumption, use C<guestfs_ll>."
32205 #: ../src/guestfs-actions.pod:6373
32207 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
32208 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
32212 #: ../src/guestfs-actions.pod:6379
32213 msgid "guestfs_readlink"
32217 #: ../src/guestfs-actions.pod:6381
32221 " guestfs_readlink (guestfs_h *g,\n"
32222 " const char *path);\n"
32227 #: ../src/guestfs-actions.pod:6392
32228 msgid "guestfs_readlinklist"
32232 #: ../src/guestfs-actions.pod:6394
32236 " guestfs_readlinklist (guestfs_h *g,\n"
32237 " const char *path,\n"
32238 " char *const *names);\n"
32243 #: ../src/guestfs-actions.pod:6427
32244 msgid "guestfs_realpath"
32248 #: ../src/guestfs-actions.pod:6429
32252 " guestfs_realpath (guestfs_h *g,\n"
32253 " const char *path);\n"
32258 #: ../src/guestfs-actions.pod:6441
32259 msgid "guestfs_removexattr"
32263 #: ../src/guestfs-actions.pod:6443
32267 " guestfs_removexattr (guestfs_h *g,\n"
32268 " const char *xattr,\n"
32269 " const char *path);\n"
32274 #: ../src/guestfs-actions.pod:6451
32275 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
32279 #: ../src/guestfs-actions.pod:6457
32280 msgid "guestfs_resize2fs"
32284 #: ../src/guestfs-actions.pod:6459
32288 " guestfs_resize2fs (guestfs_h *g,\n"
32289 " const char *device);\n"
32294 #: ../src/guestfs-actions.pod:6466
32296 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
32297 "C<device> before calling this command. For unknown reasons C<resize2fs> "
32298 "sometimes gives an error about this and sometimes not. In any case, it is "
32299 "always safe to call C<guestfs_e2fsck_f> before calling this function."
32303 #: ../src/guestfs-actions.pod:6476
32304 msgid "guestfs_resize2fs_M"
32308 #: ../src/guestfs-actions.pod:6478
32312 " guestfs_resize2fs_M (guestfs_h *g,\n"
32313 " const char *device);\n"
32318 #: ../src/guestfs-actions.pod:6482
32320 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
32321 "resized to its minimum size. This works like the I<-M> option to the "
32322 "C<resize2fs> command."
32326 #: ../src/guestfs-actions.pod:6486
32328 "To get the resulting size of the filesystem you should call "
32329 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
32330 "These two numbers, multiplied together, give the resulting size of the "
32331 "minimal filesystem in bytes."
32335 #: ../src/guestfs-actions.pod:6495
32336 msgid "guestfs_resize2fs_size"
32340 #: ../src/guestfs-actions.pod:6497
32344 " guestfs_resize2fs_size (guestfs_h *g,\n"
32345 " const char *device,\n"
32346 " int64_t size);\n"
32351 #: ../src/guestfs-actions.pod:6502
32353 "This command is the same as C<guestfs_resize2fs> except that it allows you "
32354 "to specify the new size (in bytes) explicitly."
32358 #: ../src/guestfs-actions.pod:6509
32363 #: ../src/guestfs-actions.pod:6511
32367 " guestfs_rm (guestfs_h *g,\n"
32368 " const char *path);\n"
32373 #: ../src/guestfs-actions.pod:6521
32374 msgid "guestfs_rm_rf"
32378 #: ../src/guestfs-actions.pod:6523
32382 " guestfs_rm_rf (guestfs_h *g,\n"
32383 " const char *path);\n"
32388 #: ../src/guestfs-actions.pod:6535
32389 msgid "guestfs_rmdir"
32393 #: ../src/guestfs-actions.pod:6537
32397 " guestfs_rmdir (guestfs_h *g,\n"
32398 " const char *path);\n"
32403 #: ../src/guestfs-actions.pod:6547
32404 msgid "guestfs_rmmountpoint"
32408 #: ../src/guestfs-actions.pod:6549
32412 " guestfs_rmmountpoint (guestfs_h *g,\n"
32413 " const char *exemptpath);\n"
32418 #: ../src/guestfs-actions.pod:6553
32420 "This calls removes a mountpoint that was previously created with "
32421 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
32425 #: ../src/guestfs-actions.pod:6561
32426 msgid "guestfs_scrub_device"
32430 #: ../src/guestfs-actions.pod:6563
32434 " guestfs_scrub_device (guestfs_h *g,\n"
32435 " const char *device);\n"
32440 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6593
32441 #: ../src/guestfs-actions.pod:6612
32442 msgid "(Added in 1.0.52)"
32446 #: ../src/guestfs-actions.pod:6577
32447 msgid "guestfs_scrub_file"
32451 #: ../src/guestfs-actions.pod:6579
32455 " guestfs_scrub_file (guestfs_h *g,\n"
32456 " const char *file);\n"
32461 #: ../src/guestfs-actions.pod:6595
32462 msgid "guestfs_scrub_freespace"
32466 #: ../src/guestfs-actions.pod:6597
32470 " guestfs_scrub_freespace (guestfs_h *g,\n"
32471 " const char *dir);\n"
32476 #: ../src/guestfs-actions.pod:6601
32478 "This command creates the directory C<dir> and then fills it with files until "
32479 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
32480 "and deletes them. The intention is to scrub any free space on the partition "
32481 "containing C<dir>."
32485 #: ../src/guestfs-actions.pod:6614
32486 msgid "guestfs_set_append"
32490 #: ../src/guestfs-actions.pod:6616
32494 " guestfs_set_append (guestfs_h *g,\n"
32495 " const char *append);\n"
32500 #: ../src/guestfs-actions.pod:6633
32501 msgid "guestfs_set_attach_method"
32505 #: ../src/guestfs-actions.pod:6635
32509 " guestfs_set_attach_method (guestfs_h *g,\n"
32510 " const char *attachmethod);\n"
32515 #: ../src/guestfs-actions.pod:6663
32516 msgid "guestfs_set_autosync"
32520 #: ../src/guestfs-actions.pod:6665
32524 " guestfs_set_autosync (guestfs_h *g,\n"
32525 " int autosync);\n"
32530 #: ../src/guestfs-actions.pod:6681
32531 msgid "guestfs_set_direct"
32535 #: ../src/guestfs-actions.pod:6683
32539 " guestfs_set_direct (guestfs_h *g,\n"
32545 #: ../src/guestfs-actions.pod:6691
32547 "One consequence of this is that log messages aren't caught by the library "
32548 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
32553 #: ../src/guestfs-actions.pod:6704
32554 msgid "guestfs_set_e2label"
32558 #: ../src/guestfs-actions.pod:6706
32562 " guestfs_set_e2label (guestfs_h *g,\n"
32563 " const char *device,\n"
32564 " const char *label);\n"
32569 #: ../src/guestfs-actions.pod:6715
32571 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
32572 "the existing label on a filesystem."
32576 #: ../src/guestfs-actions.pod:6722
32577 msgid "guestfs_set_e2uuid"
32581 #: ../src/guestfs-actions.pod:6724
32585 " guestfs_set_e2uuid (guestfs_h *g,\n"
32586 " const char *device,\n"
32587 " const char *uuid);\n"
32592 #: ../src/guestfs-actions.pod:6734
32594 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
32595 "the existing UUID of a filesystem."
32599 #: ../src/guestfs-actions.pod:6741
32600 msgid "guestfs_set_memsize"
32604 #: ../src/guestfs-actions.pod:6743
32608 " guestfs_set_memsize (guestfs_h *g,\n"
32614 #: ../src/guestfs-actions.pod:6747
32616 "This sets the memory size in megabytes allocated to the qemu subprocess. "
32617 "This only has any effect if called before C<guestfs_launch>."
32621 #: ../src/guestfs-actions.pod:6762
32622 msgid "guestfs_set_network"
32626 #: ../src/guestfs-actions.pod:6764
32630 " guestfs_set_network (guestfs_h *g,\n"
32636 #: ../src/guestfs-actions.pod:6774
32638 "You must call this before calling C<guestfs_launch>, otherwise it has no "
32643 #: ../src/guestfs-actions.pod:6781
32644 msgid "guestfs_set_path"
32648 #: ../src/guestfs-actions.pod:6783
32652 " guestfs_set_path (guestfs_h *g,\n"
32653 " const char *searchpath);\n"
32658 #: ../src/guestfs-actions.pod:6798
32659 msgid "guestfs_set_pgroup"
32663 #: ../src/guestfs-actions.pod:6800
32667 " guestfs_set_pgroup (guestfs_h *g,\n"
32673 #: ../src/guestfs-actions.pod:6817
32674 msgid "guestfs_set_qemu"
32678 #: ../src/guestfs-actions.pod:6819
32682 " guestfs_set_qemu (guestfs_h *g,\n"
32683 " const char *qemu);\n"
32688 #: ../src/guestfs-actions.pod:6845
32689 msgid "guestfs_set_recovery_proc"
32693 #: ../src/guestfs-actions.pod:6847
32697 " guestfs_set_recovery_proc (guestfs_h *g,\n"
32698 " int recoveryproc);\n"
32703 #: ../src/guestfs-actions.pod:6851
32705 "If this is called with the parameter C<false> then C<guestfs_launch> does "
32706 "not create a recovery process. The purpose of the recovery process is to "
32707 "stop runaway qemu processes in the case where the main program aborts "
32712 #: ../src/guestfs-actions.pod:6856
32714 "This only has any effect if called before C<guestfs_launch>, and the default "
32719 #: ../src/guestfs-actions.pod:6869
32720 msgid "guestfs_set_selinux"
32724 #: ../src/guestfs-actions.pod:6871
32728 " guestfs_set_selinux (guestfs_h *g,\n"
32734 #: ../src/guestfs-actions.pod:6888
32735 msgid "guestfs_set_smp"
32739 #: ../src/guestfs-actions.pod:6890
32743 " guestfs_set_smp (guestfs_h *g,\n"
32749 #: ../src/guestfs-actions.pod:6898
32750 msgid "This function must be called before C<guestfs_launch>."
32754 #: ../src/guestfs-actions.pod:6904
32755 msgid "guestfs_set_trace"
32759 #: ../src/guestfs-actions.pod:6906
32763 " guestfs_set_trace (guestfs_h *g,\n"
32769 #: ../src/guestfs-actions.pod:6920
32771 "Trace messages are normally sent to C<stderr>, unless you register a "
32772 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
32776 #: ../src/guestfs-actions.pod:6928
32777 msgid "guestfs_set_verbose"
32781 #: ../src/guestfs-actions.pod:6930
32785 " guestfs_set_verbose (guestfs_h *g,\n"
32791 #: ../src/guestfs-actions.pod:6939
32793 "Verbose messages are normally sent to C<stderr>, unless you register a "
32794 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
32798 #: ../src/guestfs-actions.pod:6947
32799 msgid "guestfs_setcon"
32803 #: ../src/guestfs-actions.pod:6949
32807 " guestfs_setcon (guestfs_h *g,\n"
32808 " const char *context);\n"
32813 #: ../src/guestfs-actions.pod:6962
32814 msgid "guestfs_setxattr"
32818 #: ../src/guestfs-actions.pod:6964
32822 " guestfs_setxattr (guestfs_h *g,\n"
32823 " const char *xattr,\n"
32824 " const char *val,\n"
32826 " const char *path);\n"
32831 #: ../src/guestfs-actions.pod:6975
32832 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
32836 #: ../src/guestfs-actions.pod:6981
32837 msgid "guestfs_sfdisk"
32841 #: ../src/guestfs-actions.pod:6983
32845 " guestfs_sfdisk (guestfs_h *g,\n"
32846 " const char *device,\n"
32850 " char *const *lines);\n"
32855 #: ../src/guestfs-actions.pod:6991 ../src/guestfs-actions.pod:7032
32856 #: ../src/guestfs-actions.pod:7063
32858 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
32863 #: ../src/guestfs-actions.pod:7018
32865 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
32869 #: ../src/guestfs-actions.pod:7025
32870 msgid "guestfs_sfdiskM"
32874 #: ../src/guestfs-actions.pod:7027
32878 " guestfs_sfdiskM (guestfs_h *g,\n"
32879 " const char *device,\n"
32880 " char *const *lines);\n"
32885 #: ../src/guestfs-actions.pod:7039
32887 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
32888 "partition sizes are specified in megabytes only (rounded to the nearest "
32889 "cylinder) and you don't need to specify the cyls, heads and sectors "
32890 "parameters which were rarely if ever used anyway."
32894 #: ../src/guestfs-actions.pod:7045
32896 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
32897 "C<guestfs_part_disk>"
32901 #: ../src/guestfs-actions.pod:7052
32902 msgid "guestfs_sfdisk_N"
32906 #: ../src/guestfs-actions.pod:7054
32910 " guestfs_sfdisk_N (guestfs_h *g,\n"
32911 " const char *device,\n"
32916 " const char *line);\n"
32921 #: ../src/guestfs-actions.pod:7073
32923 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
32924 "for the cyls/heads/sectors parameters."
32928 #: ../src/guestfs-actions.pod:7076
32929 msgid "See also: C<guestfs_part_add>"
32933 #: ../src/guestfs-actions.pod:7082
32934 msgid "guestfs_sfdisk_disk_geometry"
32938 #: ../src/guestfs-actions.pod:7084
32942 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
32943 " const char *device);\n"
32948 #: ../src/guestfs-actions.pod:7088
32950 "This displays the disk geometry of C<device> read from the partition table. "
32951 "Especially in the case where the underlying block device has been resized, "
32952 "this can be different from the kernel's idea of the geometry (see "
32953 "C<guestfs_sfdisk_kernel_geometry>)."
32957 #: ../src/guestfs-actions.pod:7101
32958 msgid "guestfs_sfdisk_kernel_geometry"
32962 #: ../src/guestfs-actions.pod:7103
32966 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
32967 " const char *device);\n"
32972 #: ../src/guestfs-actions.pod:7117
32973 msgid "guestfs_sfdisk_l"
32977 #: ../src/guestfs-actions.pod:7119
32981 " guestfs_sfdisk_l (guestfs_h *g,\n"
32982 " const char *device);\n"
32987 #: ../src/guestfs-actions.pod:7123
32989 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
32994 #: ../src/guestfs-actions.pod:7134
32995 msgid "See also: C<guestfs_part_list>"
32999 #: ../src/guestfs-actions.pod:7141
33004 #: ../src/guestfs-actions.pod:7143
33008 " guestfs_sh (guestfs_h *g,\n"
33009 " const char *command);\n"
33014 #: ../src/guestfs-actions.pod:7150
33015 msgid "This is like C<guestfs_command>, but passes the command to:"
33019 #: ../src/guestfs-actions.pod:7158
33020 msgid "All the provisos about C<guestfs_command> apply to this call."
33024 #: ../src/guestfs-actions.pod:7165
33025 msgid "guestfs_sh_lines"
33029 #: ../src/guestfs-actions.pod:7167
33033 " guestfs_sh_lines (guestfs_h *g,\n"
33034 " const char *command);\n"
33039 #: ../src/guestfs-actions.pod:7171
33041 "This is the same as C<guestfs_sh>, but splits the result into a list of "
33046 #: ../src/guestfs-actions.pod:7174
33047 msgid "See also: C<guestfs_command_lines>"
33051 #: ../src/guestfs-actions.pod:7182
33052 msgid "guestfs_sleep"
33056 #: ../src/guestfs-actions.pod:7184
33060 " guestfs_sleep (guestfs_h *g,\n"
33066 #: ../src/guestfs-actions.pod:7192
33067 msgid "(Added in 1.0.41)"
33071 #: ../src/guestfs-actions.pod:7194 ../src/guestfs-structs.pod:109
33072 msgid "guestfs_stat"
33076 #: ../src/guestfs-actions.pod:7196
33079 " struct guestfs_stat *\n"
33080 " guestfs_stat (guestfs_h *g,\n"
33081 " const char *path);\n"
33086 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-structs.pod:135
33087 msgid "guestfs_statvfs"
33091 #: ../src/guestfs-actions.pod:7212
33094 " struct guestfs_statvfs *\n"
33095 " guestfs_statvfs (guestfs_h *g,\n"
33096 " const char *path);\n"
33101 #: ../src/guestfs-actions.pod:7222
33103 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
33104 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
33108 #: ../src/guestfs-actions.pod:7228
33109 msgid "guestfs_strings"
33113 #: ../src/guestfs-actions.pod:7230
33117 " guestfs_strings (guestfs_h *g,\n"
33118 " const char *path);\n"
33123 #: ../src/guestfs-actions.pod:7246
33124 msgid "guestfs_strings_e"
33128 #: ../src/guestfs-actions.pod:7248
33132 " guestfs_strings_e (guestfs_h *g,\n"
33133 " const char *encoding,\n"
33134 " const char *path);\n"
33139 #: ../src/guestfs-actions.pod:7253
33141 "This is like the C<guestfs_strings> command, but allows you to specify the "
33142 "encoding of strings that are looked for in the source file C<path>."
33146 #: ../src/guestfs-actions.pod:7263
33148 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
33149 "ISO-8859-X (this is what C<guestfs_strings> uses)."
33153 #: ../src/guestfs-actions.pod:7301
33154 msgid "guestfs_swapoff_device"
33158 #: ../src/guestfs-actions.pod:7303
33162 " guestfs_swapoff_device (guestfs_h *g,\n"
33163 " const char *device);\n"
33168 #: ../src/guestfs-actions.pod:7307
33170 "This command disables the libguestfs appliance swap device or partition "
33171 "named C<device>. See C<guestfs_swapon_device>."
33175 #: ../src/guestfs-actions.pod:7315
33176 msgid "guestfs_swapoff_file"
33180 #: ../src/guestfs-actions.pod:7317
33184 " guestfs_swapoff_file (guestfs_h *g,\n"
33185 " const char *file);\n"
33190 #: ../src/guestfs-actions.pod:7327
33191 msgid "guestfs_swapoff_label"
33195 #: ../src/guestfs-actions.pod:7329
33199 " guestfs_swapoff_label (guestfs_h *g,\n"
33200 " const char *label);\n"
33205 #: ../src/guestfs-actions.pod:7340
33206 msgid "guestfs_swapoff_uuid"
33210 #: ../src/guestfs-actions.pod:7342
33214 " guestfs_swapoff_uuid (guestfs_h *g,\n"
33215 " const char *uuid);\n"
33220 #: ../src/guestfs-actions.pod:7353
33221 msgid "guestfs_swapon_device"
33225 #: ../src/guestfs-actions.pod:7355
33229 " guestfs_swapon_device (guestfs_h *g,\n"
33230 " const char *device);\n"
33235 #: ../src/guestfs-actions.pod:7359
33237 "This command enables the libguestfs appliance to use the swap device or "
33238 "partition named C<device>. The increased memory is made available for all "
33239 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
33243 #: ../src/guestfs-actions.pod:7375
33244 msgid "guestfs_swapon_file"
33248 #: ../src/guestfs-actions.pod:7377
33252 " guestfs_swapon_file (guestfs_h *g,\n"
33253 " const char *file);\n"
33258 #: ../src/guestfs-actions.pod:7381
33260 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
33265 #: ../src/guestfs-actions.pod:7388
33266 msgid "guestfs_swapon_label"
33270 #: ../src/guestfs-actions.pod:7390
33274 " guestfs_swapon_label (guestfs_h *g,\n"
33275 " const char *label);\n"
33280 #: ../src/guestfs-actions.pod:7394
33282 "This command enables swap to a labeled swap partition. See "
33283 "C<guestfs_swapon_device> for other notes."
33287 #: ../src/guestfs-actions.pod:7401
33288 msgid "guestfs_swapon_uuid"
33292 #: ../src/guestfs-actions.pod:7403
33296 " guestfs_swapon_uuid (guestfs_h *g,\n"
33297 " const char *uuid);\n"
33302 #: ../src/guestfs-actions.pod:7407
33304 "This command enables swap to a swap partition with the given UUID. See "
33305 "C<guestfs_swapon_device> for other notes."
33309 #: ../src/guestfs-actions.pod:7414
33310 msgid "guestfs_sync"
33314 #: ../src/guestfs-actions.pod:7416
33318 " guestfs_sync (guestfs_h *g);\n"
33323 #: ../src/guestfs-actions.pod:7429
33324 msgid "guestfs_tail"
33328 #: ../src/guestfs-actions.pod:7431
33332 " guestfs_tail (guestfs_h *g,\n"
33333 " const char *path);\n"
33338 #: ../src/guestfs-actions.pod:7447
33339 msgid "guestfs_tail_n"
33343 #: ../src/guestfs-actions.pod:7449
33347 " guestfs_tail_n (guestfs_h *g,\n"
33349 " const char *path);\n"
33354 #: ../src/guestfs-actions.pod:7471
33355 msgid "guestfs_tar_in"
33359 #: ../src/guestfs-actions.pod:7473
33363 " guestfs_tar_in (guestfs_h *g,\n"
33364 " const char *tarfile,\n"
33365 " const char *directory);\n"
33370 #: ../src/guestfs-actions.pod:7481
33372 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
33376 #: ../src/guestfs-actions.pod:7486 ../src/guestfs-actions.pod:7503
33377 #: ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7535
33378 msgid "(Added in 1.0.3)"
33382 #: ../src/guestfs-actions.pod:7488
33383 msgid "guestfs_tar_out"
33387 #: ../src/guestfs-actions.pod:7490
33391 " guestfs_tar_out (guestfs_h *g,\n"
33392 " const char *directory,\n"
33393 " const char *tarfile);\n"
33398 #: ../src/guestfs-actions.pod:7498
33400 "To download a compressed tarball, use C<guestfs_tgz_out> or "
33401 "C<guestfs_txz_out>."
33405 #: ../src/guestfs-actions.pod:7505
33406 msgid "guestfs_tgz_in"
33410 #: ../src/guestfs-actions.pod:7507
33414 " guestfs_tgz_in (guestfs_h *g,\n"
33415 " const char *tarball,\n"
33416 " const char *directory);\n"
33421 #: ../src/guestfs-actions.pod:7515
33422 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
33426 #: ../src/guestfs-actions.pod:7521
33427 msgid "guestfs_tgz_out"
33431 #: ../src/guestfs-actions.pod:7523
33435 " guestfs_tgz_out (guestfs_h *g,\n"
33436 " const char *directory,\n"
33437 " const char *tarball);\n"
33442 #: ../src/guestfs-actions.pod:7531
33443 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
33447 #: ../src/guestfs-actions.pod:7537
33448 msgid "guestfs_touch"
33452 #: ../src/guestfs-actions.pod:7539
33456 " guestfs_touch (guestfs_h *g,\n"
33457 " const char *path);\n"
33462 #: ../src/guestfs-actions.pod:7554
33463 msgid "guestfs_truncate"
33467 #: ../src/guestfs-actions.pod:7556
33471 " guestfs_truncate (guestfs_h *g,\n"
33472 " const char *path);\n"
33477 #: ../src/guestfs-actions.pod:7567
33478 msgid "guestfs_truncate_size"
33482 #: ../src/guestfs-actions.pod:7569
33486 " guestfs_truncate_size (guestfs_h *g,\n"
33487 " const char *path,\n"
33488 " int64_t size);\n"
33493 #: ../src/guestfs-actions.pod:7577
33495 "If the current file size is less than C<size> then the file is extended to "
33496 "the required size with zero bytes. This creates a sparse file (ie. disk "
33497 "blocks are not allocated for the file until you write to it). To create a "
33498 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
33502 #: ../src/guestfs-actions.pod:7587
33503 msgid "guestfs_tune2fs_l"
33507 #: ../src/guestfs-actions.pod:7589
33511 " guestfs_tune2fs_l (guestfs_h *g,\n"
33512 " const char *device);\n"
33517 #: ../src/guestfs-actions.pod:7609
33518 msgid "guestfs_txz_in"
33522 #: ../src/guestfs-actions.pod:7611
33526 " guestfs_txz_in (guestfs_h *g,\n"
33527 " const char *tarball,\n"
33528 " const char *directory);\n"
33533 #: ../src/guestfs-actions.pod:7623
33534 msgid "guestfs_txz_out"
33538 #: ../src/guestfs-actions.pod:7625
33542 " guestfs_txz_out (guestfs_h *g,\n"
33543 " const char *directory,\n"
33544 " const char *tarball);\n"
33549 #: ../src/guestfs-actions.pod:7637
33550 msgid "guestfs_umask"
33554 #: ../src/guestfs-actions.pod:7639
33558 " guestfs_umask (guestfs_h *g,\n"
33564 #: ../src/guestfs-actions.pod:7655
33566 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
33567 "C<guestfs_mkdir>."
33571 #: ../src/guestfs-actions.pod:7664
33572 msgid "guestfs_umount"
33576 #: ../src/guestfs-actions.pod:7666
33580 " guestfs_umount (guestfs_h *g,\n"
33581 " const char *pathordevice);\n"
33586 #: ../src/guestfs-actions.pod:7678
33587 msgid "guestfs_umount_all"
33591 #: ../src/guestfs-actions.pod:7680
33595 " guestfs_umount_all (guestfs_h *g);\n"
33600 #: ../src/guestfs-actions.pod:7691
33601 msgid "guestfs_upload"
33605 #: ../src/guestfs-actions.pod:7693
33609 " guestfs_upload (guestfs_h *g,\n"
33610 " const char *filename,\n"
33611 " const char *remotefilename);\n"
33616 #: ../src/guestfs-actions.pod:7703
33617 msgid "See also C<guestfs_download>."
33621 #: ../src/guestfs-actions.pod:7714
33622 msgid "guestfs_upload_offset"
33626 #: ../src/guestfs-actions.pod:7716
33630 " guestfs_upload_offset (guestfs_h *g,\n"
33631 " const char *filename,\n"
33632 " const char *remotefilename,\n"
33633 " int64_t offset);\n"
33638 #: ../src/guestfs-actions.pod:7732
33640 "Note that there is no limit on the amount of data that can be uploaded with "
33641 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
33642 "full amount unless an error occurs."
33646 #: ../src/guestfs-actions.pod:7737
33647 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
33651 #: ../src/guestfs-actions.pod:7748
33652 msgid "guestfs_utimens"
33656 #: ../src/guestfs-actions.pod:7750
33660 " guestfs_utimens (guestfs_h *g,\n"
33661 " const char *path,\n"
33662 " int64_t atsecs,\n"
33663 " int64_t atnsecs,\n"
33664 " int64_t mtsecs,\n"
33665 " int64_t mtnsecs);\n"
33670 #: ../src/guestfs-actions.pod:7779 ../src/guestfs-structs.pod:175
33671 msgid "guestfs_version"
33675 #: ../src/guestfs-actions.pod:7781
33678 " struct guestfs_version *\n"
33679 " guestfs_version (guestfs_h *g);\n"
33684 #: ../src/guestfs-actions.pod:7809
33686 "I<Note:> Don't use this call to test for availability of features. In "
33687 "enterprise distributions we backport features from later versions into "
33688 "earlier versions, making this an unreliable way to test for features. Use "
33689 "C<guestfs_available> instead."
33693 #: ../src/guestfs-actions.pod:7815
33695 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
33696 "error. I<The caller must call C<guestfs_free_version> after use>."
33700 #: ../src/guestfs-actions.pod:7819
33701 msgid "(Added in 1.0.58)"
33705 #: ../src/guestfs-actions.pod:7821
33706 msgid "guestfs_vfs_label"
33710 #: ../src/guestfs-actions.pod:7823
33714 " guestfs_vfs_label (guestfs_h *g,\n"
33715 " const char *device);\n"
33720 #: ../src/guestfs-actions.pod:7832
33721 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
33725 #: ../src/guestfs-actions.pod:7837 ../src/guestfs-actions.pod:7874
33726 msgid "(Added in 1.3.18)"
33730 #: ../src/guestfs-actions.pod:7839
33731 msgid "guestfs_vfs_type"
33735 #: ../src/guestfs-actions.pod:7841
33739 " guestfs_vfs_type (guestfs_h *g,\n"
33740 " const char *device);\n"
33745 #: ../src/guestfs-actions.pod:7858
33746 msgid "guestfs_vfs_uuid"
33750 #: ../src/guestfs-actions.pod:7860
33754 " guestfs_vfs_uuid (guestfs_h *g,\n"
33755 " const char *device);\n"
33760 #: ../src/guestfs-actions.pod:7869
33761 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
33765 #: ../src/guestfs-actions.pod:7876
33766 msgid "guestfs_vg_activate"
33770 #: ../src/guestfs-actions.pod:7878
33774 " guestfs_vg_activate (guestfs_h *g,\n"
33776 " char *const *volgroups);\n"
33781 #: ../src/guestfs-actions.pod:7895
33782 msgid "guestfs_vg_activate_all"
33786 #: ../src/guestfs-actions.pod:7897
33790 " guestfs_vg_activate_all (guestfs_h *g,\n"
33791 " int activate);\n"
33796 #: ../src/guestfs-actions.pod:7910
33797 msgid "guestfs_vgcreate"
33801 #: ../src/guestfs-actions.pod:7912
33805 " guestfs_vgcreate (guestfs_h *g,\n"
33806 " const char *volgroup,\n"
33807 " char *const *physvols);\n"
33812 #: ../src/guestfs-actions.pod:7924
33813 msgid "guestfs_vglvuuids"
33817 #: ../src/guestfs-actions.pod:7926
33821 " guestfs_vglvuuids (guestfs_h *g,\n"
33822 " const char *vgname);\n"
33827 #: ../src/guestfs-actions.pod:7933
33829 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
33830 "associate logical volumes and volume groups."
33834 #: ../src/guestfs-actions.pod:7936
33835 msgid "See also C<guestfs_vgpvuuids>."
33839 #: ../src/guestfs-actions.pod:7944
33840 msgid "guestfs_vgpvuuids"
33844 #: ../src/guestfs-actions.pod:7946
33848 " guestfs_vgpvuuids (guestfs_h *g,\n"
33849 " const char *vgname);\n"
33854 #: ../src/guestfs-actions.pod:7953
33856 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
33857 "associate physical volumes and volume groups."
33861 #: ../src/guestfs-actions.pod:7956
33862 msgid "See also C<guestfs_vglvuuids>."
33866 #: ../src/guestfs-actions.pod:7964
33867 msgid "guestfs_vgremove"
33871 #: ../src/guestfs-actions.pod:7966
33875 " guestfs_vgremove (guestfs_h *g,\n"
33876 " const char *vgname);\n"
33881 #: ../src/guestfs-actions.pod:7979
33882 msgid "guestfs_vgrename"
33886 #: ../src/guestfs-actions.pod:7981
33890 " guestfs_vgrename (guestfs_h *g,\n"
33891 " const char *volgroup,\n"
33892 " const char *newvolgroup);\n"
33897 #: ../src/guestfs-actions.pod:7992
33898 msgid "guestfs_vgs"
33902 #: ../src/guestfs-actions.pod:7994
33906 " guestfs_vgs (guestfs_h *g);\n"
33911 #: ../src/guestfs-actions.pod:8003
33912 msgid "See also C<guestfs_vgs_full>."
33916 #: ../src/guestfs-actions.pod:8011
33917 msgid "guestfs_vgs_full"
33921 #: ../src/guestfs-actions.pod:8013
33924 " struct guestfs_lvm_vg_list *\n"
33925 " guestfs_vgs_full (guestfs_h *g);\n"
33930 #: ../src/guestfs-actions.pod:8019
33932 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
33933 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
33937 #: ../src/guestfs-actions.pod:8025
33938 msgid "guestfs_vgscan"
33942 #: ../src/guestfs-actions.pod:8027
33946 " guestfs_vgscan (guestfs_h *g);\n"
33951 #: ../src/guestfs-actions.pod:8037
33952 msgid "guestfs_vguuid"
33956 #: ../src/guestfs-actions.pod:8039
33960 " guestfs_vguuid (guestfs_h *g,\n"
33961 " const char *vgname);\n"
33966 #: ../src/guestfs-actions.pod:8050
33967 msgid "guestfs_wait_ready"
33971 #: ../src/guestfs-actions.pod:8052
33975 " guestfs_wait_ready (guestfs_h *g);\n"
33980 #: ../src/guestfs-actions.pod:8055
33982 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
33987 #: ../src/guestfs-actions.pod:8062
33988 msgid "This function is a no op."
33992 #: ../src/guestfs-actions.pod:8064
33994 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
33995 "calling C<guestfs_launch> to wait for the launch to complete. However this "
33996 "is no longer necessary because C<guestfs_launch> now does the waiting."
34000 #: ../src/guestfs-actions.pod:8069
34002 "If you see any calls to this function in code then you can just remove them, "
34003 "unless you want to retain compatibility with older versions of the API."
34007 #: ../src/guestfs-actions.pod:8077
34008 msgid "guestfs_wc_c"
34012 #: ../src/guestfs-actions.pod:8079
34016 " guestfs_wc_c (guestfs_h *g,\n"
34017 " const char *path);\n"
34022 #: ../src/guestfs-actions.pod:8090
34023 msgid "guestfs_wc_l"
34027 #: ../src/guestfs-actions.pod:8092
34031 " guestfs_wc_l (guestfs_h *g,\n"
34032 " const char *path);\n"
34037 #: ../src/guestfs-actions.pod:8103
34038 msgid "guestfs_wc_w"
34042 #: ../src/guestfs-actions.pod:8105
34046 " guestfs_wc_w (guestfs_h *g,\n"
34047 " const char *path);\n"
34052 #: ../src/guestfs-actions.pod:8116
34053 msgid "guestfs_write"
34057 #: ../src/guestfs-actions.pod:8118
34061 " guestfs_write (guestfs_h *g,\n"
34062 " const char *path,\n"
34063 " const char *content,\n"
34064 " size_t content_size);\n"
34069 #: ../src/guestfs-actions.pod:8127
34070 msgid "See also C<guestfs_write_append>."
34074 #: ../src/guestfs-actions.pod:8136
34075 msgid "guestfs_write_append"
34079 #: ../src/guestfs-actions.pod:8138
34083 " guestfs_write_append (guestfs_h *g,\n"
34084 " const char *path,\n"
34085 " const char *content,\n"
34086 " size_t content_size);\n"
34091 #: ../src/guestfs-actions.pod:8147
34092 msgid "See also C<guestfs_write>."
34096 #: ../src/guestfs-actions.pod:8156
34097 msgid "guestfs_write_file"
34101 #: ../src/guestfs-actions.pod:8158
34105 " guestfs_write_file (guestfs_h *g,\n"
34106 " const char *path,\n"
34107 " const char *content,\n"
34113 #: ../src/guestfs-actions.pod:8164
34115 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
34120 #: ../src/guestfs-actions.pod:8189
34121 msgid "guestfs_zegrep"
34125 #: ../src/guestfs-actions.pod:8191
34129 " guestfs_zegrep (guestfs_h *g,\n"
34130 " const char *regex,\n"
34131 " const char *path);\n"
34136 #: ../src/guestfs-actions.pod:8208
34137 msgid "guestfs_zegrepi"
34141 #: ../src/guestfs-actions.pod:8210
34145 " guestfs_zegrepi (guestfs_h *g,\n"
34146 " const char *regex,\n"
34147 " const char *path);\n"
34152 #: ../src/guestfs-actions.pod:8227
34153 msgid "guestfs_zero"
34157 #: ../src/guestfs-actions.pod:8229
34161 " guestfs_zero (guestfs_h *g,\n"
34162 " const char *device);\n"
34167 #: ../src/guestfs-actions.pod:8243
34169 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
34170 "C<guestfs_is_zero_device>"
34174 #: ../src/guestfs-actions.pod:8255
34175 msgid "guestfs_zero_device"
34179 #: ../src/guestfs-actions.pod:8257
34183 " guestfs_zero_device (guestfs_h *g,\n"
34184 " const char *device);\n"
34189 #: ../src/guestfs-actions.pod:8261
34191 "This command writes zeroes over the entire C<device>. Compare with "
34192 "C<guestfs_zero> which just zeroes the first few blocks of a device."
34196 #: ../src/guestfs-actions.pod:8276
34197 msgid "(Added in 1.3.1)"
34201 #: ../src/guestfs-actions.pod:8278
34202 msgid "guestfs_zerofree"
34206 #: ../src/guestfs-actions.pod:8280
34210 " guestfs_zerofree (guestfs_h *g,\n"
34211 " const char *device);\n"
34216 #: ../src/guestfs-actions.pod:8299
34217 msgid "guestfs_zfgrep"
34221 #: ../src/guestfs-actions.pod:8301
34225 " guestfs_zfgrep (guestfs_h *g,\n"
34226 " const char *pattern,\n"
34227 " const char *path);\n"
34232 #: ../src/guestfs-actions.pod:8318
34233 msgid "guestfs_zfgrepi"
34237 #: ../src/guestfs-actions.pod:8320
34241 " guestfs_zfgrepi (guestfs_h *g,\n"
34242 " const char *pattern,\n"
34243 " const char *path);\n"
34248 #: ../src/guestfs-actions.pod:8337
34249 msgid "guestfs_zfile"
34253 #: ../src/guestfs-actions.pod:8339
34257 " guestfs_zfile (guestfs_h *g,\n"
34258 " const char *meth,\n"
34259 " const char *path);\n"
34264 #: ../src/guestfs-actions.pod:8344
34266 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
34271 #: ../src/guestfs-actions.pod:8356
34273 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
34278 #: ../src/guestfs-actions.pod:8364
34279 msgid "guestfs_zgrep"
34283 #: ../src/guestfs-actions.pod:8366
34287 " guestfs_zgrep (guestfs_h *g,\n"
34288 " const char *regex,\n"
34289 " const char *path);\n"
34294 #: ../src/guestfs-actions.pod:8383
34295 msgid "guestfs_zgrepi"
34299 #: ../src/guestfs-actions.pod:8385
34303 " guestfs_zgrepi (guestfs_h *g,\n"
34304 " const char *regex,\n"
34305 " const char *path);\n"
34310 #: ../src/guestfs-availability.pod:3
34315 #: ../src/guestfs-availability.pod:5
34317 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
34318 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
34319 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
34320 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
34321 "L</guestfs_aug_save> L</guestfs_aug_set>"
34325 #: ../src/guestfs-availability.pod:21
34330 #: ../src/guestfs-availability.pod:23
34331 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
34335 #: ../src/guestfs-availability.pod:26
34340 #: ../src/guestfs-availability.pod:28
34341 msgid "The following functions: L</guestfs_grub_install>"
34345 #: ../src/guestfs-availability.pod:31
34350 #: ../src/guestfs-availability.pod:33
34352 "The following functions: L</guestfs_inotify_add_watch> L</"
34353 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
34354 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
34358 #: ../src/guestfs-availability.pod:41
34359 msgid "B<linuxfsuuid>"
34363 #: ../src/guestfs-availability.pod:43
34365 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
34366 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
34370 #: ../src/guestfs-availability.pod:50
34371 msgid "B<linuxmodules>"
34375 #: ../src/guestfs-availability.pod:52
34376 msgid "The following functions: L</guestfs_modprobe>"
34380 #: ../src/guestfs-availability.pod:55
34381 msgid "B<linuxxattrs>"
34385 #: ../src/guestfs-availability.pod:57
34387 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
34388 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
34389 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
34390 "guestfs_setxattr>"
34394 #: ../src/guestfs-availability.pod:68
34399 #: ../src/guestfs-availability.pod:70
34401 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
34402 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
34403 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
34407 #: ../src/guestfs-availability.pod:79
34412 #: ../src/guestfs-availability.pod:81
34414 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
34415 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
34416 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
34417 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
34418 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
34419 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
34420 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
34424 #: ../src/guestfs-availability.pod:104
34429 #: ../src/guestfs-availability.pod:106
34431 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
34432 "guestfs_mknod_b> L</guestfs_mknod_c>"
34436 #: ../src/guestfs-availability.pod:112
34441 #: ../src/guestfs-availability.pod:114
34442 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
34446 #: ../src/guestfs-availability.pod:117
34447 msgid "B<ntfsprogs>"
34451 #: ../src/guestfs-availability.pod:119
34453 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
34454 "L</guestfs_ntfsresize_size>"
34458 #: ../src/guestfs-availability.pod:124
34459 msgid "B<realpath>"
34463 #: ../src/guestfs-availability.pod:126
34464 msgid "The following functions: L</guestfs_realpath>"
34468 #: ../src/guestfs-availability.pod:129
34473 #: ../src/guestfs-availability.pod:131
34475 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
34476 "guestfs_scrub_freespace>"
34480 #: ../src/guestfs-availability.pod:136
34485 #: ../src/guestfs-availability.pod:138
34486 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
34490 #: ../src/guestfs-availability.pod:142
34495 #: ../src/guestfs-availability.pod:144
34496 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
34500 #: ../src/guestfs-availability.pod:148
34501 msgid "B<zerofree>"
34505 #: ../src/guestfs-availability.pod:150
34506 msgid "The following functions: L</guestfs_zerofree>"
34510 #: ../src/guestfs-structs.pod:1
34511 msgid "guestfs_int_bool"
34515 #: ../src/guestfs-structs.pod:3
34518 " struct guestfs_int_bool {\n"
34526 #: ../src/guestfs-structs.pod:8
34529 " struct guestfs_int_bool_list {\n"
34530 " uint32_t len; /* Number of elements in list. */\n"
34531 " struct guestfs_int_bool *val; /* Elements. */\n"
34537 #: ../src/guestfs-structs.pod:13
34540 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
34541 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
34546 #: ../src/guestfs-structs.pod:16
34547 msgid "guestfs_lvm_pv"
34551 #: ../src/guestfs-structs.pod:18
34554 " struct guestfs_lvm_pv {\n"
34555 " char *pv_name;\n"
34556 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
34557 " char pv_uuid[32];\n"
34559 " uint64_t pv_size;\n"
34560 " uint64_t dev_size;\n"
34561 " uint64_t pv_free;\n"
34562 " uint64_t pv_used;\n"
34563 " char *pv_attr;\n"
34564 " int64_t pv_pe_count;\n"
34565 " int64_t pv_pe_alloc_count;\n"
34566 " char *pv_tags;\n"
34567 " uint64_t pe_start;\n"
34568 " int64_t pv_mda_count;\n"
34569 " uint64_t pv_mda_free;\n"
34575 #: ../src/guestfs-structs.pod:36
34578 " struct guestfs_lvm_pv_list {\n"
34579 " uint32_t len; /* Number of elements in list. */\n"
34580 " struct guestfs_lvm_pv *val; /* Elements. */\n"
34586 #: ../src/guestfs-structs.pod:41
34589 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
34590 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
34595 #: ../src/guestfs-structs.pod:44
34596 msgid "guestfs_lvm_vg"
34600 #: ../src/guestfs-structs.pod:46
34603 " struct guestfs_lvm_vg {\n"
34604 " char *vg_name;\n"
34605 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
34606 " char vg_uuid[32];\n"
34608 " char *vg_attr;\n"
34609 " uint64_t vg_size;\n"
34610 " uint64_t vg_free;\n"
34611 " char *vg_sysid;\n"
34612 " uint64_t vg_extent_size;\n"
34613 " int64_t vg_extent_count;\n"
34614 " int64_t vg_free_count;\n"
34615 " int64_t max_lv;\n"
34616 " int64_t max_pv;\n"
34617 " int64_t pv_count;\n"
34618 " int64_t lv_count;\n"
34619 " int64_t snap_count;\n"
34620 " int64_t vg_seqno;\n"
34621 " char *vg_tags;\n"
34622 " int64_t vg_mda_count;\n"
34623 " uint64_t vg_mda_free;\n"
34629 #: ../src/guestfs-structs.pod:69
34632 " struct guestfs_lvm_vg_list {\n"
34633 " uint32_t len; /* Number of elements in list. */\n"
34634 " struct guestfs_lvm_vg *val; /* Elements. */\n"
34640 #: ../src/guestfs-structs.pod:74
34643 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
34644 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
34649 #: ../src/guestfs-structs.pod:77
34650 msgid "guestfs_lvm_lv"
34654 #: ../src/guestfs-structs.pod:79
34657 " struct guestfs_lvm_lv {\n"
34658 " char *lv_name;\n"
34659 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
34660 " char lv_uuid[32];\n"
34661 " char *lv_attr;\n"
34662 " int64_t lv_major;\n"
34663 " int64_t lv_minor;\n"
34664 " int64_t lv_kernel_major;\n"
34665 " int64_t lv_kernel_minor;\n"
34666 " uint64_t lv_size;\n"
34667 " int64_t seg_count;\n"
34669 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
34670 " float snap_percent;\n"
34671 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
34672 " float copy_percent;\n"
34673 " char *move_pv;\n"
34674 " char *lv_tags;\n"
34675 " char *mirror_log;\n"
34676 " char *modules;\n"
34682 #: ../src/guestfs-structs.pod:101
34685 " struct guestfs_lvm_lv_list {\n"
34686 " uint32_t len; /* Number of elements in list. */\n"
34687 " struct guestfs_lvm_lv *val; /* Elements. */\n"
34693 #: ../src/guestfs-structs.pod:106
34696 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
34697 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
34702 #: ../src/guestfs-structs.pod:111
34705 " struct guestfs_stat {\n"
34709 " int64_t nlink;\n"
34714 " int64_t blksize;\n"
34715 " int64_t blocks;\n"
34716 " int64_t atime;\n"
34717 " int64_t mtime;\n"
34718 " int64_t ctime;\n"
34724 #: ../src/guestfs-structs.pod:127
34727 " struct guestfs_stat_list {\n"
34728 " uint32_t len; /* Number of elements in list. */\n"
34729 " struct guestfs_stat *val; /* Elements. */\n"
34735 #: ../src/guestfs-structs.pod:132
34738 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
34739 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
34744 #: ../src/guestfs-structs.pod:137
34747 " struct guestfs_statvfs {\n"
34748 " int64_t bsize;\n"
34749 " int64_t frsize;\n"
34750 " int64_t blocks;\n"
34751 " int64_t bfree;\n"
34752 " int64_t bavail;\n"
34753 " int64_t files;\n"
34754 " int64_t ffree;\n"
34755 " int64_t favail;\n"
34758 " int64_t namemax;\n"
34764 #: ../src/guestfs-structs.pod:151
34767 " struct guestfs_statvfs_list {\n"
34768 " uint32_t len; /* Number of elements in list. */\n"
34769 " struct guestfs_statvfs *val; /* Elements. */\n"
34775 #: ../src/guestfs-structs.pod:156
34778 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
34779 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
34784 #: ../src/guestfs-structs.pod:159
34785 msgid "guestfs_dirent"
34789 #: ../src/guestfs-structs.pod:161
34792 " struct guestfs_dirent {\n"
34801 #: ../src/guestfs-structs.pod:167
34804 " struct guestfs_dirent_list {\n"
34805 " uint32_t len; /* Number of elements in list. */\n"
34806 " struct guestfs_dirent *val; /* Elements. */\n"
34812 #: ../src/guestfs-structs.pod:172
34815 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
34816 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
34821 #: ../src/guestfs-structs.pod:177
34824 " struct guestfs_version {\n"
34825 " int64_t major;\n"
34826 " int64_t minor;\n"
34827 " int64_t release;\n"
34834 #: ../src/guestfs-structs.pod:184
34837 " struct guestfs_version_list {\n"
34838 " uint32_t len; /* Number of elements in list. */\n"
34839 " struct guestfs_version *val; /* Elements. */\n"
34845 #: ../src/guestfs-structs.pod:189
34848 " void guestfs_free_version (struct guestfs_free_version *);\n"
34849 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
34854 #: ../src/guestfs-structs.pod:192
34855 msgid "guestfs_xattr"
34859 #: ../src/guestfs-structs.pod:194
34862 " struct guestfs_xattr {\n"
34863 " char *attrname;\n"
34864 " /* The next two fields describe a byte array. */\n"
34865 " uint32_t attrval_len;\n"
34866 " char *attrval;\n"
34872 #: ../src/guestfs-structs.pod:201
34875 " struct guestfs_xattr_list {\n"
34876 " uint32_t len; /* Number of elements in list. */\n"
34877 " struct guestfs_xattr *val; /* Elements. */\n"
34883 #: ../src/guestfs-structs.pod:206
34886 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
34887 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
34892 #: ../src/guestfs-structs.pod:209
34893 msgid "guestfs_inotify_event"
34897 #: ../src/guestfs-structs.pod:211
34900 " struct guestfs_inotify_event {\n"
34901 " int64_t in_wd;\n"
34902 " uint32_t in_mask;\n"
34903 " uint32_t in_cookie;\n"
34904 " char *in_name;\n"
34910 #: ../src/guestfs-structs.pod:218
34913 " struct guestfs_inotify_event_list {\n"
34914 " uint32_t len; /* Number of elements in list. */\n"
34915 " struct guestfs_inotify_event *val; /* Elements. */\n"
34921 #: ../src/guestfs-structs.pod:223
34924 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
34925 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
34930 #: ../src/guestfs-structs.pod:226
34931 msgid "guestfs_partition"
34935 #: ../src/guestfs-structs.pod:228
34938 " struct guestfs_partition {\n"
34939 " int32_t part_num;\n"
34940 " uint64_t part_start;\n"
34941 " uint64_t part_end;\n"
34942 " uint64_t part_size;\n"
34948 #: ../src/guestfs-structs.pod:235
34951 " struct guestfs_partition_list {\n"
34952 " uint32_t len; /* Number of elements in list. */\n"
34953 " struct guestfs_partition *val; /* Elements. */\n"
34959 #: ../src/guestfs-structs.pod:240
34962 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
34963 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
34968 #: ../src/guestfs-structs.pod:243
34969 msgid "guestfs_application"
34973 #: ../src/guestfs-structs.pod:245
34976 " struct guestfs_application {\n"
34977 " char *app_name;\n"
34978 " char *app_display_name;\n"
34979 " int32_t app_epoch;\n"
34980 " char *app_version;\n"
34981 " char *app_release;\n"
34982 " char *app_install_path;\n"
34983 " char *app_trans_path;\n"
34984 " char *app_publisher;\n"
34985 " char *app_url;\n"
34986 " char *app_source_package;\n"
34987 " char *app_summary;\n"
34988 " char *app_description;\n"
34994 #: ../src/guestfs-structs.pod:260
34997 " struct guestfs_application_list {\n"
34998 " uint32_t len; /* Number of elements in list. */\n"
34999 " struct guestfs_application *val; /* Elements. */\n"
35005 #: ../src/guestfs-structs.pod:265
35008 " void guestfs_free_application (struct guestfs_free_application *);\n"
35009 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
35014 #: ../src/guestfs.pod:5
35015 msgid "guestfs - Library for accessing and modifying virtual machine images"
35019 #: ../src/guestfs.pod:11
35022 " guestfs_h *g = guestfs_create ();\n"
35023 " guestfs_add_drive (g, \"guest.img\");\n"
35024 " guestfs_launch (g);\n"
35025 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
35026 " guestfs_touch (g, \"/hello\");\n"
35027 " guestfs_umount (g, \"/\");\n"
35028 " guestfs_close (g);\n"
35031 " guestfs_h *g = guestfs_create ();\n"
35032 " guestfs_add_drive (g, \"guest.img\");\n"
35033 " guestfs_launch (g);\n"
35034 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
35035 " guestfs_touch (g, \"/hello\");\n"
35036 " guestfs_umount (g, \"/\");\n"
35037 " guestfs_close (g);\n"
35041 #: ../src/guestfs.pod:25
35043 "Libguestfs is a library for accessing and modifying guest disk images. "
35044 "Amongst the things this is good for: making batch configuration changes to "
35045 "guests, getting disk used/free statistics (see also: virt-df), migrating "
35046 "between virtualization systems (see also: virt-p2v), performing partial "
35047 "backups, performing partial guest clones, cloning guests and changing "
35048 "registry/UUID/hostname info, and much else besides."
35052 #: ../src/guestfs.pod:33
35054 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
35055 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
35056 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
35061 #: ../src/guestfs.pod:38
35063 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
35064 "what filesystem is in each LV, etc.). It can also run commands in the "
35065 "context of the guest. Also you can access filesystems over FUSE."
35069 #: ../src/guestfs.pod:43
35071 "Libguestfs is a library that can be linked with C and C++ management "
35072 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
35073 "PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
35078 #: ../src/guestfs.pod:48
35080 "You don't need to be root to use libguestfs, although obviously you do need "
35081 "enough permissions to access the disk images."
35085 #: ../src/guestfs.pod:51
35087 "Libguestfs is a large API because it can do many things. For a gentle "
35088 "introduction, please read the L</API OVERVIEW> section next."
35092 #: ../src/guestfs.pod:54
35094 "There are also some example programs in the L<guestfs-examples(3)> manual "
35099 #: ../src/guestfs.pod:57
35100 msgid "API OVERVIEW"
35104 #: ../src/guestfs.pod:59
35106 "This section provides a gentler overview of the libguestfs API. We also try "
35107 "to group API calls together, where that may not be obvious from reading "
35108 "about the individual calls in the main section of this manual."
35112 #: ../src/guestfs.pod:64
35117 #: ../src/guestfs.pod:66
35119 "Before you can use libguestfs calls, you have to create a handle. Then you "
35120 "must add at least one disk image to the handle, followed by launching the "
35121 "handle, then performing whatever operations you want, and finally closing "
35122 "the handle. By convention we use the single letter C<g> for the name of the "
35123 "handle variable, although of course you can use any name you want."
35127 #: ../src/guestfs.pod:73
35128 msgid "The general structure of all libguestfs-using programs looks like this:"
35132 #: ../src/guestfs.pod:76
35135 " guestfs_h *g = guestfs_create ();\n"
35140 #: ../src/guestfs.pod:78
35143 " /* Call guestfs_add_drive additional times if there are\n"
35144 " * multiple disk images.\n"
35146 " guestfs_add_drive (g, \"guest.img\");\n"
35151 #: ../src/guestfs.pod:83
35154 " /* Most manipulation calls won't work until you've launched\n"
35155 " * the handle 'g'. You have to do this _after_ adding drives\n"
35156 " * and _before_ other commands.\n"
35158 " guestfs_launch (g);\n"
35163 #: ../src/guestfs.pod:89
35166 " /* Now you can examine what partitions, LVs etc are available.\n"
35168 " char **partitions = guestfs_list_partitions (g);\n"
35169 " char **logvols = guestfs_lvs (g);\n"
35174 #: ../src/guestfs.pod:94
35177 " /* To access a filesystem in the image, you must mount it.\n"
35179 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
35184 #: ../src/guestfs.pod:98
35187 " /* Now you can perform filesystem actions on the guest\n"
35190 " guestfs_touch (g, \"/hello\");\n"
35195 #: ../src/guestfs.pod:103
35198 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
35199 " * it is done automatically when you close the handle. See\n"
35200 " * discussion of autosync in this page.\n"
35202 " guestfs_sync (g);\n"
35207 #: ../src/guestfs.pod:109
35210 " /* Close the handle 'g'. */\n"
35211 " guestfs_close (g);\n"
35216 #: ../src/guestfs.pod:112
35218 "The code above doesn't include any error checking. In real code you should "
35219 "check return values carefully for errors. In general all functions that "
35220 "return integers return C<-1> on error, and all functions that return "
35221 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
35222 "how to handle errors, and consult the documentation for each function call "
35223 "below to see precisely how they return error indications. See L<guestfs-"
35224 "examples(3)> for fully worked examples."
35228 #: ../src/guestfs.pod:121
35229 msgid "DISK IMAGES"
35233 #: ../src/guestfs.pod:123
35235 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
35236 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
35237 "actual block device, or simply an empty file of zeroes that you have created "
35238 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
35243 #: ../src/guestfs.pod:129
35245 "The call you should use in modern code for adding drives is L</"
35246 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
35247 "specifying that the format is raw, do:"
35251 #: ../src/guestfs.pod:133
35254 " guestfs_add_drive_opts (g, filename,\n"
35255 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
35261 #: ../src/guestfs.pod:137
35262 msgid "You can add a disk read-only using:"
35266 #: ../src/guestfs.pod:139
35269 " guestfs_add_drive_opts (g, filename,\n"
35270 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
35271 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
35277 #: ../src/guestfs.pod:144
35279 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
35280 "libguestfs won't modify the file."
35284 #: ../src/guestfs.pod:147
35286 "Be extremely cautious if the disk image is in use, eg. if it is being used "
35287 "by a virtual machine. Adding it read-write will almost certainly cause disk "
35288 "corruption, but adding it read-only is safe."
35292 #: ../src/guestfs.pod:151
35294 "You must add at least one disk image, and you may add multiple disk images. "
35295 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
35296 "first one you added), C</dev/sdb> (for the second one you added), etc."
35300 #: ../src/guestfs.pod:156
35302 "Once L</guestfs_launch> has been called you cannot add any more images. You "
35303 "can call L</guestfs_list_devices> to get a list of the device names, in the "
35304 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
35308 #: ../src/guestfs.pod:161
35313 #: ../src/guestfs.pod:163
35315 "Before you can read or write files, create directories and so on in a disk "
35316 "image that contains filesystems, you have to mount those filesystems using "
35317 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
35318 "a disk image contains (for example) one partition with a filesystem on that "
35319 "partition, then you can mount it directly:"
35323 #: ../src/guestfs.pod:170
35326 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
35331 #: ../src/guestfs.pod:172
35333 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
35334 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
35335 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
35336 "that these are libguestfs virtual devices, and are nothing to do with host "
35341 #: ../src/guestfs.pod:178
35343 "If you are given a disk image and you don't know what it contains then you "
35344 "have to find out. Libguestfs can do that too: use L</"
35345 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
35346 "LVs, and either try mounting each to see what is mountable, or else examine "
35347 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
35348 "filesystems, use L</guestfs_list_filesystems>."
35352 #: ../src/guestfs.pod:186
35354 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
35355 "L</INSPECTION> below). But you might find it easier to look at higher level "
35356 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
35360 #: ../src/guestfs.pod:191
35362 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
35363 "several other variations of the C<guestfs_mount_*> call."
35367 #: ../src/guestfs.pod:194
35368 msgid "FILESYSTEM ACCESS AND MODIFICATION"
35372 #: ../src/guestfs.pod:196
35374 "The majority of the libguestfs API consists of fairly low-level calls for "
35375 "accessing and modifying the files, directories, symlinks etc on mounted "
35376 "filesystems. There are over a hundred such calls which you can find listed "
35377 "in detail below in this man page, and we don't even pretend to cover them "
35378 "all in this overview."
35382 #: ../src/guestfs.pod:202
35384 "Specify filenames as full paths, starting with C<\"/\"> and including the "
35389 #: ../src/guestfs.pod:205
35391 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
35392 "the file called C<\"etc/passwd\"> then you could do:"
35396 #: ../src/guestfs.pod:208
35399 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
35404 #: ../src/guestfs.pod:210
35406 "This would return C<data> as a newly allocated buffer containing the full "
35407 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
35408 "or C<NULL> if there was an error."
35412 #: ../src/guestfs.pod:214
35414 "As another example, to create a top-level directory on that filesystem "
35415 "called C<\"var\"> you would do:"
35419 #: ../src/guestfs.pod:217
35422 " guestfs_mkdir (g, \"/var\");\n"
35427 #: ../src/guestfs.pod:219
35428 msgid "To create a symlink you could do:"
35432 #: ../src/guestfs.pod:221
35435 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
35436 " \"/etc/rc3.d/S30portmap\");\n"
35441 #: ../src/guestfs.pod:224
35443 "Libguestfs will reject attempts to use relative paths and there is no "
35444 "concept of a current working directory."
35448 #: ../src/guestfs.pod:227
35450 "Libguestfs can return errors in many situations: for example if the "
35451 "filesystem isn't writable, or if a file or directory that you requested "
35452 "doesn't exist. If you are using the C API (documented here) you have to "
35453 "check for those error conditions after each call. (Other language bindings "
35454 "turn these errors into exceptions)."
35458 #: ../src/guestfs.pod:233
35460 "File writes are affected by the per-handle umask, set by calling L</"
35461 "guestfs_umask> and defaulting to 022. See L</UMASK>."
35465 #: ../src/guestfs.pod:236
35466 msgid "PARTITIONING"
35470 #: ../src/guestfs.pod:238
35472 "Libguestfs contains API calls to read, create and modify partition tables on "
35477 #: ../src/guestfs.pod:241
35479 "In the common case where you want to create a single partition covering the "
35480 "whole disk, you should use the L</guestfs_part_disk> call:"
35484 #: ../src/guestfs.pod:245
35487 " const char *parttype = \"mbr\";\n"
35488 " if (disk_is_larger_than_2TB)\n"
35489 " parttype = \"gpt\";\n"
35490 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
35495 #: ../src/guestfs.pod:250
35497 "Obviously this effectively wipes anything that was on that disk image before."
35501 #: ../src/guestfs.pod:253
35506 #: ../src/guestfs.pod:255
35508 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
35509 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
35510 "you familiarize yourself with the concepts of physical volumes, volume "
35511 "groups and logical volumes."
35515 #: ../src/guestfs.pod:260
35517 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
35518 "tldp.org/HOWTO/LVM-HOWTO/>."
35522 #: ../src/guestfs.pod:263
35523 msgid "DOWNLOADING"
35527 #: ../src/guestfs.pod:265
35529 "Use L</guestfs_cat> to download small, text only files. This call is "
35530 "limited to files which are less than 2 MB and which cannot contain any ASCII "
35531 "NUL (C<\\0>) characters. However the API is very simple to use."
35535 #: ../src/guestfs.pod:269
35537 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
35538 "bit data, since it returns a (pointer, size) pair. However it is still "
35539 "limited to \"small\" files, less than 2 MB."
35543 #: ../src/guestfs.pod:273
35545 "L</guestfs_download> can be used to download any file, with no limits on "
35546 "content or size (even files larger than 4 GB)."
35550 #: ../src/guestfs.pod:276
35552 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
35556 #: ../src/guestfs.pod:279
35561 #: ../src/guestfs.pod:281
35563 "It's often the case that you want to write a file or files to the disk image."
35567 #: ../src/guestfs.pod:284
35569 "To write a small file with fixed content, use L</guestfs_write>. To create "
35570 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
35571 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
35572 "of other functions for creating test files, for example L</guestfs_fill> and "
35573 "L</guestfs_fill_pattern>."
35577 #: ../src/guestfs.pod:290
35579 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
35580 "file content or size (even files larger than 4 GB)."
35584 #: ../src/guestfs.pod:293
35586 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
35590 #: ../src/guestfs.pod:295
35592 "However the fastest way to upload I<large numbers of arbitrary files> is to "
35593 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
35594 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
35595 "in a predictable way (eg. adding it last after all other drives) then you "
35596 "can get the device name from L</guestfs_list_devices> and mount it directly "
35597 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
35598 "portable between kernel versions, and they don't support labels or UUIDs. "
35599 "If you want to pre-build an image or you need to mount it using a label or "
35600 "UUID, use an ISO image instead."
35604 #: ../src/guestfs.pod:306
35609 #: ../src/guestfs.pod:308
35611 "There are various different commands for copying between files and devices "
35612 "and in and out of the guest filesystem. These are summarised in the table "
35617 #: ../src/guestfs.pod:314
35618 msgid "B<file> to B<file>"
35622 #: ../src/guestfs.pod:316
35624 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
35625 "directories recursively."
35629 #: ../src/guestfs.pod:319
35631 "To copy part of a file (offset and size) use L</guestfs_copy_file_to_file>."
35635 #: ../src/guestfs.pod:322
35636 msgid "B<file> to B<device>"
35640 #: ../src/guestfs.pod:324
35641 msgid "B<device> to B<file>"
35645 #: ../src/guestfs.pod:326
35646 msgid "B<device> to B<device>"
35650 #: ../src/guestfs.pod:328
35652 "Use L</guestfs_copy_file_to_device>, L</guestfs_copy_device_to_file>, or L</"
35653 "guestfs_copy_device_to_device>."
35657 #: ../src/guestfs.pod:331
35658 msgid "Example: duplicate the contents of an LV:"
35662 #: ../src/guestfs.pod:333
35665 " guestfs_copy_device_to_device (g,\n"
35666 " \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
35667 " /* -1 marks the end of the list of optional parameters */\n"
35673 #: ../src/guestfs.pod:338
35675 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
35676 "(C</dev/VG/Original>). To copy less than the whole source device, use the "
35677 "optional C<size> parameter:"
35681 #: ../src/guestfs.pod:342
35684 " guestfs_copy_device_to_device (g,\n"
35685 " \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
35686 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, 10000,\n"
35692 #: ../src/guestfs.pod:347
35693 msgid "B<file on the host> to B<file or device>"
35697 #: ../src/guestfs.pod:349
35698 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
35702 #: ../src/guestfs.pod:351
35703 msgid "B<file or device> to B<file on the host>"
35707 #: ../src/guestfs.pod:353
35708 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
35712 #: ../src/guestfs.pod:357
35713 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
35717 #: ../src/guestfs.pod:359
35719 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
35720 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
35721 "appears you can only upload and download to files. However many Un*x-like "
35722 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
35723 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
35724 "and arbitrary file descriptor N."
35728 #: ../src/guestfs.pod:367
35729 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
35733 #: ../src/guestfs.pod:370
35736 " guestfs_download (g, filename, \"/dev/stdout\");\n"
35741 #: ../src/guestfs.pod:372
35742 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
35746 #: ../src/guestfs.pod:374
35749 " char devfd[64];\n"
35750 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
35751 " guestfs_tar_out (g, \"/\", devfd);\n"
35756 #: ../src/guestfs.pod:378
35757 msgid "LISTING FILES"
35761 #: ../src/guestfs.pod:380
35763 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
35764 "L<guestfish(1)>-equivalent command C<ll>)."
35768 #: ../src/guestfs.pod:383
35770 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
35771 "programs, as a flat list of strings."
35775 #: ../src/guestfs.pod:386
35777 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
35778 "directory, plus additional information about each one. It is more "
35779 "equivalent to using the L<readdir(3)> call on a local filesystem."
35783 #: ../src/guestfs.pod:390
35785 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
35789 #: ../src/guestfs.pod:393
35790 msgid "RUNNING COMMANDS"
35794 #: ../src/guestfs.pod:395
35796 "Although libguestfs is primarily an API for manipulating files inside guest "
35797 "images, we also provide some limited facilities for running commands inside "
35802 #: ../src/guestfs.pod:399
35803 msgid "There are many limitations to this:"
35807 #: ../src/guestfs.pod:405
35809 "The kernel version that the command runs under will be different from what "
35814 #: ../src/guestfs.pod:410
35816 "If the command needs to communicate with daemons, then most likely they "
35817 "won't be running."
35821 #: ../src/guestfs.pod:415
35822 msgid "The command will be running in limited memory."
35826 #: ../src/guestfs.pod:419
35828 "The network may not be available unless you enable it (see L</"
35829 "guestfs_set_network>)."
35833 #: ../src/guestfs.pod:424
35834 msgid "Only supports Linux guests (not Windows, BSD, etc)."
35838 #: ../src/guestfs.pod:428
35840 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
35844 #: ../src/guestfs.pod:433
35846 "For SELinux guests, you may need to enable SELinux and load policy first. "
35847 "See L</SELINUX> in this manpage."
35851 #: ../src/guestfs.pod:438
35853 "I<Security:> It is not safe to run commands from untrusted, possibly "
35854 "malicious guests. These commands may attempt to exploit your program by "
35855 "sending unexpected output. They could also try to exploit the Linux kernel "
35856 "or qemu provided by the libguestfs appliance. They could use the network "
35857 "provided by the libguestfs appliance to bypass ordinary network partitions "
35858 "and firewalls. They could use the elevated privileges or different SELinux "
35859 "context of your program to their advantage."
35863 #: ../src/guestfs.pod:447
35865 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
35866 "(a script which runs when the guest next boots normally), and to have this "
35867 "script run the commands you want in the normal context of the running guest, "
35868 "network security and so on. For information about other security issues, "
35869 "see L</SECURITY>."
35873 #: ../src/guestfs.pod:455
35875 "The two main API calls to run commands are L</guestfs_command> and L</"
35876 "guestfs_sh> (there are also variations)."
35880 #: ../src/guestfs.pod:458
35882 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
35883 "shell globs, redirections, etc will work."
35887 #: ../src/guestfs.pod:461
35888 msgid "CONFIGURATION FILES"
35892 #: ../src/guestfs.pod:463
35894 "To read and write configuration files in Linux guest filesystems, we "
35895 "strongly recommend using Augeas. For example, Augeas understands how to "
35896 "read and write, say, a Linux shadow password file or X.org configuration "
35897 "file, and so avoids you having to write that code."
35901 #: ../src/guestfs.pod:468
35903 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
35904 "document Augeas itself here because there is excellent documentation on the "
35905 "L<http://augeas.net/> website."
35909 #: ../src/guestfs.pod:472
35911 "If you don't want to use Augeas (you fool!) then try calling L</"
35912 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
35917 #: ../src/guestfs.pod:476
35922 #: ../src/guestfs.pod:478
35924 "We support SELinux guests. To ensure that labeling happens correctly in "
35925 "SELinux guests, you need to enable SELinux and load the guest's policy:"
35929 #: ../src/guestfs.pod:486
35930 msgid "Before launching, do:"
35934 #: ../src/guestfs.pod:488
35937 " guestfs_set_selinux (g, 1);\n"
35942 #: ../src/guestfs.pod:492
35944 "After mounting the guest's filesystem(s), load the policy. This is best "
35945 "done by running the L<load_policy(8)> command in the guest itself:"
35949 #: ../src/guestfs.pod:496
35952 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
35957 #: ../src/guestfs.pod:498
35959 "(Older versions of C<load_policy> require you to specify the name of the "
35964 #: ../src/guestfs.pod:503
35966 "Optionally, set the security context for the API. The correct security "
35967 "context to use can only be known by inspecting the guest. As an example:"
35971 #: ../src/guestfs.pod:507
35974 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
35979 #: ../src/guestfs.pod:511
35980 msgid "This will work for running commands and editing existing files."
35984 #: ../src/guestfs.pod:513
35986 "When new files are created, you may need to label them explicitly, for "
35987 "example by running the external command C<restorecon pathname>."
35991 #: ../src/guestfs.pod:517
35996 #: ../src/guestfs.pod:519
35998 "Certain calls are affected by the current file mode creation mask (the "
35999 "\"umask\"). In particular ones which create files or directories, such as "
36000 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
36001 "either the default mode that the file is created with or modifies the mode "
36006 #: ../src/guestfs.pod:525
36008 "The default umask is C<022>, so files are created with modes such as C<0644> "
36009 "and directories with C<0755>."
36013 #: ../src/guestfs.pod:528
36015 "There are two ways to avoid being affected by umask. Either set umask to 0 "
36016 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
36017 "guestfs_chmod> after creating each file or directory."
36021 #: ../src/guestfs.pod:532
36022 msgid "For more information about umask, see L<umask(2)>."
36026 #: ../src/guestfs.pod:536
36028 "Libguestfs allows you to access Linux guests which have been encrypted using "
36029 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
36030 "standard. This includes nearly all whole disk encryption systems used by "
36031 "modern Linux guests."
36035 #: ../src/guestfs.pod:542
36037 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
36038 "returns the string C<crypto_LUKS>)."
36042 #: ../src/guestfs.pod:545
36044 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
36045 "will require the passphrase!"
36049 #: ../src/guestfs.pod:548
36051 "Opening a LUKS device creates a new device mapper device called C</dev/"
36052 "mapper/mapname> (where C<mapname> is the string you supply to L</"
36053 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
36054 "from and encrypted to the underlying block device respectively."
36058 #: ../src/guestfs.pod:554
36060 "LVM volume groups on the device can be made visible by calling L</"
36061 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
36062 "(s) can now be mounted in the usual way."
36066 #: ../src/guestfs.pod:558
36068 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
36069 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
36070 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
36071 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
36072 "underlying encrypted block device)."
36076 #: ../src/guestfs.pod:565
36081 #: ../src/guestfs.pod:567
36083 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
36084 "contains operating systems, an install CD or a live CD. (These APIs used to "
36085 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
36086 "version 1.5.3 the most frequently used part of this library has been "
36087 "rewritten in C and moved into the core code)."
36091 #: ../src/guestfs.pod:574
36093 "Add all disks belonging to the unknown virtual machine and call L</"
36094 "guestfs_launch> in the usual way."
36098 #: ../src/guestfs.pod:577
36100 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
36101 "and certain heuristics, and returns a list of operating systems that were "
36102 "found. An empty list means none were found. A single element is the root "
36103 "filesystem of the operating system. For dual- or multi-boot guests, "
36104 "multiple roots can be returned, each one corresponding to a separate "
36105 "operating system. (Multi-boot virtual machines are extremely rare in the "
36106 "world of virtualization, but since this scenario can happen, we have built "
36107 "libguestfs to deal with it.)"
36111 #: ../src/guestfs.pod:586
36113 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
36114 "to get additional details about that operating system. For example, call L</"
36115 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
36116 "Windows and Linux-based operating systems respectively."
36120 #: ../src/guestfs.pod:592
36122 "Un*x-like and Linux-based operating systems usually consist of several "
36123 "filesystems which are mounted at boot time (for example, a separate boot "
36124 "partition mounted on C</boot>). The inspection rules are able to detect how "
36125 "filesystems correspond to mount points. Call "
36126 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
36127 "hash table like this example:"
36131 #: ../src/guestfs.pod:599
36134 " /boot => /dev/sda1\n"
36135 " / => /dev/vg_guest/lv_root\n"
36136 " /usr => /dev/vg_guest/lv_usr\n"
36141 #: ../src/guestfs.pod:603
36143 "The caller can then make calls to L</guestfs_mount_options> to mount the "
36144 "filesystems as suggested."
36148 #: ../src/guestfs.pod:606
36150 "Be careful to mount filesystems in the right order (eg. C</> before C</"
36151 "usr>). Sorting the keys of the hash by length, shortest first, should work."
36155 #: ../src/guestfs.pod:610
36157 "Inspection currently only works for some common operating systems. "
36158 "Contributors are welcome to send patches for other operating systems that we "
36159 "currently cannot detect."
36163 #: ../src/guestfs.pod:614
36165 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
36166 "for more details. The L</guestfs_inspect_os> function just ignores any "
36167 "encrypted devices."
36171 #: ../src/guestfs.pod:618
36173 "A note on the implementation: The call L</guestfs_inspect_os> performs "
36174 "inspection and caches the results in the guest handle. Subsequent calls to "
36175 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
36176 "read the disks. If you change the content of the guest disks, you can redo "
36177 "inspection by calling L</guestfs_inspect_os> again. (L</"
36178 "guestfs_inspect_list_applications> works a little differently from the other "
36179 "calls and does read the disks. See documentation for that function for "
36184 #: ../src/guestfs.pod:627
36185 msgid "INSPECTING INSTALL DISKS"
36189 #: ../src/guestfs.pod:629
36191 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
36196 #: ../src/guestfs.pod:632
36198 "Call L</guestfs_inspect_get_format> to return the format of the operating "
36199 "system, which currently can be C<installed> (a regular operating system) or "
36200 "C<installer> (some sort of install disk)."
36204 #: ../src/guestfs.pod:636
36206 "Further information is available about the operating system that can be "
36207 "installed using the regular inspection APIs like L</"
36208 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
36212 #: ../src/guestfs.pod:641
36214 "Some additional information specific to installer disks is also available "
36215 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
36216 "guestfs_inspect_is_multipart> calls."
36220 #: ../src/guestfs.pod:646
36221 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
36225 #: ../src/guestfs.pod:648
36227 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
36228 "ntfs-3g.org/> driver."
36232 #: ../src/guestfs.pod:651
36233 msgid "DRIVE LETTERS AND PATHS"
36237 #: ../src/guestfs.pod:653
36239 "DOS and Windows still use drive letters, and the filesystems are always "
36240 "treated as case insensitive by Windows itself, and therefore you might find "
36241 "a Windows configuration file referring to a path like C<c:\\windows"
36242 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
36243 "might be referred to as C</WINDOWS/System32>."
36247 #: ../src/guestfs.pod:659
36249 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
36250 "L</guestfs_inspect_get_drive_mappings>)"
36254 #: ../src/guestfs.pod:662
36256 "Dealing with separator characters (backslash vs forward slash) is outside "
36257 "the scope of libguestfs, but usually a simple character replacement will "
36262 #: ../src/guestfs.pod:666
36264 "To resolve the case insensitivity of paths, call L</"
36265 "guestfs_case_sensitive_path>."
36269 #: ../src/guestfs.pod:669
36270 msgid "ACCESSING THE WINDOWS REGISTRY"
36274 #: ../src/guestfs.pod:671
36276 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
36277 "files, through the library C<hivex> which is part of the libguestfs project "
36278 "although ships as a separate tarball. You have to locate and download the "
36279 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
36280 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
36281 "reg(1)> for more help on this issue."
36285 #: ../src/guestfs.pod:679
36286 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
36290 #: ../src/guestfs.pod:681
36292 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
36293 "provide something which looks like a Linux symlink. The way it tries to do "
36294 "the rewriting is described here:"
36298 #: ../src/guestfs.pod:685
36300 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
36305 #: ../src/guestfs.pod:687
36307 "The essential problem is that ntfs-3g simply does not have enough "
36308 "information to do a correct job. NTFS links can contain drive letters and "
36309 "references to external device GUIDs that ntfs-3g has no way of resolving. "
36310 "It is almost certainly the case that libguestfs callers should ignore what "
36311 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
36315 #: ../src/guestfs.pod:694
36317 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
36318 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
36319 "attribute, and read the raw reparse data from that (you can find the format "
36320 "documented in various places around the web)."
36324 #: ../src/guestfs.pod:699
36325 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
36329 #: ../src/guestfs.pod:701
36331 "There are other useful extended attributes that can be read from ntfs-3g "
36332 "filesystems (using L</guestfs_getxattr>). See:"
36336 #: ../src/guestfs.pod:704
36338 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
36342 #: ../src/guestfs.pod:706
36343 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
36347 #: ../src/guestfs.pod:708
36349 "Although we don't want to discourage you from using the C API, we will "
36350 "mention here that the same API is also available in other languages."
36354 #: ../src/guestfs.pod:711
36356 "The API is broadly identical in all supported languages. This means that "
36357 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
36358 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
36359 "OCaml. In other words, a straightforward, predictable isomorphism between "
36364 #: ../src/guestfs.pod:717
36366 "Error messages are automatically transformed into exceptions if the language "
36371 #: ../src/guestfs.pod:720
36373 "We don't try to \"object orientify\" parts of the API in OO languages, "
36374 "although contributors are welcome to write higher level APIs above what we "
36375 "provide in their favourite languages if they wish."
36379 #: ../src/guestfs.pod:726
36384 #: ../src/guestfs.pod:728
36386 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
36387 "identical to the C API. C++ classes and exceptions are not used."
36391 #: ../src/guestfs.pod:732
36396 #: ../src/guestfs.pod:734
36398 "The C# bindings are highly experimental. Please read the warnings at the "
36399 "top of C<csharp/Libguestfs.cs>."
36403 #: ../src/guestfs.pod:737
36408 #: ../src/guestfs.pod:739
36409 msgid "See L<guestfs-erlang(3)>."
36413 #: ../src/guestfs.pod:741
36418 #: ../src/guestfs.pod:743
36420 "This is the only language binding that is working but incomplete. Only "
36421 "calls which return simple integers have been bound in Haskell, and we are "
36422 "looking for help to complete this binding."
36426 #: ../src/guestfs.pod:747
36431 #: ../src/guestfs.pod:749
36433 "Full documentation is contained in the Javadoc which is distributed with "
36434 "libguestfs. For examples, see L<guestfs-java(3)>."
36438 #: ../src/guestfs.pod:752
36443 #: ../src/guestfs.pod:754
36444 msgid "See L<guestfs-ocaml(3)>."
36448 #: ../src/guestfs.pod:756
36453 #: ../src/guestfs.pod:758
36454 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
36458 #: ../src/guestfs.pod:760
36463 #: ../src/guestfs.pod:762
36465 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
36466 "the php-libguestfs package for your distribution."
36470 #: ../src/guestfs.pod:765
36471 msgid "The PHP binding only works correctly on 64 bit machines."
36475 #: ../src/guestfs.pod:767
36480 #: ../src/guestfs.pod:769
36481 msgid "See L<guestfs-python(3)>."
36485 #: ../src/guestfs.pod:771
36490 #: ../src/guestfs.pod:773
36491 msgid "See L<guestfs-ruby(3)>."
36495 #: ../src/guestfs.pod:775
36496 msgid "B<shell scripts>"
36500 #: ../src/guestfs.pod:777
36501 msgid "See L<guestfish(1)>."
36505 #: ../src/guestfs.pod:781
36506 msgid "LIBGUESTFS GOTCHAS"
36510 #: ../src/guestfs.pod:783
36512 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
36513 "system [...] that works in the way it is documented but is counterintuitive "
36514 "and almost invites mistakes.\""
36518 #: ../src/guestfs.pod:787
36520 "Since we developed libguestfs and the associated tools, there are several "
36521 "things we would have designed differently, but are now stuck with for "
36522 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
36523 "release, you can expect these to change. Beware of them."
36527 #: ../src/guestfs.pod:795
36528 msgid "Autosync / forgetting to sync."
36532 #: ../src/guestfs.pod:797
36534 "I<Update:> Autosync is enabled by default for all API users starting from "
36535 "libguestfs 1.5.24. This section only applies to older versions."
36539 #: ../src/guestfs.pod:800
36541 "When modifying a filesystem from C or another language, you B<must> unmount "
36542 "all filesystems and call L</guestfs_sync> explicitly before you close the "
36543 "libguestfs handle. You can also call:"
36547 #: ../src/guestfs.pod:804
36550 " guestfs_set_autosync (g, 1);\n"
36555 #: ../src/guestfs.pod:806
36557 "to have the unmount/sync done automatically for you when the handle 'g' is "
36558 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
36562 #: ../src/guestfs.pod:810
36564 "If you forget to do this, then it is entirely possible that your changes "
36565 "won't be written out, or will be partially written, or (very rarely) that "
36566 "you'll get disk corruption."
36570 #: ../src/guestfs.pod:814
36572 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
36573 "guestfish scripts that forget to sync will work just fine, which can make "
36574 "this very puzzling if you are trying to debug a problem."
36578 #: ../src/guestfs.pod:818
36579 msgid "Mount option C<-o sync> should not be the default."
36583 #: ../src/guestfs.pod:820
36585 "I<Update:> L</guestfs_mount> no longer adds any options starting from "
36586 "libguestfs 1.13.16. This section only applies to older versions."
36590 #: ../src/guestfs.pod:823
36592 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
36593 "However C<-o sync> does not add any reliability benefit, but does have a "
36594 "very large performance impact."
36598 #: ../src/guestfs.pod:827
36600 "The work around is to use L</guestfs_mount_options> and set the mount "
36601 "options that you actually want to use."
36605 #: ../src/guestfs.pod:830
36606 msgid "Read-only should be the default."
36610 #: ../src/guestfs.pod:832
36612 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
36613 "specify I<--rw> if you want to make changes to the image."
36617 #: ../src/guestfs.pod:835
36618 msgid "This would reduce the potential to corrupt live VM images."
36622 #: ../src/guestfs.pod:837
36624 "Note that many filesystems change the disk when you just mount and unmount, "
36625 "even if you didn't perform any writes. You need to use L</"
36626 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
36630 #: ../src/guestfs.pod:841
36631 msgid "guestfish command line is hard to use."
36635 #: ../src/guestfs.pod:843
36637 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
36638 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
36639 "exist, so it fails. In earlier versions of guestfish the error message was "
36640 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
36641 "we should have used C<guestfish -c command> to run commands."
36645 #: ../src/guestfs.pod:850
36646 msgid "guestfish megabyte modifiers don't work right on all commands"
36650 #: ../src/guestfs.pod:852
36652 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
36653 "other modifiers). What guestfish actually does is to multiply the number "
36654 "part by the modifier part and pass the result to the C API. However this "
36655 "doesn't work for a few APIs which aren't expecting bytes, but are already "
36656 "expecting some other unit (eg. megabytes)."
36660 #: ../src/guestfs.pod:859
36661 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
36665 #: ../src/guestfs.pod:861
36668 " lvcreate LV VG 100M\n"
36673 #: ../src/guestfs.pod:863
36675 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
36676 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
36677 "megabytes * megabytes) logical volume. The error message you get from this "
36678 "is also a little obscure."
36682 #: ../src/guestfs.pod:868
36684 "This could be fixed in the generator by specially marking parameters and "
36685 "return values which take bytes or other units."
36689 #: ../src/guestfs.pod:871
36690 msgid "Ambiguity between devices and paths"
36694 #: ../src/guestfs.pod:873
36696 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
36697 "sdb2>) and a similar pathname. A file might just happen to be called "
36698 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
36702 #: ../src/guestfs.pod:878
36704 "In the current API we usually resolve this ambiguity by having two separate "
36705 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
36706 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
36707 "detecting if the path supplied begins with C</dev/>."
36711 #: ../src/guestfs.pod:884
36713 "To avoid both the ambiguity and the need to duplicate some calls, we could "
36714 "make paths/devices into structured names. One way to do this would be to "
36715 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
36716 "aspect of grub. Another way would be to use a structured type, equivalent "
36717 "to this OCaml type:"
36721 #: ../src/guestfs.pod:890
36724 " type path = Path of string | Device of int | Partition of int * int\n"
36729 #: ../src/guestfs.pod:892
36730 msgid "which would allow you to pass arguments like:"
36734 #: ../src/guestfs.pod:894
36737 " Path \"/foo/bar\"\n"
36738 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
36739 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
36740 " Path \"/dev/sdb2\" (* not a device *)\n"
36745 #: ../src/guestfs.pod:899
36747 "As you can see there are still problems to resolve even with this "
36748 "representation. Also consider how it might work in guestfish."
36752 #: ../src/guestfs.pod:904
36753 msgid "KEYS AND PASSPHRASES"
36757 #: ../src/guestfs.pod:906
36759 "Certain libguestfs calls take a parameter that contains sensitive key "
36760 "material, passed in as a C string."
36764 #: ../src/guestfs.pod:909
36766 "In the future we would hope to change the libguestfs implementation so that "
36767 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
36768 "swap. However this is I<not> done at the moment, because of the complexity "
36769 "of such an implementation."
36773 #: ../src/guestfs.pod:914
36775 "Therefore you should be aware that any key parameter you pass to libguestfs "
36776 "might end up being written out to the swap partition. If this is a concern, "
36777 "scrub the swap partition or don't use libguestfs on encrypted devices."
36781 #: ../src/guestfs.pod:919
36782 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
36786 #: ../src/guestfs.pod:921
36788 "All high-level libguestfs actions are synchronous. If you want to use "
36789 "libguestfs asynchronously then you must create a thread."
36793 #: ../src/guestfs.pod:924
36795 "Only use the handle from a single thread. Either use the handle exclusively "
36796 "from one thread, or provide your own mutex so that two threads cannot issue "
36797 "calls on the same handle at the same time."
36801 #: ../src/guestfs.pod:928
36803 "See the graphical program guestfs-browser for one possible architecture for "
36804 "multithreaded programs using libvirt and libguestfs."
36808 #: ../src/guestfs.pod:931
36813 #: ../src/guestfs.pod:933
36815 "Libguestfs needs a supermin appliance, which it finds by looking along an "
36820 #: ../src/guestfs.pod:936
36822 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
36823 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
36827 #: ../src/guestfs.pod:939
36829 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
36830 "to change the directories that libguestfs will search in. The value is a "
36831 "colon-separated list of paths. The current directory is I<not> searched "
36832 "unless the path contains an empty element or C<.>. For example "
36833 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
36834 "then C</usr/lib/guestfs>."
36838 #: ../src/guestfs.pod:946
36839 msgid "QEMU WRAPPERS"
36843 #: ../src/guestfs.pod:948
36845 "If you want to compile your own qemu, run qemu from a non-standard location, "
36846 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
36851 #: ../src/guestfs.pod:952
36853 "There is one important rule to remember: you I<must C<exec qemu>> as the "
36854 "last command in the shell script (so that qemu replaces the shell and "
36855 "becomes the direct child of the libguestfs-using program). If you don't do "
36856 "this, then the qemu process won't be cleaned up correctly."
36860 #: ../src/guestfs.pod:957
36862 "Here is an example of a wrapper, where I have built my own copy of qemu from "
36867 #: ../src/guestfs.pod:960
36871 " qemudir=/home/rjones/d/qemu\n"
36872 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
36877 #: ../src/guestfs.pod:964
36879 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
36880 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
36885 #: ../src/guestfs.pod:968
36888 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
36893 #: ../src/guestfs.pod:970
36895 "Note that libguestfs also calls qemu with the -help and -version options in "
36896 "order to determine features."
36900 #: ../src/guestfs.pod:973
36902 "Wrappers can also be used to edit the options passed to qemu. In the "
36903 "following example, the C<-machine ...> option (C<-machine> and the following "
36904 "argument) are removed from the command line and replaced with C<-machine pc,"
36905 "accel=tcg>. The while loop iterates over the options until it finds the "
36906 "right one to remove, putting the remaining options into the C<args> array."
36910 #: ../src/guestfs.pod:982
36914 " while [ $# -gt 0 ]; do\n"
36915 " case \"$1\" in\n"
36919 " args[i]=\"$1\"\n"
36928 #: ../src/guestfs.pod:994
36931 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
36936 #: ../src/guestfs.pod:996
36937 msgid "ATTACHING TO RUNNING DAEMONS"
36941 #: ../src/guestfs.pod:998
36943 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
36944 "babies. Use with caution."
36948 #: ../src/guestfs.pod:1001
36950 "I<Note (2):> This section explains how to attach to a running daemon from a "
36951 "low level perspective. For most users, simply using virt tools such as "
36952 "L<guestfish(1)> with the I<--live> option will \"just work\"."
36956 #: ../src/guestfs.pod:1005
36957 msgid "Using guestfs_set_attach_method"
36961 #: ../src/guestfs.pod:1007
36963 "By calling L</guestfs_set_attach_method> you can change how the library "
36964 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
36965 "ARCHITECTURE> for some background)."
36969 #: ../src/guestfs.pod:1011
36971 "The normal attach method is C<appliance>, where a small appliance is created "
36972 "containing the daemon, and then the library connects to this."
36976 #: ../src/guestfs.pod:1014
36978 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
36979 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
36980 "daemon over the Unix domain socket."
36984 #: ../src/guestfs.pod:1018
36986 "The normal use for this is to connect to a running virtual machine that "
36987 "contains a C<guestfsd> daemon, and send commands so you can read and write "
36988 "files inside the live virtual machine."
36992 #: ../src/guestfs.pod:1022
36993 msgid "Using guestfs_add_domain with live flag"
36997 #: ../src/guestfs.pod:1024
36999 "L</guestfs_add_domain> provides some help for getting the correct attach "
37000 "method. If you pass the C<live> option to this function, then (if the "
37001 "virtual machine is running) it will examine the libvirt XML looking for a "
37002 "virtio-serial channel to connect to:"
37006 #: ../src/guestfs.pod:1030
37013 " <channel type='unix'>\n"
37014 " <source mode='bind' path='/path/to/socket'/>\n"
37015 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
37024 #: ../src/guestfs.pod:1042
37026 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
37027 "method to C<unix:/path/to/socket>."
37031 #: ../src/guestfs.pod:1045
37033 "Some of the libguestfs tools (including guestfish) support a I<--live> "
37034 "option which is passed through to L</guestfs_add_domain> thus allowing you "
37035 "to attach to and modify live virtual machines."
37039 #: ../src/guestfs.pod:1049
37041 "The virtual machine needs to have been set up beforehand so that it has the "
37042 "virtio-serial channel and so that guestfsd is running inside it."
37046 #: ../src/guestfs.pod:1053
37047 msgid "ABI GUARANTEE"
37051 #: ../src/guestfs.pod:1055
37053 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
37054 "actions as outlined in this section. Although we will deprecate some "
37055 "actions, for example if they get replaced by newer calls, we will keep the "
37056 "old actions forever. This allows you the developer to program in confidence "
37057 "against the libguestfs API."
37061 #: ../src/guestfs.pod:1061
37062 msgid "BLOCK DEVICE NAMING"
37066 #: ../src/guestfs.pod:1063
37068 "In the kernel there is now quite a profusion of schemata for naming block "
37069 "devices (in this context, by I<block device> I mean a physical or virtual "
37070 "hard drive). The original Linux IDE driver used names starting with C</dev/"
37071 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
37072 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
37073 "for the old IDE driver (particularly for SATA devices) those devices also "
37074 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
37075 "paravirtualized drivers. This has created several different naming systems, "
37076 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
37080 #: ../src/guestfs.pod:1075
37082 "As discussed above, libguestfs uses a qemu appliance running an embedded "
37083 "Linux kernel to access block devices. We can run a variety of appliances "
37084 "based on a variety of Linux kernels."
37088 #: ../src/guestfs.pod:1079
37090 "This causes a problem for libguestfs because many API calls use device or "
37091 "partition names. Working scripts and the recipe (example) scripts that we "
37092 "make available over the internet could fail if the naming scheme changes."
37096 #: ../src/guestfs.pod:1084
37098 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
37099 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
37100 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
37101 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
37105 #: ../src/guestfs.pod:1090
37107 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
37108 "L</guestfs_list_partitions> and similar calls return the true names of the "
37109 "devices and partitions as known to the appliance."
37113 #: ../src/guestfs.pod:1095
37114 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
37118 #: ../src/guestfs.pod:1097
37120 "Usually this translation is transparent. However in some (very rare) cases "
37121 "you may need to know the exact algorithm. Such cases include where you use "
37122 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
37123 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
37127 #: ../src/guestfs.pod:1103
37129 "The algorithm is applied only to I<parameters> which are known to be either "
37130 "device or partition names. Return values from functions such as L</"
37131 "guestfs_list_devices> are never changed."
37135 #: ../src/guestfs.pod:1111
37136 msgid "Is the string a parameter which is a device or partition name?"
37140 #: ../src/guestfs.pod:1115
37141 msgid "Does the string begin with C</dev/sd>?"
37145 #: ../src/guestfs.pod:1119
37147 "Does the named device exist? If so, we use that device. However if I<not> "
37148 "then we continue with this algorithm."
37152 #: ../src/guestfs.pod:1124
37153 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
37157 #: ../src/guestfs.pod:1126
37158 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
37162 #: ../src/guestfs.pod:1128
37163 msgid "If that named device exists, use it. If not, continue."
37167 #: ../src/guestfs.pod:1132
37168 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
37172 #: ../src/guestfs.pod:1134
37173 msgid "If that named device exists, use it. If not, return an error."
37177 #: ../src/guestfs.pod:1138
37178 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
37182 #: ../src/guestfs.pod:1140
37184 "Although the standard naming scheme and automatic translation is useful for "
37185 "simple programs and guestfish scripts, for larger programs it is best not to "
37186 "rely on this mechanism."
37190 #: ../src/guestfs.pod:1144
37192 "Where possible for maximum future portability programs using libguestfs "
37193 "should use these future-proof techniques:"
37197 #: ../src/guestfs.pod:1151
37199 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
37200 "device names, and then use those names directly."
37204 #: ../src/guestfs.pod:1154
37206 "Since those device names exist by definition, they will never be translated."
37210 #: ../src/guestfs.pod:1159
37212 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
37213 "filesystem labels."
37217 #: ../src/guestfs.pod:1166
37219 "This section discusses security implications of using libguestfs, "
37220 "particularly with untrusted or malicious guests or disk images."
37224 #: ../src/guestfs.pod:1169
37225 msgid "GENERAL SECURITY CONSIDERATIONS"
37229 #: ../src/guestfs.pod:1171
37231 "Be careful with any files or data that you download from a guest (by "
37232 "\"download\" we mean not just the L</guestfs_download> command but any "
37233 "command that reads files, filenames, directories or anything else from a "
37234 "disk image). An attacker could manipulate the data to fool your program "
37235 "into doing the wrong thing. Consider cases such as:"
37239 #: ../src/guestfs.pod:1181
37240 msgid "the data (file etc) not being present"
37244 #: ../src/guestfs.pod:1185
37245 msgid "being present but empty"
37249 #: ../src/guestfs.pod:1189
37250 msgid "being much larger than normal"
37254 #: ../src/guestfs.pod:1193
37255 msgid "containing arbitrary 8 bit data"
37259 #: ../src/guestfs.pod:1197
37260 msgid "being in an unexpected character encoding"
37264 #: ../src/guestfs.pod:1201
37265 msgid "containing homoglyphs."
37269 #: ../src/guestfs.pod:1205
37270 msgid "SECURITY OF MOUNTING FILESYSTEMS"
37274 #: ../src/guestfs.pod:1207
37276 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
37277 "(VFS) module can sometimes be escalated into exploits by deliberately "
37278 "creating a malicious, malformed filesystem. These exploits are very severe "
37279 "for two reasons. Firstly there are very many filesystem drivers in the "
37280 "kernel, and many of them are infrequently used and not much developer "
37281 "attention has been paid to the code. Linux userspace helps potential "
37282 "crackers by detecting the filesystem type and automatically choosing the "
37283 "right VFS driver, even if that filesystem type is obscure or unexpected for "
37284 "the administrator. Secondly, a kernel-level exploit is like a local root "
37285 "exploit (worse in some ways), giving immediate and total access to the "
37286 "system right down to the hardware level."
37290 #: ../src/guestfs.pod:1220
37292 "That explains why you should never mount a filesystem from an untrusted "
37293 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
37294 "inside a qemu virtual machine, usually running as a non-root user. The "
37295 "attacker would need to write a filesystem which first exploited the kernel, "
37296 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
37297 "the libguestfs protocol, and finally to be as serious as the host kernel "
37298 "exploit it would need to escalate its privileges to root. This multi-step "
37299 "escalation, performed by a static piece of data, is thought to be extremely "
37300 "hard to do, although we never say 'never' about security issues."
37304 #: ../src/guestfs.pod:1231
37306 "In any case callers can reduce the attack surface by forcing the filesystem "
37307 "type when mounting (use L</guestfs_mount_vfs>)."
37311 #: ../src/guestfs.pod:1234
37312 msgid "PROTOCOL SECURITY"
37316 #: ../src/guestfs.pod:1236
37318 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
37319 "defined upper message size. However a program that uses libguestfs must "
37320 "also take care - for example you can write a program that downloads a binary "
37321 "from a disk image and executes it locally, and no amount of protocol "
37322 "security will save you from the consequences."
37326 #: ../src/guestfs.pod:1242
37327 msgid "INSPECTION SECURITY"
37331 #: ../src/guestfs.pod:1244
37333 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
37334 "directly from the guest, and these could contain any 8 bit data. Callers "
37335 "should be careful to escape these before printing them to a structured file "
37336 "(for example, use HTML escaping if creating a web page)."
37340 #: ../src/guestfs.pod:1250
37342 "Guest configuration may be altered in unusual ways by the administrator of "
37343 "the virtual machine, and may not reflect reality (particularly for untrusted "
37344 "or actively malicious guests). For example we parse the hostname from "
37345 "configuration files like C</etc/sysconfig/network> that we find in the "
37346 "guest, but the guest administrator can easily manipulate these files to "
37347 "provide the wrong hostname."
37351 #: ../src/guestfs.pod:1258
37353 "The inspection API parses guest configuration using two external libraries: "
37354 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
37355 "designed to be robust in the face of malicious data, although denial of "
37356 "service attacks are still possible, for example with oversized configuration "
37361 #: ../src/guestfs.pod:1264
37362 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
37366 #: ../src/guestfs.pod:1266
37368 "Be very cautious about running commands from the guest. By running a "
37369 "command in the guest, you are giving CPU time to a binary that you do not "
37370 "control, under the same user account as the library, albeit wrapped in qemu "
37371 "virtualization. More information and alternatives can be found in the "
37372 "section L</RUNNING COMMANDS>."
37376 #: ../src/guestfs.pod:1272
37377 msgid "CVE-2010-3851"
37381 #: ../src/guestfs.pod:1274
37382 msgid "https://bugzilla.redhat.com/642934"
37386 #: ../src/guestfs.pod:1276
37388 "This security bug concerns the automatic disk format detection that qemu "
37389 "does on disk images."
37393 #: ../src/guestfs.pod:1279
37395 "A raw disk image is just the raw bytes, there is no header. Other disk "
37396 "images like qcow2 contain a special header. Qemu deals with this by looking "
37397 "for one of the known headers, and if none is found then assuming the disk "
37398 "image must be raw."
37402 #: ../src/guestfs.pod:1284
37404 "This allows a guest which has been given a raw disk image to write some "
37405 "other header. At next boot (or when the disk image is accessed by "
37406 "libguestfs) qemu would do autodetection and think the disk image format was, "
37407 "say, qcow2 based on the header written by the guest."
37411 #: ../src/guestfs.pod:1289
37413 "This in itself would not be a problem, but qcow2 offers many features, one "
37414 "of which is to allow a disk image to refer to another image (called the "
37415 "\"backing disk\"). It does this by placing the path to the backing disk "
37416 "into the qcow2 header. This path is not validated and could point to any "
37417 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
37418 "\"holes\" in the qcow2 disk image, which of course is completely under the "
37419 "control of the attacker."
37423 #: ../src/guestfs.pod:1297
37425 "In libguestfs this is rather hard to exploit except under two circumstances:"
37429 #: ../src/guestfs.pod:1304
37430 msgid "You have enabled the network or have opened the disk in write mode."
37434 #: ../src/guestfs.pod:1308
37436 "You are also running untrusted code from the guest (see L</RUNNING "
37441 #: ../src/guestfs.pod:1313
37443 "The way to avoid this is to specify the expected disk format when adding "
37444 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
37445 "should always do this if the disk is raw format, and it's a good idea for "
37450 #: ../src/guestfs.pod:1318
37452 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
37453 "format is fetched from libvirt and passed through."
37457 #: ../src/guestfs.pod:1321
37459 "For libguestfs tools, use the I<--format> command line parameter as "
37464 #: ../src/guestfs.pod:1324
37465 msgid "CONNECTION MANAGEMENT"
37469 #: ../src/guestfs.pod:1326
37470 msgid "guestfs_h *"
37474 #: ../src/guestfs.pod:1328
37476 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
37477 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
37478 "handle and release all resources used."
37482 #: ../src/guestfs.pod:1332
37484 "For information on using multiple handles and threads, see the section L</"
37485 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
37489 #: ../src/guestfs.pod:1335
37490 msgid "guestfs_create"
37494 #: ../src/guestfs.pod:1337
37497 " guestfs_h *guestfs_create (void);\n"
37502 #: ../src/guestfs.pod:1339
37503 msgid "Create a connection handle."
37507 #: ../src/guestfs.pod:1341
37509 "On success this returns a non-NULL pointer to a handle. On error it returns "
37514 #: ../src/guestfs.pod:1344
37516 "You have to \"configure\" the handle after creating it. This includes "
37517 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
37518 "handle at least once."
37522 #: ../src/guestfs.pod:1348
37523 msgid "After configuring the handle, you have to call L</guestfs_launch>."
37527 #: ../src/guestfs.pod:1350
37529 "You may also want to configure error handling for the handle. See the L</"
37530 "ERROR HANDLING> section below."
37534 #: ../src/guestfs.pod:1353
37535 msgid "guestfs_close"
37539 #: ../src/guestfs.pod:1355
37542 " void guestfs_close (guestfs_h *g);\n"
37547 #: ../src/guestfs.pod:1357
37548 msgid "This closes the connection handle and frees up all resources used."
37552 #: ../src/guestfs.pod:1359
37554 "If autosync was set on the handle and the handle was launched, then this "
37555 "implicitly calls various functions to unmount filesystems and sync the "
37556 "disk. See L</guestfs_set_autosync> for more details."
37560 #: ../src/guestfs.pod:1363
37561 msgid "If a close callback was set on the handle, then it is called."
37565 #: ../src/guestfs.pod:1365
37566 msgid "ERROR HANDLING"
37570 #: ../src/guestfs.pod:1367
37572 "API functions can return errors. For example, almost all functions that "
37573 "return C<int> will return C<-1> to indicate an error."
37577 #: ../src/guestfs.pod:1370
37579 "Additional information is available for errors: an error message string and "
37580 "optionally an error number (errno) if the thing that failed was a system "
37585 #: ../src/guestfs.pod:1374
37587 "You can get at the additional information about the last error on the handle "
37588 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
37589 "up an error handler with L</guestfs_set_error_handler>."
37593 #: ../src/guestfs.pod:1379
37595 "When the handle is created, a default error handler is installed which "
37596 "prints the error message string to C<stderr>. For small short-running "
37597 "command line programs it is sufficient to do:"
37601 #: ../src/guestfs.pod:1383
37604 " if (guestfs_launch (g) == -1)\n"
37605 " exit (EXIT_FAILURE);\n"
37610 #: ../src/guestfs.pod:1386
37612 "since the default error handler will ensure that an error message has been "
37613 "printed to C<stderr> before the program exits."
37617 #: ../src/guestfs.pod:1389
37619 "For other programs the caller will almost certainly want to install an "
37620 "alternate error handler or do error handling in-line like this:"
37624 #: ../src/guestfs.pod:1392
37627 " /* This disables the default behaviour of printing errors\n"
37629 " guestfs_set_error_handler (g, NULL, NULL);\n"
37634 #: ../src/guestfs.pod:1396
37637 " if (guestfs_launch (g) == -1) {\n"
37638 " /* Examine the error message and print it etc. */\n"
37639 " char *msg = guestfs_last_error (g);\n"
37640 " int errnum = guestfs_last_errno (g);\n"
37641 " fprintf (stderr, \"%s\", msg);\n"
37642 " if (errnum != 0)\n"
37643 " fprintf (stderr, \": %s\", strerror (errnum));\n"
37644 " fprintf (stderr, \"\\n\");\n"
37651 #: ../src/guestfs.pod:1407
37653 "Out of memory errors are handled differently. The default action is to call "
37654 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
37655 "guestfs_set_out_of_memory_handler>."
37659 #: ../src/guestfs.pod:1411
37661 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
37662 "because there is no handle if this happens there is no way to get additional "
37663 "error information. However L</guestfs_create> is supposed to be a "
37664 "lightweight operation which can only fail because of insufficient memory (it "
37665 "returns NULL in this case)."
37669 #: ../src/guestfs.pod:1417
37670 msgid "guestfs_last_error"
37674 #: ../src/guestfs.pod:1419
37677 " const char *guestfs_last_error (guestfs_h *g);\n"
37682 #: ../src/guestfs.pod:1421
37684 "This returns the last error message that happened on C<g>. If there has not "
37685 "been an error since the handle was created, then this returns C<NULL>."
37689 #: ../src/guestfs.pod:1425
37691 "The lifetime of the returned string is until the next error occurs, or L</"
37692 "guestfs_close> is called."
37696 #: ../src/guestfs.pod:1428
37697 msgid "guestfs_last_errno"
37701 #: ../src/guestfs.pod:1430
37704 " int guestfs_last_errno (guestfs_h *g);\n"
37709 #: ../src/guestfs.pod:1432
37710 msgid "This returns the last error number (errno) that happened on C<g>."
37714 #: ../src/guestfs.pod:1434
37715 msgid "If successful, an errno integer not equal to zero is returned."
37719 #: ../src/guestfs.pod:1436
37721 "If no error, this returns 0. This call can return 0 in three situations:"
37725 #: ../src/guestfs.pod:1443
37726 msgid "There has not been any error on the handle."
37730 #: ../src/guestfs.pod:1447
37732 "There has been an error but the errno was meaningless. This corresponds to "
37733 "the case where the error did not come from a failed system call, but for "
37734 "some other reason."
37738 #: ../src/guestfs.pod:1453
37740 "There was an error from a failed system call, but for some reason the errno "
37741 "was not captured and returned. This usually indicates a bug in libguestfs."
37745 #: ../src/guestfs.pod:1459
37747 "Libguestfs tries to convert the errno from inside the applicance into a "
37748 "corresponding errno for the caller (not entirely trivial: the appliance "
37749 "might be running a completely different operating system from the library "
37750 "and error numbers are not standardized across Un*xen). If this could not be "
37751 "done, then the error is translated to C<EINVAL>. In practice this should "
37752 "only happen in very rare circumstances."
37756 #: ../src/guestfs.pod:1467
37757 msgid "guestfs_set_error_handler"
37761 #: ../src/guestfs.pod:1469
37764 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
37766 " const char *msg);\n"
37767 " void guestfs_set_error_handler (guestfs_h *g,\n"
37768 " guestfs_error_handler_cb cb,\n"
37769 " void *opaque);\n"
37774 #: ../src/guestfs.pod:1476
37776 "The callback C<cb> will be called if there is an error. The parameters "
37777 "passed to the callback are an opaque data pointer and the error message "
37782 #: ../src/guestfs.pod:1480
37784 "C<errno> is not passed to the callback. To get that the callback must call "
37785 "L</guestfs_last_errno>."
37789 #: ../src/guestfs.pod:1483
37791 "Note that the message string C<msg> is freed as soon as the callback "
37792 "function returns, so if you want to stash it somewhere you must make your "
37797 #: ../src/guestfs.pod:1487
37798 msgid "The default handler prints messages on C<stderr>."
37802 #: ../src/guestfs.pod:1489
37803 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
37807 #: ../src/guestfs.pod:1491
37808 msgid "guestfs_get_error_handler"
37812 #: ../src/guestfs.pod:1493
37815 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
37816 " void **opaque_rtn);\n"
37821 #: ../src/guestfs.pod:1496
37822 msgid "Returns the current error handler callback."
37826 #: ../src/guestfs.pod:1498
37827 msgid "guestfs_set_out_of_memory_handler"
37831 #: ../src/guestfs.pod:1500
37834 " typedef void (*guestfs_abort_cb) (void);\n"
37835 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
37836 " guestfs_abort_cb);\n"
37841 #: ../src/guestfs.pod:1504
37843 "The callback C<cb> will be called if there is an out of memory situation. "
37844 "I<Note this callback must not return>."
37848 #: ../src/guestfs.pod:1507
37849 msgid "The default is to call L<abort(3)>."
37853 #: ../src/guestfs.pod:1509
37855 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
37859 #: ../src/guestfs.pod:1512
37860 msgid "guestfs_get_out_of_memory_handler"
37864 #: ../src/guestfs.pod:1514
37867 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
37872 #: ../src/guestfs.pod:1516
37873 msgid "This returns the current out of memory handler."
37877 #: ../src/guestfs.pod:1518
37882 #: ../src/guestfs.pod:1522
37887 #: ../src/guestfs.pod:1524
37892 #: ../src/guestfs.pod:1526
37893 msgid "AVAILABILITY"
37897 #: ../src/guestfs.pod:1528
37898 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
37902 #: ../src/guestfs.pod:1530
37904 "Using L</guestfs_available> you can test availability of the following "
37905 "groups of functions. This test queries the appliance to see if the "
37906 "appliance you are currently using supports the functionality."
37910 #: ../src/guestfs.pod:1535
37911 msgid "@AVAILABILITY@"
37915 #: ../src/guestfs.pod:1537
37916 msgid "GUESTFISH supported COMMAND"
37920 #: ../src/guestfs.pod:1539
37922 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
37923 "prints out the available groups and whether they are supported by this build "
37924 "of libguestfs. Note however that you have to do C<run> first."
37928 #: ../src/guestfs.pod:1544
37929 msgid "SINGLE CALLS AT COMPILE TIME"
37933 #: ../src/guestfs.pod:1546
37935 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
37936 "function, such as:"
37940 #: ../src/guestfs.pod:1549
37943 " #define LIBGUESTFS_HAVE_DD 1\n"
37948 #: ../src/guestfs.pod:1551
37949 msgid "if L</guestfs_dd> is available."
37953 #: ../src/guestfs.pod:1553
37955 "Before version 1.5.8, if you needed to test whether a single libguestfs "
37956 "function is available at compile time, we recommended using build tools such "
37957 "as autoconf or cmake. For example in autotools you could use:"
37961 #: ../src/guestfs.pod:1558
37964 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
37965 " AC_CHECK_FUNCS([guestfs_dd])\n"
37970 #: ../src/guestfs.pod:1561
37972 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
37977 #: ../src/guestfs.pod:1564
37978 msgid "SINGLE CALLS AT RUN TIME"
37982 #: ../src/guestfs.pod:1566
37984 "Testing at compile time doesn't guarantee that a function really exists in "
37985 "the library. The reason is that you might be dynamically linked against a "
37986 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
37987 "This situation unfortunately results in a segmentation fault, which is a "
37988 "shortcoming of the C dynamic linking system itself."
37992 #: ../src/guestfs.pod:1573
37994 "You can use L<dlopen(3)> to test if a function is available at run time, as "
37995 "in this example program (note that you still need the compile time check as "
38000 #: ../src/guestfs.pod:1577
38003 " #include <stdio.h>\n"
38004 " #include <stdlib.h>\n"
38005 " #include <unistd.h>\n"
38006 " #include <dlfcn.h>\n"
38007 " #include <guestfs.h>\n"
38012 #: ../src/guestfs.pod:1583
38017 " #ifdef LIBGUESTFS_HAVE_DD\n"
38019 " int has_function;\n"
38024 #: ../src/guestfs.pod:1589
38027 " /* Test if the function guestfs_dd is really available. */\n"
38028 " dl = dlopen (NULL, RTLD_LAZY);\n"
38030 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
38031 " exit (EXIT_FAILURE);\n"
38033 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
38039 #: ../src/guestfs.pod:1598
38042 " if (!has_function)\n"
38043 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
38045 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
38046 " /* Now it's safe to call\n"
38047 " guestfs_dd (g, \"foo\", \"bar\");\n"
38051 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
38058 #: ../src/guestfs.pod:1611
38060 "You may think the above is an awful lot of hassle, and it is. There are "
38061 "other ways outside of the C linking system to ensure that this kind of "
38062 "incompatibility never arises, such as using package versioning:"
38066 #: ../src/guestfs.pod:1616
38069 " Requires: libguestfs >= 1.0.80\n"
38074 #: ../src/guestfs.pod:1618
38075 msgid "CALLS WITH OPTIONAL ARGUMENTS"
38079 #: ../src/guestfs.pod:1620
38081 "A recent feature of the API is the introduction of calls which take optional "
38082 "arguments. In C these are declared 3 ways. The main way is as a call which "
38083 "takes variable arguments (ie. C<...>), as in this example:"
38087 #: ../src/guestfs.pod:1625
38090 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
38095 #: ../src/guestfs.pod:1627
38097 "Call this with a list of optional arguments, terminated by C<-1>. So to "
38098 "call with no optional arguments specified:"
38102 #: ../src/guestfs.pod:1630
38105 " guestfs_add_drive_opts (g, filename, -1);\n"
38110 #: ../src/guestfs.pod:1632
38111 msgid "With a single optional argument:"
38115 #: ../src/guestfs.pod:1634
38118 " guestfs_add_drive_opts (g, filename,\n"
38119 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
38125 #: ../src/guestfs.pod:1638
38130 #: ../src/guestfs.pod:1640
38133 " guestfs_add_drive_opts (g, filename,\n"
38134 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
38135 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
38141 #: ../src/guestfs.pod:1645
38143 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
38148 #: ../src/guestfs.pod:1648
38149 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
38153 #: ../src/guestfs.pod:1650
38155 "The second variant has the same name with the suffix C<_va>, which works the "
38156 "same way but takes a C<va_list>. See the C manual for details. For the "
38157 "example function, this is declared:"
38161 #: ../src/guestfs.pod:1654
38164 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
38165 " va_list args);\n"
38170 #: ../src/guestfs.pod:1657
38171 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
38175 #: ../src/guestfs.pod:1659
38177 "The third variant is useful where you need to construct these calls. You "
38178 "pass in a structure where you fill in the optional fields. The structure "
38179 "has a bitmask as the first element which you must set to indicate which "
38180 "fields you have filled in. For our example function the structure and call "
38185 #: ../src/guestfs.pod:1665
38188 " struct guestfs_add_drive_opts_argv {\n"
38189 " uint64_t bitmask;\n"
38191 " const char *format;\n"
38194 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
38195 " const struct guestfs_add_drive_opts_argv *optargs);\n"
38200 #: ../src/guestfs.pod:1674
38201 msgid "You could call it like this:"
38205 #: ../src/guestfs.pod:1676
38208 " struct guestfs_add_drive_opts_argv optargs = {\n"
38209 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
38210 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
38211 " .readonly = 1,\n"
38212 " .format = \"qcow2\"\n"
38218 #: ../src/guestfs.pod:1683
38221 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
38226 #: ../src/guestfs.pod:1691
38227 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
38231 #: ../src/guestfs.pod:1696
38232 msgid "You do not need to fill in all fields of the structure."
38236 #: ../src/guestfs.pod:1700
38238 "There must be a one-to-one correspondence between fields of the structure "
38239 "that are filled in, and bits set in the bitmask."
38243 #: ../src/guestfs.pod:1705
38244 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
38248 #: ../src/guestfs.pod:1707
38250 "In other languages, optional arguments are expressed in the way that is "
38251 "natural for that language. We refer you to the language-specific "
38252 "documentation for more details on that."
38256 #: ../src/guestfs.pod:1711
38257 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
38261 #: ../src/guestfs.pod:1713
38262 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
38266 #: ../src/guestfs.pod:1715
38268 "B<Note:> This section documents the generic event mechanism introduced in "
38269 "libguestfs 1.10, which you should use in new code if possible. The old "
38270 "functions C<guestfs_set_log_message_callback>, "
38271 "C<guestfs_set_subprocess_quit_callback>, "
38272 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
38273 "C<guestfs_set_progress_callback> are no longer documented in this manual "
38274 "page. Because of the ABI guarantee, the old functions continue to work."
38278 #: ../src/guestfs.pod:1724
38280 "Handles generate events when certain things happen, such as log messages "
38281 "being generated, progress messages during long-running operations, or the "
38282 "handle being closed. The API calls described below let you register a "
38283 "callback to be called when events happen. You can register multiple "
38284 "callbacks (for the same, different or overlapping sets of events), and "
38285 "individually remove callbacks. If callbacks are not removed, then they "
38286 "remain in force until the handle is closed."
38290 #: ../src/guestfs.pod:1732
38292 "In the current implementation, events are only generated synchronously: that "
38293 "means that events (and hence callbacks) can only happen while you are in the "
38294 "middle of making another libguestfs call. The callback is called in the "
38299 #: ../src/guestfs.pod:1737
38301 "Events may contain a payload, usually nothing (void), an array of 64 bit "
38302 "unsigned integers, or a message buffer. Payloads are discussed later on."
38306 #: ../src/guestfs.pod:1741
38307 msgid "CLASSES OF EVENTS"
38311 #: ../src/guestfs.pod:1745
38312 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
38316 #: ../src/guestfs.pod:1748
38318 "The callback function will be called while the handle is being closed "
38319 "(synchronously from L</guestfs_close>)."
38323 #: ../src/guestfs.pod:1751
38325 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
38326 "handles that are open when the program exits. This means that this callback "
38327 "might be called indirectly from L<exit(3)>, which can cause unexpected "
38328 "problems in higher-level languages (eg. if your HLL interpreter has already "
38329 "been cleaned up by the time this is called, and if your callback then jumps "
38330 "into some HLL function)."
38334 #: ../src/guestfs.pod:1758
38336 "If no callback is registered: the handle is closed without any callback "
38341 #: ../src/guestfs.pod:1761
38342 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
38346 #: ../src/guestfs.pod:1764
38348 "The callback function will be called when the child process quits, either "
38349 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
38350 "corresponds to a transition from any state to the CONFIG state)."
38354 #: ../src/guestfs.pod:1768 ../src/guestfs.pod:1777 ../src/guestfs.pod:1894
38355 msgid "If no callback is registered: the event is ignored."
38359 #: ../src/guestfs.pod:1770
38360 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
38364 #: ../src/guestfs.pod:1773
38366 "The callback function will be called when the child process becomes ready "
38367 "first time after it has been launched. (This corresponds to a transition "
38368 "from LAUNCHING to the READY state)."
38372 #: ../src/guestfs.pod:1779
38373 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
38377 #: ../src/guestfs.pod:1782
38379 "Some long-running operations can generate progress messages. If this "
38380 "callback is registered, then it will be called each time a progress message "
38381 "is generated (usually two seconds after the operation started, and three "
38382 "times per second thereafter until it completes, although the frequency may "
38383 "change in future versions)."
38387 #: ../src/guestfs.pod:1788
38389 "The callback receives in the payload four unsigned 64 bit numbers which are "
38390 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
38394 #: ../src/guestfs.pod:1791
38396 "The units of C<total> are not defined, although for some operations C<total> "
38397 "may relate in some way to the amount of data to be transferred (eg. in bytes "
38398 "or megabytes), and C<position> may be the portion which has been transferred."
38402 #: ../src/guestfs.pod:1796
38403 msgid "The only defined and stable parts of the API are:"
38407 #: ../src/guestfs.pod:1802
38409 "The callback can display to the user some type of progress bar or indicator "
38410 "which shows the ratio of C<position>:C<total>."
38414 #: ../src/guestfs.pod:1807
38415 msgid "0 E<lt>= C<position> E<lt>= C<total>"
38419 #: ../src/guestfs.pod:1811
38421 "If any progress notification is sent during a call, then a final progress "
38422 "notification is always sent when C<position> = C<total> (I<unless> the call "
38423 "fails with an error)."
38427 #: ../src/guestfs.pod:1815
38429 "This is to simplify caller code, so callers can easily set the progress "
38430 "indicator to \"100%\" at the end of the operation, without requiring special "
38431 "code to detect this case."
38435 #: ../src/guestfs.pod:1821
38437 "For some calls we are unable to estimate the progress of the call, but we "
38438 "can still generate progress messages to indicate activity. This is known as "
38439 "\"pulse mode\", and is directly supported by certain progress bar "
38440 "implementations (eg. GtkProgressBar)."
38444 #: ../src/guestfs.pod:1826
38446 "For these calls, zero or more progress messages are generated with "
38447 "C<position = 0> and C<total = 1>, followed by a final message with "
38448 "C<position = total = 1>."
38452 #: ../src/guestfs.pod:1830
38454 "As noted above, if the call fails with an error then the final message may "
38455 "not be generated."
38459 #: ../src/guestfs.pod:1835
38461 "The callback also receives the procedure number (C<proc_nr>) and serial "
38462 "number (C<serial>) of the call. These are only useful for debugging "
38463 "protocol issues, and the callback can normally ignore them. The callback "
38464 "may want to print these numbers in error messages or debugging messages."
38468 #: ../src/guestfs.pod:1841
38469 msgid "If no callback is registered: progress messages are discarded."
38473 #: ../src/guestfs.pod:1843
38474 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
38478 #: ../src/guestfs.pod:1846
38480 "The callback function is called whenever a log message is generated by qemu, "
38481 "the appliance kernel, guestfsd (daemon), or utility programs."
38485 #: ../src/guestfs.pod:1849
38487 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
38488 "guestfs_launch>) then additional debug messages are generated."
38492 #: ../src/guestfs.pod:1852 ../src/guestfs.pod:1866
38494 "If no callback is registered: the messages are discarded unless the verbose "
38495 "flag is set in which case they are sent to stderr. You can override the "
38496 "printing of verbose messages to stderr by setting up a callback."
38500 #: ../src/guestfs.pod:1857
38501 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
38505 #: ../src/guestfs.pod:1860
38507 "The callback function is called whenever a log message is generated by the "
38508 "library part of libguestfs."
38512 #: ../src/guestfs.pod:1863
38514 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
38515 "messages are generated."
38519 #: ../src/guestfs.pod:1871
38520 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
38524 #: ../src/guestfs.pod:1874
38526 "The callback function is called whenever a trace message is generated. This "
38527 "only applies if the trace flag (L</guestfs_set_trace>) is set."
38531 #: ../src/guestfs.pod:1877
38533 "If no callback is registered: the messages are sent to stderr. You can "
38534 "override the printing of trace messages to stderr by setting up a callback."
38538 #: ../src/guestfs.pod:1881
38539 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
38543 #: ../src/guestfs.pod:1884
38545 "The callback function is called whenever a libguestfs function is entered."
38549 #: ../src/guestfs.pod:1887
38551 "The payload is a string which contains the name of the function that we are "
38552 "entering (not including C<guestfs_> prefix)."
38556 #: ../src/guestfs.pod:1890
38558 "Note that libguestfs functions can call themselves, so you may see many "
38559 "events from a single call. A few libguestfs functions do not generate this "
38564 #: ../src/guestfs.pod:1898
38565 msgid "guestfs_set_event_callback"
38569 #: ../src/guestfs.pod:1900
38572 " int guestfs_set_event_callback (guestfs_h *g,\n"
38573 " guestfs_event_callback cb,\n"
38574 " uint64_t event_bitmask,\n"
38576 " void *opaque);\n"
38581 #: ../src/guestfs.pod:1906
38583 "This function registers a callback (C<cb>) for all event classes in the "
38584 "C<event_bitmask>."
38588 #: ../src/guestfs.pod:1909
38590 "For example, to register for all log message events, you could call this "
38591 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
38592 "To register a single callback for all possible classes of events, use "
38593 "C<GUESTFS_EVENT_ALL>."
38597 #: ../src/guestfs.pod:1915
38598 msgid "C<flags> should always be passed as 0."
38602 #: ../src/guestfs.pod:1917
38604 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
38605 "it for any purpose."
38609 #: ../src/guestfs.pod:1920
38611 "The return value is the event handle (an integer) which you can use to "
38612 "delete the callback (see below)."
38616 #: ../src/guestfs.pod:1923
38618 "If there is an error, this function returns C<-1>, and sets the error in the "
38619 "handle in the usual way (see L</guestfs_last_error> etc.)"
38623 #: ../src/guestfs.pod:1926
38625 "Callbacks remain in effect until they are deleted, or until the handle is "
38630 #: ../src/guestfs.pod:1929
38632 "In the case where multiple callbacks are registered for a particular event "
38633 "class, all of the callbacks are called. The order in which multiple "
38634 "callbacks are called is not defined."
38638 #: ../src/guestfs.pod:1933
38639 msgid "guestfs_delete_event_callback"
38643 #: ../src/guestfs.pod:1935
38646 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
38651 #: ../src/guestfs.pod:1937
38653 "Delete a callback that was previously registered. C<event_handle> should be "
38654 "the integer that was returned by a previous call to "
38655 "C<guestfs_set_event_callback> on the same handle."
38659 #: ../src/guestfs.pod:1941
38660 msgid "guestfs_event_callback"
38664 #: ../src/guestfs.pod:1943
38667 " typedef void (*guestfs_event_callback) (\n"
38670 " uint64_t event,\n"
38671 " int event_handle,\n"
38673 " const char *buf, size_t buf_len,\n"
38674 " const uint64_t *array, size_t array_len);\n"
38679 #: ../src/guestfs.pod:1952
38681 "This is the type of the event callback function that you have to provide."
38685 #: ../src/guestfs.pod:1955
38687 "The basic parameters are: the handle (C<g>), the opaque user pointer "
38688 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
38689 "handle, and C<flags> which in the current API you should ignore."
38693 #: ../src/guestfs.pod:1959
38695 "The remaining parameters contain the event payload (if any). Each event may "
38696 "contain a payload, which usually relates to the event class, but for future "
38697 "proofing your code should be written to handle any payload for any event "
38702 #: ../src/guestfs.pod:1964
38704 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
38705 "there is no message buffer). Note that this message buffer can contain "
38706 "arbitrary 8 bit data, including NUL bytes."
38710 #: ../src/guestfs.pod:1968
38712 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
38713 "moment this is only used for progress messages."
38717 #: ../src/guestfs.pod:1971
38718 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
38722 #: ../src/guestfs.pod:1973
38724 "One motivation for the generic event API was to allow GUI programs to "
38725 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
38726 "unconditionally to C<stderr>."
38730 #: ../src/guestfs.pod:1977
38732 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
38733 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
38734 "messages are not events; you must capture error messages separately)."
38738 #: ../src/guestfs.pod:1982
38740 "Programs have to set up a callback to capture the classes of events of "
38745 #: ../src/guestfs.pod:1985
38749 " guestfs_set_event_callback\n"
38750 " (g, message_callback,\n"
38751 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
38752 " GUESTFS_EVENT_TRACE,\n"
38753 " 0, NULL) == -1)\n"
38754 " if (eh == -1) {\n"
38755 " // handle error in the usual way\n"
38761 #: ../src/guestfs.pod:1995
38763 "The callback can then direct messages to the appropriate place. In this "
38764 "example, messages are directed to syslog:"
38768 #: ../src/guestfs.pod:1998
38772 " message_callback (\n"
38775 " uint64_t event,\n"
38776 " int event_handle,\n"
38778 " const char *buf, size_t buf_len,\n"
38779 " const uint64_t *array, size_t array_len)\n"
38781 " const int priority = LOG_USER|LOG_INFO;\n"
38782 " if (buf_len > 0)\n"
38783 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
38789 #: ../src/guestfs.pod:2013
38790 msgid "CANCELLING LONG TRANSFERS"
38794 #: ../src/guestfs.pod:2015
38796 "Some operations can be cancelled by the caller while they are in progress. "
38797 "Currently only operations that involve uploading or downloading data can be "
38798 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
38799 "parameters in the generator)."
38803 #: ../src/guestfs.pod:2020
38804 msgid "guestfs_user_cancel"
38808 #: ../src/guestfs.pod:2022
38811 " void guestfs_user_cancel (guestfs_h *g);\n"
38816 #: ../src/guestfs.pod:2024
38818 "C<guestfs_user_cancel> cancels the current upload or download operation."
38822 #: ../src/guestfs.pod:2027
38824 "Unlike most other libguestfs calls, this function is signal safe and thread "
38825 "safe. You can call it from a signal handler or from another thread, without "
38826 "needing to do any locking."
38830 #: ../src/guestfs.pod:2031
38832 "The transfer that was in progress (if there is one) will stop shortly "
38833 "afterwards, and will return an error. The errno (see L</"
38834 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
38835 "out if the operation was cancelled or failed because of another error."
38839 #: ../src/guestfs.pod:2037
38841 "No cleanup is performed: for example, if a file was being uploaded then "
38842 "after cancellation there may be a partially uploaded file. It is the "
38843 "caller's responsibility to clean up if necessary."
38847 #: ../src/guestfs.pod:2041
38848 msgid "There are two common places that you might call C<guestfs_user_cancel>."
38852 #: ../src/guestfs.pod:2043
38854 "In an interactive text-based program, you might call it from a C<SIGINT> "
38855 "signal handler so that pressing C<^C> cancels the current operation. (You "
38856 "also need to call L</guestfs_set_pgroup> so that child processes don't "
38857 "receive the C<^C> signal)."
38861 #: ../src/guestfs.pod:2048
38863 "In a graphical program, when the main thread is displaying a progress bar "
38864 "with a cancel button, wire up the cancel button to call this function."
38868 #: ../src/guestfs.pod:2052
38869 msgid "PRIVATE DATA AREA"
38873 #: ../src/guestfs.pod:2054
38875 "You can attach named pieces of private data to the libguestfs handle, fetch "
38876 "them by name, and walk over them, for the lifetime of the handle. This is "
38877 "called the private data area and is only available from the C API."
38881 #: ../src/guestfs.pod:2059
38882 msgid "To attach a named piece of data, use the following call:"
38886 #: ../src/guestfs.pod:2061
38889 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
38894 #: ../src/guestfs.pod:2063
38896 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
38897 "pointer (which can be C<NULL>). Any previous item with the same key is "
38902 #: ../src/guestfs.pod:2067
38904 "You can use any C<key> you want, but your key should I<not> start with an "
38905 "underscore character. Keys beginning with an underscore character are "
38906 "reserved for internal libguestfs purposes (eg. for implementing language "
38907 "bindings). It is recommended that you prefix the key with some unique "
38908 "string to avoid collisions with other users."
38912 #: ../src/guestfs.pod:2073
38913 msgid "To retrieve the pointer, use:"
38917 #: ../src/guestfs.pod:2075
38920 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
38925 #: ../src/guestfs.pod:2077
38927 "This function returns C<NULL> if either no data is found associated with "
38928 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
38933 #: ../src/guestfs.pod:2081
38935 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
38936 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
38937 "all. In particular, libguestfs does I<not> try to free the data when the "
38938 "handle is closed. If the data must be freed, then the caller must either "
38939 "free it before calling L</guestfs_close> or must set up a close callback to "
38940 "do it (see L</GUESTFS_EVENT_CLOSE>)."
38944 #: ../src/guestfs.pod:2088
38945 msgid "To walk over all entries, use these two functions:"
38949 #: ../src/guestfs.pod:2090
38952 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
38957 #: ../src/guestfs.pod:2092
38960 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
38965 #: ../src/guestfs.pod:2094
38967 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
38968 "not have any particular meaning -- keys are not returned in any defined "
38969 "order). A pointer to the key is returned in C<*key_rtn> and the "
38970 "corresponding data pointer is returned from the function. C<NULL> is "
38971 "returned if there are no keys stored in the handle."
38975 #: ../src/guestfs.pod:2100
38977 "C<guestfs_next_private> returns the next key, pointer pair. The return "
38978 "value of this function is also C<NULL> is there are no further entries to "
38983 #: ../src/guestfs.pod:2104
38984 msgid "Notes about walking over entries:"
38988 #: ../src/guestfs.pod:2110
38990 "You must not call C<guestfs_set_private> while walking over the entries."
38994 #: ../src/guestfs.pod:2115
38996 "The handle maintains an internal iterator which is reset when you call "
38997 "C<guestfs_first_private>. This internal iterator is invalidated when you "
38998 "call C<guestfs_set_private>."
39002 #: ../src/guestfs.pod:2121
39003 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
39007 #: ../src/guestfs.pod:2123
39010 " guestfs_set_private (g, key, NULL);\n"
39015 #: ../src/guestfs.pod:2125
39016 msgid "then that C<key> is not returned when walking."
39020 #: ../src/guestfs.pod:2129
39022 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
39023 "C<guestfs_next_private> or C<guestfs_set_private>."
39027 #: ../src/guestfs.pod:2135
39029 "The following example code shows how to print all keys and data pointers "
39030 "that are associated with the handle C<g>:"
39034 #: ../src/guestfs.pod:2138
39037 " const char *key;\n"
39038 " void *data = guestfs_first_private (g, &key);\n"
39039 " while (data != NULL)\n"
39041 " printf (\"key = %s, data = %p\\n\", key, data);\n"
39042 " data = guestfs_next_private (g, &key);\n"
39048 #: ../src/guestfs.pod:2146
39050 "More commonly you are only interested in keys that begin with an application-"
39051 "specific prefix C<foo_>. Modify the loop like so:"
39055 #: ../src/guestfs.pod:2149
39058 " const char *key;\n"
39059 " void *data = guestfs_first_private (g, &key);\n"
39060 " while (data != NULL)\n"
39062 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
39063 " printf (\"key = %s, data = %p\\n\", key, data);\n"
39064 " data = guestfs_next_private (g, &key);\n"
39070 #: ../src/guestfs.pod:2158
39072 "If you need to modify keys while walking, then you have to jump back to the "
39073 "beginning of the loop. For example, to delete all keys prefixed with "
39078 #: ../src/guestfs.pod:2162
39081 " const char *key;\n"
39084 " data = guestfs_first_private (g, &key);\n"
39085 " while (data != NULL)\n"
39087 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
39089 " guestfs_set_private (g, key, NULL);\n"
39090 " /* note that 'key' pointer is now invalid, and so is\n"
39091 " the internal iterator */\n"
39094 " data = guestfs_next_private (g, &key);\n"
39100 #: ../src/guestfs.pod:2178
39102 "Note that the above loop is guaranteed to terminate because the keys are "
39103 "being deleted, but other manipulations of keys within the loop might not "
39104 "terminate unless you also maintain an indication of which keys have been "
39109 #: ../src/guestfs.pod:2183
39114 #: ../src/guestfs.pod:2185
39116 "The libguestfs C library can be probed using systemtap or DTrace. This is "
39117 "true of any library, not just libguestfs. However libguestfs also contains "
39118 "static markers to help in probing internal operations."
39122 #: ../src/guestfs.pod:2189
39123 msgid "You can list all the static markers by doing:"
39127 #: ../src/guestfs.pod:2191
39130 " stap -l 'process(\"/usr/lib*/libguestfs.so.0\")\n"
39131 " .provider(\"guestfs\").mark(\"*\")'\n"
39136 #: ../src/guestfs.pod:2194
39138 "B<Note:> These static markers are I<not> part of the stable API and may "
39139 "change in future versions."
39143 #: ../src/guestfs.pod:2197
39144 msgid "SYSTEMTAP SCRIPT EXAMPLE"
39148 #: ../src/guestfs.pod:2199
39150 "This script contains examples of displaying both the static markers and some "
39151 "ordinary C entry points:"
39155 #: ../src/guestfs.pod:2202
39163 #: ../src/guestfs.pod:2204
39166 " function display_time () {\n"
39167 " now = gettimeofday_us ();\n"
39170 " delta = now - last;\n"
39176 #: ../src/guestfs.pod:2211
39179 " printf (\"%d (+%d):\", now, delta);\n"
39185 #: ../src/guestfs.pod:2214
39190 " printf (\"ready\\n\");\n"
39196 #: ../src/guestfs.pod:2219
39199 " /* Display all calls to static markers. */\n"
39200 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
39201 " .provider(\"guestfs\").mark(\"*\") ? {\n"
39202 " display_time();\n"
39203 " printf (\"\\t%s %s\\n\", $$name, $$parms);\n"
39209 #: ../src/guestfs.pod:2226
39212 " /* Display all calls to guestfs_mkfs* functions. */\n"
39213 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
39214 " .function(\"guestfs_mkfs*\") ? {\n"
39215 " display_time();\n"
39216 " printf (\"\\t%s %s\\n\", probefunc(), $$parms);\n"
39222 #: ../src/guestfs.pod:2233
39224 "The script above can be saved to C<test.stap> and run using the L<stap(1)> "
39225 "program. Note that you either have to be root, or you have to add yourself "
39226 "to several special stap groups. Consult the systemtap documentation for "
39227 "more information."
39231 #: ../src/guestfs.pod:2238
39234 " # stap /tmp/test.stap\n"
39240 #: ../src/guestfs.pod:2241
39241 msgid "In another terminal, run a guestfish command such as this:"
39245 #: ../src/guestfs.pod:2245
39246 msgid "In the first terminal, stap trace output similar to this is shown:"
39250 #: ../src/guestfs.pod:2247
39253 " 1318248056692655 (+0):\tlaunch_start\n"
39254 " 1318248056692850 (+195): launch_build_appliance_start\n"
39255 " 1318248056818285 (+125435): launch_build_appliance_end\n"
39256 " 1318248056838059 (+19774): launch_run_qemu\n"
39257 " 1318248061071167 (+4233108): launch_end\n"
39258 " 1318248061280324 (+209157): guestfs_mkfs g=0x1024ab0 fstype=0x46116f device=0x1024e60\n"
39263 #: ../src/guestfs.pod:2254 ../src/guestfs.pod:2259
39268 #: ../src/guestfs.pod:2256
39270 "<!-- old anchor for the next section --> <a name="
39271 "\"state_machine_and_low_level_event_api\"/>"
39275 #: ../src/guestfs.pod:2261
39276 msgid "ARCHITECTURE"
39280 #: ../src/guestfs.pod:2263
39282 "Internally, libguestfs is implemented by running an appliance (a special "
39283 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
39284 "process of the main program."
39288 #: ../src/guestfs.pod:2267
39291 " ___________________\n"
39293 " | main program |\n"
39295 " | | child process / appliance\n"
39296 " | | __________________________\n"
39298 " +-------------------+ RPC | +-----------------+ |\n"
39299 " | libguestfs <--------------------> guestfsd | |\n"
39300 " | | | +-----------------+ |\n"
39301 " \\___________________/ | | Linux kernel | |\n"
39302 " | +--^--------------+ |\n"
39303 " \\_________|________________/\n"
39305 " _______v______\n"
39308 " | disk image |\n"
39309 " \\______________/\n"
39314 #: ../src/guestfs.pod:2287
39316 "The library, linked to the main program, creates the child process and hence "
39317 "the appliance in the L</guestfs_launch> function."
39321 #: ../src/guestfs.pod:2290
39323 "Inside the appliance is a Linux kernel and a complete stack of userspace "
39324 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
39325 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
39326 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
39327 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
39328 "attached to the qemu process which translates device access by the "
39329 "appliance's Linux kernel into accesses to the image."
39333 #: ../src/guestfs.pod:2299
39335 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
39336 "Although the disk image you are attached to might also be used by some "
39337 "virtual machine, libguestfs doesn't know or care about this. (But you will "
39338 "care if both libguestfs's qemu process and your virtual machine are trying "
39339 "to update the disk image at the same time, since these usually results in "
39340 "massive disk corruption)."
39344 #: ../src/guestfs.pod:2306
39345 msgid "STATE MACHINE"
39349 #: ../src/guestfs.pod:2308
39350 msgid "libguestfs uses a state machine to model the child process:"
39354 #: ../src/guestfs.pod:2310
39358 " guestfs_create\n"
39366 " / | \\ \\ guestfs_launch\n"
39367 " / | _\\__V______\n"
39369 " / | | LAUNCHING |\n"
39370 " / | \\___________/\n"
39372 " / | guestfs_launch\n"
39374 " ______ / __|____V\n"
39375 " / \\ ------> / \\\n"
39376 " | BUSY | | READY |\n"
39377 " \\______/ <------ \\________/\n"
39382 #: ../src/guestfs.pod:2332
39384 "The normal transitions are (1) CONFIG (when the handle is created, but there "
39385 "is no child process), (2) LAUNCHING (when the child process is booting up), "
39386 "(3) alternating between READY and BUSY as commands are issued to, and "
39387 "carried out by, the child process."
39391 #: ../src/guestfs.pod:2337
39393 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
39394 "asynchronously at any time (eg. due to some internal error), and that causes "
39395 "the state to transition back to CONFIG."
39399 #: ../src/guestfs.pod:2341
39401 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
39402 "issued when in the CONFIG state."
39406 #: ../src/guestfs.pod:2344
39408 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
39409 "L</guestfs_launch> blocks until the child process is READY to accept "
39410 "commands (or until some failure or timeout). L</guestfs_launch> internally "
39411 "moves the state from CONFIG to LAUNCHING while it is running."
39415 #: ../src/guestfs.pod:2350
39417 "API actions such as L</guestfs_mount> can only be issued when in the READY "
39418 "state. These API calls block waiting for the command to be carried out (ie. "
39419 "the state to transition to BUSY and then back to READY). There are no non-"
39420 "blocking versions, and no way to issue more than one command per handle at "
39425 #: ../src/guestfs.pod:2356
39427 "Finally, the child process sends asynchronous messages back to the main "
39428 "program, such as kernel log messages. You can register a callback to "
39429 "receive these messages."
39433 #: ../src/guestfs.pod:2360
39438 #: ../src/guestfs.pod:2362
39439 msgid "APPLIANCE BOOT PROCESS"
39443 #: ../src/guestfs.pod:2364
39445 "This process has evolved and continues to evolve. The description here "
39446 "corresponds only to the current version of libguestfs and is provided for "
39447 "information only."
39451 #: ../src/guestfs.pod:2368
39453 "In order to follow the stages involved below, enable libguestfs debugging "
39454 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
39458 #: ../src/guestfs.pod:2373
39459 msgid "Create the appliance"
39463 #: ../src/guestfs.pod:2375
39465 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
39466 "initrd and the appliance."
39470 #: ../src/guestfs.pod:2378
39472 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
39473 "directory if C<TMPDIR> is set)."
39477 #: ../src/guestfs.pod:2381
39479 "For a complete description of how the appliance is created and cached, read "
39480 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
39484 #: ../src/guestfs.pod:2385
39485 msgid "Start qemu and boot the kernel"
39489 #: ../src/guestfs.pod:2387
39490 msgid "qemu is invoked to boot the kernel."
39494 #: ../src/guestfs.pod:2389
39495 msgid "Run the initrd"
39499 #: ../src/guestfs.pod:2391
39501 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
39502 "appliance. The purpose of the initrd is to load enough kernel modules in "
39503 "order that the appliance itself can be mounted and started."
39507 #: ../src/guestfs.pod:2395
39509 "The initrd is a cpio archive called C</var/tmp/.guestfs-E<lt>UIDE<gt>/"
39514 #: ../src/guestfs.pod:2398
39516 "When the initrd has started you will see messages showing that kernel "
39517 "modules are being loaded, similar to this:"
39521 #: ../src/guestfs.pod:2401
39524 " febootstrap: ext2 mini initrd starting up\n"
39525 " febootstrap: mounting /sys\n"
39526 " febootstrap: internal insmod libcrc32c.ko\n"
39527 " febootstrap: internal insmod crc32c-intel.ko\n"
39532 #: ../src/guestfs.pod:2406
39533 msgid "Find and mount the appliance device"
39537 #: ../src/guestfs.pod:2408
39539 "The appliance is a sparse file containing an ext2 filesystem which contains "
39540 "a familiar (although reduced in size) Linux operating system. It would "
39541 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
39545 #: ../src/guestfs.pod:2412
39547 "The regular disks being inspected by libguestfs are the first devices "
39548 "exposed by qemu (eg. as C</dev/vda>)."
39552 #: ../src/guestfs.pod:2415
39554 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
39555 "there was only one regular disk)."
39559 #: ../src/guestfs.pod:2418
39561 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
39562 "and switch root into the appliance, and run C</init> from the appliance."
39566 #: ../src/guestfs.pod:2422
39567 msgid "If this works successfully you will see messages such as:"
39571 #: ../src/guestfs.pod:2424
39574 " febootstrap: picked /sys/block/vdb/dev as root device\n"
39575 " febootstrap: creating /dev/root as block special 252:16\n"
39576 " febootstrap: mounting new root on /root\n"
39577 " febootstrap: chroot\n"
39578 " Starting /init script ...\n"
39583 #: ../src/guestfs.pod:2430
39585 "Note that C<Starting /init script ...> indicates that the appliance's init "
39586 "script is now running."
39590 #: ../src/guestfs.pod:2433
39591 msgid "Initialize the appliance"
39595 #: ../src/guestfs.pod:2435
39597 "The appliance itself now initializes itself. This involves starting certain "
39598 "processes like C<udev>, possibly printing some debug information, and "
39599 "finally running the daemon (C<guestfsd>)."
39603 #: ../src/guestfs.pod:2439
39608 #: ../src/guestfs.pod:2441
39610 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
39615 #: ../src/guestfs.pod:2444
39618 " verbose daemon enabled\n"
39623 #: ../src/guestfs.pod:2446
39625 "The daemon expects to see a named virtio-serial port exposed by qemu and "
39626 "connected on the other end to the library."
39630 #: ../src/guestfs.pod:2449
39632 "The daemon connects to this port (and hence to the library) and sends a four "
39633 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
39634 "protocol (see below)."
39638 #: ../src/guestfs.pod:2455
39639 msgid "COMMUNICATION PROTOCOL"
39643 #: ../src/guestfs.pod:2457
39645 "Don't rely on using this protocol directly. This section documents how it "
39646 "currently works, but it may change at any time."
39650 #: ../src/guestfs.pod:2460
39652 "The protocol used to talk between the library and the daemon running inside "
39653 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
39654 "1014, RFC 1832, RFC 4506)."
39658 #: ../src/guestfs.pod:2464
39660 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
39661 "this file is automatically generated)."
39665 #: ../src/guestfs.pod:2467
39667 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
39668 "and C<FileOut> parameters, which are handled with very simple request/reply "
39669 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
39670 "parameters, which use the same request and reply messages, but they may also "
39671 "be followed by files sent using a chunked encoding."
39675 #: ../src/guestfs.pod:2474
39676 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
39680 #: ../src/guestfs.pod:2476
39681 msgid "For ordinary functions, the request message is:"
39685 #: ../src/guestfs.pod:2478
39688 " total length (header + arguments,\n"
39689 " but not including the length word itself)\n"
39690 " struct guestfs_message_header (encoded as XDR)\n"
39691 " struct guestfs_<foo>_args (encoded as XDR)\n"
39696 #: ../src/guestfs.pod:2483
39698 "The total length field allows the daemon to allocate a fixed size buffer "
39699 "into which it slurps the rest of the message. As a result, the total length "
39700 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
39701 "effective size of any request is limited to somewhere under this size."
39705 #: ../src/guestfs.pod:2489
39707 "Note also that many functions don't take any arguments, in which case the "
39708 "C<guestfs_I<foo>_args> is completely omitted."
39712 #: ../src/guestfs.pod:2492
39714 "The header contains the procedure number (C<guestfs_proc>) which is how the "
39715 "receiver knows what type of args structure to expect, or none at all."
39719 #: ../src/guestfs.pod:2496
39721 "For functions that take optional arguments, the optional arguments are "
39722 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
39723 "arguments. A bitmask in the header indicates which optional arguments are "
39724 "meaningful. The bitmask is also checked to see if it contains bits set "
39725 "which the daemon does not know about (eg. if more optional arguments were "
39726 "added in a later version of the library), and this causes the call to be "
39731 #: ../src/guestfs.pod:2504
39732 msgid "The reply message for ordinary functions is:"
39736 #: ../src/guestfs.pod:2506
39739 " total length (header + ret,\n"
39740 " but not including the length word itself)\n"
39741 " struct guestfs_message_header (encoded as XDR)\n"
39742 " struct guestfs_<foo>_ret (encoded as XDR)\n"
39747 #: ../src/guestfs.pod:2511
39749 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
39750 "functions that return no formal return values."
39754 #: ../src/guestfs.pod:2514
39756 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
39760 #: ../src/guestfs.pod:2517
39762 "In the case of an error, a flag is set in the header, and the reply message "
39763 "is slightly changed:"
39767 #: ../src/guestfs.pod:2520
39770 " total length (header + error,\n"
39771 " but not including the length word itself)\n"
39772 " struct guestfs_message_header (encoded as XDR)\n"
39773 " struct guestfs_message_error (encoded as XDR)\n"
39778 #: ../src/guestfs.pod:2525
39780 "The C<guestfs_message_error> structure contains the error message as a "
39785 #: ../src/guestfs.pod:2528
39786 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
39790 #: ../src/guestfs.pod:2530
39792 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
39793 "The normal request message is sent (see above). However this is followed by "
39794 "a sequence of file chunks."
39798 #: ../src/guestfs.pod:2534
39801 " total length (header + arguments,\n"
39802 " but not including the length word itself,\n"
39803 " and not including the chunks)\n"
39804 " struct guestfs_message_header (encoded as XDR)\n"
39805 " struct guestfs_<foo>_args (encoded as XDR)\n"
39806 " sequence of chunks for FileIn param #0\n"
39807 " sequence of chunks for FileIn param #1 etc.\n"
39812 #: ../src/guestfs.pod:2542
39813 msgid "The \"sequence of chunks\" is:"
39817 #: ../src/guestfs.pod:2544
39820 " length of chunk (not including length word itself)\n"
39821 " struct guestfs_chunk (encoded as XDR)\n"
39822 " length of chunk\n"
39823 " struct guestfs_chunk (encoded as XDR)\n"
39825 " length of chunk\n"
39826 " struct guestfs_chunk (with data.data_len == 0)\n"
39831 #: ../src/guestfs.pod:2552
39833 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
39834 "is set in the final chunk to indicate either successful completion or early "
39839 #: ../src/guestfs.pod:2556
39841 "At time of writing there are no functions that have more than one FileIn "
39842 "parameter. However this is (theoretically) supported, by sending the "
39843 "sequence of chunks for each FileIn parameter one after another (from left to "
39848 #: ../src/guestfs.pod:2561
39850 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
39851 "transfer. The library does this by sending a chunk with a special flag set "
39852 "to indicate cancellation. When the daemon sees this, it cancels the whole "
39853 "RPC, does I<not> send any reply, and goes back to reading the next request."
39857 #: ../src/guestfs.pod:2567
39859 "The daemon may also cancel. It does this by writing a special word "
39860 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
39861 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
39862 "cancel chunk). The special word is chosen so that even if cancellation "
39863 "happens right at the end of the transfer (after the library has finished "
39864 "writing and has started listening for the reply), the \"spurious\" cancel "
39865 "flag will not be confused with the reply message."
39869 #: ../src/guestfs.pod:2576
39871 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
39872 "limit), and also files where the size is not known in advance (eg. from "
39873 "pipes or sockets). However the chunks are rather small "
39874 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
39875 "to keep much in memory."
39879 #: ../src/guestfs.pod:2582
39880 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
39884 #: ../src/guestfs.pod:2584
39886 "The protocol for FileOut parameters is exactly the same as for FileIn "
39887 "parameters, but with the roles of daemon and library reversed."
39891 #: ../src/guestfs.pod:2587
39894 " total length (header + ret,\n"
39895 " but not including the length word itself,\n"
39896 " and not including the chunks)\n"
39897 " struct guestfs_message_header (encoded as XDR)\n"
39898 " struct guestfs_<foo>_ret (encoded as XDR)\n"
39899 " sequence of chunks for FileOut param #0\n"
39900 " sequence of chunks for FileOut param #1 etc.\n"
39905 #: ../src/guestfs.pod:2595
39906 msgid "INITIAL MESSAGE"
39910 #: ../src/guestfs.pod:2597
39912 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
39913 "which indicates that the guest and daemon is alive. This is what L</"
39914 "guestfs_launch> waits for."
39918 #: ../src/guestfs.pod:2601
39919 msgid "PROGRESS NOTIFICATION MESSAGES"
39923 #: ../src/guestfs.pod:2603
39925 "The daemon may send progress notification messages at any time. These are "
39926 "distinguished by the normal length word being replaced by "
39927 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
39931 #: ../src/guestfs.pod:2607
39933 "The library turns them into progress callbacks (see L</"
39934 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
39939 #: ../src/guestfs.pod:2611
39941 "The daemon self-limits the frequency of progress messages it sends (see "
39942 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
39947 #: ../src/guestfs.pod:2615
39948 msgid "LIBGUESTFS VERSION NUMBERS"
39952 #: ../src/guestfs.pod:2617
39954 "Since April 2010, libguestfs has started to make separate development and "
39955 "stable releases, along with corresponding branches in our git repository. "
39956 "These separate releases can be identified by version number:"
39960 #: ../src/guestfs.pod:2622
39963 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
39964 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
39970 " | `-------- sub-version\n"
39972 " `------ always '1' because we don't change the ABI\n"
39977 #: ../src/guestfs.pod:2633
39978 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
39982 #: ../src/guestfs.pod:2635
39984 "As time passes we cherry pick fixes from the development branch and backport "
39985 "those into the stable branch, the effect being that the stable branch should "
39986 "get more stable and less buggy over time. So the stable releases are ideal "
39987 "for people who don't need new features but would just like the software to "
39992 #: ../src/guestfs.pod:2641
39993 msgid "Our criteria for backporting changes are:"
39997 #: ../src/guestfs.pod:2647
39999 "Documentation changes which don't affect any code are backported unless the "
40000 "documentation refers to a future feature which is not in stable."
40004 #: ../src/guestfs.pod:2653
40006 "Bug fixes which are not controversial, fix obvious problems, and have been "
40007 "well tested are backported."
40011 #: ../src/guestfs.pod:2658
40013 "Simple rearrangements of code which shouldn't affect how it works get "
40014 "backported. This is so that the code in the two branches doesn't get too "
40015 "far out of step, allowing us to backport future fixes more easily."
40019 #: ../src/guestfs.pod:2664
40021 "We I<don't> backport new features, new APIs, new tools etc, except in one "
40022 "exceptional case: the new feature is required in order to implement an "
40023 "important bug fix."
40027 #: ../src/guestfs.pod:2670
40029 "A new stable branch starts when we think the new features in development are "
40030 "substantial and compelling enough over the current stable branch to warrant "
40031 "it. When that happens we create new stable and development versions 1.N.0 "
40032 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
40033 "stable at this point, but by backporting fixes from development, that branch "
40034 "will stabilize over time."
40038 #: ../src/guestfs.pod:2678
40039 msgid "EXTENDING LIBGUESTFS"
40043 #: ../src/guestfs.pod:2680
40044 msgid "ADDING A NEW API ACTION"
40048 #: ../src/guestfs.pod:2682
40050 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
40051 "documentation) are generated, and this makes it easy to extend the "
40056 #: ../src/guestfs.pod:2686
40057 msgid "To add a new API action there are two changes:"
40061 #: ../src/guestfs.pod:2692
40063 "You need to add a description of the call (name, parameters, return type, "
40064 "tests, documentation) to C<generator/generator_actions.ml>."
40068 #: ../src/guestfs.pod:2695
40070 "There are two sorts of API action, depending on whether the call goes "
40071 "through to the daemon in the appliance, or is serviced entirely by the "
40072 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
40073 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
40074 "an example of the latter, since a trace flag is maintained in the handle and "
40075 "all tracing is done on the library side."
40079 #: ../src/guestfs.pod:2703
40081 "Most new actions are of the first type, and get added to the "
40082 "C<daemon_functions> list. Each function has a unique procedure number used "
40083 "in the RPC protocol which is assigned to that action when we publish "
40084 "libguestfs and cannot be reused. Take the latest procedure number and "
40089 #: ../src/guestfs.pod:2709
40091 "For library-only actions of the second type, add to the "
40092 "C<non_daemon_functions> list. Since these functions are serviced by the "
40093 "library and do not travel over the RPC mechanism to the daemon, these "
40094 "functions do not need a procedure number, and so the procedure number is set "
40099 #: ../src/guestfs.pod:2717
40100 msgid "Implement the action (in C):"
40104 #: ../src/guestfs.pod:2719
40106 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
40107 "C<daemon/> directory."
40111 #: ../src/guestfs.pod:2722
40113 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
40114 "(note: double underscore) in the C<src/> directory."
40118 #: ../src/guestfs.pod:2725
40119 msgid "In either case, use another function as an example of what to do."
40123 #: ../src/guestfs.pod:2729
40124 msgid "After making these changes, use C<make> to compile."
40128 #: ../src/guestfs.pod:2731
40130 "Note that you don't need to implement the RPC, language bindings, manual "
40131 "pages or anything else. It's all automatically generated from the OCaml "
40136 #: ../src/guestfs.pod:2735
40137 msgid "ADDING TESTS FOR AN API ACTION"
40141 #: ../src/guestfs.pod:2737
40143 "You can supply zero or as many tests as you want per API call. The tests "
40144 "can either be added as part of the API description (C<generator/"
40145 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
40146 "into C<regressions/>. Note that adding a script to C<regressions/> is "
40147 "slower, so if possible use the first method."
40151 #: ../src/guestfs.pod:2743
40153 "The following describes the test environment used when you add an API test "
40154 "in C<generator_actions.ml>."
40158 #: ../src/guestfs.pod:2746
40159 msgid "The test environment has 4 block devices:"
40163 #: ../src/guestfs.pod:2750
40164 msgid "C</dev/sda> 500MB"
40168 #: ../src/guestfs.pod:2752
40169 msgid "General block device for testing."
40173 #: ../src/guestfs.pod:2754
40174 msgid "C</dev/sdb> 50MB"
40178 #: ../src/guestfs.pod:2756
40180 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
40185 #: ../src/guestfs.pod:2759
40186 msgid "C</dev/sdc> 10MB"
40190 #: ../src/guestfs.pod:2761
40191 msgid "Used in a few tests where two block devices are needed."
40195 #: ../src/guestfs.pod:2763
40196 msgid "C</dev/sdd>"
40200 #: ../src/guestfs.pod:2765
40201 msgid "ISO with fixed content (see C<images/test.iso>)."
40205 #: ../src/guestfs.pod:2769
40207 "To be able to run the tests in a reasonable amount of time, the libguestfs "
40208 "appliance and block devices are reused between tests. So don't try testing "
40209 "L</guestfs_kill_subprocess> :-x"
40213 #: ../src/guestfs.pod:2773
40215 "Each test starts with an initial scenario, selected using one of the "
40216 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
40217 "initialize the disks mentioned above in a particular way as documented in "
40218 "C<generator_types.ml>. You should not assume anything about the previous "
40219 "contents of other disks that are not initialized."
40223 #: ../src/guestfs.pod:2779
40225 "You can add a prerequisite clause to any individual test. This is a run-"
40226 "time check, which, if it fails, causes the test to be skipped. Useful if "
40227 "testing a command which might not work on all variations of libguestfs "
40228 "builds. A test that has prerequisite of C<Always> means to run "
40233 #: ../src/guestfs.pod:2785
40235 "In addition, packagers can skip individual tests by setting environment "
40236 "variables before running C<make check>."
40240 #: ../src/guestfs.pod:2788
40243 " SKIP_TEST_<CMD>_<NUM>=1\n"
40248 #: ../src/guestfs.pod:2790
40249 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
40253 #: ../src/guestfs.pod:2794
40256 " SKIP_TEST_<CMD>=1\n"
40261 #: ../src/guestfs.pod:2796
40262 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
40266 #: ../src/guestfs.pod:2798
40267 msgid "Packagers can run only certain tests by setting for example:"
40271 #: ../src/guestfs.pod:2800
40274 " TEST_ONLY=\"vfs_type zerofree\"\n"
40279 #: ../src/guestfs.pod:2802
40281 "See C<capitests/tests.c> for more details of how these environment variables "
40286 #: ../src/guestfs.pod:2805
40287 msgid "DEBUGGING NEW API ACTIONS"
40291 #: ../src/guestfs.pod:2807
40292 msgid "Test new actions work before submitting them."
40296 #: ../src/guestfs.pod:2809
40297 msgid "You can use guestfish to try out new commands."
40301 #: ../src/guestfs.pod:2811
40303 "Debugging the daemon is a problem because it runs inside a minimal "
40304 "environment. However you can fprintf messages in the daemon to stderr, and "
40305 "they will show up if you use C<guestfish -v>."
40309 #: ../src/guestfs.pod:2815
40310 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
40314 #: ../src/guestfs.pod:2817
40316 "Our C source code generally adheres to some basic code-formatting "
40317 "conventions. The existing code base is not totally consistent on this "
40318 "front, but we do prefer that contributed code be formatted similarly. In "
40319 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
40320 "indentation level, and other than that, follow the K&R style."
40324 #: ../src/guestfs.pod:2823
40326 "If you use Emacs, add the following to one of one of your start-up files (e."
40327 "g., ~/.emacs), to help ensure that you get indentation right:"
40331 #: ../src/guestfs.pod:2826
40334 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
40335 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
40336 " (add-hook 'find-file-hook\n"
40337 " '(lambda () (if (and buffer-file-name\n"
40338 " (string-match \"/libguestfs\\\\>\"\n"
40339 " (buffer-file-name))\n"
40340 " (not (string-equal mode-name \"Change Log\"))\n"
40341 " (not (string-equal mode-name \"Makefile\")))\n"
40342 " (setq indent-tabs-mode nil))))\n"
40347 #: ../src/guestfs.pod:2836
40350 " ;;; When editing C sources in libguestfs, use this style.\n"
40351 " (defun libguestfs-c-mode ()\n"
40352 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
40354 " (c-set-style \"K&R\")\n"
40355 " (setq c-indent-level 2)\n"
40356 " (setq c-basic-offset 2))\n"
40357 " (add-hook 'c-mode-hook\n"
40358 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
40359 " (buffer-file-name))\n"
40360 " (libguestfs-c-mode))))\n"
40365 #: ../src/guestfs.pod:2848
40366 msgid "Enable warnings when compiling (and fix any problems this finds):"
40370 #: ../src/guestfs.pod:2851
40373 " ./configure --enable-gcc-warnings\n"
40378 #: ../src/guestfs.pod:2853
40379 msgid "Useful targets are:"
40383 #: ../src/guestfs.pod:2855
40386 " make syntax-check # checks the syntax of the C code\n"
40387 " make check # runs the test suite\n"
40392 #: ../src/guestfs.pod:2858
40393 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
40397 #: ../src/guestfs.pod:2860
40399 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
40400 "which are used to do shell quoting."
40404 #: ../src/guestfs.pod:2865
40409 #: ../src/guestfs.pod:2867
40411 "Simple shell quoted string. Any spaces or other shell characters are "
40416 #: ../src/guestfs.pod:2870
40421 #: ../src/guestfs.pod:2872
40423 "Same as C<%Q> except the string is treated as a path which is prefixed by "
40428 #: ../src/guestfs.pod:2879
40431 " asprintf (&cmd, \"cat %R\", path);\n"
40436 #: ../src/guestfs.pod:2881
40437 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
40441 #: ../src/guestfs.pod:2883
40443 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
40444 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
40445 "they are not passed via the shell (instead, straight to exec). You probably "
40446 "want to use the C<sysroot_path()> function however."
40450 #: ../src/guestfs.pod:2889
40451 msgid "SUBMITTING YOUR NEW API ACTIONS"
40455 #: ../src/guestfs.pod:2891
40457 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
40458 "libguestfs> and CC to L<rjones@redhat.com>."
40462 #: ../src/guestfs.pod:2895
40463 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
40467 #: ../src/guestfs.pod:2897
40468 msgid "We support i18n (gettext anyhow) in the library."
40472 #: ../src/guestfs.pod:2899
40474 "However many messages come from the daemon, and we don't translate those at "
40475 "the moment. One reason is that the appliance generally has all locale files "
40476 "removed from it, because they take up a lot of space. So we'd have to readd "
40477 "some of those, as well as copying our PO files into the appliance."
40481 #: ../src/guestfs.pod:2905
40483 "Debugging messages are never translated, since they are intended for the "
40488 #: ../src/guestfs.pod:2908
40489 msgid "SOURCE CODE SUBDIRECTORIES"
40493 #: ../src/guestfs.pod:2912
40498 #: ../src/guestfs.pod:2914
40499 msgid "L<virt-alignment-scan(1)> command and documentation."
40503 #: ../src/guestfs.pod:2918
40504 msgid "The libguestfs appliance, build scripts and so on."
40508 #: ../src/guestfs.pod:2920
40509 msgid "C<capitests>"
40513 #: ../src/guestfs.pod:2922
40514 msgid "Automated tests of the C API."
40518 #: ../src/guestfs.pod:2924
40523 #: ../src/guestfs.pod:2926
40525 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
40530 #: ../src/guestfs.pod:2929
40535 #: ../src/guestfs.pod:2931
40537 "Safety and liveness tests of components that libguestfs depends upon (not of "
40538 "libguestfs itself). Mainly this is for qemu and the kernel."
40542 #: ../src/guestfs.pod:2934
40547 #: ../src/guestfs.pod:2936
40549 "Tools for cloning virtual machines. Currently contains L<virt-sysprep(1)> "
40550 "command and documentation."
40554 #: ../src/guestfs.pod:2939
40559 #: ../src/guestfs.pod:2941
40560 msgid "Outside contributions, experimental parts."
40564 #: ../src/guestfs.pod:2943
40569 #: ../src/guestfs.pod:2945
40571 "The daemon that runs inside the libguestfs appliance and carries out actions."
40575 #: ../src/guestfs.pod:2948
40580 #: ../src/guestfs.pod:2950
40581 msgid "L<virt-df(1)> command and documentation."
40585 #: ../src/guestfs.pod:2952
40590 #: ../src/guestfs.pod:2954
40591 msgid "L<virt-edit(1)> command and documentation."
40595 #: ../src/guestfs.pod:2956
40596 msgid "C<examples>"
40600 #: ../src/guestfs.pod:2958
40601 msgid "C API example code."
40605 #: ../src/guestfs.pod:2960
40606 msgid "C<extratests>"
40610 #: ../src/guestfs.pod:2962
40612 "Extra tests. These are not run by default because they require special "
40613 "tools or configuration."
40617 #: ../src/guestfs.pod:2965
40622 #: ../src/guestfs.pod:2967
40624 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
40625 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
40626 "L<virt-tar-out(1)>."
40630 #: ../src/guestfs.pod:2971
40635 #: ../src/guestfs.pod:2973
40637 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
40641 #: ../src/guestfs.pod:2975
40642 msgid "C<generator>"
40646 #: ../src/guestfs.pod:2977
40648 "The crucially important generator, used to automatically generate large "
40649 "amounts of boilerplate C code for things like RPC and bindings."
40653 #: ../src/guestfs.pod:2980
40658 #: ../src/guestfs.pod:2982
40659 msgid "Files used by the test suite."
40663 #: ../src/guestfs.pod:2984
40664 msgid "Some \"phony\" guest images which we test against."
40668 #: ../src/guestfs.pod:2986
40669 msgid "C<inspector>"
40673 #: ../src/guestfs.pod:2988
40674 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
40678 #: ../src/guestfs.pod:2990
40683 #: ../src/guestfs.pod:2992
40684 msgid "Logo used on the website. The fish is called Arthur by the way."
40688 #: ../src/guestfs.pod:2994
40693 #: ../src/guestfs.pod:2996
40694 msgid "M4 macros used by autoconf."
40698 #: ../src/guestfs.pod:2998
40703 #: ../src/guestfs.pod:3000
40704 msgid "Translations of simple gettext strings."
40708 #: ../src/guestfs.pod:3002
40713 #: ../src/guestfs.pod:3004
40715 "The build infrastructure and PO files for translations of manpages and POD "
40716 "files. Eventually this will be combined with the C<po> directory, but that "
40717 "is rather complicated."
40721 #: ../src/guestfs.pod:3008
40722 msgid "C<regressions>"
40726 #: ../src/guestfs.pod:3010
40727 msgid "Regression tests."
40731 #: ../src/guestfs.pod:3012
40736 #: ../src/guestfs.pod:3014
40737 msgid "L<virt-rescue(1)> command and documentation."
40741 #: ../src/guestfs.pod:3016
40746 #: ../src/guestfs.pod:3018
40747 msgid "L<virt-resize(1)> command and documentation."
40751 #: ../src/guestfs.pod:3020
40752 msgid "C<sparsify>"
40756 #: ../src/guestfs.pod:3022
40757 msgid "L<virt-sparsify(1)> command and documentation."
40761 #: ../src/guestfs.pod:3024
40766 #: ../src/guestfs.pod:3026
40767 msgid "Source code to the C library."
40771 #: ../src/guestfs.pod:3028
40776 #: ../src/guestfs.pod:3030
40778 "Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
40782 #: ../src/guestfs.pod:3032
40783 msgid "C<test-tool>"
40787 #: ../src/guestfs.pod:3034
40789 "Test tool for end users to test if their qemu/kernel combination will work "
40794 #: ../src/guestfs.pod:3037
40799 #: ../src/guestfs.pod:3039
40804 #: ../src/guestfs.pod:3041
40809 #: ../src/guestfs.pod:3043
40814 #: ../src/guestfs.pod:3045
40819 #: ../src/guestfs.pod:3047
40824 #: ../src/guestfs.pod:3049
40829 #: ../src/guestfs.pod:3051
40834 #: ../src/guestfs.pod:3053
40839 #: ../src/guestfs.pod:3055
40840 msgid "Language bindings."
40844 #: ../src/guestfs.pod:3059
40845 msgid "MAKING A STABLE RELEASE"
40849 #: ../src/guestfs.pod:3061
40851 "When we make a stable release, there are several steps documented here. See "
40852 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
40857 #: ../src/guestfs.pod:3069
40859 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
40863 #: ../src/guestfs.pod:3074
40864 msgid "Finalize RELEASE-NOTES."
40868 #: ../src/guestfs.pod:3078
40869 msgid "Update ROADMAP."
40873 #: ../src/guestfs.pod:3082
40874 msgid "Run C<src/api-support/update-from-tarballs.sh>."
40878 #: ../src/guestfs.pod:3086
40879 msgid "Push and pull from Transifex."
40883 #: ../src/guestfs.pod:3090
40891 #: ../src/guestfs.pod:3092
40892 msgid "to push the latest POT files to Transifex. Then run:"
40896 #: ../src/guestfs.pod:3094
40904 #: ../src/guestfs.pod:3096
40905 msgid "which is a wrapper to pull the latest translated C<*.po> files."
40909 #: ../src/guestfs.pod:3100
40911 "Create new stable and development directories under L<http://libguestfs.org/"
40916 #: ../src/guestfs.pod:3105
40917 msgid "Create the branch in git:"
40921 #: ../src/guestfs.pod:3107
40924 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
40925 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
40926 " git branch stable-1.XX\n"
40927 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
40932 #: ../src/guestfs.pod:3114
40937 #: ../src/guestfs.pod:3116
40938 msgid "PROTOCOL LIMITS"
40942 #: ../src/guestfs.pod:3118
40944 "Internally libguestfs uses a message-based protocol to pass API calls and "
40945 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
40946 "plenty more detail about this). The maximum message size used by the "
40947 "protocol is slightly less than 4 MB. For some API calls you may need to be "
40948 "aware of this limit. The API calls which may be affected are individually "
40949 "documented, with a link back to this section of the documentation."
40953 #: ../src/guestfs.pod:3126
40955 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
40956 "a simple string. Because this string is at some point internally encoded as "
40957 "a message, the maximum size that it can return is slightly under 4 MB. If "
40958 "the requested file is larger than this then you will get an error."
40962 #: ../src/guestfs.pod:3132
40964 "In order to transfer large files into and out of the guest filesystem, you "
40965 "need to use particular calls that support this. The sections L</UPLOADING> "
40966 "and L</DOWNLOADING> document how to do this."
40970 #: ../src/guestfs.pod:3136
40972 "You might also consider mounting the disk image using our FUSE filesystem "
40973 "support (L<guestmount(1)>)."
40977 #: ../src/guestfs.pod:3139
40978 msgid "MAXIMUM NUMBER OF DISKS"
40982 #: ../src/guestfs.pod:3141
40983 msgid "When using virtio disks (the default) the current limit is B<25> disks."
40987 #: ../src/guestfs.pod:3144
40989 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
40990 "slots. However febootstrap only understands disks with names C</dev/vda> "
40991 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
40996 #: ../src/guestfs.pod:3149
40998 "We are working to substantially raise this limit in future versions but it "
40999 "requires complex changes to qemu."
41003 #: ../src/guestfs.pod:3152
41005 "In future versions of libguestfs it should also be possible to \"hot plug\" "
41006 "disks (add and remove disks after calling L</guestfs_launch>). This also "
41007 "requires changes to qemu."
41011 #: ../src/guestfs.pod:3156
41012 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
41016 #: ../src/guestfs.pod:3158
41017 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
41021 #: ../src/guestfs.pod:3160
41023 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
41024 "vda>, and C</dev/vda1> through C</dev/vda15>)."
41028 #: ../src/guestfs.pod:3163
41030 "If you attach a disk with more than 15 partitions, the extra partitions are "
41031 "ignored by libguestfs."
41035 #: ../src/guestfs.pod:3166
41036 msgid "MAXIMUM SIZE OF A DISK"
41040 #: ../src/guestfs.pod:3168
41041 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
41045 #: ../src/guestfs.pod:3170
41047 "We have tested block devices up to 1 exabyte (2**60 or "
41048 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
41053 #: ../src/guestfs.pod:3174
41055 "Although libguestfs probably does not impose any limit, the underlying host "
41056 "storage will. If you store disk images on a host ext4 filesystem, then the "
41057 "maximum size will be limited by the maximum ext4 file size (currently 16 "
41058 "TB). If you store disk images as host logical volumes then you are limited "
41059 "by the maximum size of an LV."
41063 #: ../src/guestfs.pod:3180
41065 "For the hugest disk image files, we recommend using XFS on the host for "
41070 #: ../src/guestfs.pod:3183
41071 msgid "MAXIMUM SIZE OF A PARTITION"
41075 #: ../src/guestfs.pod:3185
41077 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
41078 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
41079 "address a partition located beyond 2 TB on the disk."
41083 #: ../src/guestfs.pod:3189
41085 "It is recommended that you use GPT partitions on disks which are larger than "
41086 "this size. GPT uses 64 bit sector numbers and so can address partitions "
41087 "which are theoretically larger than the largest disk we could support."
41091 #: ../src/guestfs.pod:3194
41092 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
41096 #: ../src/guestfs.pod:3196
41098 "This depends on the filesystem type. libguestfs itself does not impose any "
41099 "known limit. Consult Wikipedia or the filesystem documentation to find out "
41100 "what these limits are."
41104 #: ../src/guestfs.pod:3200
41105 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
41109 #: ../src/guestfs.pod:3202
41111 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
41112 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
41113 "uploads and downloads."
41117 #: ../src/guestfs.pod:3206
41118 msgid "INSPECTION LIMITS"
41122 #: ../src/guestfs.pod:3208
41124 "The inspection code has several arbitrary limits on things like the size of "
41125 "Windows Registry hive it will read, and the length of product name. These "
41126 "are intended to stop a malicious guest from consuming arbitrary amounts of "
41127 "memory and disk space on the host, and should not be reached in practice. "
41128 "See the source code for more information."
41132 #: ../src/guestfs.pod:3234
41134 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
41135 "effect as calling C<guestfs_set_verbose (g, 1)>."
41139 #: ../src/guestfs.pod:3246
41141 "Set the path that libguestfs uses to search for a supermin appliance. See "
41142 "the discussion of paths in section L</PATH> above."
41146 #: ../src/guestfs.pod:3255
41147 msgid "See also L</QEMU WRAPPERS> above."
41151 #: ../src/guestfs.pod:3259
41153 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
41154 "effect as calling C<guestfs_set_trace (g, 1)>."
41158 #: ../src/guestfs.pod:3277
41160 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-"
41161 "ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
41162 "L<guestfish(1)>, L<guestmount(1)>, L<virt-alignment-scan(1)>, L<virt-cat(1)"
41163 ">, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
41164 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
41165 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue"
41166 "(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, L<virt-sysprep(1)>, L<virt-tar"
41167 "(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<guestfs-"
41168 "testing(1)>, L<qemu(1)>, L<febootstrap(1)>, L<febootstrap-supermin-helper(8)"
41169 ">, L<hivex(3)>, L<stap(1)>, L<http://libguestfs.org/>."
41173 #: ../src/guestfs.pod:3314
41175 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
41176 "(8)>, L<disktype(1)>."
41180 #: ../src/guestfs.pod:3321 ../tools/virt-make-fs.pl:571
41181 #: ../tools/virt-win-reg.pl:772
41186 #: ../src/guestfs.pod:3323
41187 msgid "To get a list of bugs against libguestfs use this link:"
41191 #: ../src/guestfs.pod:3325
41193 "L<https://bugzilla.redhat.com/buglist.cgi?"
41194 "component=libguestfs&product=Virtualization+Tools>"
41198 #: ../src/guestfs.pod:3327
41199 msgid "To report a new bug against libguestfs use this link:"
41203 #: ../src/guestfs.pod:3329
41205 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
41206 "component=libguestfs&product=Virtualization+Tools>"
41210 #: ../src/guestfs.pod:3331
41211 msgid "When reporting a bug, please check:"
41215 #: ../src/guestfs.pod:3337
41216 msgid "That the bug hasn't been reported already."
41220 #: ../src/guestfs.pod:3341
41221 msgid "That you are testing a recent version."
41225 #: ../src/guestfs.pod:3345
41226 msgid "Describe the bug accurately, and give a way to reproduce it."
41230 #: ../src/guestfs.pod:3349
41232 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
41237 #: ../test-tool/libguestfs-test-tool.pod:5
41238 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
41242 #: ../test-tool/libguestfs-test-tool.pod:9
41245 " libguestfs-test-tool [--options]\n"
41250 #: ../test-tool/libguestfs-test-tool.pod:13
41252 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
41253 "to check basic libguestfs functionality is working. This is needed because "
41254 "libguestfs occasionally breaks for reasons beyond our control: usually "
41255 "because of changes in the underlying qemu or kernel packages, or the host "
41260 #: ../test-tool/libguestfs-test-tool.pod:19
41261 msgid "If you suspect a problem in libguestfs, then just run:"
41265 #: ../test-tool/libguestfs-test-tool.pod:21
41268 " libguestfs-test-tool\n"
41273 #: ../test-tool/libguestfs-test-tool.pod:23
41274 msgid "It will print lots of diagnostic messages."
41278 #: ../test-tool/libguestfs-test-tool.pod:25
41279 msgid "If it runs to completion successfully, you will see this near the end:"
41283 #: ../test-tool/libguestfs-test-tool.pod:27
41286 " ===== TEST FINISHED OK =====\n"
41291 #: ../test-tool/libguestfs-test-tool.pod:29
41292 msgid "and the test tool will exit with code 0."
41296 #: ../test-tool/libguestfs-test-tool.pod:31
41298 "If it fails (and/or exits with non-zero error code), please paste the "
41299 "I<complete, unedited> output of the test tool into a bug report. More "
41300 "information about reporting bugs can be found on the L<http://libguestfs.org/"
41305 #: ../test-tool/libguestfs-test-tool.pod:42
41306 msgid "Display short usage information and exit."
41310 #: ../test-tool/libguestfs-test-tool.pod:44
41311 msgid "B<--qemu qemu_binary>"
41315 #: ../test-tool/libguestfs-test-tool.pod:46
41317 "If you have downloaded another qemu binary, point this option at the full "
41318 "path of the binary to try it."
41322 #: ../test-tool/libguestfs-test-tool.pod:49
41323 msgid "B<--qemudir qemu_source_dir>"
41327 #: ../test-tool/libguestfs-test-tool.pod:51
41329 "If you have compiled qemu from source, point this option at the source "
41330 "directory to try it."
41334 #: ../test-tool/libguestfs-test-tool.pod:54
41339 #: ../test-tool/libguestfs-test-tool.pod:56
41340 msgid "B<--timeout N>"
41344 #: ../test-tool/libguestfs-test-tool.pod:58
41346 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
41347 "minutes) which does not usually need to be adjusted."
41351 #: ../test-tool/libguestfs-test-tool.pod:63
41352 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
41356 #: ../test-tool/libguestfs-test-tool.pod:65
41358 "If you have compiled another version of qemu from source and would like to "
41359 "try that, then you can use the I<--qemudir> option to point to the qemu "
41360 "source directory."
41364 #: ../test-tool/libguestfs-test-tool.pod:69
41366 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
41367 "option to point to the binary."
41371 #: ../test-tool/libguestfs-test-tool.pod:72
41373 "Note when using these options, you can ignore the business of qemu wrapper "
41374 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
41375 "wrapper script for you if one is needed."
41379 #: ../test-tool/libguestfs-test-tool.pod:76
41380 msgid "TRYING OUT A DIFFERENT KERNEL"
41384 #: ../test-tool/libguestfs-test-tool.pod:78
41386 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
41387 "libguestfs tries. You do this by setting the environment variables "
41388 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
41392 #: ../test-tool/libguestfs-test-tool.pod:82
41394 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
41399 #: ../test-tool/libguestfs-test-tool.pod:85
41400 msgid "SELF-DIAGNOSIS"
41404 #: ../test-tool/libguestfs-test-tool.pod:87
41406 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
41407 "produced by libguestfs-test-tool and/or possible errors."
41411 #: ../test-tool/libguestfs-test-tool.pod:92
41413 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
41414 "I<1> if there was an error."
41418 #: ../test-tool/libguestfs-test-tool.pod:97
41420 "For the full list of environment variables which may affect libguestfs, "
41421 "please see the L<guestfs(3)> manual page."
41425 #: ../test-tool/libguestfs-test-tool.pod:102
41426 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
41430 #: ../tools/virt-list-filesystems.pl:32
41432 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
41436 #: ../tools/virt-list-filesystems.pl:36
41439 " virt-list-filesystems [--options] domname\n"
41444 #: ../tools/virt-list-filesystems.pl:38
41447 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
41452 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
41454 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
41459 #: ../tools/virt-list-filesystems.pl:45
41461 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
41462 "are contained in a virtual machine or disk image."
41466 #: ../tools/virt-list-filesystems.pl:49
41468 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
41469 "functionality. For more complex cases you should look at the L<guestfish(1)"
41474 #: ../tools/virt-list-filesystems.pl:112
41476 "With this option, C<virt-list-filesystems> displays the type of each "
41477 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
41481 #: ../tools/virt-list-filesystems.pl:119
41486 #: ../tools/virt-list-filesystems.pl:123
41488 "Normally we only show mountable filesystems. If this option is given then "
41489 "swap devices are shown too."
41493 #: ../tools/virt-list-filesystems.pl:197
41495 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
41496 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
41497 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
41501 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
41502 msgid "Copyright (C) 2009 Red Hat Inc."
41506 #: ../tools/virt-list-partitions.pl:32
41508 "virt-list-partitions - List partitions in a virtual machine or disk image"
41512 #: ../tools/virt-list-partitions.pl:36
41515 " virt-list-partitions [--options] domname\n"
41520 #: ../tools/virt-list-partitions.pl:38
41523 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
41528 #: ../tools/virt-list-partitions.pl:45
41530 "C<virt-list-partitions> is a command line tool to list the partitions that "
41531 "are contained in a virtual machine or disk image. It is mainly useful as a "
41532 "first step to using L<virt-resize(1)>."
41536 #: ../tools/virt-list-partitions.pl:50
41538 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
41539 "functionality. For more complex cases you should look at the L<guestfish(1)"
41544 #: ../tools/virt-list-partitions.pl:113
41545 msgid "Show sizes in human-readable form (eg. \"1G\")."
41549 #: ../tools/virt-list-partitions.pl:123
41551 "With this option, C<virt-list-partitions> displays the type and size of each "
41552 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
41556 #: ../tools/virt-list-partitions.pl:130
41561 #: ../tools/virt-list-partitions.pl:132
41566 #: ../tools/virt-list-partitions.pl:134
41568 "Display the total size of each block device (as a separate row or rows)."
41572 #: ../tools/virt-list-partitions.pl:267
41574 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
41575 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
41576 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
41580 #: ../tools/virt-list-partitions.pl:283
41581 msgid "Copyright (C) 2009-2010 Red Hat Inc."
41585 #: ../tools/virt-make-fs.pl:37
41586 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
41590 #: ../tools/virt-make-fs.pl:41
41593 " virt-make-fs [--options] input.tar output.img\n"
41598 #: ../tools/virt-make-fs.pl:43
41601 " virt-make-fs [--options] input.tar.gz output.img\n"
41606 #: ../tools/virt-make-fs.pl:45
41609 " virt-make-fs [--options] directory output.img\n"
41614 #: ../tools/virt-make-fs.pl:49
41616 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
41617 "archive or some files in a directory. It is similar to tools like L<mkisofs"
41618 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
41619 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
41620 "you want to attach these filesystems to existing virtual machines (eg. to "
41621 "import large amounts of read-only data to a VM)."
41625 #: ../tools/virt-make-fs.pl:57
41626 msgid "Basic usage is:"
41630 #: ../tools/virt-make-fs.pl:59
41633 " virt-make-fs input output.img\n"
41638 #: ../tools/virt-make-fs.pl:61
41640 "where C<input> is either a directory containing files that you want to add, "
41641 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
41642 "C<output.img> is a disk image. The input type is detected automatically. "
41643 "The output disk image defaults to a raw ext2 sparse image unless you specify "
41644 "extra flags (see L</OPTIONS> below)."
41648 #: ../tools/virt-make-fs.pl:67
41649 msgid "FILESYSTEM TYPE"
41653 #: ../tools/virt-make-fs.pl:69
41655 "The default filesystem type is C<ext2>. Just about any filesystem type that "
41656 "libguestfs supports can be used (but I<not> read-only formats like "
41657 "ISO9660). Here are some of the more common choices:"
41661 #: ../tools/virt-make-fs.pl:75
41666 #: ../tools/virt-make-fs.pl:77
41668 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
41669 "you are not going to use the filesystem in a way that requires the journal, "
41670 "then this is just wasted overhead."
41674 #: ../tools/virt-make-fs.pl:81
41675 msgid "I<ntfs> or I<vfat>"
41679 #: ../tools/virt-make-fs.pl:83
41680 msgid "Useful if exporting data to a Windows guest."
41684 #: ../tools/virt-make-fs.pl:85
41686 "I<Note for vfat>: The tar archive or local directory must only contain files "
41687 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
41688 "program running within libguestfs is unable to change the ownership of non-"
41689 "root files, since vfat itself does not support this."
41693 #: ../tools/virt-make-fs.pl:90
41698 #: ../tools/virt-make-fs.pl:92
41700 "Lower overhead than C<ext2>, but certain limitations on filename length and "
41701 "total filesystem size."
41705 #: ../tools/virt-make-fs.pl:97 ../tools/virt-make-fs.pl:116
41706 #: ../tools/virt-make-fs.pl:149
41711 #: ../tools/virt-make-fs.pl:99
41714 " virt-make-fs --type=minix input minixfs.img\n"
41719 #: ../tools/virt-make-fs.pl:101
41720 msgid "TO PARTITION OR NOT TO PARTITION"
41724 #: ../tools/virt-make-fs.pl:103
41725 msgid "Optionally virt-make-fs can add a partition table to the output disk."
41729 #: ../tools/virt-make-fs.pl:105
41731 "Adding a partition can make the disk image more compatible with certain "
41732 "virtualized operating systems which don't expect to see a filesystem "
41733 "directly located on a block device (Linux doesn't care and will happily "
41734 "handle both types)."
41738 #: ../tools/virt-make-fs.pl:110
41740 "On the other hand, if you have a partition table then the output image is no "
41741 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
41742 "directly on a partitioned disk image. (However libguestfs tools such as "
41743 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
41747 #: ../tools/virt-make-fs.pl:118
41748 msgid "Add an MBR partition:"
41752 #: ../tools/virt-make-fs.pl:120
41755 " virt-make-fs --partition -- input disk.img\n"
41760 #: ../tools/virt-make-fs.pl:122
41762 "If the output disk image could be terabyte-sized or larger, it's better to "
41763 "use an EFI/GPT-compatible partition table:"
41767 #: ../tools/virt-make-fs.pl:125
41770 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
41775 #: ../tools/virt-make-fs.pl:127
41776 msgid "EXTRA SPACE"
41780 #: ../tools/virt-make-fs.pl:129
41782 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
41783 "the files that it contains, but might have extra space. Depending on how "
41784 "you are going to use the output, you might think this extra space is wasted "
41785 "and want to minimize it, or you might want to leave space so that more files "
41786 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
41787 "but you can use the I<--size> flag to leave space in the filesystem if you "
41792 #: ../tools/virt-make-fs.pl:137
41794 "An alternative way to leave extra space but not make the output image any "
41795 "bigger is to use an alternative disk image format (instead of the default "
41796 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
41797 "image format (check your hypervisor supports this before using it). This "
41798 "allows you to choose a large I<--size> but the extra space won't actually be "
41799 "allocated in the image until you try to store something in it."
41803 #: ../tools/virt-make-fs.pl:145
41805 "Don't forget that you can also use local commands including L<resize2fs(8)> "
41806 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
41807 "to build another image from scratch."
41811 #: ../tools/virt-make-fs.pl:151
41814 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
41819 #: ../tools/virt-make-fs.pl:179
41820 msgid "Enable debugging information."
41824 #: ../tools/virt-make-fs.pl:185
41825 msgid "B<--size=E<lt>NE<gt>>"
41829 #: ../tools/virt-make-fs.pl:187
41830 msgid "B<--size=+E<lt>NE<gt>>"
41834 #: ../tools/virt-make-fs.pl:189
41835 msgid "B<-s E<lt>NE<gt>>"
41839 #: ../tools/virt-make-fs.pl:191
41840 msgid "B<-s +E<lt>NE<gt>>"
41844 #: ../tools/virt-make-fs.pl:193
41846 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
41850 #: ../tools/virt-make-fs.pl:196
41852 "If this option is I<not> given, then the output image will be just large "
41853 "enough to contain all the files, with not much wasted space."
41857 #: ../tools/virt-make-fs.pl:199
41859 "To choose a fixed size output disk, specify an absolute number followed by b/"
41860 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
41861 "Petabytes or Exabytes. This must be large enough to contain all the input "
41862 "files, else you will get an error."
41866 #: ../tools/virt-make-fs.pl:204
41868 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
41869 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
41870 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
41871 "the input files, and (approximately) an extra 200 MB free space."
41875 #: ../tools/virt-make-fs.pl:210
41877 "Note that virt-make-fs estimates free space, and therefore will not produce "
41878 "filesystems containing precisely the free space requested. (It is much more "
41879 "expensive and time-consuming to produce a filesystem which has precisely the "
41880 "desired free space)."
41884 #: ../tools/virt-make-fs.pl:219
41885 msgid "B<--format=E<lt>fmtE<gt>>"
41889 #: ../tools/virt-make-fs.pl:221
41890 msgid "B<-F E<lt>fmtE<gt>>"
41894 #: ../tools/virt-make-fs.pl:223
41895 msgid "Choose the output disk image format."
41899 #: ../tools/virt-make-fs.pl:225
41900 msgid "The default is C<raw> (raw sparse disk image)."
41904 #: ../tools/virt-make-fs.pl:227
41906 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
41907 "that would really make sense here is C<qcow2>."
41911 #: ../tools/virt-make-fs.pl:234
41912 msgid "B<--type=E<lt>fsE<gt>>"
41916 #: ../tools/virt-make-fs.pl:236
41917 msgid "B<-t E<lt>fsE<gt>>"
41921 #: ../tools/virt-make-fs.pl:238
41922 msgid "Choose the output filesystem type."
41926 #: ../tools/virt-make-fs.pl:240
41927 msgid "The default is C<ext2>."
41931 #: ../tools/virt-make-fs.pl:242
41933 "Any filesystem which is supported read-write by libguestfs can be used here."
41937 #: ../tools/virt-make-fs.pl:249
41938 msgid "B<--partition>"
41942 #: ../tools/virt-make-fs.pl:251
41943 msgid "B<--partition=E<lt>parttypeE<gt>>"
41947 #: ../tools/virt-make-fs.pl:253
41949 "If specified, this flag adds an MBR partition table to the output disk image."
41953 #: ../tools/virt-make-fs.pl:256
41955 "You can change the partition table type, eg. I<--partition=gpt> for large "
41960 #: ../tools/virt-make-fs.pl:259
41962 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
41963 "might consider the next parameter to be the partition type. For example:"
41967 #: ../tools/virt-make-fs.pl:263
41970 " virt-make-fs --partition input.tar output.img\n"
41975 #: ../tools/virt-make-fs.pl:265
41977 "would cause virt-make-fs to think you wanted to use a partition type of "
41978 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
41979 "dash) between options and the input and output arguments:"
41983 #: ../tools/virt-make-fs.pl:269
41986 " virt-make-fs --partition -- input.tar output.img\n"
41991 #: ../tools/virt-make-fs.pl:271
41992 msgid "For MBR, virt-make-fs sets the partition type byte automatically."
41996 #: ../tools/virt-make-fs.pl:559
41998 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
41999 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
42000 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
42004 #: ../tools/virt-make-fs.pl:573 ../tools/virt-win-reg.pl:774
42006 "When reporting bugs, please enable debugging and capture the I<complete> "
42011 #: ../tools/virt-make-fs.pl:576
42014 " export LIBGUESTFS_DEBUG=1\n"
42015 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
42020 #: ../tools/virt-make-fs.pl:579
42022 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
42027 #: ../tools/virt-tar.pl:33
42028 msgid "virt-tar - Extract or upload files to a virtual machine"
42032 #: ../tools/virt-tar.pl:37
42035 " virt-tar [--options] -x domname directory tarball\n"
42040 #: ../tools/virt-tar.pl:39
42043 " virt-tar [--options] -u domname tarball directory\n"
42048 #: ../tools/virt-tar.pl:41
42051 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
42056 #: ../tools/virt-tar.pl:43
42059 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
42064 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
42069 #: ../tools/virt-tar.pl:47
42071 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
42072 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
42076 #: ../tools/virt-tar.pl:52
42077 msgid "Download C</home> from the VM into a local tarball:"
42081 #: ../tools/virt-tar.pl:54
42084 " virt-tar -x domname /home home.tar\n"
42089 #: ../tools/virt-tar.pl:56
42092 " virt-tar -zx domname /home home.tar.gz\n"
42097 #: ../tools/virt-tar.pl:58
42098 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
42102 #: ../tools/virt-tar.pl:60
42105 " virt-tar -u domname uploadstuff.tar /tmp\n"
42110 #: ../tools/virt-tar.pl:62
42113 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
42118 #: ../tools/virt-tar.pl:66
42120 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
42121 "virtual machines. If you do this, you risk disk corruption in the VM. "
42122 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
42126 #: ../tools/virt-tar.pl:71
42128 "You can use I<-x> (extract) on live virtual machines, but you might get "
42129 "inconsistent results or errors if there is filesystem activity inside the "
42130 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
42131 "work, but the only way to guarantee consistent results is if the virtual "
42132 "machine is shut down."
42136 #: ../tools/virt-tar.pl:79
42138 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
42139 "parts of a guest filesystem. There are many possibilities: making backups, "
42140 "uploading data files, snooping on guest activity, fixing or customizing "
42145 #: ../tools/virt-tar.pl:84
42147 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
42148 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
42149 "should look at the L<guestfish(1)> tool."
42153 #: ../tools/virt-tar.pl:88
42155 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
42156 "its contents (recursively) from the virtual machine into a local tarball. "
42157 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
42158 "virtual machine. You cannot use these two options together."
42162 #: ../tools/virt-tar.pl:94
42164 "In addition, you may need to use the I<-z> (gZip) option to enable "
42165 "compression. When uploading, you have to specify I<-z> if the upload file "
42166 "is compressed because virt-tar won't detect this on its own."
42170 #: ../tools/virt-tar.pl:98
42172 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
42173 "example it cannot do PKZip files or bzip2 compression. If you want that "
42174 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
42175 "the L<libguestfs(3)> API)."
42179 #: ../tools/virt-tar.pl:160
42180 msgid "B<--extract>"
42184 #: ../tools/virt-tar.pl:162
42185 msgid "B<--download>"
42189 #: ../tools/virt-tar.pl:164
42194 #: ../tools/virt-tar.pl:166
42195 msgid "B<--upload>"
42199 #: ../tools/virt-tar.pl:168
42201 "Use I<-x> to extract (download) a directory from a virtual machine to a "
42206 #: ../tools/virt-tar.pl:171
42208 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
42209 "Please read the L</WARNING> section above before using this option."
42213 #: ../tools/virt-tar.pl:175
42214 msgid "You must specify exactly one of these options."
42218 #: ../tools/virt-tar.pl:181
42223 #: ../tools/virt-tar.pl:183
42228 #: ../tools/virt-tar.pl:185
42229 msgid "Specify that the input or output tarball is gzip-compressed."
42233 #: ../tools/virt-tar.pl:298
42235 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
42236 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
42237 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
42242 #: ../tools/virt-win-reg.pl:37
42244 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
42248 #: ../tools/virt-win-reg.pl:41
42251 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
42256 #: ../tools/virt-win-reg.pl:43
42259 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
42264 #: ../tools/virt-win-reg.pl:45
42267 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
42272 #: ../tools/virt-win-reg.pl:47
42275 " virt-win-reg --merge domname [input.reg ...]\n"
42280 #: ../tools/virt-win-reg.pl:49
42283 " virt-win-reg [--options] disk.img ... # instead of domname\n"
42288 #: ../tools/virt-win-reg.pl:53
42290 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
42291 "virtual machines. If you do this, you I<will> get irreversible disk "
42292 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
42293 "but doesn't catch all cases."
42297 #: ../tools/virt-win-reg.pl:58
42299 "Modifying the Windows Registry is an inherently risky operation. The format "
42300 "is deliberately obscure and undocumented, and Registry changes can leave the "
42301 "system unbootable. Therefore when using the I<--merge> option, make sure "
42302 "you have a reliable backup first."
42306 #: ../tools/virt-win-reg.pl:65
42308 "This program can export and merge Windows Registry entries from a Windows "
42313 #: ../tools/virt-win-reg.pl:68
42315 "The first parameter is the libvirt guest name or the raw disk image of a "
42320 #: ../tools/virt-win-reg.pl:71
42322 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
42323 "exported (recursively). For example:"
42327 #: ../tools/virt-win-reg.pl:74
42330 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
42335 #: ../tools/virt-win-reg.pl:76
42337 "You can also display single values from within registry keys, for example:"
42341 #: ../tools/virt-win-reg.pl:79
42344 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
42345 " $ virt-win-reg Windows7 $cvkey ProductName\n"
42346 " Windows 7 Enterprise\n"
42351 #: ../tools/virt-win-reg.pl:83
42353 "With I<--merge>, you can merge a textual regedit file into the Windows "
42358 #: ../tools/virt-win-reg.pl:86
42361 " $ virt-win-reg --merge Windows7 changes.reg\n"
42366 #: ../tools/virt-win-reg.pl:90
42368 "This program is only meant for simple access to the registry. If you want "
42369 "to do complicated things with the registry, we suggest you download the "
42370 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
42371 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
42372 "L<hivexregedit(1)>."
42376 #: ../tools/virt-win-reg.pl:159
42381 #: ../tools/virt-win-reg.pl:161
42383 "In merge mode, this merges a textual regedit file into the Windows Registry "
42384 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
42385 "displays or exports Registry entries instead."
42389 #: ../tools/virt-win-reg.pl:165
42391 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
42392 "result in disk corruption. However exporting (without this flag) is always "
42397 #: ../tools/virt-win-reg.pl:173
42398 msgid "B<--encoding> UTF-16LE|ASCII"
42402 #: ../tools/virt-win-reg.pl:175
42404 "When merging (only), you may need to specify the encoding for strings to be "
42405 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
42406 "(3)/ENCODING STRINGS>."
42410 #: ../tools/virt-win-reg.pl:179
42412 "The default is to use UTF-16LE, which should work with recent versions of "
42417 #: ../tools/virt-win-reg.pl:186
42418 msgid "B<--unsafe-printable-strings>"
42422 #: ../tools/virt-win-reg.pl:188
42424 "When exporting (only), assume strings are UTF-16LE and print them as strings "
42425 "instead of hex sequences. Remove the final zero codepoint from strings if "
42430 #: ../tools/virt-win-reg.pl:192
42432 "This is unsafe and does not preserve the fidelity of strings in the original "
42433 "Registry for various reasons:"
42437 #: ../tools/virt-win-reg.pl:199
42439 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
42440 "other encodings will be corrupted by this transformation."
42444 #: ../tools/virt-win-reg.pl:204
42446 "Assumes that everything which has type 1 or 2 is really a string and that "
42447 "everything else is not a string, but the type field in real Registries is "
42452 #: ../tools/virt-win-reg.pl:210
42454 "Loses information about whether a zero codepoint followed the string in the "
42459 #: ../tools/virt-win-reg.pl:215
42461 "This all happens because the Registry itself contains no information about "
42462 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
42466 #: ../tools/virt-win-reg.pl:219
42468 "You should only use this option for quick hacking and debugging of the "
42469 "Registry contents, and I<never> use it if the output is going to be passed "
42470 "into another program or stored in another Registry."
42474 #: ../tools/virt-win-reg.pl:556
42475 msgid "SUPPORTED SYSTEMS"
42479 #: ../tools/virt-win-reg.pl:558
42481 "The program currently supports Windows NT-derived guests starting with "
42482 "Windows XP through to at least Windows 7."
42486 #: ../tools/virt-win-reg.pl:561
42487 msgid "The following Registry keys are supported:"
42491 #: ../tools/virt-win-reg.pl:565
42492 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
42496 #: ../tools/virt-win-reg.pl:567
42497 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
42501 #: ../tools/virt-win-reg.pl:569
42502 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
42506 #: ../tools/virt-win-reg.pl:571
42507 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
42511 #: ../tools/virt-win-reg.pl:573
42512 msgid "C<HKEY_USERS\\.DEFAULT>"
42516 #: ../tools/virt-win-reg.pl:575
42517 msgid "C<HKEY_USERS\\I<SID>>"
42521 #: ../tools/virt-win-reg.pl:577
42522 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
42526 #: ../tools/virt-win-reg.pl:579
42527 msgid "C<HKEY_USERS\\I<username>>"
42531 #: ../tools/virt-win-reg.pl:581
42533 "where I<username> is a local user name (this is a libguestfs extension)."
42537 #: ../tools/virt-win-reg.pl:585
42539 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
42544 #: ../tools/virt-win-reg.pl:588
42546 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
42547 "supported (there is no \"current user\")."
42551 #: ../tools/virt-win-reg.pl:591
42556 #: ../tools/virt-win-reg.pl:593
42558 "C<virt-win-reg> expects that regedit files have already been reencoded in "
42559 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
42560 "style line endings. Since Windows regedit files are often in UTF-16LE with "
42561 "Windows-style line endings, you may need to reencode the whole file before "
42562 "or after processing."
42566 #: ../tools/virt-win-reg.pl:599
42568 "To reencode a file from Windows format to Linux (before processing it with "
42569 "the I<--merge> option), you would do something like this:"
42573 #: ../tools/virt-win-reg.pl:602
42576 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
42581 #: ../tools/virt-win-reg.pl:604
42583 "To go in the opposite direction, after exporting and before sending the file "
42584 "to a Windows user, do something like this:"
42588 #: ../tools/virt-win-reg.pl:607
42591 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
42596 #: ../tools/virt-win-reg.pl:609
42597 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
42601 #: ../tools/virt-win-reg.pl:611
42603 "If you are unsure about the current encoding, use the L<file(1)> command. "
42604 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
42605 "style (CRLF) line endings, like this:"
42609 #: ../tools/virt-win-reg.pl:615
42612 " $ file software.reg\n"
42613 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
42614 " with CRLF line terminators\n"
42619 #: ../tools/virt-win-reg.pl:619
42620 msgid "This file would need conversion before you could I<--merge> it."
42624 #: ../tools/virt-win-reg.pl:621
42625 msgid "CurrentControlSet etc."
42629 #: ../tools/virt-win-reg.pl:623
42631 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
42632 "Registry at the level of the hive file, and therefore you cannot modify "
42637 #: ../tools/virt-win-reg.pl:627
42639 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
42640 "circumstances it might refer to another control set. The way to find out is "
42641 "to look at the C<HKLM\\SYSTEM\\Select> key:"
42645 #: ../tools/virt-win-reg.pl:631
42648 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
42649 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
42650 " \"Current\"=dword:00000001\n"
42651 " \"Default\"=dword:00000001\n"
42652 " \"Failed\"=dword:00000000\n"
42653 " \"LastKnownGood\"=dword:00000002\n"
42658 #: ../tools/virt-win-reg.pl:638
42659 msgid "\"Current\" is the one which Windows will choose when it boots."
42663 #: ../tools/virt-win-reg.pl:640
42665 "Similarly, other C<Current...> keys in the path may need to be replaced."
42669 #: ../tools/virt-win-reg.pl:643
42670 msgid "DELETING REGISTRY KEYS AND VALUES"
42674 #: ../tools/virt-win-reg.pl:645
42675 msgid "To delete a whole registry key, use the syntax:"
42679 #: ../tools/virt-win-reg.pl:647
42682 " [-HKEY_LOCAL_MACHINE\\Foo]\n"
42687 #: ../tools/virt-win-reg.pl:649
42688 msgid "To delete a single value within a key, use the syntax:"
42692 #: ../tools/virt-win-reg.pl:651
42695 " [HKEY_LOCAL_MACHINE\\Foo]\n"
42701 #: ../tools/virt-win-reg.pl:654
42702 msgid "WINDOWS TIPS"
42706 #: ../tools/virt-win-reg.pl:656
42708 "Note that some of these tips modify the guest disk image. The guest I<must> "
42709 "be shut off, else you will get disk corruption."
42713 #: ../tools/virt-win-reg.pl:659
42714 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
42718 #: ../tools/virt-win-reg.pl:661
42720 "Prepare a DOS batch script, VBScript or executable. Upload this using "
42721 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
42722 "is uploaded into C<C:\\>:"
42726 #: ../tools/virt-win-reg.pl:665
42729 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
42734 #: ../tools/virt-win-reg.pl:667
42735 msgid "Prepare a regedit file containing the registry change:"
42739 #: ../tools/virt-win-reg.pl:669
42742 " cat > test.reg <<'EOF'\n"
42743 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
42744 " \"Test\"=\"c:\\\\test.bat\"\n"
42750 #: ../tools/virt-win-reg.pl:674
42752 "In this example we use the key C<RunOnce> which means that the script will "
42753 "run precisely once when the first user logs in. If you want it to run every "
42754 "time a user logs in, replace C<RunOnce> with C<Run>."
42758 #: ../tools/virt-win-reg.pl:678
42759 msgid "Now update the registry:"
42763 #: ../tools/virt-win-reg.pl:680
42766 " virt-win-reg --merge WindowsGuest test.reg\n"
42771 #: ../tools/virt-win-reg.pl:682
42772 msgid "INSTALLING A SERVICE"
42776 #: ../tools/virt-win-reg.pl:684
42778 "This section assumes you are familiar with Windows services, and you either "
42779 "have a program which handles the Windows Service Control Protocol directly "
42780 "or you want to run any program using a service wrapper like SrvAny or the "
42785 #: ../tools/virt-win-reg.pl:689
42787 "First upload the program and optionally the service wrapper. In this case "
42788 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
42792 #: ../tools/virt-win-reg.pl:693
42795 " guestfish -i -d WindowsGuest <<EOF\n"
42796 " upload rhsrvany.exe /rhsrvany.exe\n"
42797 " upload test.exe /test.exe\n"
42803 #: ../tools/virt-win-reg.pl:698
42805 "Prepare a regedit file containing the registry changes. In this example, "
42806 "the first registry change is needed for the service itself or the service "
42807 "wrapper (if used). The second registry change is only needed because I am "
42808 "using the RHSrvAny service wrapper."
42812 #: ../tools/virt-win-reg.pl:703
42815 " cat > service.reg <<'EOF'\n"
42816 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
42817 " \"Type\"=dword:00000010\n"
42818 " \"Start\"=dword:00000002\n"
42819 " \"ErrorControl\"=dword:00000001\n"
42820 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
42821 " \"DisplayName\"=\"RHSrvAny\"\n"
42822 " \"ObjectName\"=\"NetworkService\"\n"
42827 #: ../tools/virt-win-reg.pl:712
42830 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
42831 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
42832 " \"PWD\"=\"c:\\\\Temp\"\n"
42838 #: ../tools/virt-win-reg.pl:723
42840 "For use of C<ControlSet001> see the section above in this manual page. You "
42841 "may need to adjust this according to the control set that is in use by the "
42846 #: ../tools/virt-win-reg.pl:729
42848 "C<\"ObjectName\"> controls the privileges that the service will have. An "
42849 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
42850 "privileged account."
42854 #: ../tools/virt-win-reg.pl:735
42856 "For the meaning of the magic numbers, see this Microsoft KB article: "
42857 "L<http://support.microsoft.com/kb/103000>."
42861 #: ../tools/virt-win-reg.pl:740
42862 msgid "Update the registry:"
42866 #: ../tools/virt-win-reg.pl:742
42869 " virt-win-reg --merge WindowsGuest service.reg\n"
42874 #: ../tools/virt-win-reg.pl:746
42876 "Be careful when passing parameters containing C<\\> (backslash) in the "
42877 "shell. Usually you will have to use 'single quotes' or double backslashes "
42878 "(but not both) to protect them from the shell."
42882 #: ../tools/virt-win-reg.pl:750
42883 msgid "Paths and value names are case-insensitive."
42887 #: ../tools/virt-win-reg.pl:759
42889 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
42890 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
42891 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
42895 #: ../tools/virt-win-reg.pl:777
42898 " export LIBGUESTFS_DEBUG=1\n"
42899 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
42904 #: ../tools/virt-win-reg.pl:780
42906 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."