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-12-03 11:24+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:31
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:112
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:116
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:118
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:120
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:122
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:128
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:135
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:137
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:139
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:142
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:145
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:147
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:149
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:152
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:154
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:156
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:161 ../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:165
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:169
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:172
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:497
492 #: ../sparsify/virt-sparsify.pod:177
497 #: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:499
498 #: ../sparsify/virt-sparsify.pod:179
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:219 ../sparsify/virt-sparsify.pod:183
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:221 ../sparsify/virt-sparsify.pod:185
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:223 ../sparsify/virt-sparsify.pod:187
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:225 ../resize/virt-resize.pod:567
545 #: ../sparsify/virt-sparsify.pod:189
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:227 ../resize/virt-resize.pod:569
556 #: ../sparsify/virt-sparsify.pod:191 ../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:229 ../resize/virt-resize.pod:571
568 #: ../sparsify/virt-sparsify.pod:193 ../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:240 ../sparsify/virt-sparsify.pod:195
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:242 ../sparsify/virt-sparsify.pod:197
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:303 ../resize/virt-resize.pod:682
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:305 ../resize/virt-resize.pod:684
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:689 ../sparsify/virt-sparsify.pod:251
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:1293
929 #: ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1301
930 #: ../fish/guestfish-actions.pod:1305 ../fish/guestfish-actions.pod:1313
931 #: ../fish/guestfish-actions.pod:1317 ../fish/guestfish-actions.pod:1321
932 #: ../fish/guestfish-actions.pod:1331 ../fish/guestfish-actions.pod:1335
933 #: ../fish/guestfish-actions.pod:1339 ../fish/guestfish-actions.pod:1429
934 #: ../fish/guestfish-actions.pod:1433 ../fish/guestfish-actions.pod:1438
935 #: ../fish/guestfish-actions.pod:1443 ../fish/guestfish-actions.pod:1485
936 #: ../fish/guestfish-actions.pod:1489 ../fish/guestfish-actions.pod:1494
937 #: ../fish/guestfish-actions.pod:1750 ../fish/guestfish-actions.pod:1757
938 #: ../fish/guestfish-actions.pod:1764 ../fish/guestfish-actions.pod:2167
939 #: ../fish/guestfish-actions.pod:2173 ../fish/guestfish-actions.pod:2181
940 #: ../fish/guestfish-actions.pod:2188 ../fish/guestfish-actions.pod:2195
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:365 ../resize/virt-resize.pod:369
945 #: ../resize/virt-resize.pod:378 ../resize/virt-resize.pod:384
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:2118
953 #: ../src/guestfs-actions.pod:2122 ../src/guestfs-actions.pod:2126
954 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:2138
955 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2146
956 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:2160
957 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2302
958 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:2311
959 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2377
960 #: ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:2386
961 #: ../src/guestfs-actions.pod:2801 ../src/guestfs-actions.pod:2808
962 #: ../src/guestfs-actions.pod:2815 ../src/guestfs-actions.pod:3360
963 #: ../src/guestfs-actions.pod:3366 ../src/guestfs-actions.pod:3374
964 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3388
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:325
1045 #: ../resize/virt-resize.pod:694 ../ruby/examples/guestfs-ruby.pod:36
1046 #: ../sparsify/virt-sparsify.pod:275 ../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:334
1066 #: ../resize/virt-resize.pod:717 ../sparsify/virt-sparsify.pod:288
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:336 ../resize/virt-resize.pod:719
1079 #: ../sparsify/virt-sparsify.pod:290 ../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:338
1098 #: ../resize/virt-resize.pod:721 ../ruby/examples/guestfs-ruby.pod:52
1099 #: ../sparsify/virt-sparsify.pod:292 ../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:294
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:342 ../resize/virt-resize.pod:725
1122 #: ../sparsify/virt-sparsify.pod:296 ../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:347 ../resize/virt-resize.pod:730
1142 #: ../sparsify/virt-sparsify.pod:301 ../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:352 ../resize/virt-resize.pod:735
1162 #: ../sparsify/virt-sparsify.pod:306 ../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:124
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:246
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:252
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:256
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:260
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:691 ../sparsify/virt-sparsify.pod:253
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:723 ../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:15
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:4519
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:340
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:21
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:298 ../sparsify/virt-sparsify.pod:256
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:1481 ../fish/guestfish-actions.pod:1746
5266 #: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:18
5267 #: ../src/guestfs-actions.pod:2373 ../src/guestfs-actions.pod:2797
5268 #: ../src/guestfs-actions.pod:3356 ../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:972
6577 #: ../fish/guestfish-actions.pod:1007 ../fish/guestfish-actions.pod:1180
6578 #: ../fish/guestfish-actions.pod:1540 ../fish/guestfish-actions.pod:1554
6579 #: ../fish/guestfish-actions.pod:3423 ../fish/guestfish-actions.pod:3734
6580 #: ../fish/guestfish-actions.pod:3782 ../fish/guestfish-actions.pod:4700
6581 #: ../fish/guestfish-actions.pod:4720 ../fish/guestfish-actions.pod:4739
6582 #: ../fish/guestfish-actions.pod:4777 ../fish/guestfish-actions.pod:5505
6583 #: ../fish/guestfish-actions.pod:5608 ../src/guestfs-actions.pod:10
6584 #: ../src/guestfs-actions.pod:305 ../src/guestfs-actions.pod:326
6585 #: ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1676
6586 #: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:2458
6587 #: ../src/guestfs-actions.pod:2479 ../src/guestfs-actions.pod:5281
6588 #: ../src/guestfs-actions.pod:5803 ../src/guestfs-actions.pod:5903
6589 #: ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7240
6590 #: ../src/guestfs-actions.pod:7271 ../src/guestfs-actions.pod:7331
6591 #: ../src/guestfs-actions.pod:8385 ../src/guestfs-actions.pod:8494
6592 #: ../src/guestfs-actions.pod:8674
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:655 ../fish/guestfish-actions.pod:866
6763 #: ../fish/guestfish-actions.pod:887 ../fish/guestfish-actions.pod:925
6764 #: ../fish/guestfish-actions.pod:934 ../fish/guestfish-actions.pod:943
6765 #: ../fish/guestfish-actions.pod:957 ../fish/guestfish-actions.pod:2202
6766 #: ../fish/guestfish-actions.pod:3250 ../fish/guestfish-actions.pod:3472
6767 #: ../fish/guestfish-actions.pod:3635 ../fish/guestfish-actions.pod:3770
6768 #: ../fish/guestfish-actions.pod:5141
6770 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
6774 #: ../fish/guestfish-actions.pod:127
6779 #: ../fish/guestfish-actions.pod:129
6782 " add-drive filename\n"
6787 #: ../fish/guestfish-actions.pod:131
6789 "This function is the equivalent of calling L</add-drive-opts> with no "
6790 "optional parameters, so the disk is added writable, with the format being "
6791 "detected automatically."
6795 #: ../fish/guestfish-actions.pod:135
6797 "Automatic detection of the format opens you up to a potential security hole "
6798 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6799 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6800 "you should think about replacing calls to this function with calls to L</add-"
6801 "drive-opts>, and specifying the format."
6805 #: ../fish/guestfish-actions.pod:142
6806 msgid "add-drive-opts"
6810 #: ../fish/guestfish-actions.pod:144
6815 #: ../fish/guestfish-actions.pod:146
6818 " add-drive-opts filename [readonly:true|false] [format:..] [iface:..] [name:..]\n"
6823 #: ../fish/guestfish-actions.pod:148 ../src/guestfs-actions.pod:208
6825 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6826 "The first time you call this function, the disk appears as C</dev/sda>, the "
6827 "second time as C</dev/sdb>, and so on."
6831 #: ../fish/guestfish-actions.pod:153 ../src/guestfs-actions.pod:213
6833 "You don't necessarily need to be root when using libguestfs. However you "
6834 "obviously do need sufficient permissions to access the filename for whatever "
6835 "operations you want to perform (ie. read access if you just want to read the "
6836 "image or write access if you want to modify the image)."
6840 #: ../fish/guestfish-actions.pod:159 ../src/guestfs-actions.pod:219
6841 msgid "This call checks that C<filename> exists."
6845 #: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:3434
6846 #: ../src/guestfs-actions.pod:221 ../src/guestfs-actions.pod:5318
6847 msgid "The optional arguments are:"
6851 #: ../fish/guestfish-actions.pod:165 ../src/guestfs-actions.pod:225
6856 #: ../fish/guestfish-actions.pod:167 ../src/guestfs-actions.pod:227
6858 "If true then the image is treated as read-only. Writes are still allowed, "
6859 "but they are stored in a temporary snapshot overlay which is discarded at "
6860 "the end. The disk that you add is not modified."
6864 #: ../fish/guestfish-actions.pod:171 ../src/guestfs-actions.pod:231
6869 #: ../fish/guestfish-actions.pod:173
6871 "This forces the image format. If you omit this (or use L</add-drive> or L</"
6872 "add-drive-ro>) then the format is automatically detected. Possible formats "
6873 "include C<raw> and C<qcow2>."
6877 #: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:237
6879 "Automatic detection of the format opens you up to a potential security hole "
6880 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6881 "RHBZ#642934. Specifying the format closes this security hole."
6885 #: ../fish/guestfish-actions.pod:182 ../src/guestfs-actions.pod:242
6890 #: ../fish/guestfish-actions.pod:184
6892 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
6893 "add-drive-with-if> call (q.v.)"
6897 #: ../fish/guestfish-actions.pod:187 ../fish/guestfish-actions.pod:3277
6898 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:5039
6903 #: ../fish/guestfish-actions.pod:189 ../src/guestfs-actions.pod:249
6905 "The name the drive had in the original guest, e.g. /dev/sdb. This is used as "
6906 "a hint to the guest inspection process if it is available."
6910 #: ../fish/guestfish-actions.pod:196
6911 msgid "add-drive-ro"
6915 #: ../fish/guestfish-actions.pod:198
6920 #: ../fish/guestfish-actions.pod:200
6923 " add-drive-ro filename\n"
6928 #: ../fish/guestfish-actions.pod:202
6930 "This function is the equivalent of calling L</add-drive-opts> with the "
6931 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
6932 "is added read-only, with the format being detected automatically."
6936 #: ../fish/guestfish-actions.pod:207
6937 msgid "add-drive-ro-with-if"
6941 #: ../fish/guestfish-actions.pod:209
6944 " add-drive-ro-with-if filename iface\n"
6949 #: ../fish/guestfish-actions.pod:211
6951 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
6952 "interface emulation to use at run time."
6956 #: ../fish/guestfish-actions.pod:221
6957 msgid "add-drive-with-if"
6961 #: ../fish/guestfish-actions.pod:223
6964 " add-drive-with-if filename iface\n"
6969 #: ../fish/guestfish-actions.pod:225
6971 "This is the same as L</add-drive> but it allows you to specify the QEMU "
6972 "interface emulation to use at run time."
6976 #: ../fish/guestfish-actions.pod:235
6981 #: ../fish/guestfish-actions.pod:237
6984 " aug-clear augpath\n"
6989 #: ../fish/guestfish-actions.pod:239 ../src/guestfs-actions.pod:343
6991 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6992 "L<augtool(1)> C<clear> command."
6996 #: ../fish/guestfish-actions.pod:242
7001 #: ../fish/guestfish-actions.pod:244
7009 #: ../fish/guestfish-actions.pod:246
7011 "Close the current Augeas handle and free up any resources used by it. After "
7012 "calling this, you have to call L</aug-init> again before you can use any "
7013 "other Augeas functions."
7017 #: ../fish/guestfish-actions.pod:251
7022 #: ../fish/guestfish-actions.pod:253
7025 " aug-defnode name expr val\n"
7030 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:372
7032 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
7036 #: ../fish/guestfish-actions.pod:258
7038 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
7039 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
7040 "containing that single node."
7044 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:379
7046 "On success this returns a pair containing the number of nodes in the "
7047 "nodeset, and a boolean flag if a node was created."
7051 #: ../fish/guestfish-actions.pod:266
7056 #: ../fish/guestfish-actions.pod:268
7059 " aug-defvar name expr\n"
7064 #: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:396
7066 "Defines an Augeas variable C<name> whose value is the result of evaluating "
7067 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
7071 #: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:400
7073 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
7074 "evaluates to something which is not a nodeset."
7078 #: ../fish/guestfish-actions.pod:277
7083 #: ../fish/guestfish-actions.pod:279
7086 " aug-get augpath\n"
7091 #: ../fish/guestfish-actions.pod:281 ../src/guestfs-actions.pod:413
7093 "Look up the value associated with C<path>. If C<path> matches exactly one "
7094 "node, the C<value> is returned."
7098 #: ../fish/guestfish-actions.pod:284
7103 #: ../fish/guestfish-actions.pod:286
7106 " aug-init root flags\n"
7111 #: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:428
7113 "Create a new Augeas handle for editing configuration files. If there was "
7114 "any previous Augeas handle associated with this guestfs session, then it is "
7119 #: ../fish/guestfish-actions.pod:292
7120 msgid "You must call this before using any other L</aug-*> commands."
7124 #: ../fish/guestfish-actions.pod:295 ../src/guestfs-actions.pod:435
7126 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
7130 #: ../fish/guestfish-actions.pod:298 ../src/guestfs-actions.pod:438
7132 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
7133 "logical I<or> of the following integers:"
7137 #: ../fish/guestfish-actions.pod:304 ../src/guestfs-actions.pod:444
7138 msgid "C<AUG_SAVE_BACKUP> = 1"
7142 #: ../fish/guestfish-actions.pod:306 ../src/guestfs-actions.pod:446
7143 msgid "Keep the original file with a C<.augsave> extension."
7147 #: ../fish/guestfish-actions.pod:308 ../src/guestfs-actions.pod:448
7148 msgid "C<AUG_SAVE_NEWFILE> = 2"
7152 #: ../fish/guestfish-actions.pod:310 ../src/guestfs-actions.pod:450
7154 "Save changes into a file with extension C<.augnew>, and do not overwrite "
7155 "original. Overrides C<AUG_SAVE_BACKUP>."
7159 #: ../fish/guestfish-actions.pod:313 ../src/guestfs-actions.pod:453
7160 msgid "C<AUG_TYPE_CHECK> = 4"
7164 #: ../fish/guestfish-actions.pod:315 ../src/guestfs-actions.pod:455
7165 msgid "Typecheck lenses."
7169 #: ../fish/guestfish-actions.pod:317
7171 "This option is only useful when debugging Augeas lenses. Use of this option "
7172 "may require additional memory for the libguestfs appliance. You may need to "
7173 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
7177 #: ../fish/guestfish-actions.pod:322 ../src/guestfs-actions.pod:462
7178 msgid "C<AUG_NO_STDINC> = 8"
7182 #: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:464
7183 msgid "Do not use standard load path for modules."
7187 #: ../fish/guestfish-actions.pod:326 ../src/guestfs-actions.pod:466
7188 msgid "C<AUG_SAVE_NOOP> = 16"
7192 #: ../fish/guestfish-actions.pod:328 ../src/guestfs-actions.pod:468
7193 msgid "Make save a no-op, just record what would have been changed."
7197 #: ../fish/guestfish-actions.pod:330 ../src/guestfs-actions.pod:470
7198 msgid "C<AUG_NO_LOAD> = 32"
7202 #: ../fish/guestfish-actions.pod:332
7203 msgid "Do not load the tree in L</aug-init>."
7207 #: ../fish/guestfish-actions.pod:336
7208 msgid "To close the handle, you can call L</aug-close>."
7212 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:478
7213 msgid "To find out more about Augeas, see L<http://augeas.net/>."
7217 #: ../fish/guestfish-actions.pod:340
7222 #: ../fish/guestfish-actions.pod:342
7225 " aug-insert augpath label true|false\n"
7230 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:492
7232 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
7233 "or after C<path> (depending on the boolean flag C<before>)."
7237 #: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:496
7239 "C<path> must match exactly one existing node in the tree, and C<label> must "
7240 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
7244 #: ../fish/guestfish-actions.pod:352
7249 #: ../fish/guestfish-actions.pod:354
7257 #: ../fish/guestfish-actions.pod:356 ../src/guestfs-actions.pod:509
7258 msgid "Load files into the tree."
7262 #: ../fish/guestfish-actions.pod:358 ../src/guestfs-actions.pod:511
7263 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
7267 #: ../fish/guestfish-actions.pod:361
7272 #: ../fish/guestfish-actions.pod:363
7280 #: ../fish/guestfish-actions.pod:365
7282 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
7283 "resulting nodes into alphabetical order."
7287 #: ../fish/guestfish-actions.pod:368
7292 #: ../fish/guestfish-actions.pod:370
7295 " aug-match augpath\n"
7300 #: ../fish/guestfish-actions.pod:372 ../src/guestfs-actions.pod:539
7302 "Returns a list of paths which match the path expression C<path>. The "
7303 "returned paths are sufficiently qualified so that they match exactly one "
7304 "node in the current tree."
7308 #: ../fish/guestfish-actions.pod:376
7313 #: ../fish/guestfish-actions.pod:378
7316 " aug-mv src dest\n"
7321 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:556
7323 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7324 "C<dest> is overwritten if it exists."
7328 #: ../fish/guestfish-actions.pod:383
7333 #: ../fish/guestfish-actions.pod:385
7341 #: ../fish/guestfish-actions.pod:387 ../src/guestfs-actions.pod:569
7342 msgid "Remove C<path> and all of its children."
7346 #: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:571
7347 msgid "On success this returns the number of entries which were removed."
7351 #: ../fish/guestfish-actions.pod:391
7356 #: ../fish/guestfish-actions.pod:393
7364 #: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:582
7365 msgid "This writes all pending changes to disk."
7369 #: ../fish/guestfish-actions.pod:397
7371 "The flags which were passed to L</aug-init> affect exactly how files are "
7376 #: ../fish/guestfish-actions.pod:400
7381 #: ../fish/guestfish-actions.pod:402
7384 " aug-set augpath val\n"
7389 #: ../fish/guestfish-actions.pod:404 ../src/guestfs-actions.pod:598
7390 msgid "Set the value associated with C<path> to C<val>."
7394 #: ../fish/guestfish-actions.pod:406
7396 "In the Augeas API, it is possible to clear a node by setting the value to "
7397 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7398 "this call. Instead you must use the L</aug-clear> call."
7402 #: ../fish/guestfish-actions.pod:411
7407 #: ../fish/guestfish-actions.pod:413
7410 " available 'groups ...'\n"
7415 #: ../fish/guestfish-actions.pod:415 ../src/guestfs-actions.pod:615
7417 "This command is used to check the availability of some groups of "
7418 "functionality in the appliance, which not all builds of the libguestfs "
7419 "appliance will be able to provide."
7423 #: ../fish/guestfish-actions.pod:419
7425 "The libguestfs groups, and the functions that those groups correspond to, "
7426 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7427 "runtime by calling L</available-all-groups>."
7431 #: ../fish/guestfish-actions.pod:424 ../src/guestfs-actions.pod:624
7433 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
7434 "\"]> would check for the availability of the Linux inotify functions and "
7435 "Augeas (configuration file editing) functions."
7439 #: ../fish/guestfish-actions.pod:429 ../src/guestfs-actions.pod:629
7440 msgid "The command returns no error if I<all> requested groups are available."
7444 #: ../fish/guestfish-actions.pod:431 ../src/guestfs-actions.pod:631
7446 "It fails with an error if one or more of the requested groups is unavailable "
7451 #: ../fish/guestfish-actions.pod:434 ../src/guestfs-actions.pod:634
7453 "If an unknown group name is included in the list of groups then an error is "
7458 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:637
7463 #: ../fish/guestfish-actions.pod:443
7464 msgid "You must call L</launch> before calling this function."
7468 #: ../fish/guestfish-actions.pod:445 ../src/guestfs-actions.pod:645
7470 "The reason is because we don't know what groups are supported by the "
7471 "appliance/daemon until it is running and can be queried."
7475 #: ../fish/guestfish-actions.pod:451 ../src/guestfs-actions.pod:651
7477 "If a group of functions is available, this does not necessarily mean that "
7478 "they will work. You still have to check for errors when calling individual "
7479 "API functions even if they are available."
7483 #: ../fish/guestfish-actions.pod:458 ../src/guestfs-actions.pod:658
7485 "It is usually the job of distro packagers to build complete functionality "
7486 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7487 "with all requirements satisfied, will support everything."
7491 #: ../fish/guestfish-actions.pod:465
7493 "This call was added in version C<1.0.80>. In previous versions of "
7494 "libguestfs all you could do would be to speculatively execute a command to "
7495 "find out if the daemon implemented it. See also L</version>."
7499 #: ../fish/guestfish-actions.pod:472
7500 msgid "available-all-groups"
7504 #: ../fish/guestfish-actions.pod:474
7507 " available-all-groups\n"
7512 #: ../fish/guestfish-actions.pod:476
7514 "This command returns a list of all optional groups that this daemon knows "
7515 "about. Note this returns both supported and unsupported groups. To find "
7516 "out which ones the daemon can actually support you have to call L</"
7517 "available> on each member of the returned list."
7521 #: ../fish/guestfish-actions.pod:482
7522 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
7526 #: ../fish/guestfish-actions.pod:484
7531 #: ../fish/guestfish-actions.pod:486
7534 " base64-in (base64file|-) filename\n"
7539 #: ../fish/guestfish-actions.pod:488 ../src/guestfs-actions.pod:702
7541 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7545 #: ../fish/guestfish-actions.pod:491 ../fish/guestfish-actions.pod:500
7546 #: ../fish/guestfish-actions.pod:780 ../fish/guestfish-actions.pod:864
7547 #: ../fish/guestfish-actions.pod:885 ../fish/guestfish-actions.pod:1056
7548 #: ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1449
7549 #: ../fish/guestfish-actions.pod:4997 ../fish/guestfish-actions.pod:5009
7550 #: ../fish/guestfish-actions.pod:5020 ../fish/guestfish-actions.pod:5031
7551 #: ../fish/guestfish-actions.pod:5162 ../fish/guestfish-actions.pod:5171
7552 #: ../fish/guestfish-actions.pod:5225 ../fish/guestfish-actions.pod:5248
7553 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
7557 #: ../fish/guestfish-actions.pod:493
7562 #: ../fish/guestfish-actions.pod:495
7565 " base64-out filename (base64file|-)\n"
7570 #: ../fish/guestfish-actions.pod:497 ../src/guestfs-actions.pod:716
7572 "This command downloads the contents of C<filename>, writing it out to local "
7573 "file C<base64file> encoded as base64."
7577 #: ../fish/guestfish-actions.pod:502
7582 #: ../fish/guestfish-actions.pod:504
7590 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:729
7592 "This command returns block device attributes for C<device>. The following "
7593 "fields are usually present in the returned hash. Other fields may also be "
7598 #: ../fish/guestfish-actions.pod:511 ../src/guestfs-actions.pod:734
7603 #: ../fish/guestfish-actions.pod:513 ../src/guestfs-actions.pod:736
7604 msgid "The uuid of this device."
7608 #: ../fish/guestfish-actions.pod:515 ../src/guestfs-actions.pod:738
7613 #: ../fish/guestfish-actions.pod:517 ../src/guestfs-actions.pod:740
7614 msgid "The label of this device."
7618 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:742
7623 #: ../fish/guestfish-actions.pod:521 ../src/guestfs-actions.pod:744
7624 msgid "The version of blkid command."
7628 #: ../fish/guestfish-actions.pod:523 ../src/guestfs-actions.pod:746
7633 #: ../fish/guestfish-actions.pod:525 ../src/guestfs-actions.pod:748
7634 msgid "The filesystem type or RAID of this device."
7638 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:750
7643 #: ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:752
7644 msgid "The usage of this device, for example C<filesystem> or C<raid>."
7648 #: ../fish/guestfish-actions.pod:533
7649 msgid "blockdev-flushbufs"
7653 #: ../fish/guestfish-actions.pod:535
7656 " blockdev-flushbufs device\n"
7661 #: ../fish/guestfish-actions.pod:537 ../src/guestfs-actions.pod:768
7663 "This tells the kernel to flush internal buffers associated with C<device>."
7667 #: ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:551
7668 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:570
7669 #: ../fish/guestfish-actions.pod:582 ../fish/guestfish-actions.pod:595
7670 #: ../fish/guestfish-actions.pod:603 ../fish/guestfish-actions.pod:614
7671 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:630
7672 #: ../src/guestfs-actions.pod:771 ../src/guestfs-actions.pod:788
7673 #: ../src/guestfs-actions.pod:803 ../src/guestfs-actions.pod:819
7674 #: ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:856
7675 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:888
7676 #: ../src/guestfs-actions.pod:902 ../src/guestfs-actions.pod:916
7677 msgid "This uses the L<blockdev(8)> command."
7681 #: ../fish/guestfish-actions.pod:542
7682 msgid "blockdev-getbsz"
7686 #: ../fish/guestfish-actions.pod:544
7689 " blockdev-getbsz device\n"
7694 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:783
7695 msgid "This returns the block size of a device."
7699 #: ../fish/guestfish-actions.pod:548 ../fish/guestfish-actions.pod:611
7700 #: ../src/guestfs-actions.pod:785 ../src/guestfs-actions.pod:885
7702 "(Note this is different from both I<size in blocks> and I<filesystem block "
7707 #: ../fish/guestfish-actions.pod:553
7708 msgid "blockdev-getro"
7712 #: ../fish/guestfish-actions.pod:555
7715 " blockdev-getro device\n"
7720 #: ../fish/guestfish-actions.pod:557 ../src/guestfs-actions.pod:800
7722 "Returns a boolean indicating if the block device is read-only (true if read-"
7723 "only, false if not)."
7727 #: ../fish/guestfish-actions.pod:562
7728 msgid "blockdev-getsize64"
7732 #: ../fish/guestfish-actions.pod:564
7735 " blockdev-getsize64 device\n"
7740 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:815
7741 msgid "This returns the size of the device in bytes."
7745 #: ../fish/guestfish-actions.pod:568
7746 msgid "See also L</blockdev-getsz>."
7750 #: ../fish/guestfish-actions.pod:572
7751 msgid "blockdev-getss"
7755 #: ../fish/guestfish-actions.pod:574
7758 " blockdev-getss device\n"
7763 #: ../fish/guestfish-actions.pod:576 ../src/guestfs-actions.pod:831
7765 "This returns the size of sectors on a block device. Usually 512, but can be "
7766 "larger for modern devices."
7770 #: ../fish/guestfish-actions.pod:579
7772 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
7776 #: ../fish/guestfish-actions.pod:584
7777 msgid "blockdev-getsz"
7781 #: ../fish/guestfish-actions.pod:586
7784 " blockdev-getsz device\n"
7789 #: ../fish/guestfish-actions.pod:588 ../src/guestfs-actions.pod:849
7791 "This returns the size of the device in units of 512-byte sectors (even if "
7792 "the sectorsize isn't 512 bytes ... weird)."
7796 #: ../fish/guestfish-actions.pod:591
7798 "See also L</blockdev-getss> for the real sector size of the device, and L</"
7799 "blockdev-getsize64> for the more useful I<size in bytes>."
7803 #: ../fish/guestfish-actions.pod:597
7804 msgid "blockdev-rereadpt"
7808 #: ../fish/guestfish-actions.pod:599
7811 " blockdev-rereadpt device\n"
7816 #: ../fish/guestfish-actions.pod:601 ../src/guestfs-actions.pod:868
7817 msgid "Reread the partition table on C<device>."
7821 #: ../fish/guestfish-actions.pod:605
7822 msgid "blockdev-setbsz"
7826 #: ../fish/guestfish-actions.pod:607
7829 " blockdev-setbsz device blocksize\n"
7834 #: ../fish/guestfish-actions.pod:609 ../src/guestfs-actions.pod:883
7835 msgid "This sets the block size of a device."
7839 #: ../fish/guestfish-actions.pod:616
7840 msgid "blockdev-setro"
7844 #: ../fish/guestfish-actions.pod:618
7847 " blockdev-setro device\n"
7852 #: ../fish/guestfish-actions.pod:620 ../src/guestfs-actions.pod:900
7853 msgid "Sets the block device named C<device> to read-only."
7857 #: ../fish/guestfish-actions.pod:624
7858 msgid "blockdev-setrw"
7862 #: ../fish/guestfish-actions.pod:626
7865 " blockdev-setrw device\n"
7870 #: ../fish/guestfish-actions.pod:628 ../src/guestfs-actions.pod:914
7871 msgid "Sets the block device named C<device> to read-write."
7875 #: ../fish/guestfish-actions.pod:632
7876 msgid "btrfs-filesystem-resize"
7880 #: ../fish/guestfish-actions.pod:634
7883 " btrfs-filesystem-resize mountpoint [size:N]\n"
7888 #: ../fish/guestfish-actions.pod:636 ../src/guestfs-actions.pod:936
7889 msgid "This command resizes a btrfs filesystem."
7893 #: ../fish/guestfish-actions.pod:638 ../src/guestfs-actions.pod:938
7895 "Note that unlike other resize calls, the filesystem has to be mounted and "
7896 "the parameter is the mountpoint not the device (this is a requirement of "
7901 #: ../fish/guestfish-actions.pod:642 ../fish/guestfish-actions.pod:3199
7902 #: ../fish/guestfish-actions.pod:3745 ../fish/guestfish-actions.pod:5071
7903 #: ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:4935
7904 #: ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:7818
7905 msgid "The optional parameters are:"
7909 #: ../fish/guestfish-actions.pod:646 ../fish/guestfish-actions.pod:3749
7910 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:5846
7915 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:948
7917 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7918 "resized to the maximum size."
7922 #: ../fish/guestfish-actions.pod:653 ../src/guestfs-actions.pod:953
7923 msgid "See also L<btrfs(8)>."
7927 #: ../fish/guestfish-actions.pod:657
7928 msgid "case-sensitive-path"
7932 #: ../fish/guestfish-actions.pod:659
7935 " case-sensitive-path path\n"
7940 #: ../fish/guestfish-actions.pod:661 ../src/guestfs-actions.pod:987
7942 "This can be used to resolve case insensitive paths on a filesystem which is "
7943 "case sensitive. The use case is to resolve paths which you have read from "
7944 "Windows configuration files or the Windows Registry, to the true path."
7948 #: ../fish/guestfish-actions.pod:666 ../src/guestfs-actions.pod:992
7950 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7951 "(and probably others), which is that although the underlying filesystem is "
7952 "case-insensitive, the driver exports the filesystem to Linux as case-"
7957 #: ../fish/guestfish-actions.pod:671 ../src/guestfs-actions.pod:997
7959 "One consequence of this is that special directories such as C<c:\\windows> "
7960 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7961 "precise details of how they were created. In Windows itself this would not "
7966 #: ../fish/guestfish-actions.pod:677 ../src/guestfs-actions.pod:1003
7968 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7973 #: ../fish/guestfish-actions.pod:680 ../src/guestfs-actions.pod:1006
7975 "This function resolves the true case of each element in the path and returns "
7976 "the case-sensitive path."
7980 #: ../fish/guestfish-actions.pod:683
7982 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
7983 "WINDOWS/system32\"> (the exact return value would depend on details of how "
7984 "the directories were originally created under Windows)."
7988 #: ../fish/guestfish-actions.pod:688 ../src/guestfs-actions.pod:1014
7989 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7993 #: ../fish/guestfish-actions.pod:691
7994 msgid "See also L</realpath>."
7998 #: ../fish/guestfish-actions.pod:693
8003 #: ../fish/guestfish-actions.pod:695
8011 #: ../fish/guestfish-actions.pod:697 ../fish/guestfish-actions.pod:4176
8012 #: ../src/guestfs-actions.pod:1030 ../src/guestfs-actions.pod:6502
8013 msgid "Return the contents of the file named C<path>."
8017 #: ../fish/guestfish-actions.pod:699
8019 "Note that this function cannot correctly handle binary files (specifically, "
8020 "files containing C<\\0> character which is treated as end of string). For "
8021 "those you need to use the L</read-file> or L</download> functions which have "
8022 "a more complex interface."
8026 #: ../fish/guestfish-actions.pod:704 ../fish/guestfish-actions.pod:839
8027 #: ../fish/guestfish-actions.pod:851 ../fish/guestfish-actions.pod:1134
8028 #: ../fish/guestfish-actions.pod:1144 ../fish/guestfish-actions.pod:1211
8029 #: ../fish/guestfish-actions.pod:1221 ../fish/guestfish-actions.pod:1413
8030 #: ../fish/guestfish-actions.pod:1726 ../fish/guestfish-actions.pod:1736
8031 #: ../fish/guestfish-actions.pod:1786 ../fish/guestfish-actions.pod:1801
8032 #: ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1830
8033 #: ../fish/guestfish-actions.pod:4046 ../fish/guestfish-actions.pod:4061
8034 #: ../fish/guestfish-actions.pod:4137 ../fish/guestfish-actions.pod:4154
8035 #: ../fish/guestfish-actions.pod:4169 ../fish/guestfish-actions.pod:4838
8036 #: ../fish/guestfish-actions.pod:4884 ../fish/guestfish-actions.pod:4969
8037 #: ../fish/guestfish-actions.pod:4984 ../fish/guestfish-actions.pod:5469
8038 #: ../fish/guestfish-actions.pod:5481 ../fish/guestfish-actions.pod:5499
8039 #: ../fish/guestfish-actions.pod:5516 ../fish/guestfish-actions.pod:5526
8040 #: ../fish/guestfish-actions.pod:5580 ../fish/guestfish-actions.pod:5590
8041 #: ../fish/guestfish-actions.pod:5619 ../fish/guestfish-actions.pod:5629
8042 #: ../src/guestfs-actions.pod:1040 ../src/guestfs-actions.pod:1219
8043 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1894
8044 #: ../src/guestfs-actions.pod:1913 ../src/guestfs-actions.pod:2016
8045 #: ../src/guestfs-actions.pod:2035 ../src/guestfs-actions.pod:2281
8046 #: ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2782
8047 #: ../src/guestfs-actions.pod:2847 ../src/guestfs-actions.pod:2871
8048 #: ../src/guestfs-actions.pod:2888 ../src/guestfs-actions.pod:2917
8049 #: ../src/guestfs-actions.pod:6284 ../src/guestfs-actions.pod:6310
8050 #: ../src/guestfs-actions.pod:6441 ../src/guestfs-actions.pod:6467
8051 #: ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:7446
8052 #: ../src/guestfs-actions.pod:7501 ../src/guestfs-actions.pod:7647
8053 #: ../src/guestfs-actions.pod:7671 ../src/guestfs-actions.pod:8458
8054 #: ../src/guestfs-actions.pod:8478 ../src/guestfs-actions.pod:8511
8055 #: ../src/guestfs-actions.pod:8530 ../src/guestfs-actions.pod:8549
8056 #: ../src/guestfs-actions.pod:8640 ../src/guestfs-actions.pod:8659
8057 #: ../src/guestfs-actions.pod:8705 ../src/guestfs-actions.pod:8724
8059 "Because of the message protocol, there is a transfer limit of somewhere "
8060 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
8064 #: ../fish/guestfish-actions.pod:707
8069 #: ../fish/guestfish-actions.pod:709
8072 " checksum csumtype path\n"
8077 #: ../fish/guestfish-actions.pod:711 ../src/guestfs-actions.pod:1052
8079 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
8083 #: ../fish/guestfish-actions.pod:714 ../src/guestfs-actions.pod:1055
8085 "The type of checksum to compute is given by the C<csumtype> parameter which "
8086 "must have one of the following values:"
8090 #: ../fish/guestfish-actions.pod:719 ../src/guestfs-actions.pod:1060
8095 #: ../fish/guestfish-actions.pod:721 ../src/guestfs-actions.pod:1062
8097 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
8102 #: ../fish/guestfish-actions.pod:724 ../src/guestfs-actions.pod:1065
8107 #: ../fish/guestfish-actions.pod:726 ../src/guestfs-actions.pod:1067
8108 msgid "Compute the MD5 hash (using the C<md5sum> program)."
8112 #: ../fish/guestfish-actions.pod:728 ../src/guestfs-actions.pod:1069
8117 #: ../fish/guestfish-actions.pod:730 ../src/guestfs-actions.pod:1071
8118 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
8122 #: ../fish/guestfish-actions.pod:732 ../src/guestfs-actions.pod:1073
8127 #: ../fish/guestfish-actions.pod:734 ../src/guestfs-actions.pod:1075
8128 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
8132 #: ../fish/guestfish-actions.pod:736 ../src/guestfs-actions.pod:1077
8137 #: ../fish/guestfish-actions.pod:738 ../src/guestfs-actions.pod:1079
8138 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
8142 #: ../fish/guestfish-actions.pod:740 ../src/guestfs-actions.pod:1081
8147 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1083
8148 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
8152 #: ../fish/guestfish-actions.pod:744 ../src/guestfs-actions.pod:1085
8157 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1087
8158 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
8162 #: ../fish/guestfish-actions.pod:750 ../src/guestfs-actions.pod:1091
8163 msgid "The checksum is returned as a printable string."
8167 #: ../fish/guestfish-actions.pod:752
8168 msgid "To get the checksum for a device, use L</checksum-device>."
8172 #: ../fish/guestfish-actions.pod:754
8173 msgid "To get the checksums for many files, use L</checksums-out>."
8177 #: ../fish/guestfish-actions.pod:756
8178 msgid "checksum-device"
8182 #: ../fish/guestfish-actions.pod:758
8185 " checksum-device csumtype device\n"
8190 #: ../fish/guestfish-actions.pod:760
8192 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
8193 "device named C<device>. For the types of checksums supported see the L</"
8194 "checksum> command."
8198 #: ../fish/guestfish-actions.pod:764
8199 msgid "checksums-out"
8203 #: ../fish/guestfish-actions.pod:766
8206 " checksums-out csumtype directory (sumsfile|-)\n"
8211 #: ../fish/guestfish-actions.pod:768 ../src/guestfs-actions.pod:1126
8213 "This command computes the checksums of all regular files in C<directory> and "
8214 "then emits a list of those checksums to the local output file C<sumsfile>."
8218 #: ../fish/guestfish-actions.pod:772 ../src/guestfs-actions.pod:1130
8220 "This can be used for verifying the integrity of a virtual machine. However "
8221 "to be properly secure you should pay attention to the output of the checksum "
8222 "command (it uses the ones from GNU coreutils). In particular when the "
8223 "filename is not printable, coreutils uses a special backslash syntax. For "
8224 "more information, see the GNU coreutils info file."
8228 #: ../fish/guestfish-actions.pod:782
8233 #: ../fish/guestfish-actions.pod:784
8236 " chmod mode path\n"
8241 #: ../fish/guestfish-actions.pod:786 ../src/guestfs-actions.pod:1149
8243 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
8248 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1152
8250 "I<Note>: When using this command from guestfish, C<mode> by default would be "
8251 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8256 #: ../fish/guestfish-actions.pod:793 ../fish/guestfish-actions.pod:3398
8257 #: ../fish/guestfish-actions.pod:3537 ../fish/guestfish-actions.pod:3547
8258 #: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:1156
8259 #: ../src/guestfs-actions.pod:5249 ../src/guestfs-actions.pod:5458
8260 #: ../src/guestfs-actions.pod:5477 ../src/guestfs-actions.pod:5496
8261 msgid "The mode actually set is affected by the umask."
8265 #: ../fish/guestfish-actions.pod:795
8270 #: ../fish/guestfish-actions.pod:797
8273 " chown owner group path\n"
8278 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1170
8279 msgid "Change the file owner to C<owner> and group to C<group>."
8283 #: ../fish/guestfish-actions.pod:801 ../fish/guestfish-actions.pod:2738
8284 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:4167
8286 "Only numeric uid and gid are supported. If you want to use names, you will "
8287 "need to locate and parse the password file yourself (Augeas support makes "
8288 "this relatively easy)."
8292 #: ../fish/guestfish-actions.pod:805
8297 #: ../fish/guestfish-actions.pod:807
8300 " command 'arguments ...'\n"
8305 #: ../fish/guestfish-actions.pod:809 ../src/guestfs-actions.pod:1186
8307 "This call runs a command from the guest filesystem. The filesystem must be "
8308 "mounted, and must contain a compatible operating system (ie. something "
8309 "Linux, with the same or compatible processor architecture)."
8313 #: ../fish/guestfish-actions.pod:814
8315 "The single parameter is an argv-style list of arguments. The first element "
8316 "is the name of the program to run. Subsequent elements are parameters. The "
8317 "list must be non-empty (ie. must contain a program name). Note that the "
8318 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
8322 #: ../fish/guestfish-actions.pod:821 ../src/guestfs-actions.pod:1198
8323 msgid "The return value is anything printed to I<stdout> by the command."
8327 #: ../fish/guestfish-actions.pod:824 ../src/guestfs-actions.pod:1201
8329 "If the command returns a non-zero exit status, then this function returns an "
8330 "error message. The error message string is the content of I<stderr> from "
8335 #: ../fish/guestfish-actions.pod:828 ../src/guestfs-actions.pod:1205
8337 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
8338 "bin>. If you require a program from another location, you should provide "
8339 "the full path in the first parameter."
8343 #: ../fish/guestfish-actions.pod:833 ../src/guestfs-actions.pod:1210
8345 "Shared libraries and data files required by the program must be available on "
8346 "filesystems which are mounted in the correct places. It is the caller's "
8347 "responsibility to ensure all filesystems that are needed are mounted at the "
8352 #: ../fish/guestfish-actions.pod:842
8353 msgid "command-lines"
8357 #: ../fish/guestfish-actions.pod:844
8360 " command-lines 'arguments ...'\n"
8365 #: ../fish/guestfish-actions.pod:846
8367 "This is the same as L</command>, but splits the result into a list of lines."
8371 #: ../fish/guestfish-actions.pod:849
8372 msgid "See also: L</sh-lines>"
8376 #: ../fish/guestfish-actions.pod:854
8377 msgid "compress-device-out"
8381 #: ../fish/guestfish-actions.pod:856
8384 " compress-device-out ctype device (zdevice|-) [level:N]\n"
8389 #: ../fish/guestfish-actions.pod:858 ../src/guestfs-actions.pod:1260
8391 "This command compresses C<device> and writes it out to the local file "
8396 #: ../fish/guestfish-actions.pod:861
8398 "The C<ctype> and optional C<level> parameters have the same meaning as in L</"
8403 #: ../fish/guestfish-actions.pod:868
8404 msgid "compress-out"
8408 #: ../fish/guestfish-actions.pod:870
8411 " compress-out ctype file (zfile|-) [level:N]\n"
8416 #: ../fish/guestfish-actions.pod:872 ../src/guestfs-actions.pod:1312
8418 "This command compresses C<file> and writes it out to the local file C<zfile>."
8422 #: ../fish/guestfish-actions.pod:875 ../src/guestfs-actions.pod:1315
8424 "The compression program used is controlled by the C<ctype> parameter. "
8425 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>. "
8426 "Some compression types may not be supported by particular builds of "
8427 "libguestfs, in which case you will get an error containing the substring "
8428 "\"not supported\"."
8432 #: ../fish/guestfish-actions.pod:881 ../src/guestfs-actions.pod:1321
8434 "The optional C<level> parameter controls compression level. The meaning and "
8435 "default for this parameter depends on the compression program being used."
8439 #: ../fish/guestfish-actions.pod:889
8444 #: ../fish/guestfish-actions.pod:891
8447 " config qemuparam qemuvalue\n"
8452 #: ../fish/guestfish-actions.pod:893 ../src/guestfs-actions.pod:1362
8454 "This can be used to add arbitrary qemu command line parameters of the form "
8455 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8456 "setting some parameters which would interfere with parameters that we use."
8460 #: ../fish/guestfish-actions.pod:898 ../src/guestfs-actions.pod:1367
8461 msgid "The first character of C<param> string must be a C<-> (dash)."
8465 #: ../fish/guestfish-actions.pod:900 ../src/guestfs-actions.pod:1369
8466 msgid "C<value> can be NULL."
8470 #: ../fish/guestfish-actions.pod:902
8471 msgid "copy-device-to-device"
8475 #: ../fish/guestfish-actions.pod:904
8478 " copy-device-to-device src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8483 #: ../fish/guestfish-actions.pod:906
8485 "The four calls L</copy-device-to-device>, L</copy-device-to-file>, L</copy-"
8486 "file-to-device>, and L</copy-file-to-file> let you copy from a source "
8487 "(device|file) to a destination (device|file)."
8491 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1399
8493 "Partial copies can be made since you can specify optionally the source "
8494 "offset, destination offset and size to copy. These values are all specified "
8495 "in bytes. If not given, the offsets both default to zero, and the size "
8496 "defaults to copying as much as possible until we hit the end of the source."
8500 #: ../fish/guestfish-actions.pod:919 ../src/guestfs-actions.pod:1405
8502 "The source and destination may be the same object. However overlapping "
8503 "regions may not be copied correctly."
8507 #: ../fish/guestfish-actions.pod:922 ../src/guestfs-actions.pod:1408
8509 "If the destination is a file, it is created if required. If the destination "
8510 "file is not large enough, it is extended."
8514 #: ../fish/guestfish-actions.pod:927
8515 msgid "copy-device-to-file"
8519 #: ../fish/guestfish-actions.pod:929
8522 " copy-device-to-file src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8527 #: ../fish/guestfish-actions.pod:931 ../fish/guestfish-actions.pod:940
8528 #: ../fish/guestfish-actions.pod:949
8529 msgid "See L</copy-device-to-device> for a general overview of this call."
8533 #: ../fish/guestfish-actions.pod:936
8534 msgid "copy-file-to-device"
8538 #: ../fish/guestfish-actions.pod:938
8541 " copy-file-to-device src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8546 #: ../fish/guestfish-actions.pod:945
8547 msgid "copy-file-to-file"
8551 #: ../fish/guestfish-actions.pod:947
8554 " copy-file-to-file src dest [srcoffset:N] [destoffset:N] [size:N]\n"
8559 #: ../fish/guestfish-actions.pod:952
8561 "This is B<not> the function you want for copying files. This is for copying "
8562 "blocks within existing files. See L</cp>, L</cp-a> and L</mv> for general "
8563 "file copying and moving functions."
8567 #: ../fish/guestfish-actions.pod:959
8572 #: ../fish/guestfish-actions.pod:961
8575 " copy-size src dest size\n"
8580 #: ../fish/guestfish-actions.pod:963 ../src/guestfs-actions.pod:1623
8582 "This command copies exactly C<size> bytes from one source device or file "
8583 "C<src> to another destination device or file C<dest>."
8587 #: ../fish/guestfish-actions.pod:966 ../src/guestfs-actions.pod:1626
8589 "Note this will fail if the source is too short or if the destination is not "
8594 #: ../fish/guestfish-actions.pod:969 ../fish/guestfish-actions.pod:1004
8596 "I<This function is deprecated.> In new code, use the L</"
8597 "copy_device_to_device> call instead."
8601 #: ../fish/guestfish-actions.pod:976
8606 #: ../fish/guestfish-actions.pod:978
8614 #: ../fish/guestfish-actions.pod:980 ../src/guestfs-actions.pod:1645
8616 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8617 "destination filename or destination directory."
8621 #: ../fish/guestfish-actions.pod:983
8626 #: ../fish/guestfish-actions.pod:985
8634 #: ../fish/guestfish-actions.pod:987 ../src/guestfs-actions.pod:1659
8636 "This copies a file or directory from C<src> to C<dest> recursively using the "
8641 #: ../fish/guestfish-actions.pod:990
8646 #: ../fish/guestfish-actions.pod:992
8654 #: ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1680
8656 "This command copies from one source device or file C<src> to another "
8657 "destination device or file C<dest>. Normally you would use this to copy to "
8658 "or from a device or partition, for example to duplicate a filesystem."
8662 #: ../fish/guestfish-actions.pod:999
8664 "If the destination is a device, it must be as large or larger than the "
8665 "source file or device, otherwise the copy will fail. This command cannot do "
8666 "partial copies (see L</copy-device-to-device>)."
8670 #: ../fish/guestfish-actions.pod:1011
8675 #: ../fish/guestfish-actions.pod:1013
8683 #: ../fish/guestfish-actions.pod:1015 ../src/guestfs-actions.pod:1699
8684 msgid "This command runs the C<df> command to report disk space used."
8688 #: ../fish/guestfish-actions.pod:1017 ../fish/guestfish-actions.pod:1028
8690 "This command is mostly useful for interactive sessions. It is I<not> "
8691 "intended that you try to parse the output string. Use L</statvfs> from "
8696 #: ../fish/guestfish-actions.pod:1021
8701 #: ../fish/guestfish-actions.pod:1023
8709 #: ../fish/guestfish-actions.pod:1025 ../src/guestfs-actions.pod:1715
8711 "This command runs the C<df -h> command to report disk space used in human-"
8716 #: ../fish/guestfish-actions.pod:1032
8721 #: ../fish/guestfish-actions.pod:1034
8729 #: ../fish/guestfish-actions.pod:1036 ../src/guestfs-actions.pod:1732
8731 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8732 "This is sometimes useful for extended debugging of problems."
8736 #: ../fish/guestfish-actions.pod:1040
8738 "Another way to get the same information is to enable verbose messages with "
8739 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
8740 "before running the program."
8744 #: ../fish/guestfish-actions.pod:1045
8749 #: ../fish/guestfish-actions.pod:1047
8752 " download remotefilename (filename|-)\n"
8757 #: ../fish/guestfish-actions.pod:1049 ../fish/guestfish-actions.pod:1062
8758 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:1778
8760 "Download file C<remotefilename> and save it as C<filename> on the local "
8765 #: ../fish/guestfish-actions.pod:1052 ../fish/guestfish-actions.pod:5221
8766 #: ../src/guestfs-actions.pod:1756 ../src/guestfs-actions.pod:8028
8767 msgid "C<filename> can also be a named pipe."
8771 #: ../fish/guestfish-actions.pod:1054
8772 msgid "See also L</upload>, L</cat>."
8776 #: ../fish/guestfish-actions.pod:1058
8777 msgid "download-offset"
8781 #: ../fish/guestfish-actions.pod:1060
8784 " download-offset remotefilename (filename|-) offset size\n"
8789 #: ../fish/guestfish-actions.pod:1065 ../src/guestfs-actions.pod:1781
8791 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8792 "region must be within the file or device)."
8796 #: ../fish/guestfish-actions.pod:1068
8798 "Note that there is no limit on the amount of data that can be downloaded "
8799 "with this call, unlike with L</pread>, and this call always reads the full "
8800 "amount unless an error occurs."
8804 #: ../fish/guestfish-actions.pod:1073
8805 msgid "See also L</download>, L</pread>."
8809 #: ../fish/guestfish-actions.pod:1077
8814 #: ../fish/guestfish-actions.pod:1079
8817 " drop-caches whattodrop\n"
8822 #: ../fish/guestfish-actions.pod:1081 ../src/guestfs-actions.pod:1806
8824 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8825 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8826 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8830 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1811
8831 msgid "Setting C<whattodrop> to 3 should drop everything."
8835 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1813
8837 "This automatically calls L<sync(2)> before the operation, so that the "
8838 "maximum guest memory is freed."
8842 #: ../fish/guestfish-actions.pod:1091
8847 #: ../fish/guestfish-actions.pod:1093
8855 #: ../fish/guestfish-actions.pod:1095 ../src/guestfs-actions.pod:1826
8857 "This command runs the C<du -s> command to estimate file space usage for "
8862 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1829
8864 "C<path> can be a file or a directory. If C<path> is a directory then the "
8865 "estimate includes the contents of the directory and all subdirectories "
8870 #: ../fish/guestfish-actions.pod:1102 ../src/guestfs-actions.pod:1833
8872 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8876 #: ../fish/guestfish-actions.pod:1105
8881 #: ../fish/guestfish-actions.pod:1107
8884 " e2fsck-f device\n"
8889 #: ../fish/guestfish-actions.pod:1109 ../src/guestfs-actions.pod:1851
8891 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8892 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8897 #: ../fish/guestfish-actions.pod:1113
8899 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
8900 "should use L</fsck>."
8904 #: ../fish/guestfish-actions.pod:1116
8909 #: ../fish/guestfish-actions.pod:1118
8912 " echo-daemon 'words ...'\n"
8917 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1868
8919 "This command concatenates the list of C<words> passed with single spaces "
8920 "between them and returns the resulting string."
8924 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1871
8925 msgid "You can use this command to test the connection through to the daemon."
8929 #: ../fish/guestfish-actions.pod:1125
8930 msgid "See also L</ping-daemon>."
8934 #: ../fish/guestfish-actions.pod:1127
8939 #: ../fish/guestfish-actions.pod:1129
8942 " egrep regex path\n"
8947 #: ../fish/guestfish-actions.pod:1131 ../src/guestfs-actions.pod:1887
8949 "This calls the external C<egrep> program and returns the matching lines."
8953 #: ../fish/guestfish-actions.pod:1137
8958 #: ../fish/guestfish-actions.pod:1139
8961 " egrepi regex path\n"
8966 #: ../fish/guestfish-actions.pod:1141 ../src/guestfs-actions.pod:1906
8968 "This calls the external C<egrep -i> program and returns the matching lines."
8972 #: ../fish/guestfish-actions.pod:1147
8977 #: ../fish/guestfish-actions.pod:1149
8980 " equal file1 file2\n"
8985 #: ../fish/guestfish-actions.pod:1151 ../src/guestfs-actions.pod:1925
8987 "This compares the two files C<file1> and C<file2> and returns true if their "
8988 "content is exactly equal, or false otherwise."
8992 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1928
8993 msgid "The external L<cmp(1)> program is used for the comparison."
8997 #: ../fish/guestfish-actions.pod:1156
9002 #: ../fish/guestfish-actions.pod:1158
9010 #: ../fish/guestfish-actions.pod:1160 ../src/guestfs-actions.pod:1940
9012 "This returns C<true> if and only if there is a file, directory (or anything) "
9013 "with the given C<path> name."
9017 #: ../fish/guestfish-actions.pod:1163
9018 msgid "See also L</is-file>, L</is-dir>, L</stat>."
9022 #: ../fish/guestfish-actions.pod:1165
9027 #: ../fish/guestfish-actions.pod:1167
9030 " fallocate path len\n"
9035 #: ../fish/guestfish-actions.pod:1169 ../fish/guestfish-actions.pod:1188
9036 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:1982
9038 "This command preallocates a file (containing zero bytes) named C<path> of "
9039 "size C<len> bytes. If the file exists already, it is overwritten."
9043 #: ../fish/guestfish-actions.pod:1173 ../src/guestfs-actions.pod:1967
9045 "Do not confuse this with the guestfish-specific C<alloc> command which "
9046 "allocates a file in the host and attaches it as a device."
9050 #: ../fish/guestfish-actions.pod:1177
9052 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
9057 #: ../fish/guestfish-actions.pod:1184
9062 #: ../fish/guestfish-actions.pod:1186
9065 " fallocate64 path len\n"
9070 #: ../fish/guestfish-actions.pod:1192
9072 "Note that this call allocates disk blocks for the file. To create a sparse "
9073 "file use L</truncate-size> instead."
9077 #: ../fish/guestfish-actions.pod:1195
9079 "The deprecated call L</fallocate> does the same, but owing to an oversight "
9080 "it only allowed 30 bit lengths to be specified, effectively limiting the "
9081 "maximum size of files created through that call to 1GB."
9085 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:1994
9087 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
9088 "commands which create a file in the host and attach it as a device."
9092 #: ../fish/guestfish-actions.pod:1204
9097 #: ../fish/guestfish-actions.pod:1206
9100 " fgrep pattern path\n"
9105 #: ../fish/guestfish-actions.pod:1208 ../src/guestfs-actions.pod:2009
9107 "This calls the external C<fgrep> program and returns the matching lines."
9111 #: ../fish/guestfish-actions.pod:1214
9116 #: ../fish/guestfish-actions.pod:1216
9119 " fgrepi pattern path\n"
9124 #: ../fish/guestfish-actions.pod:1218 ../src/guestfs-actions.pod:2028
9126 "This calls the external C<fgrep -i> program and returns the matching lines."
9130 #: ../fish/guestfish-actions.pod:1224
9135 #: ../fish/guestfish-actions.pod:1226
9143 #: ../fish/guestfish-actions.pod:1228 ../src/guestfs-actions.pod:2046
9145 "This call uses the standard L<file(1)> command to determine the type or "
9146 "contents of the file."
9150 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:2049
9152 "This call will also transparently look inside various types of compressed "
9157 #: ../fish/guestfish-actions.pod:1234 ../src/guestfs-actions.pod:2052
9159 "The exact command which runs is C<file -zb path>. Note in particular that "
9160 "the filename is not prepended to the output (the I<-b> option)."
9164 #: ../fish/guestfish-actions.pod:1238 ../src/guestfs-actions.pod:2056
9166 "The output depends on the output of the underlying L<file(1)> command and it "
9167 "can change in future in ways beyond our control. In other words, the output "
9168 "is not guaranteed by the ABI."
9172 #: ../fish/guestfish-actions.pod:1242
9174 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
9175 "(etc), L</is-zero>."
9179 #: ../fish/guestfish-actions.pod:1245
9180 msgid "file-architecture"
9184 #: ../fish/guestfish-actions.pod:1247
9187 " file-architecture filename\n"
9192 #: ../fish/guestfish-actions.pod:1249 ../src/guestfs-actions.pod:2074
9194 "This detects the architecture of the binary C<filename>, and returns it if "
9199 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:2077
9200 msgid "Currently defined architectures are:"
9204 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:2081
9209 #: ../fish/guestfish-actions.pod:1258 ../src/guestfs-actions.pod:2083
9211 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9212 "irrespective of the precise processor requirements of the binary."
9216 #: ../fish/guestfish-actions.pod:1261 ../src/guestfs-actions.pod:2086
9221 #: ../fish/guestfish-actions.pod:1263 ../src/guestfs-actions.pod:2088
9222 msgid "64 bit x86-64."
9226 #: ../fish/guestfish-actions.pod:1265 ../src/guestfs-actions.pod:2090
9231 #: ../fish/guestfish-actions.pod:1267 ../src/guestfs-actions.pod:2092
9232 msgid "32 bit SPARC."
9236 #: ../fish/guestfish-actions.pod:1269 ../src/guestfs-actions.pod:2094
9241 #: ../fish/guestfish-actions.pod:1271 ../src/guestfs-actions.pod:2096
9242 msgid "64 bit SPARC V9 and above."
9246 #: ../fish/guestfish-actions.pod:1273 ../src/guestfs-actions.pod:2098
9251 #: ../fish/guestfish-actions.pod:1275 ../src/guestfs-actions.pod:2100
9252 msgid "Intel Itanium."
9256 #: ../fish/guestfish-actions.pod:1277 ../src/guestfs-actions.pod:2102
9261 #: ../fish/guestfish-actions.pod:1279 ../src/guestfs-actions.pod:2104
9262 msgid "32 bit Power PC."
9266 #: ../fish/guestfish-actions.pod:1281 ../src/guestfs-actions.pod:2106
9271 #: ../fish/guestfish-actions.pod:1283 ../src/guestfs-actions.pod:2108
9272 msgid "64 bit Power PC."
9276 #: ../fish/guestfish-actions.pod:1287 ../src/guestfs-actions.pod:2112
9277 msgid "Libguestfs may return other architecture strings in future."
9281 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:2114
9282 msgid "The function works on at least the following types of files:"
9286 #: ../fish/guestfish-actions.pod:1295 ../src/guestfs-actions.pod:2120
9287 msgid "many types of Un*x and Linux binary"
9291 #: ../fish/guestfish-actions.pod:1299 ../src/guestfs-actions.pod:2124
9292 msgid "many types of Un*x and Linux shared library"
9296 #: ../fish/guestfish-actions.pod:1303 ../src/guestfs-actions.pod:2128
9297 msgid "Windows Win32 and Win64 binaries"
9301 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:2132
9302 msgid "Windows Win32 and Win64 DLLs"
9306 #: ../fish/guestfish-actions.pod:1309 ../src/guestfs-actions.pod:2134
9307 msgid "Win32 binaries and DLLs return C<i386>."
9311 #: ../fish/guestfish-actions.pod:1311 ../src/guestfs-actions.pod:2136
9312 msgid "Win64 binaries and DLLs return C<x86_64>."
9316 #: ../fish/guestfish-actions.pod:1315 ../src/guestfs-actions.pod:2140
9317 msgid "Linux kernel modules"
9321 #: ../fish/guestfish-actions.pod:1319 ../src/guestfs-actions.pod:2144
9322 msgid "Linux new-style initrd images"
9326 #: ../fish/guestfish-actions.pod:1323 ../src/guestfs-actions.pod:2148
9327 msgid "some non-x86 Linux vmlinuz kernels"
9331 #: ../fish/guestfish-actions.pod:1327 ../src/guestfs-actions.pod:2152
9332 msgid "What it can't do currently:"
9336 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2158
9337 msgid "static libraries (libfoo.a)"
9341 #: ../fish/guestfish-actions.pod:1337 ../src/guestfs-actions.pod:2162
9342 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9346 #: ../fish/guestfish-actions.pod:1341 ../src/guestfs-actions.pod:2166
9347 msgid "x86 Linux vmlinuz kernels"
9351 #: ../fish/guestfish-actions.pod:1343 ../src/guestfs-actions.pod:2168
9353 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9354 "compressed code, and are horribly hard to unpack. If you want to find the "
9355 "architecture of a kernel, use the architecture of the associated initrd or "
9356 "kernel module(s) instead."
9360 #: ../fish/guestfish-actions.pod:1350
9365 #: ../fish/guestfish-actions.pod:1352
9373 #: ../fish/guestfish-actions.pod:1354 ../src/guestfs-actions.pod:2186
9374 msgid "This command returns the size of C<file> in bytes."
9378 #: ../fish/guestfish-actions.pod:1356
9380 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
9381 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
9385 #: ../fish/guestfish-actions.pod:1360
9390 #: ../fish/guestfish-actions.pod:1362
9393 " fill c len path\n"
9398 #: ../fish/guestfish-actions.pod:1364 ../src/guestfs-actions.pod:2204
9400 "This command creates a new file called C<path>. The initial content of the "
9401 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9406 #: ../fish/guestfish-actions.pod:1368
9408 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9409 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
9414 #: ../fish/guestfish-actions.pod:1373
9415 msgid "fill-pattern"
9419 #: ../fish/guestfish-actions.pod:1375
9422 " fill-pattern pattern len path\n"
9427 #: ../fish/guestfish-actions.pod:1377
9429 "This function is like L</fill> except that it creates a new file of length "
9430 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
9431 "is truncated if necessary to ensure the length of the file is exactly C<len> "
9436 #: ../fish/guestfish-actions.pod:1382
9441 #: ../fish/guestfish-actions.pod:1384
9449 #: ../fish/guestfish-actions.pod:1386 ../src/guestfs-actions.pod:2250
9451 "This command lists out all files and directories, recursively, starting at "
9452 "C<directory>. It is essentially equivalent to running the shell command "
9453 "C<find directory -print> but some post-processing happens on the output, "
9458 #: ../fish/guestfish-actions.pod:1391 ../src/guestfs-actions.pod:2255
9460 "This returns a list of strings I<without any prefix>. Thus if the directory "
9465 #: ../fish/guestfish-actions.pod:1394 ../src/guestfs-actions.pod:2258
9475 #: ../fish/guestfish-actions.pod:1398
9476 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
9480 #: ../fish/guestfish-actions.pod:1401 ../src/guestfs-actions.pod:2265
9491 #: ../fish/guestfish-actions.pod:1406 ../src/guestfs-actions.pod:2270
9492 msgid "If C<directory> is not a directory, then this command returns an error."
9496 #: ../fish/guestfish-actions.pod:1409 ../src/guestfs-actions.pod:2273
9497 msgid "The returned list is sorted."
9501 #: ../fish/guestfish-actions.pod:1411
9502 msgid "See also L</find0>."
9506 #: ../fish/guestfish-actions.pod:1416
9511 #: ../fish/guestfish-actions.pod:1418
9514 " find0 directory (files|-)\n"
9519 #: ../fish/guestfish-actions.pod:1420 ../src/guestfs-actions.pod:2293
9521 "This command lists out all files and directories, recursively, starting at "
9522 "C<directory>, placing the resulting list in the external file called "
9527 #: ../fish/guestfish-actions.pod:1424
9529 "This command works the same way as L</find> with the following exceptions:"
9533 #: ../fish/guestfish-actions.pod:1431 ../src/guestfs-actions.pod:2304
9534 msgid "The resulting list is written to an external file."
9538 #: ../fish/guestfish-actions.pod:1435 ../src/guestfs-actions.pod:2308
9540 "Items (filenames) in the result are separated by C<\\0> characters. See "
9541 "L<find(1)> option I<-print0>."
9545 #: ../fish/guestfish-actions.pod:1440 ../src/guestfs-actions.pod:2313
9546 msgid "This command is not limited in the number of names that it can return."
9550 #: ../fish/guestfish-actions.pod:1445 ../src/guestfs-actions.pod:2318
9551 msgid "The result list is not sorted."
9555 #: ../fish/guestfish-actions.pod:1451
9556 msgid "findfs-label"
9560 #: ../fish/guestfish-actions.pod:1453
9563 " findfs-label label\n"
9568 #: ../fish/guestfish-actions.pod:1455 ../src/guestfs-actions.pod:2332
9570 "This command searches the filesystems and returns the one which has the "
9571 "given label. An error is returned if no such filesystem can be found."
9575 #: ../fish/guestfish-actions.pod:1459
9576 msgid "To find the label of a filesystem, use L</vfs-label>."
9580 #: ../fish/guestfish-actions.pod:1461
9585 #: ../fish/guestfish-actions.pod:1463
9588 " findfs-uuid uuid\n"
9593 #: ../fish/guestfish-actions.pod:1465 ../src/guestfs-actions.pod:2349
9595 "This command searches the filesystems and returns the one which has the "
9596 "given UUID. An error is returned if no such filesystem can be found."
9600 #: ../fish/guestfish-actions.pod:1469
9601 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
9605 #: ../fish/guestfish-actions.pod:1471
9610 #: ../fish/guestfish-actions.pod:1473
9613 " fsck fstype device\n"
9618 #: ../fish/guestfish-actions.pod:1475 ../src/guestfs-actions.pod:2367
9620 "This runs the filesystem checker (fsck) on C<device> which should have "
9621 "filesystem type C<fstype>."
9625 #: ../fish/guestfish-actions.pod:1478 ../src/guestfs-actions.pod:2370
9627 "The returned integer is the status. See L<fsck(8)> for the list of status "
9628 "codes from C<fsck>."
9632 #: ../fish/guestfish-actions.pod:1487 ../src/guestfs-actions.pod:2379
9633 msgid "Multiple status codes can be summed together."
9637 #: ../fish/guestfish-actions.pod:1491 ../src/guestfs-actions.pod:2383
9639 "A non-zero return code can mean \"success\", for example if errors have been "
9640 "corrected on the filesystem."
9644 #: ../fish/guestfish-actions.pod:1496 ../src/guestfs-actions.pod:2388
9645 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9649 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2393
9651 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9655 #: ../fish/guestfish-actions.pod:1503
9660 #: ../fish/guestfish-actions.pod:1505
9668 #: ../fish/guestfish-actions.pod:1507 ../src/guestfs-actions.pod:2404
9670 "Return the additional kernel options which are added to the guest kernel "
9675 #: ../fish/guestfish-actions.pod:1510 ../src/guestfs-actions.pod:2407
9676 msgid "If C<NULL> then no options are added."
9680 #: ../fish/guestfish-actions.pod:1512
9681 msgid "get-attach-method"
9685 #: ../fish/guestfish-actions.pod:1514
9688 " get-attach-method\n"
9693 #: ../fish/guestfish-actions.pod:1516
9694 msgid "Return the current attach method. See L</set-attach-method>."
9698 #: ../fish/guestfish-actions.pod:1518
9699 msgid "get-autosync"
9703 #: ../fish/guestfish-actions.pod:1520
9711 #: ../fish/guestfish-actions.pod:1522 ../src/guestfs-actions.pod:2432
9712 msgid "Get the autosync flag."
9716 #: ../fish/guestfish-actions.pod:1524
9721 #: ../fish/guestfish-actions.pod:1526
9729 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2443
9730 msgid "Return the direct appliance mode flag."
9734 #: ../fish/guestfish-actions.pod:1530
9739 #: ../fish/guestfish-actions.pod:1532
9742 " get-e2label device\n"
9747 #: ../fish/guestfish-actions.pod:1534 ../src/guestfs-actions.pod:2462
9749 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9753 #: ../fish/guestfish-actions.pod:1537
9755 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
9760 #: ../fish/guestfish-actions.pod:1544
9765 #: ../fish/guestfish-actions.pod:1546
9768 " get-e2uuid device\n"
9773 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2483
9775 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9779 #: ../fish/guestfish-actions.pod:1551
9781 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
9786 #: ../fish/guestfish-actions.pod:1558
9791 #: ../fish/guestfish-actions.pod:1560
9799 #: ../fish/guestfish-actions.pod:1562 ../src/guestfs-actions.pod:2496
9801 "This gets the memory size in megabytes allocated to the qemu subprocess."
9805 #: ../fish/guestfish-actions.pod:1565
9807 "If L</set-memsize> was not called on this handle, and if "
9808 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9809 "value for memsize."
9813 #: ../fish/guestfish-actions.pod:1569 ../fish/guestfish-actions.pod:1626
9814 #: ../fish/guestfish-actions.pod:4499 ../fish/guestfish-actions.pod:4601
9815 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2595
9816 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7086
9818 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9822 #: ../fish/guestfish-actions.pod:1572
9827 #: ../fish/guestfish-actions.pod:1574
9835 #: ../fish/guestfish-actions.pod:1576 ../src/guestfs-actions.pod:2515
9836 msgid "This returns the enable network flag."
9840 #: ../fish/guestfish-actions.pod:1578
9845 #: ../fish/guestfish-actions.pod:1580
9853 #: ../fish/guestfish-actions.pod:1582 ../src/guestfs-actions.pod:2526
9854 msgid "Return the current search path."
9858 #: ../fish/guestfish-actions.pod:1584 ../src/guestfs-actions.pod:2528
9860 "This is always non-NULL. If it wasn't set already, then this will return "
9865 #: ../fish/guestfish-actions.pod:1587
9870 #: ../fish/guestfish-actions.pod:1589
9878 #: ../fish/guestfish-actions.pod:1591 ../src/guestfs-actions.pod:2541
9879 msgid "This returns the process group flag."
9883 #: ../fish/guestfish-actions.pod:1593
9888 #: ../fish/guestfish-actions.pod:1595
9893 #: ../fish/guestfish-actions.pod:1597
9901 #: ../fish/guestfish-actions.pod:1599 ../src/guestfs-actions.pod:2552
9903 "Return the process ID of the qemu subprocess. If there is no qemu "
9904 "subprocess, then this will return an error."
9908 #: ../fish/guestfish-actions.pod:1602 ../src/guestfs-actions.pod:2555
9909 msgid "This is an internal call used for debugging and testing."
9913 #: ../fish/guestfish-actions.pod:1604
9918 #: ../fish/guestfish-actions.pod:1606
9926 #: ../fish/guestfish-actions.pod:1608 ../src/guestfs-actions.pod:2566
9927 msgid "Return the current qemu binary."
9931 #: ../fish/guestfish-actions.pod:1610 ../src/guestfs-actions.pod:2568
9933 "This is always non-NULL. If it wasn't set already, then this will return "
9934 "the default qemu binary name."
9938 #: ../fish/guestfish-actions.pod:1613
9939 msgid "get-recovery-proc"
9943 #: ../fish/guestfish-actions.pod:1615
9946 " get-recovery-proc\n"
9951 #: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2581
9952 msgid "Return the recovery process enabled flag."
9956 #: ../fish/guestfish-actions.pod:1619
9961 #: ../fish/guestfish-actions.pod:1621
9969 #: ../fish/guestfish-actions.pod:1623
9971 "This returns the current setting of the selinux flag which is passed to the "
9972 "appliance at boot time. See L</set-selinux>."
9976 #: ../fish/guestfish-actions.pod:1629
9981 #: ../fish/guestfish-actions.pod:1631
9989 #: ../fish/guestfish-actions.pod:1633 ../src/guestfs-actions.pod:2607
9990 msgid "This returns the number of virtual CPUs assigned to the appliance."
9994 #: ../fish/guestfish-actions.pod:1635
9999 #: ../fish/guestfish-actions.pod:1637
10007 #: ../fish/guestfish-actions.pod:1639 ../src/guestfs-actions.pod:2618
10009 "This returns the current state as an opaque integer. This is only useful "
10010 "for printing debug and internal error messages."
10014 #: ../fish/guestfish-actions.pod:1642 ../fish/guestfish-actions.pod:2605
10015 #: ../fish/guestfish-actions.pod:2623 ../fish/guestfish-actions.pod:2661
10016 #: ../fish/guestfish-actions.pod:2677 ../src/guestfs-actions.pod:2621
10017 #: ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3973
10018 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4061
10019 msgid "For more information on states, see L<guestfs(3)>."
10023 #: ../fish/guestfish-actions.pod:1644
10028 #: ../fish/guestfish-actions.pod:1646
10036 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2632
10037 msgid "Return the command trace flag."
10041 #: ../fish/guestfish-actions.pod:1650
10046 #: ../fish/guestfish-actions.pod:1652
10054 #: ../fish/guestfish-actions.pod:1654
10056 "Return the current umask. By default the umask is C<022> unless it has been "
10057 "set by calling L</umask>."
10061 #: ../fish/guestfish-actions.pod:1657
10062 msgid "get-verbose"
10066 #: ../fish/guestfish-actions.pod:1659
10074 #: ../fish/guestfish-actions.pod:1661 ../src/guestfs-actions.pod:2655
10075 msgid "This returns the verbose messages flag."
10079 #: ../fish/guestfish-actions.pod:1663
10084 #: ../fish/guestfish-actions.pod:1665
10092 #: ../fish/guestfish-actions.pod:1667 ../src/guestfs-actions.pod:2666
10093 msgid "This gets the SELinux security context of the daemon."
10097 #: ../fish/guestfish-actions.pod:1669
10098 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
10102 #: ../fish/guestfish-actions.pod:1672
10107 #: ../fish/guestfish-actions.pod:1674
10110 " getxattr path name\n"
10115 #: ../fish/guestfish-actions.pod:1676
10117 "Get a single extended attribute from file C<path> named C<name>. This call "
10118 "follows symlinks. If you want to lookup an extended attribute for the "
10119 "symlink itself, use L</lgetxattr>."
10123 #: ../fish/guestfish-actions.pod:1680 ../fish/guestfish-actions.pod:2750
10125 "Normally it is better to get all extended attributes from a file in one go "
10126 "by calling L</getxattrs>. However some Linux filesystem implementations are "
10127 "buggy and do not provide a way to list out attributes. For these "
10128 "filesystems (notably ntfs-3g) you have to know the names of the extended "
10129 "attributes you want in advance and call this function."
10133 #: ../fish/guestfish-actions.pod:1687 ../fish/guestfish-actions.pod:2757
10134 #: ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:4194
10136 "Extended attribute values are blobs of binary data. If there is no extended "
10137 "attribute named C<name>, this returns an error."
10141 #: ../fish/guestfish-actions.pod:1690
10142 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
10146 #: ../fish/guestfish-actions.pod:1692
10151 #: ../fish/guestfish-actions.pod:1694
10154 " getxattrs path\n"
10159 #: ../fish/guestfish-actions.pod:1696 ../src/guestfs-actions.pod:2712
10161 "This call lists the extended attributes of the file or directory C<path>."
10165 #: ../fish/guestfish-actions.pod:1699 ../src/guestfs-actions.pod:2715
10167 "At the system call level, this is a combination of the L<listxattr(2)> and "
10168 "L<getxattr(2)> calls."
10172 #: ../fish/guestfish-actions.pod:1702
10173 msgid "See also: L</lgetxattrs>, L<attr(5)>."
10177 #: ../fish/guestfish-actions.pod:1704
10178 msgid "glob-expand"
10182 #: ../fish/guestfish-actions.pod:1706
10185 " glob-expand pattern\n"
10190 #: ../fish/guestfish-actions.pod:1708 ../src/guestfs-actions.pod:2732
10192 "This command searches for all the pathnames matching C<pattern> according to "
10193 "the wildcard expansion rules used by the shell."
10197 #: ../fish/guestfish-actions.pod:1712 ../src/guestfs-actions.pod:2736
10199 "If no paths match, then this returns an empty list (note: not an error)."
10203 #: ../fish/guestfish-actions.pod:1715 ../src/guestfs-actions.pod:2739
10205 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10206 "GLOB_BRACE>. See that manual page for more details."
10210 #: ../fish/guestfish-actions.pod:1719
10215 #: ../fish/guestfish-actions.pod:1721
10218 " grep regex path\n"
10223 #: ../fish/guestfish-actions.pod:1723 ../src/guestfs-actions.pod:2756
10224 msgid "This calls the external C<grep> program and returns the matching lines."
10228 #: ../fish/guestfish-actions.pod:1729
10233 #: ../fish/guestfish-actions.pod:1731
10236 " grepi regex path\n"
10241 #: ../fish/guestfish-actions.pod:1733 ../src/guestfs-actions.pod:2775
10243 "This calls the external C<grep -i> program and returns the matching lines."
10247 #: ../fish/guestfish-actions.pod:1739
10248 msgid "grub-install"
10252 #: ../fish/guestfish-actions.pod:1741
10255 " grub-install root device\n"
10260 #: ../fish/guestfish-actions.pod:1743 ../src/guestfs-actions.pod:2794
10262 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
10263 "with the root directory being C<root>."
10267 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2803
10269 "There is currently no way in the API to install grub2, which is used by most "
10270 "modern Linux guests. It is possible to run the grub2 command from the "
10271 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
10275 #: ../fish/guestfish-actions.pod:1759 ../src/guestfs-actions.pod:2810
10277 "This uses C<grub-install> from the host. Unfortunately grub is not always "
10278 "compatible with itself, so this only works in rather narrow circumstances. "
10279 "Careful testing with each guest version is advisable."
10283 #: ../fish/guestfish-actions.pod:1766 ../src/guestfs-actions.pod:2817
10285 "If grub-install reports the error \"No suitable drive was found in the "
10286 "generated device map.\" it may be that you need to create a C</boot/grub/"
10287 "device.map> file first that contains the mapping between grub device names "
10288 "and Linux device names. It is usually sufficient to create a file "
10293 #: ../fish/guestfish-actions.pod:1773 ../src/guestfs-actions.pod:2824
10296 " (hd0) /dev/vda\n"
10301 #: ../fish/guestfish-actions.pod:1775 ../src/guestfs-actions.pod:2826
10302 msgid "replacing C</dev/vda> with the name of the installation device."
10306 #: ../fish/guestfish-actions.pod:1779
10311 #: ../fish/guestfish-actions.pod:1781
10319 #: ../fish/guestfish-actions.pod:1783 ../src/guestfs-actions.pod:2840
10321 "This command returns up to the first 10 lines of a file as a list of strings."
10325 #: ../fish/guestfish-actions.pod:1789
10330 #: ../fish/guestfish-actions.pod:1791
10333 " head-n nrlines path\n"
10338 #: ../fish/guestfish-actions.pod:1793 ../src/guestfs-actions.pod:2859
10340 "If the parameter C<nrlines> is a positive number, this returns the first "
10341 "C<nrlines> lines of the file C<path>."
10345 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2862
10347 "If the parameter C<nrlines> is a negative number, this returns lines from "
10348 "the file C<path>, excluding the last C<nrlines> lines."
10352 #: ../fish/guestfish-actions.pod:1799 ../fish/guestfish-actions.pod:4982
10353 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:7665
10354 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10358 #: ../fish/guestfish-actions.pod:1804
10363 #: ../fish/guestfish-actions.pod:1806
10371 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2882
10373 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10374 "readable, canonical hex dump of the file."
10378 #: ../fish/guestfish-actions.pod:1814
10383 #: ../fish/guestfish-actions.pod:1816
10386 " initrd-cat initrdpath filename\n"
10391 #: ../fish/guestfish-actions.pod:1818 ../src/guestfs-actions.pod:2901
10393 "This command unpacks the file C<filename> from the initrd file called "
10394 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10399 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2905
10401 "For example, in guestfish you could use the following command to examine the "
10402 "boot script (usually called C</init>) contained in a Linux initrd or "
10407 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2909
10410 " initrd-cat /boot/initrd-<version>.img init\n"
10415 #: ../fish/guestfish-actions.pod:1828
10416 msgid "See also L</initrd-list>."
10420 #: ../fish/guestfish-actions.pod:1833
10421 msgid "initrd-list"
10425 #: ../fish/guestfish-actions.pod:1835
10428 " initrd-list path\n"
10433 #: ../fish/guestfish-actions.pod:1837 ../src/guestfs-actions.pod:2928
10434 msgid "This command lists out files contained in an initrd."
10438 #: ../fish/guestfish-actions.pod:1839 ../src/guestfs-actions.pod:2930
10440 "The files are listed without any initial C</> character. The files are "
10441 "listed in the order they appear (not necessarily alphabetical). Directory "
10442 "names are listed as separate items."
10446 #: ../fish/guestfish-actions.pod:1843 ../src/guestfs-actions.pod:2934
10448 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10449 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10454 #: ../fish/guestfish-actions.pod:1847
10455 msgid "inotify-add-watch"
10459 #: ../fish/guestfish-actions.pod:1849
10462 " inotify-add-watch path mask\n"
10467 #: ../fish/guestfish-actions.pod:1851 ../src/guestfs-actions.pod:2951
10468 msgid "Watch C<path> for the events listed in C<mask>."
10472 #: ../fish/guestfish-actions.pod:1853 ../src/guestfs-actions.pod:2953
10474 "Note that if C<path> is a directory then events within that directory are "
10475 "watched, but this does I<not> happen recursively (in subdirectories)."
10479 #: ../fish/guestfish-actions.pod:1857 ../src/guestfs-actions.pod:2957
10481 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10482 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10486 #: ../fish/guestfish-actions.pod:1861
10487 msgid "inotify-close"
10491 #: ../fish/guestfish-actions.pod:1863
10499 #: ../fish/guestfish-actions.pod:1865 ../src/guestfs-actions.pod:2970
10501 "This closes the inotify handle which was previously opened by inotify_init. "
10502 "It removes all watches, throws away any pending events, and deallocates all "
10507 #: ../fish/guestfish-actions.pod:1869
10508 msgid "inotify-files"
10512 #: ../fish/guestfish-actions.pod:1871
10520 #: ../fish/guestfish-actions.pod:1873
10522 "This function is a helpful wrapper around L</inotify-read> which just "
10523 "returns a list of pathnames of objects that were touched. The returned "
10524 "pathnames are sorted and deduplicated."
10528 #: ../fish/guestfish-actions.pod:1877
10529 msgid "inotify-init"
10533 #: ../fish/guestfish-actions.pod:1879
10536 " inotify-init maxevents\n"
10541 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2999
10543 "This command creates a new inotify handle. The inotify subsystem can be "
10544 "used to notify events which happen to objects in the guest filesystem."
10548 #: ../fish/guestfish-actions.pod:1885
10550 "C<maxevents> is the maximum number of events which will be queued up between "
10551 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
10552 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
10553 "default was 16384 events. Beyond this limit, the kernel throws away events, "
10554 "but records the fact that it threw them away by setting a flag "
10555 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
10559 #: ../fish/guestfish-actions.pod:1895
10561 "Before any events are generated, you have to add some watches to the "
10562 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
10563 "L</inotify-watch-all>."
10567 #: ../fish/guestfish-actions.pod:1901
10569 "Queued up events should be read periodically by calling L</inotify-read> (or "
10570 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
10571 "If you don't read the events out often enough then you risk the internal "
10572 "queue overflowing."
10576 #: ../fish/guestfish-actions.pod:1908
10578 "The handle should be closed after use by calling L</inotify-close>. This "
10579 "also removes any watches automatically."
10583 #: ../fish/guestfish-actions.pod:1912 ../src/guestfs-actions.pod:3030
10585 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10586 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10587 "that there is one global inotify handle per libguestfs instance."
10591 #: ../fish/guestfish-actions.pod:1917
10592 msgid "inotify-read"
10596 #: ../fish/guestfish-actions.pod:1919
10604 #: ../fish/guestfish-actions.pod:1921 ../src/guestfs-actions.pod:3044
10606 "Return the complete queue of events that have happened since the previous "
10611 #: ../fish/guestfish-actions.pod:1924 ../src/guestfs-actions.pod:3047
10612 msgid "If no events have happened, this returns an empty list."
10616 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:3049
10618 "I<Note>: In order to make sure that all events have been read, you must call "
10619 "this function repeatedly until it returns an empty list. The reason is that "
10620 "the call will read events up to the maximum appliance-to-host message size "
10621 "and leave remaining events in the queue."
10625 #: ../fish/guestfish-actions.pod:1932
10626 msgid "inotify-rm-watch"
10630 #: ../fish/guestfish-actions.pod:1934
10633 " inotify-rm-watch wd\n"
10638 #: ../fish/guestfish-actions.pod:1936
10639 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
10643 #: ../fish/guestfish-actions.pod:1939
10644 msgid "inspect-get-arch"
10648 #: ../fish/guestfish-actions.pod:1941
10651 " inspect-get-arch root\n"
10656 #: ../fish/guestfish-actions.pod:1943
10658 "This returns the architecture of the inspected operating system. The "
10659 "possible return values are listed under L</file-architecture>."
10663 #: ../fish/guestfish-actions.pod:1947 ../src/guestfs-actions.pod:3084
10665 "If the architecture could not be determined, then the string C<unknown> is "
10670 #: ../fish/guestfish-actions.pod:1950 ../fish/guestfish-actions.pod:2045
10671 #: ../fish/guestfish-actions.pod:2124 ../fish/guestfish-actions.pod:2136
10672 #: ../fish/guestfish-actions.pod:2220 ../fish/guestfish-actions.pod:2282
10673 #: ../fish/guestfish-actions.pod:2303 ../fish/guestfish-actions.pod:2317
10674 #: ../fish/guestfish-actions.pod:2357 ../fish/guestfish-actions.pod:2397
10675 #: ../fish/guestfish-actions.pod:2410 ../fish/guestfish-actions.pod:2423
10676 #: ../fish/guestfish-actions.pod:2433 ../fish/guestfish-actions.pod:2443
10677 #: ../fish/guestfish-actions.pod:2455 ../fish/guestfish-actions.pod:2551
10678 #: ../fish/guestfish-actions.pod:2585 ../src/guestfs-actions.pod:3087
10679 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3293
10680 #: ../src/guestfs-actions.pod:3312 ../src/guestfs-actions.pod:3443
10681 #: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3555
10682 #: ../src/guestfs-actions.pod:3576 ../src/guestfs-actions.pod:3629
10683 #: ../src/guestfs-actions.pod:3677 ../src/guestfs-actions.pod:3697
10684 #: ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3734
10685 #: ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:3768
10686 #: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3911
10687 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10691 #: ../fish/guestfish-actions.pod:1952
10692 msgid "inspect-get-distro"
10696 #: ../fish/guestfish-actions.pod:1954
10699 " inspect-get-distro root\n"
10704 #: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:3100
10706 "This returns the distro (distribution) of the inspected operating system."
10710 #: ../fish/guestfish-actions.pod:1959 ../src/guestfs-actions.pod:3103
10711 msgid "Currently defined distros are:"
10715 #: ../fish/guestfish-actions.pod:1963 ../src/guestfs-actions.pod:3107
10716 msgid "\"archlinux\""
10720 #: ../fish/guestfish-actions.pod:1965 ../src/guestfs-actions.pod:3109
10721 msgid "Arch Linux."
10725 #: ../fish/guestfish-actions.pod:1967 ../src/guestfs-actions.pod:3111
10730 #: ../fish/guestfish-actions.pod:1969 ../src/guestfs-actions.pod:3113
10735 #: ../fish/guestfish-actions.pod:1971 ../src/guestfs-actions.pod:3115
10740 #: ../fish/guestfish-actions.pod:1973 ../src/guestfs-actions.pod:3117
10745 #: ../fish/guestfish-actions.pod:1975 ../src/guestfs-actions.pod:3119
10750 #: ../fish/guestfish-actions.pod:1977 ../src/guestfs-actions.pod:3121
10755 #: ../fish/guestfish-actions.pod:1979 ../src/guestfs-actions.pod:3123
10760 #: ../fish/guestfish-actions.pod:1981 ../src/guestfs-actions.pod:3125
10765 #: ../fish/guestfish-actions.pod:1983 ../src/guestfs-actions.pod:3127
10766 msgid "\"linuxmint\""
10770 #: ../fish/guestfish-actions.pod:1985 ../src/guestfs-actions.pod:3129
10771 msgid "Linux Mint."
10775 #: ../fish/guestfish-actions.pod:1987 ../src/guestfs-actions.pod:3131
10780 #: ../fish/guestfish-actions.pod:1989 ../src/guestfs-actions.pod:3133
10785 #: ../fish/guestfish-actions.pod:1991 ../src/guestfs-actions.pod:3135
10786 msgid "\"mandriva\""
10790 #: ../fish/guestfish-actions.pod:1993 ../src/guestfs-actions.pod:3137
10795 #: ../fish/guestfish-actions.pod:1995 ../src/guestfs-actions.pod:3139
10800 #: ../fish/guestfish-actions.pod:1997 ../src/guestfs-actions.pod:3141
10805 #: ../fish/guestfish-actions.pod:1999 ../src/guestfs-actions.pod:3143
10806 msgid "\"opensuse\""
10810 #: ../fish/guestfish-actions.pod:2001 ../src/guestfs-actions.pod:3145
10815 #: ../fish/guestfish-actions.pod:2003 ../src/guestfs-actions.pod:3147
10820 #: ../fish/guestfish-actions.pod:2005 ../src/guestfs-actions.pod:3149
10825 #: ../fish/guestfish-actions.pod:2007 ../src/guestfs-actions.pod:3151
10826 msgid "\"redhat-based\""
10830 #: ../fish/guestfish-actions.pod:2009 ../src/guestfs-actions.pod:3153
10831 msgid "Some Red Hat-derived distro."
10835 #: ../fish/guestfish-actions.pod:2011 ../src/guestfs-actions.pod:3155
10840 #: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:3157
10841 msgid "Red Hat Enterprise Linux."
10845 #: ../fish/guestfish-actions.pod:2015 ../src/guestfs-actions.pod:3159
10846 msgid "\"scientificlinux\""
10850 #: ../fish/guestfish-actions.pod:2017 ../src/guestfs-actions.pod:3161
10851 msgid "Scientific Linux."
10855 #: ../fish/guestfish-actions.pod:2019 ../src/guestfs-actions.pod:3163
10856 msgid "\"slackware\""
10860 #: ../fish/guestfish-actions.pod:2021 ../src/guestfs-actions.pod:3165
10865 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:3167
10866 msgid "\"ttylinux\""
10870 #: ../fish/guestfish-actions.pod:2025 ../src/guestfs-actions.pod:3169
10875 #: ../fish/guestfish-actions.pod:2027 ../src/guestfs-actions.pod:3171
10880 #: ../fish/guestfish-actions.pod:2029 ../src/guestfs-actions.pod:3173
10885 #: ../fish/guestfish-actions.pod:2031 ../fish/guestfish-actions.pod:2115
10886 #: ../fish/guestfish-actions.pod:2388 ../src/guestfs-actions.pod:3175
10887 #: ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3668
10888 msgid "\"unknown\""
10892 #: ../fish/guestfish-actions.pod:2033 ../src/guestfs-actions.pod:3177
10893 msgid "The distro could not be determined."
10897 #: ../fish/guestfish-actions.pod:2035 ../fish/guestfish-actions.pod:2372
10898 #: ../src/guestfs-actions.pod:3179 ../src/guestfs-actions.pod:3652
10899 msgid "\"windows\""
10903 #: ../fish/guestfish-actions.pod:2037 ../src/guestfs-actions.pod:3181
10905 "Windows does not have distributions. This string is returned if the OS type "
10910 #: ../fish/guestfish-actions.pod:2042 ../fish/guestfish-actions.pod:2121
10911 #: ../fish/guestfish-actions.pod:2394 ../src/guestfs-actions.pod:3186
10912 #: ../src/guestfs-actions.pod:3290 ../src/guestfs-actions.pod:3674
10914 "Future versions of libguestfs may return other strings here. The caller "
10915 "should be prepared to handle any string."
10919 #: ../fish/guestfish-actions.pod:2047
10920 msgid "inspect-get-drive-mappings"
10924 #: ../fish/guestfish-actions.pod:2049
10927 " inspect-get-drive-mappings root\n"
10932 #: ../fish/guestfish-actions.pod:2051 ../src/guestfs-actions.pod:3202
10934 "This call is useful for Windows which uses a primitive system of assigning "
10935 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10936 "Windows Registry to find out how disks/partitions are mapped to drive "
10937 "letters, and returns a hash table as in the example below:"
10941 #: ../fish/guestfish-actions.pod:2057 ../src/guestfs-actions.pod:3208
10944 " C => /dev/vda2\n"
10945 " E => /dev/vdb1\n"
10946 " F => /dev/vdc1\n"
10951 #: ../fish/guestfish-actions.pod:2061 ../src/guestfs-actions.pod:3212
10953 "Note that keys are drive letters. For Windows, the key is case insensitive "
10954 "and just contains the drive letter, without the customary colon separator "
10959 #: ../fish/guestfish-actions.pod:2065 ../src/guestfs-actions.pod:3216
10961 "In future we may support other operating systems that also used drive "
10962 "letters, but the keys for those might not be case insensitive and might be "
10963 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10968 #: ../fish/guestfish-actions.pod:2070 ../src/guestfs-actions.pod:3221
10970 "For Windows guests, currently only hard drive mappings are returned. "
10971 "Removable disks (eg. DVD-ROMs) are ignored."
10975 #: ../fish/guestfish-actions.pod:2073 ../src/guestfs-actions.pod:3224
10977 "For guests that do not use drive mappings, or if the drive mappings could "
10978 "not be determined, this returns an empty hash table."
10982 #: ../fish/guestfish-actions.pod:2076
10984 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10985 "get-mountpoints>, L</inspect-get-filesystems>."
10989 #: ../fish/guestfish-actions.pod:2080
10990 msgid "inspect-get-filesystems"
10994 #: ../fish/guestfish-actions.pod:2082
10997 " inspect-get-filesystems root\n"
11002 #: ../fish/guestfish-actions.pod:2084 ../src/guestfs-actions.pod:3245
11004 "This returns a list of all the filesystems that we think are associated with "
11005 "this operating system. This includes the root filesystem, other ordinary "
11006 "filesystems, and non-mounted devices like swap partitions."
11010 #: ../fish/guestfish-actions.pod:2089 ../src/guestfs-actions.pod:3250
11012 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11013 "to be shared between operating systems."
11017 #: ../fish/guestfish-actions.pod:2092
11019 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11020 "get-mountpoints>."
11024 #: ../fish/guestfish-actions.pod:2095
11025 msgid "inspect-get-format"
11029 #: ../fish/guestfish-actions.pod:2097
11032 " inspect-get-format root\n"
11037 #: ../fish/guestfish-actions.pod:2099 ../src/guestfs-actions.pod:3268
11039 "This returns the format of the inspected operating system. You can use it "
11040 "to detect install images, live CDs and similar."
11044 #: ../fish/guestfish-actions.pod:2102 ../src/guestfs-actions.pod:3271
11045 msgid "Currently defined formats are:"
11049 #: ../fish/guestfish-actions.pod:2106 ../src/guestfs-actions.pod:3275
11050 msgid "\"installed\""
11054 #: ../fish/guestfish-actions.pod:2108 ../src/guestfs-actions.pod:3277
11055 msgid "This is an installed operating system."
11059 #: ../fish/guestfish-actions.pod:2110 ../src/guestfs-actions.pod:3279
11060 msgid "\"installer\""
11064 #: ../fish/guestfish-actions.pod:2112 ../src/guestfs-actions.pod:3281
11066 "The disk image being inspected is not an installed operating system, but a "
11067 "I<bootable> install disk, live CD, or similar."
11071 #: ../fish/guestfish-actions.pod:2117 ../src/guestfs-actions.pod:3286
11072 msgid "The format of this disk image is not known."
11076 #: ../fish/guestfish-actions.pod:2126
11077 msgid "inspect-get-hostname"
11081 #: ../fish/guestfish-actions.pod:2128
11084 " inspect-get-hostname root\n"
11089 #: ../fish/guestfish-actions.pod:2130 ../src/guestfs-actions.pod:3306
11091 "This function returns the hostname of the operating system as found by "
11092 "inspection of the guest's configuration files."
11096 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3309
11098 "If the hostname could not be determined, then the string C<unknown> is "
11103 #: ../fish/guestfish-actions.pod:2138
11104 msgid "inspect-get-icon"
11108 #: ../fish/guestfish-actions.pod:2140
11111 " inspect-get-icon root [favicon:true|false] [highquality:true|false]\n"
11116 #: ../fish/guestfish-actions.pod:2142 ../src/guestfs-actions.pod:3335
11118 "This function returns an icon corresponding to the inspected operating "
11119 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
11120 "to PNG if necessary)."
11124 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3339
11126 "If it was not possible to get an icon this function returns a zero-length "
11127 "(non-NULL) buffer. I<Callers must check for this case>."
11131 #: ../fish/guestfish-actions.pod:2149 ../src/guestfs-actions.pod:3342
11133 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11134 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11135 "this file will be returned. You can disable favicons by passing the "
11136 "optional C<favicon> boolean as false (default is true)."
11140 #: ../fish/guestfish-actions.pod:2155 ../src/guestfs-actions.pod:3348
11142 "If finding the favicon fails, then we look in other places in the guest for "
11147 #: ../fish/guestfish-actions.pod:2158 ../src/guestfs-actions.pod:3351
11149 "If the optional C<highquality> boolean is true then only high quality icons "
11150 "are returned, which means only icons of high resolution with an alpha "
11151 "channel. The default (false) is to return any icon we can, even if it is of "
11152 "substandard quality."
11156 #: ../fish/guestfish-actions.pod:2169 ../src/guestfs-actions.pod:3362
11158 "Unlike most other inspection API calls, the guest's disks must be mounted up "
11159 "before you call this, since it needs to read information from the guest "
11160 "filesystem during the call."
11164 #: ../fish/guestfish-actions.pod:2175 ../src/guestfs-actions.pod:3368
11166 "B<Security:> The icon data comes from the untrusted guest, and should be "
11167 "treated with caution. PNG files have been known to contain exploits. "
11168 "Ensure that libpng (or other relevant libraries) are fully up to date before "
11169 "trying to process or display the icon."
11173 #: ../fish/guestfish-actions.pod:2183 ../src/guestfs-actions.pod:3376
11175 "The PNG image returned can be any size. It might not be square. Libguestfs "
11176 "tries to return the largest, highest quality icon available. The "
11177 "application must scale the icon to the required size."
11181 #: ../fish/guestfish-actions.pod:2190 ../src/guestfs-actions.pod:3383
11183 "Extracting icons from Windows guests requires the external C<wrestool> "
11184 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11185 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11186 "installed separately."
11190 #: ../fish/guestfish-actions.pod:2197 ../src/guestfs-actions.pod:3390
11192 "Operating system icons are usually trademarks. Seek legal advice before "
11193 "using trademarks in applications."
11197 #: ../fish/guestfish-actions.pod:2204
11198 msgid "inspect-get-major-version"
11202 #: ../fish/guestfish-actions.pod:2206
11205 " inspect-get-major-version root\n"
11210 #: ../fish/guestfish-actions.pod:2208 ../src/guestfs-actions.pod:3431
11212 "This returns the major version number of the inspected operating system."
11216 #: ../fish/guestfish-actions.pod:2211 ../src/guestfs-actions.pod:3434
11218 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11219 "popular public names used by the operating system. Notably the operating "
11220 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11221 "1). You can find out the real versions corresponding to releases of Windows "
11222 "by consulting Wikipedia or MSDN."
11226 #: ../fish/guestfish-actions.pod:2218 ../fish/guestfish-actions.pod:2229
11227 #: ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3458
11228 msgid "If the version could not be determined, then C<0> is returned."
11232 #: ../fish/guestfish-actions.pod:2222
11233 msgid "inspect-get-minor-version"
11237 #: ../fish/guestfish-actions.pod:2224
11240 " inspect-get-minor-version root\n"
11245 #: ../fish/guestfish-actions.pod:2226 ../src/guestfs-actions.pod:3455
11247 "This returns the minor version number of the inspected operating system."
11251 #: ../fish/guestfish-actions.pod:2231
11253 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11254 "get-major-version>."
11258 #: ../fish/guestfish-actions.pod:2234
11259 msgid "inspect-get-mountpoints"
11263 #: ../fish/guestfish-actions.pod:2236
11266 " inspect-get-mountpoints root\n"
11271 #: ../fish/guestfish-actions.pod:2238 ../src/guestfs-actions.pod:3473
11273 "This returns a hash of where we think the filesystems associated with this "
11274 "operating system should be mounted. Callers should note that this is at "
11275 "best an educated guess made by reading configuration files such as C</etc/"
11276 "fstab>. I<In particular note> that this may return filesystems which are "
11277 "non-existent or not mountable and callers should be prepared to handle or "
11278 "ignore failures if they try to mount them."
11282 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3482
11284 "Each element in the returned hashtable has a key which is the path of the "
11285 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11286 "mounted there (eg. C</dev/sda1>)."
11290 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3487
11292 "Non-mounted devices such as swap devices are I<not> returned in this list."
11296 #: ../fish/guestfish-actions.pod:2255
11298 "For operating systems like Windows which still use drive letters, this call "
11299 "will only return an entry for the first drive \"mounted on\" C</>. For "
11300 "information about the mapping of drive letters to partitions, see L</inspect-"
11301 "get-drive-mappings>."
11305 #: ../fish/guestfish-actions.pod:2261
11307 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11308 "get-filesystems>."
11312 #: ../fish/guestfish-actions.pod:2264
11313 msgid "inspect-get-package-format"
11317 #: ../fish/guestfish-actions.pod:2266
11320 " inspect-get-package-format root\n"
11325 #: ../fish/guestfish-actions.pod:2268
11327 "This function and L</inspect-get-package-management> return the package "
11328 "format and package management tool used by the inspected operating system. "
11329 "For example for Fedora these functions would return C<rpm> (package format) "
11330 "and C<yum> (package management)."
11334 #: ../fish/guestfish-actions.pod:2274 ../src/guestfs-actions.pod:3519
11336 "This returns the string C<unknown> if we could not determine the package "
11337 "format I<or> if the operating system does not have a real packaging system "
11342 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3523
11344 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, "
11345 "C<pkgsrc>. Future versions of libguestfs may return other strings."
11349 #: ../fish/guestfish-actions.pod:2284
11350 msgid "inspect-get-package-management"
11354 #: ../fish/guestfish-actions.pod:2286
11357 " inspect-get-package-management root\n"
11362 #: ../fish/guestfish-actions.pod:2288
11364 "L</inspect-get-package-format> and this function return the package format "
11365 "and package management tool used by the inspected operating system. For "
11366 "example for Fedora these functions would return C<rpm> (package format) and "
11367 "C<yum> (package management)."
11371 #: ../fish/guestfish-actions.pod:2294 ../src/guestfs-actions.pod:3546
11373 "This returns the string C<unknown> if we could not determine the package "
11374 "management tool I<or> if the operating system does not have a real packaging "
11375 "system (eg. Windows)."
11379 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3550
11381 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11382 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>. Future "
11383 "versions of libguestfs may return other strings."
11387 #: ../fish/guestfish-actions.pod:2305
11388 msgid "inspect-get-product-name"
11392 #: ../fish/guestfish-actions.pod:2307
11395 " inspect-get-product-name root\n"
11400 #: ../fish/guestfish-actions.pod:2309 ../src/guestfs-actions.pod:3568
11402 "This returns the product name of the inspected operating system. The "
11403 "product name is generally some freeform string which can be displayed to the "
11404 "user, but should not be parsed by programs."
11408 #: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3573
11410 "If the product name could not be determined, then the string C<unknown> is "
11415 #: ../fish/guestfish-actions.pod:2319
11416 msgid "inspect-get-product-variant"
11420 #: ../fish/guestfish-actions.pod:2321
11423 " inspect-get-product-variant root\n"
11428 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3589
11429 msgid "This returns the product variant of the inspected operating system."
11433 #: ../fish/guestfish-actions.pod:2326 ../src/guestfs-actions.pod:3592
11435 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11436 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11437 "is usually a string such as C<Client> or C<Server> (other values are "
11438 "possible). This can be used to distinguish consumer and enterprise versions "
11439 "of Windows that have the same version number (for example, Windows 7 and "
11440 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11441 "the latter is C<Server>)."
11445 #: ../fish/guestfish-actions.pod:2335 ../src/guestfs-actions.pod:3601
11447 "For enterprise Linux guests, in future we intend this to return the product "
11448 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11449 "implemented at present."
11453 #: ../fish/guestfish-actions.pod:2339 ../src/guestfs-actions.pod:3605
11455 "If the product variant could not be determined, then the string C<unknown> "
11460 #: ../fish/guestfish-actions.pod:2342
11462 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11463 "get-product-name>, L</inspect-get-major-version>."
11467 #: ../fish/guestfish-actions.pod:2346
11468 msgid "inspect-get-roots"
11472 #: ../fish/guestfish-actions.pod:2348
11475 " inspect-get-roots\n"
11480 #: ../fish/guestfish-actions.pod:2350
11482 "This function is a convenient way to get the list of root devices, as "
11483 "returned from a previous call to L</inspect-os>, but without redoing the "
11484 "whole inspection process."
11488 #: ../fish/guestfish-actions.pod:2354
11490 "This returns an empty list if either no root devices were found or the "
11491 "caller has not called L</inspect-os>."
11495 #: ../fish/guestfish-actions.pod:2359
11496 msgid "inspect-get-type"
11500 #: ../fish/guestfish-actions.pod:2361
11503 " inspect-get-type root\n"
11508 #: ../fish/guestfish-actions.pod:2363 ../src/guestfs-actions.pod:3643
11510 "This returns the type of the inspected operating system. Currently defined "
11515 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3648
11520 #: ../fish/guestfish-actions.pod:2370 ../src/guestfs-actions.pod:3650
11521 msgid "Any Linux-based operating system."
11525 #: ../fish/guestfish-actions.pod:2374 ../src/guestfs-actions.pod:3654
11526 msgid "Any Microsoft Windows operating system."
11530 #: ../fish/guestfish-actions.pod:2376 ../src/guestfs-actions.pod:3656
11531 msgid "\"freebsd\""
11535 #: ../fish/guestfish-actions.pod:2378 ../src/guestfs-actions.pod:3658
11540 #: ../fish/guestfish-actions.pod:2380 ../src/guestfs-actions.pod:3660
11545 #: ../fish/guestfish-actions.pod:2382 ../src/guestfs-actions.pod:3662
11550 #: ../fish/guestfish-actions.pod:2384 ../src/guestfs-actions.pod:3664
11555 #: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3666
11560 #: ../fish/guestfish-actions.pod:2390 ../src/guestfs-actions.pod:3670
11561 msgid "The operating system type could not be determined."
11565 #: ../fish/guestfish-actions.pod:2399
11566 msgid "inspect-get-windows-current-control-set"
11570 #: ../fish/guestfish-actions.pod:2401
11573 " inspect-get-windows-current-control-set root\n"
11578 #: ../fish/guestfish-actions.pod:2403 ../src/guestfs-actions.pod:3690
11580 "This returns the Windows CurrentControlSet of the inspected guest. The "
11581 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11585 #: ../fish/guestfish-actions.pod:2406 ../src/guestfs-actions.pod:3693
11587 "This call assumes that the guest is Windows and that the Registry could be "
11588 "examined by inspection. If this is not the case then an error is returned."
11592 #: ../fish/guestfish-actions.pod:2412
11593 msgid "inspect-get-windows-systemroot"
11597 #: ../fish/guestfish-actions.pod:2414
11600 " inspect-get-windows-systemroot root\n"
11605 #: ../fish/guestfish-actions.pod:2416 ../src/guestfs-actions.pod:3710
11607 "This returns the Windows systemroot of the inspected guest. The systemroot "
11608 "is a directory path such as C</WINDOWS>."
11612 #: ../fish/guestfish-actions.pod:2419 ../src/guestfs-actions.pod:3713
11614 "This call assumes that the guest is Windows and that the systemroot could be "
11615 "determined by inspection. If this is not the case then an error is returned."
11619 #: ../fish/guestfish-actions.pod:2425
11620 msgid "inspect-is-live"
11624 #: ../fish/guestfish-actions.pod:2427
11627 " inspect-is-live root\n"
11632 #: ../fish/guestfish-actions.pod:2429
11634 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11635 "then this returns true if a live image was detected on the disk."
11639 #: ../fish/guestfish-actions.pod:2435
11640 msgid "inspect-is-multipart"
11644 #: ../fish/guestfish-actions.pod:2437
11647 " inspect-is-multipart root\n"
11652 #: ../fish/guestfish-actions.pod:2439
11654 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11655 "then this returns true if the disk is part of a set."
11659 #: ../fish/guestfish-actions.pod:2445
11660 msgid "inspect-is-netinst"
11664 #: ../fish/guestfish-actions.pod:2447
11667 " inspect-is-netinst root\n"
11672 #: ../fish/guestfish-actions.pod:2449
11674 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11675 "then this returns true if the disk is a network installer, ie. not a self-"
11676 "contained install CD but one which is likely to require network access to "
11677 "complete the install."
11681 #: ../fish/guestfish-actions.pod:2457
11682 msgid "inspect-list-applications"
11686 #: ../fish/guestfish-actions.pod:2459
11689 " inspect-list-applications root\n"
11694 #: ../fish/guestfish-actions.pod:2461 ../src/guestfs-actions.pod:3780
11695 msgid "Return the list of applications installed in the operating system."
11699 #: ../fish/guestfish-actions.pod:2463
11701 "I<Note:> This call works differently from other parts of the inspection "
11702 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
11703 "then mount up the disks, before calling this. Listing applications is a "
11704 "significantly more difficult operation which requires access to the full "
11705 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
11706 "are just returning data cached in the libguestfs handle, this call actually "
11707 "reads parts of the mounted filesystems during the call."
11711 #: ../fish/guestfish-actions.pod:2473 ../src/guestfs-actions.pod:3792
11713 "This returns an empty list if the inspection code was not able to determine "
11714 "the list of applications."
11718 #: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3795
11719 msgid "The application structure contains the following fields:"
11723 #: ../fish/guestfish-actions.pod:2480 ../src/guestfs-actions.pod:3799
11724 msgid "C<app_name>"
11728 #: ../fish/guestfish-actions.pod:2482 ../src/guestfs-actions.pod:3801
11730 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11731 "guests, this is the package name."
11735 #: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3804
11736 msgid "C<app_display_name>"
11740 #: ../fish/guestfish-actions.pod:2487 ../src/guestfs-actions.pod:3806
11742 "The display name of the application, sometimes localized to the install "
11743 "language of the guest operating system."
11747 #: ../fish/guestfish-actions.pod:2490 ../src/guestfs-actions.pod:3809
11749 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11750 "to display something can use C<app_name> instead."
11754 #: ../fish/guestfish-actions.pod:2493 ../src/guestfs-actions.pod:3812
11755 msgid "C<app_epoch>"
11759 #: ../fish/guestfish-actions.pod:2495 ../src/guestfs-actions.pod:3814
11761 "For package managers which use epochs, this contains the epoch of the "
11762 "package (an integer). If unavailable, this is returned as C<0>."
11766 #: ../fish/guestfish-actions.pod:2498 ../src/guestfs-actions.pod:3817
11767 msgid "C<app_version>"
11771 #: ../fish/guestfish-actions.pod:2500 ../src/guestfs-actions.pod:3819
11773 "The version string of the application or package. If unavailable this is "
11774 "returned as an empty string C<\"\">."
11778 #: ../fish/guestfish-actions.pod:2503 ../src/guestfs-actions.pod:3822
11779 msgid "C<app_release>"
11783 #: ../fish/guestfish-actions.pod:2505 ../src/guestfs-actions.pod:3824
11785 "The release string of the application or package, for package managers that "
11786 "use this. If unavailable this is returned as an empty string C<\"\">."
11790 #: ../fish/guestfish-actions.pod:2509 ../src/guestfs-actions.pod:3828
11791 msgid "C<app_install_path>"
11795 #: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3830
11797 "The installation path of the application (on operating systems such as "
11798 "Windows which use installation paths). This path is in the format used by "
11799 "the guest operating system, it is not a libguestfs path."
11803 #: ../fish/guestfish-actions.pod:2516 ../src/guestfs-actions.pod:3835
11804 msgid "If unavailable this is returned as an empty string C<\"\">."
11808 #: ../fish/guestfish-actions.pod:2518 ../src/guestfs-actions.pod:3837
11809 msgid "C<app_trans_path>"
11813 #: ../fish/guestfish-actions.pod:2520 ../src/guestfs-actions.pod:3839
11815 "The install path translated into a libguestfs path. If unavailable this is "
11816 "returned as an empty string C<\"\">."
11820 #: ../fish/guestfish-actions.pod:2523 ../src/guestfs-actions.pod:3842
11821 msgid "C<app_publisher>"
11825 #: ../fish/guestfish-actions.pod:2525 ../src/guestfs-actions.pod:3844
11827 "The name of the publisher of the application, for package managers that use "
11828 "this. If unavailable this is returned as an empty string C<\"\">."
11832 #: ../fish/guestfish-actions.pod:2529 ../src/guestfs-actions.pod:3848
11837 #: ../fish/guestfish-actions.pod:2531 ../src/guestfs-actions.pod:3850
11839 "The URL (eg. upstream URL) of the application. If unavailable this is "
11840 "returned as an empty string C<\"\">."
11844 #: ../fish/guestfish-actions.pod:2534 ../src/guestfs-actions.pod:3853
11845 msgid "C<app_source_package>"
11849 #: ../fish/guestfish-actions.pod:2536 ../src/guestfs-actions.pod:3855
11851 "For packaging systems which support this, the name of the source package. "
11852 "If unavailable this is returned as an empty string C<\"\">."
11856 #: ../fish/guestfish-actions.pod:2539 ../src/guestfs-actions.pod:3858
11857 msgid "C<app_summary>"
11861 #: ../fish/guestfish-actions.pod:2541 ../src/guestfs-actions.pod:3860
11863 "A short (usually one line) description of the application or package. If "
11864 "unavailable this is returned as an empty string C<\"\">."
11868 #: ../fish/guestfish-actions.pod:2544 ../src/guestfs-actions.pod:3863
11869 msgid "C<app_description>"
11873 #: ../fish/guestfish-actions.pod:2546 ../src/guestfs-actions.pod:3865
11875 "A longer description of the application or package. If unavailable this is "
11876 "returned as an empty string C<\"\">."
11880 #: ../fish/guestfish-actions.pod:2553
11885 #: ../fish/guestfish-actions.pod:2555
11893 #: ../fish/guestfish-actions.pod:2557 ../src/guestfs-actions.pod:3883
11895 "This function uses other libguestfs functions and certain heuristics to "
11896 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11897 "for operating systems."
11901 #: ../fish/guestfish-actions.pod:2561 ../src/guestfs-actions.pod:3887
11902 msgid "The list returned is empty if no operating systems were found."
11906 #: ../fish/guestfish-actions.pod:2563 ../src/guestfs-actions.pod:3889
11908 "If one operating system was found, then this returns a list with a single "
11909 "element, which is the name of the root filesystem of this operating system. "
11910 "It is also possible for this function to return a list containing more than "
11911 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11912 "element being the root filesystem of one of the operating systems."
11916 #: ../fish/guestfish-actions.pod:2570
11918 "You can pass the root string(s) returned to other L</inspect-get-*> "
11919 "functions in order to query further information about each operating system, "
11920 "such as the name and version."
11924 #: ../fish/guestfish-actions.pod:2575
11926 "This function uses other libguestfs features such as L</mount-ro> and L</"
11927 "umount-all> in order to mount and unmount filesystems and look at the "
11928 "contents. This should be called with no disks currently mounted. The "
11929 "function may also use Augeas, so any existing Augeas handle will be closed."
11933 #: ../fish/guestfish-actions.pod:2581 ../src/guestfs-actions.pod:3907
11935 "This function cannot decrypt encrypted disks. The caller must do that first "
11936 "(supplying the necessary keys) if the disk is encrypted."
11940 #: ../fish/guestfish-actions.pod:2587 ../fish/guestfish-actions.pod:2785
11941 #: ../fish/guestfish-actions.pod:2850
11942 msgid "See also L</list-filesystems>."
11946 #: ../fish/guestfish-actions.pod:2589
11947 msgid "is-blockdev"
11951 #: ../fish/guestfish-actions.pod:2591
11954 " is-blockdev path\n"
11959 #: ../fish/guestfish-actions.pod:2593 ../src/guestfs-actions.pod:3927
11961 "This returns C<true> if and only if there is a block device with the given "
11966 #: ../fish/guestfish-actions.pod:2596 ../fish/guestfish-actions.pod:2614
11967 #: ../fish/guestfish-actions.pod:2633 ../fish/guestfish-actions.pod:2642
11968 #: ../fish/guestfish-actions.pod:2652 ../fish/guestfish-actions.pod:2686
11969 #: ../fish/guestfish-actions.pod:2695
11970 msgid "See also L</stat>."
11974 #: ../fish/guestfish-actions.pod:2598
11979 #: ../fish/guestfish-actions.pod:2600
11987 #: ../fish/guestfish-actions.pod:2602 ../src/guestfs-actions.pod:3941
11989 "This returns true iff this handle is busy processing a command (in the "
11994 #: ../fish/guestfish-actions.pod:2607
11999 #: ../fish/guestfish-actions.pod:2609
12002 " is-chardev path\n"
12007 #: ../fish/guestfish-actions.pod:2611 ../src/guestfs-actions.pod:3956
12009 "This returns C<true> if and only if there is a character device with the "
12010 "given C<path> name."
12014 #: ../fish/guestfish-actions.pod:2616
12019 #: ../fish/guestfish-actions.pod:2618
12027 #: ../fish/guestfish-actions.pod:2620 ../src/guestfs-actions.pod:3970
12029 "This returns true iff this handle is being configured (in the C<CONFIG> "
12034 #: ../fish/guestfish-actions.pod:2625
12039 #: ../fish/guestfish-actions.pod:2627
12047 #: ../fish/guestfish-actions.pod:2629 ../src/guestfs-actions.pod:3985
12049 "This returns C<true> if and only if there is a directory with the given "
12050 "C<path> name. Note that it returns false for other objects like files."
12054 #: ../fish/guestfish-actions.pod:2635
12059 #: ../fish/guestfish-actions.pod:2637
12067 #: ../fish/guestfish-actions.pod:2639 ../src/guestfs-actions.pod:4001
12069 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12070 "given C<path> name."
12074 #: ../fish/guestfish-actions.pod:2644
12079 #: ../fish/guestfish-actions.pod:2646
12087 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:4016
12089 "This returns C<true> if and only if there is a regular file with the given "
12090 "C<path> name. Note that it returns false for other objects like directories."
12094 #: ../fish/guestfish-actions.pod:2654
12095 msgid "is-launching"
12099 #: ../fish/guestfish-actions.pod:2656
12107 #: ../fish/guestfish-actions.pod:2658 ../src/guestfs-actions.pod:4031
12109 "This returns true iff this handle is launching the subprocess (in the "
12110 "C<LAUNCHING> state)."
12114 #: ../fish/guestfish-actions.pod:2663
12119 #: ../fish/guestfish-actions.pod:2665
12127 #: ../fish/guestfish-actions.pod:2667 ../src/guestfs-actions.pod:4046
12129 "This command tests whether C<device> is a logical volume, and returns true "
12130 "iff this is the case."
12134 #: ../fish/guestfish-actions.pod:2670
12139 #: ../fish/guestfish-actions.pod:2672
12147 #: ../fish/guestfish-actions.pod:2674 ../src/guestfs-actions.pod:4058
12149 "This returns true iff this handle is ready to accept commands (in the "
12154 #: ../fish/guestfish-actions.pod:2679
12159 #: ../fish/guestfish-actions.pod:2681
12162 " is-socket path\n"
12167 #: ../fish/guestfish-actions.pod:2683 ../src/guestfs-actions.pod:4073
12169 "This returns C<true> if and only if there is a Unix domain socket with the "
12170 "given C<path> name."
12174 #: ../fish/guestfish-actions.pod:2688
12179 #: ../fish/guestfish-actions.pod:2690
12182 " is-symlink path\n"
12187 #: ../fish/guestfish-actions.pod:2692 ../src/guestfs-actions.pod:4088
12189 "This returns C<true> if and only if there is a symbolic link with the given "
12194 #: ../fish/guestfish-actions.pod:2697
12199 #: ../fish/guestfish-actions.pod:2699
12207 #: ../fish/guestfish-actions.pod:2701 ../src/guestfs-actions.pod:4103
12209 "This returns true iff the file exists and the file is empty or it contains "
12214 #: ../fish/guestfish-actions.pod:2704
12215 msgid "is-zero-device"
12219 #: ../fish/guestfish-actions.pod:2706
12222 " is-zero-device device\n"
12227 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4116
12228 msgid "This returns true iff the device exists and contains all zero bytes."
12232 #: ../fish/guestfish-actions.pod:2710 ../src/guestfs-actions.pod:4118
12233 msgid "Note that for large devices this can take a long time to run."
12237 #: ../fish/guestfish-actions.pod:2712
12238 msgid "kill-subprocess"
12242 #: ../fish/guestfish-actions.pod:2714
12245 " kill-subprocess\n"
12250 #: ../fish/guestfish-actions.pod:2716 ../src/guestfs-actions.pod:4129
12251 msgid "This kills the qemu subprocess. You should never need to call this."
12255 #: ../fish/guestfish-actions.pod:2718
12260 #: ../fish/guestfish-actions.pod:2720
12265 #: ../fish/guestfish-actions.pod:2722
12273 #: ../fish/guestfish-actions.pod:2724 ../src/guestfs-actions.pod:4140
12275 "Internally libguestfs is implemented by running a virtual machine using "
12280 #: ../fish/guestfish-actions.pod:2727 ../src/guestfs-actions.pod:4143
12282 "You should call this after configuring the handle (eg. adding drives) but "
12283 "before performing any actions."
12287 #: ../fish/guestfish-actions.pod:2730
12292 #: ../fish/guestfish-actions.pod:2732
12295 " lchown owner group path\n"
12300 #: ../fish/guestfish-actions.pod:2734
12302 "Change the file owner to C<owner> and group to C<group>. This is like L</"
12303 "chown> but if C<path> is a symlink then the link itself is changed, not the "
12308 #: ../fish/guestfish-actions.pod:2742
12313 #: ../fish/guestfish-actions.pod:2744
12316 " lgetxattr path name\n"
12321 #: ../fish/guestfish-actions.pod:2746 ../src/guestfs-actions.pod:4183
12323 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12324 "is a symlink, then this call returns an extended attribute from the symlink."
12328 #: ../fish/guestfish-actions.pod:2760
12329 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
12333 #: ../fish/guestfish-actions.pod:2762
12338 #: ../fish/guestfish-actions.pod:2764
12341 " lgetxattrs path\n"
12346 #: ../fish/guestfish-actions.pod:2766
12348 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
12349 "it returns the extended attributes of the link itself."
12353 #: ../fish/guestfish-actions.pod:2770
12358 #: ../fish/guestfish-actions.pod:2772
12366 #: ../fish/guestfish-actions.pod:2774 ../src/guestfs-actions.pod:4226
12368 "List all 9p filesystems attached to the guest. A list of mount tags is "
12373 #: ../fish/guestfish-actions.pod:2777
12374 msgid "list-devices"
12378 #: ../fish/guestfish-actions.pod:2779
12386 #: ../fish/guestfish-actions.pod:2781 ../src/guestfs-actions.pod:4240
12387 msgid "List all the block devices."
12391 #: ../fish/guestfish-actions.pod:2783 ../src/guestfs-actions.pod:4242
12392 msgid "The full block device names are returned, eg. C</dev/sda>."
12396 #: ../fish/guestfish-actions.pod:2787
12397 msgid "list-dm-devices"
12401 #: ../fish/guestfish-actions.pod:2789
12404 " list-dm-devices\n"
12409 #: ../fish/guestfish-actions.pod:2791 ../src/guestfs-actions.pod:4257
12410 msgid "List all device mapper devices."
12414 #: ../fish/guestfish-actions.pod:2793
12416 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12417 "previous call to L</luks-open>."
12421 #: ../fish/guestfish-actions.pod:2796
12423 "Device mapper devices which correspond to logical volumes are I<not> "
12424 "returned in this list. Call L</lvs> if you want to list logical volumes."
12428 #: ../fish/guestfish-actions.pod:2800
12429 msgid "list-filesystems"
12433 #: ../fish/guestfish-actions.pod:2802
12436 " list-filesystems\n"
12441 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4277
12443 "This inspection command looks for filesystems on partitions, block devices "
12444 "and logical volumes, returning a list of devices containing filesystems and "
12449 #: ../fish/guestfish-actions.pod:2808 ../src/guestfs-actions.pod:4281
12451 "The return value is a hash, where the keys are the devices containing "
12452 "filesystems, and the values are the filesystem types. For example:"
12456 #: ../fish/guestfish-actions.pod:2812 ../src/guestfs-actions.pod:4285
12459 " \"/dev/sda1\" => \"ntfs\"\n"
12460 " \"/dev/sda2\" => \"ext2\"\n"
12461 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12462 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12467 #: ../fish/guestfish-actions.pod:2817 ../src/guestfs-actions.pod:4290
12469 "The value can have the special value \"unknown\", meaning the content of the "
12470 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12474 #: ../fish/guestfish-actions.pod:2821
12476 "This command runs other libguestfs commands, which might include L</mount> "
12477 "and L</umount>, and therefore you should use this soon after launch and only "
12478 "when nothing is mounted."
12482 #: ../fish/guestfish-actions.pod:2825
12484 "Not all of the filesystems returned will be mountable. In particular, swap "
12485 "partitions are returned in the list. Also this command does not check that "
12486 "each filesystem found is valid and mountable, and some filesystems might be "
12487 "mountable but require special options. Filesystems may not all belong to a "
12488 "single logical operating system (use L</inspect-os> to look for OSes)."
12492 #: ../fish/guestfish-actions.pod:2833
12493 msgid "list-md-devices"
12497 #: ../fish/guestfish-actions.pod:2835
12500 " list-md-devices\n"
12505 #: ../fish/guestfish-actions.pod:2837 ../src/guestfs-actions.pod:4319
12506 msgid "List all Linux md devices."
12510 #: ../fish/guestfish-actions.pod:2839
12511 msgid "list-partitions"
12515 #: ../fish/guestfish-actions.pod:2841
12518 " list-partitions\n"
12523 #: ../fish/guestfish-actions.pod:2843 ../src/guestfs-actions.pod:4332
12524 msgid "List all the partitions detected on all block devices."
12528 #: ../fish/guestfish-actions.pod:2845 ../src/guestfs-actions.pod:4334
12529 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12533 #: ../fish/guestfish-actions.pod:2847
12535 "This does not return logical volumes. For that you will need to call L</"
12540 #: ../fish/guestfish-actions.pod:2852
12545 #: ../fish/guestfish-actions.pod:2854
12553 #: ../fish/guestfish-actions.pod:2856 ../src/guestfs-actions.pod:4353
12555 "List the files in C<directory> (relative to the root directory, there is no "
12556 "cwd) in the format of 'ls -la'."
12560 #: ../fish/guestfish-actions.pod:2859 ../src/guestfs-actions.pod:4356
12562 "This command is mostly useful for interactive sessions. It is I<not> "
12563 "intended that you try to parse the output string."
12567 #: ../fish/guestfish-actions.pod:2862
12572 #: ../fish/guestfish-actions.pod:2864
12575 " ln target linkname\n"
12580 #: ../fish/guestfish-actions.pod:2866 ../src/guestfs-actions.pod:4371
12581 msgid "This command creates a hard link using the C<ln> command."
12585 #: ../fish/guestfish-actions.pod:2868
12590 #: ../fish/guestfish-actions.pod:2870
12593 " ln-f target linkname\n"
12598 #: ../fish/guestfish-actions.pod:2872 ../src/guestfs-actions.pod:4384
12600 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12601 "option removes the link (C<linkname>) if it exists already."
12605 #: ../fish/guestfish-actions.pod:2875
12610 #: ../fish/guestfish-actions.pod:2877
12613 " ln-s target linkname\n"
12618 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4398
12619 msgid "This command creates a symbolic link using the C<ln -s> command."
12623 #: ../fish/guestfish-actions.pod:2881
12628 #: ../fish/guestfish-actions.pod:2883
12631 " ln-sf target linkname\n"
12636 #: ../fish/guestfish-actions.pod:2885 ../src/guestfs-actions.pod:4411
12638 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12639 "option removes the link (C<linkname>) if it exists already."
12643 #: ../fish/guestfish-actions.pod:2888
12644 msgid "lremovexattr"
12648 #: ../fish/guestfish-actions.pod:2890
12651 " lremovexattr xattr path\n"
12656 #: ../fish/guestfish-actions.pod:2892
12658 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
12659 "it removes an extended attribute of the link itself."
12663 #: ../fish/guestfish-actions.pod:2896
12668 #: ../fish/guestfish-actions.pod:2898
12676 #: ../fish/guestfish-actions.pod:2900 ../src/guestfs-actions.pod:4439
12678 "List the files in C<directory> (relative to the root directory, there is no "
12679 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12683 #: ../fish/guestfish-actions.pod:2904
12685 "This command is mostly useful for interactive sessions. Programs should "
12686 "probably use L</readdir> instead."
12690 #: ../fish/guestfish-actions.pod:2907
12695 #: ../fish/guestfish-actions.pod:2909
12698 " lsetxattr xattr val vallen path\n"
12703 #: ../fish/guestfish-actions.pod:2911
12705 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
12706 "sets an extended attribute of the link itself."
12710 #: ../fish/guestfish-actions.pod:2915
12715 #: ../fish/guestfish-actions.pod:2917
12723 #: ../fish/guestfish-actions.pod:2919 ../fish/guestfish-actions.pod:4817
12724 #: ../src/guestfs-actions.pod:4475 ../src/guestfs-actions.pod:7405
12725 msgid "Returns file information for the given C<path>."
12729 #: ../fish/guestfish-actions.pod:2921
12731 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
12732 "the link is stat-ed, not the file it refers to."
12736 #: ../fish/guestfish-actions.pod:2925 ../src/guestfs-actions.pod:4481
12737 msgid "This is the same as the C<lstat(2)> system call."
12741 #: ../fish/guestfish-actions.pod:2927
12746 #: ../fish/guestfish-actions.pod:2929
12749 " lstatlist path 'names ...'\n"
12754 #: ../fish/guestfish-actions.pod:2931
12756 "This call allows you to perform the L</lstat> operation on multiple files, "
12757 "where all files are in the directory C<path>. C<names> is the list of files "
12758 "from this directory."
12762 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4500
12764 "On return you get a list of stat structs, with a one-to-one correspondence "
12765 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12766 "then the C<ino> field of that structure is set to C<-1>."
12770 #: ../fish/guestfish-actions.pod:2940
12772 "This call is intended for programs that want to efficiently list a directory "
12773 "contents without making many round-trips. See also L</lxattrlist> for a "
12774 "similarly efficient call for getting extended attributes. Very long "
12775 "directory listings might cause the protocol message size to be exceeded, "
12776 "causing this call to fail. The caller must split up such requests into "
12777 "smaller groups of names."
12781 #: ../fish/guestfish-actions.pod:2948
12782 msgid "luks-add-key"
12786 #: ../fish/guestfish-actions.pod:2950
12789 " luks-add-key device keyslot\n"
12794 #: ../fish/guestfish-actions.pod:2952 ../src/guestfs-actions.pod:4528
12796 "This command adds a new key on LUKS device C<device>. C<key> is any "
12797 "existing key, and is used to access the device. C<newkey> is the new key to "
12798 "add. C<keyslot> is the key slot that will be replaced."
12802 #: ../fish/guestfish-actions.pod:2957
12804 "Note that if C<keyslot> already contains a key, then this command will "
12805 "fail. You have to use L</luks-kill-slot> first to remove that key."
12809 #: ../fish/guestfish-actions.pod:2961 ../fish/guestfish-actions.pod:2983
12810 #: ../fish/guestfish-actions.pod:2993 ../fish/guestfish-actions.pod:3004
12811 #: ../fish/guestfish-actions.pod:3030 ../fish/guestfish-actions.pod:3040
12813 "This command has one or more key or passphrase parameters. Guestfish will "
12814 "prompt for these separately."
12818 #: ../fish/guestfish-actions.pod:2964
12823 #: ../fish/guestfish-actions.pod:2966
12826 " luks-close device\n"
12831 #: ../fish/guestfish-actions.pod:2968
12833 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
12834 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
12835 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
12840 #: ../fish/guestfish-actions.pod:2974
12841 msgid "luks-format"
12845 #: ../fish/guestfish-actions.pod:2976
12848 " luks-format device keyslot\n"
12853 #: ../fish/guestfish-actions.pod:2978 ../src/guestfs-actions.pod:4569
12855 "This command erases existing data on C<device> and formats the device as a "
12856 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12857 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12861 #: ../fish/guestfish-actions.pod:2986
12862 msgid "luks-format-cipher"
12866 #: ../fish/guestfish-actions.pod:2988
12869 " luks-format-cipher device keyslot cipher\n"
12874 #: ../fish/guestfish-actions.pod:2990
12876 "This command is the same as L</luks-format> but it also allows you to set "
12877 "the C<cipher> used."
12881 #: ../fish/guestfish-actions.pod:2996
12882 msgid "luks-kill-slot"
12886 #: ../fish/guestfish-actions.pod:2998
12889 " luks-kill-slot device keyslot\n"
12894 #: ../fish/guestfish-actions.pod:3000 ../src/guestfs-actions.pod:4610
12896 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12897 "device C<device>. C<key> must be one of the I<other> keys."
12901 #: ../fish/guestfish-actions.pod:3007
12906 #: ../fish/guestfish-actions.pod:3009
12909 " luks-open device mapname\n"
12914 #: ../fish/guestfish-actions.pod:3011 ../src/guestfs-actions.pod:4630
12916 "This command opens a block device which has been encrypted according to the "
12917 "Linux Unified Key Setup (LUKS) standard."
12921 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4633
12922 msgid "C<device> is the encrypted block device or partition."
12926 #: ../fish/guestfish-actions.pod:3016 ../src/guestfs-actions.pod:4635
12928 "The caller must supply one of the keys associated with the LUKS block "
12929 "device, in the C<key> parameter."
12933 #: ../fish/guestfish-actions.pod:3019 ../src/guestfs-actions.pod:4638
12935 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12936 "writes to this block device are decrypted from and encrypted to the "
12937 "underlying C<device> respectively."
12941 #: ../fish/guestfish-actions.pod:3023
12943 "If this block device contains LVM volume groups, then calling L</vgscan> "
12944 "followed by L</vg-activate-all> will make them visible."
12948 #: ../fish/guestfish-actions.pod:3027
12949 msgid "Use L</list-dm-devices> to list all device mapper devices."
12953 #: ../fish/guestfish-actions.pod:3033
12954 msgid "luks-open-ro"
12958 #: ../fish/guestfish-actions.pod:3035
12961 " luks-open-ro device mapname\n"
12966 #: ../fish/guestfish-actions.pod:3037
12968 "This is the same as L</luks-open> except that a read-only mapping is created."
12972 #: ../fish/guestfish-actions.pod:3043
12977 #: ../fish/guestfish-actions.pod:3045
12980 " lvcreate logvol volgroup mbytes\n"
12985 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4684
12987 "This creates an LVM logical volume called C<logvol> on the volume group "
12988 "C<volgroup>, with C<size> megabytes."
12992 #: ../fish/guestfish-actions.pod:3050
12993 msgid "lvm-canonical-lv-name"
12997 #: ../fish/guestfish-actions.pod:3052
13000 " lvm-canonical-lv-name lvname\n"
13005 #: ../fish/guestfish-actions.pod:3054 ../src/guestfs-actions.pod:4697
13007 "This converts alternative naming schemes for LVs that you might find to the "
13008 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13013 #: ../fish/guestfish-actions.pod:3058 ../src/guestfs-actions.pod:4701
13015 "This command returns an error if the C<lvname> parameter does not refer to a "
13020 #: ../fish/guestfish-actions.pod:3061
13021 msgid "See also L</is-lv>."
13025 #: ../fish/guestfish-actions.pod:3063
13026 msgid "lvm-clear-filter"
13030 #: ../fish/guestfish-actions.pod:3065
13033 " lvm-clear-filter\n"
13038 #: ../fish/guestfish-actions.pod:3067
13040 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
13045 #: ../fish/guestfish-actions.pod:3070 ../fish/guestfish-actions.pod:3098
13046 #: ../src/guestfs-actions.pod:4719 ../src/guestfs-actions.pod:4758
13048 "This command also clears the LVM cache and performs a volume group scan."
13052 #: ../fish/guestfish-actions.pod:3073
13053 msgid "lvm-remove-all"
13057 #: ../fish/guestfish-actions.pod:3075
13060 " lvm-remove-all\n"
13065 #: ../fish/guestfish-actions.pod:3077 ../src/guestfs-actions.pod:4731
13067 "This command removes all LVM logical volumes, volume groups and physical "
13072 #: ../fish/guestfish-actions.pod:3080
13073 msgid "lvm-set-filter"
13077 #: ../fish/guestfish-actions.pod:3082
13080 " lvm-set-filter 'devices ...'\n"
13085 #: ../fish/guestfish-actions.pod:3084 ../src/guestfs-actions.pod:4744
13087 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13088 "block devices in the list C<devices>, and will ignore all other attached "
13093 #: ../fish/guestfish-actions.pod:3088 ../src/guestfs-actions.pod:4748
13095 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13096 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13097 "there are two types of duplication possible: either cloned PVs/VGs which "
13098 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13099 "same name. In normal operation you cannot create this situation, but you "
13100 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13101 "inside the LVM metadata."
13105 #: ../fish/guestfish-actions.pod:3101 ../src/guestfs-actions.pod:4761
13106 msgid "You can filter whole block devices or individual partitions."
13110 #: ../fish/guestfish-actions.pod:3103 ../src/guestfs-actions.pod:4763
13112 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13113 "filesystem), even if you are not filtering out that VG."
13117 #: ../fish/guestfish-actions.pod:3107
13122 #: ../fish/guestfish-actions.pod:3109
13125 " lvremove device\n"
13130 #: ../fish/guestfish-actions.pod:3111 ../src/guestfs-actions.pod:4777
13132 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13133 "LV, such as C</dev/VG/LV>."
13137 #: ../fish/guestfish-actions.pod:3114 ../src/guestfs-actions.pod:4780
13139 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13144 #: ../fish/guestfish-actions.pod:3117
13149 #: ../fish/guestfish-actions.pod:3119
13152 " lvrename logvol newlogvol\n"
13157 #: ../fish/guestfish-actions.pod:3121 ../src/guestfs-actions.pod:4794
13158 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13162 #: ../fish/guestfish-actions.pod:3123
13167 #: ../fish/guestfish-actions.pod:3125
13170 " lvresize device mbytes\n"
13175 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4807
13177 "This resizes (expands or shrinks) an existing LVM logical volume to "
13178 "C<mbytes>. When reducing, data in the reduced part is lost."
13182 #: ../fish/guestfish-actions.pod:3131
13183 msgid "lvresize-free"
13187 #: ../fish/guestfish-actions.pod:3133
13190 " lvresize-free lv percent\n"
13195 #: ../fish/guestfish-actions.pod:3135 ../src/guestfs-actions.pod:4822
13197 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13198 "remaining free space in the volume group. Commonly you would call this with "
13199 "pc = 100 which expands the logical volume as much as possible, using all "
13200 "remaining free space in the volume group."
13204 #: ../fish/guestfish-actions.pod:3141
13209 #: ../fish/guestfish-actions.pod:3143
13217 #: ../fish/guestfish-actions.pod:3145 ../src/guestfs-actions.pod:4837
13219 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13224 #: ../fish/guestfish-actions.pod:3148 ../src/guestfs-actions.pod:4840
13226 "This returns a list of the logical volume device names (eg. C</dev/"
13227 "VolGroup00/LogVol00>)."
13231 #: ../fish/guestfish-actions.pod:3151
13232 msgid "See also L</lvs-full>, L</list-filesystems>."
13236 #: ../fish/guestfish-actions.pod:3153
13241 #: ../fish/guestfish-actions.pod:3155
13249 #: ../fish/guestfish-actions.pod:3157 ../src/guestfs-actions.pod:4856
13251 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13252 "(8)> command. The \"full\" version includes all fields."
13256 #: ../fish/guestfish-actions.pod:3160
13261 #: ../fish/guestfish-actions.pod:3162
13269 #: ../fish/guestfish-actions.pod:3164 ../src/guestfs-actions.pod:4871
13270 msgid "This command returns the UUID of the LVM LV C<device>."
13274 #: ../fish/guestfish-actions.pod:3166
13279 #: ../fish/guestfish-actions.pod:3168
13282 " lxattrlist path 'names ...'\n"
13287 #: ../fish/guestfish-actions.pod:3170 ../src/guestfs-actions.pod:4885
13289 "This call allows you to get the extended attributes of multiple files, where "
13290 "all files are in the directory C<path>. C<names> is the list of files from "
13295 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4889
13297 "On return you get a flat list of xattr structs which must be interpreted "
13298 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13299 "C<attrval> in this struct is zero-length to indicate there was an error "
13300 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13301 "number (the number of following attributes for this file, which could be C<"
13302 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13303 "for the first named file. This repeats for the second and subsequent files."
13307 #: ../fish/guestfish-actions.pod:3184
13309 "This call is intended for programs that want to efficiently list a directory "
13310 "contents without making many round-trips. See also L</lstatlist> for a "
13311 "similarly efficient call for getting standard stats. Very long directory "
13312 "listings might cause the protocol message size to be exceeded, causing this "
13313 "call to fail. The caller must split up such requests into smaller groups of "
13318 #: ../fish/guestfish-actions.pod:3192
13323 #: ../fish/guestfish-actions.pod:3194
13326 " md-create name 'devices ...' [missingbitmap:N] [nrdevices:N] [spare:N] [chunk:N] [level:..]\n"
13331 #: ../fish/guestfish-actions.pod:3196 ../src/guestfs-actions.pod:4932
13333 "Create a Linux md (RAID) device named C<name> on the devices in the list "
13338 #: ../fish/guestfish-actions.pod:3203 ../src/guestfs-actions.pod:4939
13339 msgid "C<missingbitmap>"
13343 #: ../fish/guestfish-actions.pod:3205 ../src/guestfs-actions.pod:4941
13345 "A bitmap of missing devices. If a bit is set it means that a missing device "
13346 "is added to the array. The least significant bit corresponds to the first "
13347 "device in the array."
13351 #: ../fish/guestfish-actions.pod:3209 ../src/guestfs-actions.pod:4945
13352 msgid "As examples:"
13356 #: ../fish/guestfish-actions.pod:3211 ../src/guestfs-actions.pod:4947
13358 "If C<devices = [\"/dev/sda\"]> and C<missingbitmap = 0x1> then the resulting "
13359 "array would be C<[E<lt>missingE<gt>, \"/dev/sda\"]>."
13363 #: ../fish/guestfish-actions.pod:3214 ../src/guestfs-actions.pod:4950
13365 "If C<devices = [\"/dev/sda\"]> and C<missingbitmap = 0x2> then the resulting "
13366 "array would be C<[\"/dev/sda\", E<lt>missingE<gt>]>."
13370 #: ../fish/guestfish-actions.pod:3217 ../src/guestfs-actions.pod:4953
13371 msgid "This defaults to C<0> (no missing devices)."
13375 #: ../fish/guestfish-actions.pod:3219 ../src/guestfs-actions.pod:4955
13377 "The length of C<devices> + the number of bits set in C<missingbitmap> must "
13378 "equal C<nrdevices> + C<spare>."
13382 #: ../fish/guestfish-actions.pod:3222 ../src/guestfs-actions.pod:4958
13383 msgid "C<nrdevices>"
13387 #: ../fish/guestfish-actions.pod:3224 ../src/guestfs-actions.pod:4960
13388 msgid "The number of active RAID devices."
13392 #: ../fish/guestfish-actions.pod:3226 ../src/guestfs-actions.pod:4962
13394 "If not set, this defaults to the length of C<devices> plus the number of "
13395 "bits set in C<missingbitmap>."
13399 #: ../fish/guestfish-actions.pod:3229 ../src/guestfs-actions.pod:4965
13404 #: ../fish/guestfish-actions.pod:3231 ../src/guestfs-actions.pod:4967
13405 msgid "The number of spare devices."
13409 #: ../fish/guestfish-actions.pod:3233 ../src/guestfs-actions.pod:4969
13410 msgid "If not set, this defaults to C<0>."
13414 #: ../fish/guestfish-actions.pod:3235 ../src/guestfs-actions.pod:4971
13419 #: ../fish/guestfish-actions.pod:3237 ../src/guestfs-actions.pod:4973
13420 msgid "The chunk size in bytes."
13424 #: ../fish/guestfish-actions.pod:3239 ../fish/guestfish-actions.pod:3261
13425 #: ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5023
13430 #: ../fish/guestfish-actions.pod:3241 ../src/guestfs-actions.pod:4977
13432 "The RAID level, which can be one of: I<linear>, I<raid0>, I<0>, I<stripe>, "
13433 "I<raid1>, I<1>, I<mirror>, I<raid4>, I<4>, I<raid5>, I<5>, I<raid6>, I<6>, "
13434 "I<raid10>, I<10>. Some of these are synonymous, and more levels may be "
13439 #: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:4982
13440 msgid "If not set, this defaults to C<raid1>."
13444 #: ../fish/guestfish-actions.pod:3252
13449 #: ../fish/guestfish-actions.pod:3254
13457 #: ../fish/guestfish-actions.pod:3256 ../src/guestfs-actions.pod:5018
13459 "This command exposes the output of 'mdadm -DY <md>'. The following fields "
13460 "are usually present in the returned hash. Other fields may also be present."
13464 #: ../fish/guestfish-actions.pod:3263 ../src/guestfs-actions.pod:5025
13465 msgid "The raid level of the MD device."
13469 #: ../fish/guestfish-actions.pod:3265 ../src/guestfs-actions.pod:5027
13474 #: ../fish/guestfish-actions.pod:3267 ../src/guestfs-actions.pod:5029
13475 msgid "The number of underlying devices in the MD device."
13479 #: ../fish/guestfish-actions.pod:3269 ../src/guestfs-actions.pod:5031
13480 msgid "C<metadata>"
13484 #: ../fish/guestfish-actions.pod:3271 ../src/guestfs-actions.pod:5033
13485 msgid "The metadata version used."
13489 #: ../fish/guestfish-actions.pod:3273 ../src/guestfs-actions.pod:5035
13494 #: ../fish/guestfish-actions.pod:3275 ../src/guestfs-actions.pod:5037
13495 msgid "The UUID of the MD device."
13499 #: ../fish/guestfish-actions.pod:3279 ../src/guestfs-actions.pod:5041
13500 msgid "The name of the MD device."
13504 #: ../fish/guestfish-actions.pod:3283
13509 #: ../fish/guestfish-actions.pod:3285
13517 #: ../fish/guestfish-actions.pod:3287 ../src/guestfs-actions.pod:5057
13519 "This command deactivates the MD array named C<md>. The device is stopped, "
13520 "but it is not destroyed or zeroed."
13524 #: ../fish/guestfish-actions.pod:3290
13529 #: ../fish/guestfish-actions.pod:3292
13537 #: ../fish/guestfish-actions.pod:3294 ../src/guestfs-actions.pod:5068
13538 msgid "Create a directory named C<path>."
13542 #: ../fish/guestfish-actions.pod:3296
13547 #: ../fish/guestfish-actions.pod:3298
13550 " mkdir-mode path mode\n"
13555 #: ../fish/guestfish-actions.pod:3300 ../src/guestfs-actions.pod:5081
13557 "This command creates a directory, setting the initial permissions of the "
13558 "directory to C<mode>."
13562 #: ../fish/guestfish-actions.pod:3303 ../src/guestfs-actions.pod:5084
13564 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13565 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13570 #: ../fish/guestfish-actions.pod:3307
13571 msgid "See also L</mkdir>, L</umask>"
13575 #: ../fish/guestfish-actions.pod:3309
13580 #: ../fish/guestfish-actions.pod:3311
13588 #: ../fish/guestfish-actions.pod:3313 ../src/guestfs-actions.pod:5100
13590 "Create a directory named C<path>, creating any parent directories as "
13591 "necessary. This is like the C<mkdir -p> shell command."
13595 #: ../fish/guestfish-actions.pod:3316
13600 #: ../fish/guestfish-actions.pod:3318
13603 " mkdtemp template\n"
13608 #: ../fish/guestfish-actions.pod:3320 ../src/guestfs-actions.pod:5113
13610 "This command creates a temporary directory. The C<template> parameter "
13611 "should be a full pathname for the temporary directory name with the final "
13612 "six characters being \"XXXXXX\"."
13616 #: ../fish/guestfish-actions.pod:3325 ../src/guestfs-actions.pod:5118
13618 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13619 "being suitable for Windows filesystems."
13623 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5121
13624 msgid "The name of the temporary directory that was created is returned."
13628 #: ../fish/guestfish-actions.pod:3331 ../src/guestfs-actions.pod:5124
13629 msgid "The temporary directory is created with mode 0700 and is owned by root."
13633 #: ../fish/guestfish-actions.pod:3334 ../src/guestfs-actions.pod:5127
13635 "The caller is responsible for deleting the temporary directory and its "
13636 "contents after use."
13640 #: ../fish/guestfish-actions.pod:3337 ../src/guestfs-actions.pod:5130
13641 msgid "See also: L<mkdtemp(3)>"
13645 #: ../fish/guestfish-actions.pod:3339
13650 #: ../fish/guestfish-actions.pod:3341
13653 " mke2fs-J fstype blocksize device journal\n"
13658 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5146
13660 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13661 "C<journal>. It is equivalent to the command:"
13665 #: ../fish/guestfish-actions.pod:3347 ../src/guestfs-actions.pod:5150
13668 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13673 #: ../fish/guestfish-actions.pod:3349
13674 msgid "See also L</mke2journal>."
13678 #: ../fish/guestfish-actions.pod:3351
13683 #: ../fish/guestfish-actions.pod:3353
13686 " mke2fs-JL fstype blocksize device label\n"
13691 #: ../fish/guestfish-actions.pod:3355 ../src/guestfs-actions.pod:5167
13693 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13694 "the journal labeled C<label>."
13698 #: ../fish/guestfish-actions.pod:3358
13699 msgid "See also L</mke2journal-L>."
13703 #: ../fish/guestfish-actions.pod:3360
13708 #: ../fish/guestfish-actions.pod:3362
13711 " mke2fs-JU fstype blocksize device uuid\n"
13716 #: ../fish/guestfish-actions.pod:3364 ../src/guestfs-actions.pod:5185
13718 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13719 "the journal with UUID C<uuid>."
13723 #: ../fish/guestfish-actions.pod:3367
13724 msgid "See also L</mke2journal-U>."
13728 #: ../fish/guestfish-actions.pod:3369
13729 msgid "mke2journal"
13733 #: ../fish/guestfish-actions.pod:3371
13736 " mke2journal blocksize device\n"
13741 #: ../fish/guestfish-actions.pod:3373 ../src/guestfs-actions.pod:5201
13743 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13748 #: ../fish/guestfish-actions.pod:3376 ../src/guestfs-actions.pod:5204
13751 " mke2fs -O journal_dev -b blocksize device\n"
13756 #: ../fish/guestfish-actions.pod:3378
13757 msgid "mke2journal-L"
13761 #: ../fish/guestfish-actions.pod:3380
13764 " mke2journal-L blocksize label device\n"
13769 #: ../fish/guestfish-actions.pod:3382 ../src/guestfs-actions.pod:5218
13770 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13774 #: ../fish/guestfish-actions.pod:3384
13775 msgid "mke2journal-U"
13779 #: ../fish/guestfish-actions.pod:3386
13782 " mke2journal-U blocksize uuid device\n"
13787 #: ../fish/guestfish-actions.pod:3388 ../src/guestfs-actions.pod:5232
13788 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13792 #: ../fish/guestfish-actions.pod:3390
13797 #: ../fish/guestfish-actions.pod:3392
13800 " mkfifo mode path\n"
13805 #: ../fish/guestfish-actions.pod:3394
13807 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13808 "is just a convenient wrapper around L</mknod>."
13812 #: ../fish/guestfish-actions.pod:3400
13817 #: ../fish/guestfish-actions.pod:3402
13820 " mkfs fstype device\n"
13825 #: ../fish/guestfish-actions.pod:3404 ../src/guestfs-actions.pod:5262
13827 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13828 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13832 #: ../fish/guestfish-actions.pod:3408
13837 #: ../fish/guestfish-actions.pod:3410
13840 " mkfs-b fstype blocksize device\n"
13845 #: ../fish/guestfish-actions.pod:3412
13847 "This call is similar to L</mkfs>, but it allows you to control the block "
13848 "size of the resulting filesystem. Supported block sizes depend on the "
13849 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13853 #: ../fish/guestfish-actions.pod:3417 ../fish/guestfish-actions.pod:3444
13854 #: ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5328
13856 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13861 #: ../fish/guestfish-actions.pod:3420
13863 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
13868 #: ../fish/guestfish-actions.pod:3427
13873 #: ../fish/guestfish-actions.pod:3429
13876 " mkfs-opts fstype device [blocksize:N] [features:..] [inode:N] [sectorsize:N]\n"
13881 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5315
13883 "This function creates a filesystem on C<device>. The filesystem type is "
13884 "C<fstype>, for example C<ext3>."
13888 #: ../fish/guestfish-actions.pod:3438 ../src/guestfs-actions.pod:5322
13889 msgid "C<blocksize>"
13893 #: ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5324
13895 "The filesystem block size. Supported block sizes depend on the filesystem "
13896 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13901 #: ../fish/guestfish-actions.pod:3447 ../src/guestfs-actions.pod:5331
13902 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13906 #: ../fish/guestfish-actions.pod:3449 ../src/guestfs-actions.pod:5333
13907 msgid "C<features>"
13911 #: ../fish/guestfish-actions.pod:3451 ../src/guestfs-actions.pod:5335
13912 msgid "This passes the I<-O> parameter to the external mkfs program."
13916 #: ../fish/guestfish-actions.pod:3453 ../src/guestfs-actions.pod:5337
13918 "For certain filesystem types, this allows extra filesystem features to be "
13919 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13923 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5341
13925 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13930 #: ../fish/guestfish-actions.pod:3460 ../src/guestfs-actions.pod:5344
13935 #: ../fish/guestfish-actions.pod:3462 ../src/guestfs-actions.pod:5346
13937 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
13938 "sets the inode size (only for ext2/3/4 filesystems at present)."
13942 #: ../fish/guestfish-actions.pod:3465 ../src/guestfs-actions.pod:5349
13943 msgid "C<sectorsize>"
13947 #: ../fish/guestfish-actions.pod:3467 ../src/guestfs-actions.pod:5351
13949 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
13950 "sets sector size for ufs filesystem."
13954 #: ../fish/guestfish-actions.pod:3474
13955 msgid "mkmountpoint"
13959 #: ../fish/guestfish-actions.pod:3476
13962 " mkmountpoint exemptpath\n"
13967 #: ../fish/guestfish-actions.pod:3478
13969 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
13970 "to create extra mountpoints before mounting the first filesystem."
13974 #: ../fish/guestfish-actions.pod:3482 ../src/guestfs-actions.pod:5394
13976 "These calls are I<only> necessary in some very limited circumstances, mainly "
13977 "the case where you want to mount a mix of unrelated and/or read-only "
13978 "filesystems together."
13982 #: ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5398
13984 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13985 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13986 "inside that. You can unpack this as follows in guestfish:"
13990 #: ../fish/guestfish-actions.pod:3491 ../src/guestfs-actions.pod:5403
13993 " add-ro Fedora-11-i686-Live.iso\n"
13995 " mkmountpoint /cd\n"
13996 " mkmountpoint /sqsh\n"
13997 " mkmountpoint /ext3fs\n"
13998 " mount /dev/sda /cd\n"
13999 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14000 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14005 #: ../fish/guestfish-actions.pod:3500 ../src/guestfs-actions.pod:5412
14006 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14010 #: ../fish/guestfish-actions.pod:3502
14012 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
14013 "unexpected errors if you try to mix these calls. It is safest to manually "
14014 "unmount filesystems and remove mountpoints after use."
14018 #: ../fish/guestfish-actions.pod:3506
14020 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
14021 "for this to work for manual mountpoints, you must ensure that the innermost "
14022 "mountpoints have the longest pathnames, as in the example code above."
14026 #: ../fish/guestfish-actions.pod:3511 ../src/guestfs-actions.pod:5423
14028 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14032 #: ../fish/guestfish-actions.pod:3513
14034 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
14035 "L</umount-all> to be called when the handle is closed which can also trigger "
14040 #: ../fish/guestfish-actions.pod:3517
14045 #: ../fish/guestfish-actions.pod:3519
14048 " mknod mode devmajor devminor path\n"
14053 #: ../fish/guestfish-actions.pod:3521 ../src/guestfs-actions.pod:5442
14055 "This call creates block or character special devices, or named pipes (FIFOs)."
14059 #: ../fish/guestfish-actions.pod:3524 ../src/guestfs-actions.pod:5445
14061 "The C<mode> parameter should be the mode, using the standard constants. "
14062 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14063 "used when creating block and character special devices."
14067 #: ../fish/guestfish-actions.pod:3529
14069 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14070 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14071 "regular file). These constants are available in the standard Linux header "
14072 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
14073 "wrappers around this command which bitwise OR in the appropriate constant "
14078 #: ../fish/guestfish-actions.pod:3539
14083 #: ../fish/guestfish-actions.pod:3541
14086 " mknod-b mode devmajor devminor path\n"
14091 #: ../fish/guestfish-actions.pod:3543
14093 "This call creates a block device node called C<path> with mode C<mode> and "
14094 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14095 "wrapper around L</mknod>."
14099 #: ../fish/guestfish-actions.pod:3549
14104 #: ../fish/guestfish-actions.pod:3551
14107 " mknod-c mode devmajor devminor path\n"
14112 #: ../fish/guestfish-actions.pod:3553
14114 "This call creates a char device node called C<path> with mode C<mode> and "
14115 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14116 "wrapper around L</mknod>."
14120 #: ../fish/guestfish-actions.pod:3559
14125 #: ../fish/guestfish-actions.pod:3561
14133 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5508
14134 msgid "Create a swap partition on C<device>."
14138 #: ../fish/guestfish-actions.pod:3565
14143 #: ../fish/guestfish-actions.pod:3567
14146 " mkswap-L label device\n"
14151 #: ../fish/guestfish-actions.pod:3569 ../src/guestfs-actions.pod:5521
14152 msgid "Create a swap partition on C<device> with label C<label>."
14156 #: ../fish/guestfish-actions.pod:3571 ../src/guestfs-actions.pod:5523
14158 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14159 "sda>), just to a partition. This appears to be a limitation of the kernel "
14164 #: ../fish/guestfish-actions.pod:3575
14169 #: ../fish/guestfish-actions.pod:3577
14172 " mkswap-U uuid device\n"
14177 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5538
14178 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14182 #: ../fish/guestfish-actions.pod:3581
14183 msgid "mkswap-file"
14187 #: ../fish/guestfish-actions.pod:3583
14190 " mkswap-file path\n"
14195 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5550
14196 msgid "Create a swap file."
14200 #: ../fish/guestfish-actions.pod:3587
14202 "This command just writes a swap file signature to an existing file. To "
14203 "create the file itself, use something like L</fallocate>."
14207 #: ../fish/guestfish-actions.pod:3590
14212 #: ../fish/guestfish-actions.pod:3592
14215 " modprobe modulename\n"
14220 #: ../fish/guestfish-actions.pod:3594 ../src/guestfs-actions.pod:5565
14221 msgid "This loads a kernel module in the appliance."
14225 #: ../fish/guestfish-actions.pod:3596 ../src/guestfs-actions.pod:5567
14227 "The kernel module must have been whitelisted when libguestfs was built (see "
14228 "C<appliance/kmod.whitelist.in> in the source)."
14232 #: ../fish/guestfish-actions.pod:3599
14237 #: ../fish/guestfish-actions.pod:3601
14240 " mount device mountpoint\n"
14245 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5581
14247 "Mount a guest disk at a position in the filesystem. Block devices are named "
14248 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14249 "those block devices contain partitions, they will have the usual names (eg. "
14250 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14254 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5587
14256 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14257 "mounted on C</> before others can be mounted. Other filesystems can only be "
14258 "mounted on directories which already exist."
14262 #: ../fish/guestfish-actions.pod:3614 ../src/guestfs-actions.pod:5592
14264 "The mounted filesystem is writable, if we have sufficient permissions on the "
14265 "underlying device."
14269 #: ../fish/guestfish-actions.pod:3617
14271 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
14272 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
14273 "problems for users. If your program might need to work with older versions "
14274 "of libguestfs, use L</mount-options> instead (using an empty string for the "
14275 "first parameter if you don't want any options)."
14279 #: ../fish/guestfish-actions.pod:3624
14284 #: ../fish/guestfish-actions.pod:3626
14287 " mount-9p mounttag mountpoint [options:..]\n"
14292 #: ../fish/guestfish-actions.pod:3628 ../src/guestfs-actions.pod:5621
14294 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14299 #: ../fish/guestfish-actions.pod:3631 ../src/guestfs-actions.pod:5624
14301 "If required, C<trans=virtio> will be automatically added to the options. "
14302 "Any other options required can be passed in the optional C<options> "
14307 #: ../fish/guestfish-actions.pod:3637
14312 #: ../fish/guestfish-actions.pod:3639
14315 " mount-loop file mountpoint\n"
14320 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5663
14322 "This command lets you mount C<file> (a filesystem image in a file) on a "
14323 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14328 #: ../fish/guestfish-actions.pod:3645
14329 msgid "mount-options"
14333 #: ../fish/guestfish-actions.pod:3647
14336 " mount-options options device mountpoint\n"
14341 #: ../fish/guestfish-actions.pod:3649
14343 "This is the same as the L</mount> command, but it allows you to set the "
14344 "mount options as for the L<mount(8)> I<-o> flag."
14348 #: ../fish/guestfish-actions.pod:3653 ../src/guestfs-actions.pod:5683
14350 "If the C<options> parameter is an empty string, then no options are passed "
14351 "(all options default to whatever the filesystem uses)."
14355 #: ../fish/guestfish-actions.pod:3657
14360 #: ../fish/guestfish-actions.pod:3659
14363 " mount-ro device mountpoint\n"
14368 #: ../fish/guestfish-actions.pod:3661
14370 "This is the same as the L</mount> command, but it mounts the filesystem with "
14371 "the read-only (I<-o ro>) flag."
14375 #: ../fish/guestfish-actions.pod:3664
14380 #: ../fish/guestfish-actions.pod:3666
14383 " mount-vfs options vfstype device mountpoint\n"
14388 #: ../fish/guestfish-actions.pod:3668
14390 "This is the same as the L</mount> command, but it allows you to set both the "
14391 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
14395 #: ../fish/guestfish-actions.pod:3672
14396 msgid "mountpoints"
14400 #: ../fish/guestfish-actions.pod:3674
14408 #: ../fish/guestfish-actions.pod:3676
14410 "This call is similar to L</mounts>. That call returns a list of devices. "
14411 "This one returns a hash table (map) of device name to directory where the "
14412 "device is mounted."
14416 #: ../fish/guestfish-actions.pod:3680
14421 #: ../fish/guestfish-actions.pod:3682
14429 #: ../fish/guestfish-actions.pod:3684 ../src/guestfs-actions.pod:5744
14431 "This returns the list of currently mounted filesystems. It returns the list "
14432 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14436 #: ../fish/guestfish-actions.pod:3687 ../src/guestfs-actions.pod:5747
14437 msgid "Some internal mounts are not shown."
14441 #: ../fish/guestfish-actions.pod:3689
14442 msgid "See also: L</mountpoints>"
14446 #: ../fish/guestfish-actions.pod:3691
14451 #: ../fish/guestfish-actions.pod:3693
14459 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5764
14461 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14462 "destination filename or destination directory."
14466 #: ../fish/guestfish-actions.pod:3698
14467 msgid "ntfs-3g-probe"
14471 #: ../fish/guestfish-actions.pod:3700
14474 " ntfs-3g-probe true|false device\n"
14479 #: ../fish/guestfish-actions.pod:3702 ../src/guestfs-actions.pod:5778
14481 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14482 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14483 "write, and some cannot be mounted at all)."
14487 #: ../fish/guestfish-actions.pod:3706 ../src/guestfs-actions.pod:5782
14489 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14490 "can be mounted read-write. Set it to false if you want to test if the "
14491 "volume can be mounted read-only."
14495 #: ../fish/guestfish-actions.pod:3710 ../src/guestfs-actions.pod:5786
14497 "The return value is an integer which C<0> if the operation would succeed, or "
14498 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14502 #: ../fish/guestfish-actions.pod:3714
14507 #: ../fish/guestfish-actions.pod:3716
14510 " ntfsresize device\n"
14515 #: ../fish/guestfish-actions.pod:3718 ../fish/guestfish-actions.pod:3742
14516 #: ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5839
14518 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14519 "size of the underlying device."
14523 #: ../fish/guestfish-actions.pod:3721 ../src/guestfs-actions.pod:5810
14525 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14526 "consistency check (for safety). You have to boot into Windows to perform "
14527 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14528 "resize filesystems which have been marked in this way. So in effect it is "
14529 "not possible to call ntfsresize multiple times on a single filesystem "
14530 "without booting into Windows between each resize."
14534 #: ../fish/guestfish-actions.pod:3729 ../fish/guestfish-actions.pod:3768
14535 #: ../src/guestfs-actions.pod:5818 ../src/guestfs-actions.pod:5865
14536 msgid "See also L<ntfsresize(8)>."
14540 #: ../fish/guestfish-actions.pod:3731 ../fish/guestfish-actions.pod:3779
14542 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
14547 #: ../fish/guestfish-actions.pod:3738
14548 msgid "ntfsresize-opts"
14552 #: ../fish/guestfish-actions.pod:3740
14555 " ntfsresize-opts device [size:N] [force:true|false]\n"
14560 #: ../fish/guestfish-actions.pod:3751 ../src/guestfs-actions.pod:5848
14562 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14563 "resized to fit the container (eg. partition)."
14567 #: ../fish/guestfish-actions.pod:3754 ../fish/guestfish-actions.pod:5075
14568 #: ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:7822
14573 #: ../fish/guestfish-actions.pod:3756 ../src/guestfs-actions.pod:5853
14575 "If this option is true, then force the resize of the filesystem even if the "
14576 "filesystem is marked as requiring a consistency check."
14580 #: ../fish/guestfish-actions.pod:3759
14582 "After the resize operation, the filesystem is always marked as requiring a "
14583 "consistency check (for safety). You have to boot into Windows to perform "
14584 "this check and clear this condition. If you I<don't> set the C<force> "
14585 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
14586 "a single filesystem without booting into Windows between each resize."
14590 #: ../fish/guestfish-actions.pod:3772
14591 msgid "ntfsresize-size"
14595 #: ../fish/guestfish-actions.pod:3774
14598 " ntfsresize-size device size\n"
14603 #: ../fish/guestfish-actions.pod:3776
14605 "This command is the same as L</ntfsresize> except that it allows you to "
14606 "specify the new size (in bytes) explicitly."
14610 #: ../fish/guestfish-actions.pod:3786
14615 #: ../fish/guestfish-actions.pod:3788
14618 " part-add device prlogex startsect endsect\n"
14623 #: ../fish/guestfish-actions.pod:3790
14625 "This command adds a partition to C<device>. If there is no partition table "
14626 "on the device, call L</part-init> first."
14630 #: ../fish/guestfish-actions.pod:3793 ../src/guestfs-actions.pod:5926
14632 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14633 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14634 "C<logical>) and C<e> (or C<extended>) partition types."
14638 #: ../fish/guestfish-actions.pod:3798 ../src/guestfs-actions.pod:5931
14640 "C<startsect> and C<endsect> are the start and end of the partition in "
14641 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14642 "from the end of the disk (C<-1> is the last sector)."
14646 #: ../fish/guestfish-actions.pod:3802
14648 "Creating a partition which covers the whole disk is not so easy. Use L</"
14649 "part-disk> to do that."
14653 #: ../fish/guestfish-actions.pod:3805
14658 #: ../fish/guestfish-actions.pod:3807
14661 " part-del device partnum\n"
14666 #: ../fish/guestfish-actions.pod:3809 ../src/guestfs-actions.pod:5949
14667 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14671 #: ../fish/guestfish-actions.pod:3811 ../src/guestfs-actions.pod:5951
14673 "Note that in the case of MBR partitioning, deleting an extended partition "
14674 "also deletes any logical partitions it contains."
14678 #: ../fish/guestfish-actions.pod:3815
14683 #: ../fish/guestfish-actions.pod:3817
14686 " part-disk device parttype\n"
14691 #: ../fish/guestfish-actions.pod:3819
14693 "This command is simply a combination of L</part-init> followed by L</part-"
14694 "add> to create a single primary partition covering the whole disk."
14698 #: ../fish/guestfish-actions.pod:3823
14700 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14701 "possible values are described in L</part-init>."
14705 #: ../fish/guestfish-actions.pod:3826
14706 msgid "part-get-bootable"
14710 #: ../fish/guestfish-actions.pod:3828
14713 " part-get-bootable device partnum\n"
14718 #: ../fish/guestfish-actions.pod:3830 ../src/guestfs-actions.pod:5984
14720 "This command returns true if the partition C<partnum> on C<device> has the "
14721 "bootable flag set."
14725 #: ../fish/guestfish-actions.pod:3833
14726 msgid "See also L</part-set-bootable>."
14730 #: ../fish/guestfish-actions.pod:3835
14731 msgid "part-get-mbr-id"
14735 #: ../fish/guestfish-actions.pod:3837
14738 " part-get-mbr-id device partnum\n"
14743 #: ../fish/guestfish-actions.pod:3839 ../src/guestfs-actions.pod:6000
14745 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14746 "partition C<partnum>."
14750 #: ../fish/guestfish-actions.pod:3842 ../fish/guestfish-actions.pod:3986
14752 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14753 "undefined results for other partition table types (see L</part-get-"
14758 #: ../fish/guestfish-actions.pod:3846
14759 msgid "part-get-parttype"
14763 #: ../fish/guestfish-actions.pod:3848
14766 " part-get-parttype device\n"
14771 #: ../fish/guestfish-actions.pod:3850 ../src/guestfs-actions.pod:6017
14773 "This command examines the partition table on C<device> and returns the "
14774 "partition table type (format) being used."
14778 #: ../fish/guestfish-actions.pod:3853
14780 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14781 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14782 "possible, although unusual. See L</part-init> for a full list."
14786 #: ../fish/guestfish-actions.pod:3858
14791 #: ../fish/guestfish-actions.pod:3860
14794 " part-init device parttype\n"
14799 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:6037
14801 "This creates an empty partition table on C<device> of one of the partition "
14802 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14803 "(for large disks)."
14807 #: ../fish/guestfish-actions.pod:3866
14809 "Initially there are no partitions. Following this, you should call L</part-"
14810 "add> for each partition required."
14814 #: ../fish/guestfish-actions.pod:3869 ../src/guestfs-actions.pod:6044
14815 msgid "Possible values for C<parttype> are:"
14819 #: ../fish/guestfish-actions.pod:3873 ../src/guestfs-actions.pod:6048
14824 #: ../fish/guestfish-actions.pod:3875 ../src/guestfs-actions.pod:6050
14829 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:6052
14830 msgid "Intel EFI / GPT partition table."
14834 #: ../fish/guestfish-actions.pod:3879 ../src/guestfs-actions.pod:6054
14836 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14837 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14838 "the C<mbr> format."
14842 #: ../fish/guestfish-actions.pod:3883 ../src/guestfs-actions.pod:6058
14847 #: ../fish/guestfish-actions.pod:3885 ../src/guestfs-actions.pod:6060
14852 #: ../fish/guestfish-actions.pod:3887 ../src/guestfs-actions.pod:6062
14854 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14855 "Windows. This partition type will B<only> work for device sizes up to 2 "
14856 "TB. For large disks we recommend using C<gpt>."
14860 #: ../fish/guestfish-actions.pod:3894 ../src/guestfs-actions.pod:6069
14862 "Other partition table types that may work but are not supported include:"
14866 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:6074
14871 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:6076
14872 msgid "AIX disk labels."
14876 #: ../fish/guestfish-actions.pod:3903 ../src/guestfs-actions.pod:6078
14881 #: ../fish/guestfish-actions.pod:3905 ../src/guestfs-actions.pod:6080
14886 #: ../fish/guestfish-actions.pod:3907 ../src/guestfs-actions.pod:6082
14887 msgid "Amiga \"Rigid Disk Block\" format."
14891 #: ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:6084
14896 #: ../fish/guestfish-actions.pod:3911 ../src/guestfs-actions.pod:6086
14897 msgid "BSD disk labels."
14901 #: ../fish/guestfish-actions.pod:3913 ../src/guestfs-actions.pod:6088
14906 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:6090
14907 msgid "DASD, used on IBM mainframes."
14911 #: ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:6092
14916 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:6094
14917 msgid "MIPS/SGI volumes."
14921 #: ../fish/guestfish-actions.pod:3921 ../src/guestfs-actions.pod:6096
14926 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:6098
14927 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14931 #: ../fish/guestfish-actions.pod:3925 ../src/guestfs-actions.pod:6100
14936 #: ../fish/guestfish-actions.pod:3927 ../src/guestfs-actions.pod:6102
14937 msgid "NEC PC-98 format, common in Japan apparently."
14941 #: ../fish/guestfish-actions.pod:3929 ../src/guestfs-actions.pod:6104
14946 #: ../fish/guestfish-actions.pod:3931 ../src/guestfs-actions.pod:6106
14947 msgid "Sun disk labels."
14951 #: ../fish/guestfish-actions.pod:3935
14956 #: ../fish/guestfish-actions.pod:3937
14959 " part-list device\n"
14964 #: ../fish/guestfish-actions.pod:3939 ../src/guestfs-actions.pod:6120
14966 "This command parses the partition table on C<device> and returns the list of "
14967 "partitions found."
14971 #: ../fish/guestfish-actions.pod:3942 ../src/guestfs-actions.pod:6123
14972 msgid "The fields in the returned structure are:"
14976 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:6127
14977 msgid "B<part_num>"
14981 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6129
14982 msgid "Partition number, counting from 1."
14986 #: ../fish/guestfish-actions.pod:3950 ../src/guestfs-actions.pod:6131
14987 msgid "B<part_start>"
14991 #: ../fish/guestfish-actions.pod:3952
14993 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14994 "the device's sector size, see L</blockdev-getss>."
14998 #: ../fish/guestfish-actions.pod:3955 ../src/guestfs-actions.pod:6136
14999 msgid "B<part_end>"
15003 #: ../fish/guestfish-actions.pod:3957 ../src/guestfs-actions.pod:6138
15004 msgid "End of the partition in bytes."
15008 #: ../fish/guestfish-actions.pod:3959 ../src/guestfs-actions.pod:6140
15009 msgid "B<part_size>"
15013 #: ../fish/guestfish-actions.pod:3961 ../src/guestfs-actions.pod:6142
15014 msgid "Size of the partition in bytes."
15018 #: ../fish/guestfish-actions.pod:3965
15019 msgid "part-set-bootable"
15023 #: ../fish/guestfish-actions.pod:3967
15026 " part-set-bootable device partnum true|false\n"
15031 #: ../fish/guestfish-actions.pod:3969 ../src/guestfs-actions.pod:6160
15033 "This sets the bootable flag on partition numbered C<partnum> on device "
15034 "C<device>. Note that partitions are numbered from 1."
15038 #: ../fish/guestfish-actions.pod:3972 ../src/guestfs-actions.pod:6163
15040 "The bootable flag is used by some operating systems (notably Windows) to "
15041 "determine which partition to boot from. It is by no means universally "
15046 #: ../fish/guestfish-actions.pod:3976
15047 msgid "part-set-mbr-id"
15051 #: ../fish/guestfish-actions.pod:3978
15054 " part-set-mbr-id device partnum idbyte\n"
15059 #: ../fish/guestfish-actions.pod:3980 ../src/guestfs-actions.pod:6179
15061 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15062 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15063 "documentation are in fact hexadecimal numbers, but usually documented "
15064 "without any leading \"0x\" which might be confusing."
15068 #: ../fish/guestfish-actions.pod:3990
15069 msgid "part-set-name"
15073 #: ../fish/guestfish-actions.pod:3992
15076 " part-set-name device partnum name\n"
15081 #: ../fish/guestfish-actions.pod:3994 ../src/guestfs-actions.pod:6201
15083 "This sets the partition name on partition numbered C<partnum> on device "
15084 "C<device>. Note that partitions are numbered from 1."
15088 #: ../fish/guestfish-actions.pod:3997 ../src/guestfs-actions.pod:6204
15090 "The partition name can only be set on certain types of partition table. "
15091 "This works on C<gpt> but not on C<mbr> partitions."
15095 #: ../fish/guestfish-actions.pod:4000
15096 msgid "part-to-dev"
15100 #: ../fish/guestfish-actions.pod:4002
15103 " part-to-dev partition\n"
15108 #: ../fish/guestfish-actions.pod:4004 ../src/guestfs-actions.pod:6217
15110 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15111 "partition number, returning the device name (eg. \"/dev/sdb\")."
15115 #: ../fish/guestfish-actions.pod:4008 ../fish/guestfish-actions.pod:4020
15117 "The named partition must exist, for example as a string returned from L</"
15118 "list-partitions>."
15122 #: ../fish/guestfish-actions.pod:4011
15123 msgid "See also L</part-to-partnum>."
15127 #: ../fish/guestfish-actions.pod:4013
15128 msgid "part-to-partnum"
15132 #: ../fish/guestfish-actions.pod:4015
15135 " part-to-partnum partition\n"
15140 #: ../fish/guestfish-actions.pod:4017 ../src/guestfs-actions.pod:6237
15142 "This function takes a partition name (eg. \"/dev/sdb1\") and returns the "
15143 "partition number (eg. C<1>)."
15147 #: ../fish/guestfish-actions.pod:4023
15148 msgid "See also L</part-to-dev>."
15152 #: ../fish/guestfish-actions.pod:4025
15153 msgid "ping-daemon"
15157 #: ../fish/guestfish-actions.pod:4027
15165 #: ../fish/guestfish-actions.pod:4029 ../src/guestfs-actions.pod:6254
15167 "This is a test probe into the guestfs daemon running inside the qemu "
15168 "subprocess. Calling this function checks that the daemon responds to the "
15169 "ping message, without affecting the daemon or attached block device(s) in "
15174 #: ../fish/guestfish-actions.pod:4034
15179 #: ../fish/guestfish-actions.pod:4036
15182 " pread path count offset\n"
15187 #: ../fish/guestfish-actions.pod:4038 ../src/guestfs-actions.pod:6272
15189 "This command lets you read part of a file. It reads C<count> bytes of the "
15190 "file, starting at C<offset>, from file C<path>."
15194 #: ../fish/guestfish-actions.pod:4041 ../fish/guestfish-actions.pod:4056
15195 #: ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6301
15197 "This may read fewer bytes than requested. For further details see the "
15198 "L<pread(2)> system call."
15202 #: ../fish/guestfish-actions.pod:4044
15203 msgid "See also L</pwrite>, L</pread-device>."
15207 #: ../fish/guestfish-actions.pod:4049
15208 msgid "pread-device"
15212 #: ../fish/guestfish-actions.pod:4051
15215 " pread-device device count offset\n"
15220 #: ../fish/guestfish-actions.pod:4053 ../src/guestfs-actions.pod:6298
15222 "This command lets you read part of a file. It reads C<count> bytes of "
15223 "C<device>, starting at C<offset>."
15227 #: ../fish/guestfish-actions.pod:4059
15228 msgid "See also L</pread>."
15232 #: ../fish/guestfish-actions.pod:4064
15237 #: ../fish/guestfish-actions.pod:4066
15240 " pvcreate device\n"
15245 #: ../fish/guestfish-actions.pod:4068 ../src/guestfs-actions.pod:6321
15247 "This creates an LVM physical volume on the named C<device>, where C<device> "
15248 "should usually be a partition name such as C</dev/sda1>."
15252 #: ../fish/guestfish-actions.pod:4072
15257 #: ../fish/guestfish-actions.pod:4074
15260 " pvremove device\n"
15265 #: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6335
15267 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15272 #: ../fish/guestfish-actions.pod:4079 ../src/guestfs-actions.pod:6338
15274 "The implementation uses the C<pvremove> command which refuses to wipe "
15275 "physical volumes that contain any volume groups, so you have to remove those "
15280 #: ../fish/guestfish-actions.pod:4083
15285 #: ../fish/guestfish-actions.pod:4085
15288 " pvresize device\n"
15293 #: ../fish/guestfish-actions.pod:4087 ../src/guestfs-actions.pod:6352
15295 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15296 "the new size of the underlying device."
15300 #: ../fish/guestfish-actions.pod:4090
15301 msgid "pvresize-size"
15305 #: ../fish/guestfish-actions.pod:4092
15308 " pvresize-size device size\n"
15313 #: ../fish/guestfish-actions.pod:4094
15315 "This command is the same as L</pvresize> except that it allows you to "
15316 "specify the new size (in bytes) explicitly."
15320 #: ../fish/guestfish-actions.pod:4097
15325 #: ../fish/guestfish-actions.pod:4099
15333 #: ../fish/guestfish-actions.pod:4101 ../src/guestfs-actions.pod:6378
15335 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15340 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6381
15342 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15347 #: ../fish/guestfish-actions.pod:4107
15348 msgid "See also L</pvs-full>."
15352 #: ../fish/guestfish-actions.pod:4109
15357 #: ../fish/guestfish-actions.pod:4111
15365 #: ../fish/guestfish-actions.pod:4113 ../src/guestfs-actions.pod:6397
15367 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15368 "(8)> command. The \"full\" version includes all fields."
15372 #: ../fish/guestfish-actions.pod:4116
15377 #: ../fish/guestfish-actions.pod:4118
15385 #: ../fish/guestfish-actions.pod:4120 ../src/guestfs-actions.pod:6412
15386 msgid "This command returns the UUID of the LVM PV C<device>."
15390 #: ../fish/guestfish-actions.pod:4122
15395 #: ../fish/guestfish-actions.pod:4124
15398 " pwrite path content offset\n"
15403 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6428
15405 "This command writes to part of a file. It writes the data buffer C<content> "
15406 "to the file C<path> starting at offset C<offset>."
15410 #: ../fish/guestfish-actions.pod:4129 ../src/guestfs-actions.pod:6431
15412 "This command implements the L<pwrite(2)> system call, and like that system "
15413 "call it may not write the full data requested. The return value is the "
15414 "number of bytes that were actually written to the file. This could even be "
15415 "0, although short writes are unlikely for regular files in ordinary "
15420 #: ../fish/guestfish-actions.pod:4135
15421 msgid "See also L</pread>, L</pwrite-device>."
15425 #: ../fish/guestfish-actions.pod:4140
15426 msgid "pwrite-device"
15430 #: ../fish/guestfish-actions.pod:4142
15433 " pwrite-device device content offset\n"
15438 #: ../fish/guestfish-actions.pod:4144 ../src/guestfs-actions.pod:6455
15440 "This command writes to part of a device. It writes the data buffer "
15441 "C<content> to C<device> starting at offset C<offset>."
15445 #: ../fish/guestfish-actions.pod:4147 ../src/guestfs-actions.pod:6458
15447 "This command implements the L<pwrite(2)> system call, and like that system "
15448 "call it may not write the full data requested (although short writes to disk "
15449 "devices and partitions are probably impossible with standard Linux kernels)."
15453 #: ../fish/guestfish-actions.pod:4152
15454 msgid "See also L</pwrite>."
15458 #: ../fish/guestfish-actions.pod:4157
15463 #: ../fish/guestfish-actions.pod:4159
15466 " read-file path\n"
15471 #: ../fish/guestfish-actions.pod:4161 ../src/guestfs-actions.pod:6479
15472 msgid "This calls returns the contents of the file C<path> as a buffer."
15476 #: ../fish/guestfish-actions.pod:4164
15478 "Unlike L</cat>, this function can correctly handle files that contain "
15479 "embedded ASCII NUL characters. However unlike L</download>, this function "
15480 "is limited in the total size of file that can be handled."
15484 #: ../fish/guestfish-actions.pod:4172
15489 #: ../fish/guestfish-actions.pod:4174
15492 " read-lines path\n"
15497 #: ../fish/guestfish-actions.pod:4178 ../src/guestfs-actions.pod:6504
15499 "The file contents are returned as a list of lines. Trailing C<LF> and "
15500 "C<CRLF> character sequences are I<not> returned."
15504 #: ../fish/guestfish-actions.pod:4181
15506 "Note that this function cannot correctly handle binary files (specifically, "
15507 "files containing C<\\0> character which is treated as end of line). For "
15508 "those you need to use the L</read-file> function which has a more complex "
15513 #: ../fish/guestfish-actions.pod:4186
15518 #: ../fish/guestfish-actions.pod:4188
15526 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6524
15527 msgid "This returns the list of directory entries in directory C<dir>."
15531 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6526
15533 "All entries in the directory are returned, including C<.> and C<..>. The "
15534 "entries are I<not> sorted, but returned in the same order as the underlying "
15539 #: ../fish/guestfish-actions.pod:4196 ../src/guestfs-actions.pod:6530
15541 "Also this call returns basic file type information about each file. The "
15542 "C<ftyp> field will contain one of the following characters:"
15546 #: ../fish/guestfish-actions.pod:4201 ../src/guestfs-actions.pod:6535
15551 #: ../fish/guestfish-actions.pod:4203 ../src/guestfs-actions.pod:6537
15552 msgid "Block special"
15556 #: ../fish/guestfish-actions.pod:4205 ../src/guestfs-actions.pod:6539
15561 #: ../fish/guestfish-actions.pod:4207 ../src/guestfs-actions.pod:6541
15562 msgid "Char special"
15566 #: ../fish/guestfish-actions.pod:4209 ../src/guestfs-actions.pod:6543
15571 #: ../fish/guestfish-actions.pod:4211 ../src/guestfs-actions.pod:6545
15576 #: ../fish/guestfish-actions.pod:4213 ../src/guestfs-actions.pod:6547
15581 #: ../fish/guestfish-actions.pod:4215 ../src/guestfs-actions.pod:6549
15582 msgid "FIFO (named pipe)"
15586 #: ../fish/guestfish-actions.pod:4217 ../src/guestfs-actions.pod:6551
15591 #: ../fish/guestfish-actions.pod:4219 ../src/guestfs-actions.pod:6553
15592 msgid "Symbolic link"
15596 #: ../fish/guestfish-actions.pod:4221 ../src/guestfs-actions.pod:6555
15601 #: ../fish/guestfish-actions.pod:4223 ../src/guestfs-actions.pod:6557
15602 msgid "Regular file"
15606 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6559
15611 #: ../fish/guestfish-actions.pod:4227 ../src/guestfs-actions.pod:6561
15616 #: ../fish/guestfish-actions.pod:4229 ../src/guestfs-actions.pod:6563
15621 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6565
15622 msgid "Unknown file type"
15626 #: ../fish/guestfish-actions.pod:4233 ../src/guestfs-actions.pod:6567
15631 #: ../fish/guestfish-actions.pod:4235 ../src/guestfs-actions.pod:6569
15633 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15637 #: ../fish/guestfish-actions.pod:4240
15639 "This function is primarily intended for use by programs. To get a simple "
15640 "list of names, use L</ls>. To get a printable directory for human "
15641 "consumption, use L</ll>."
15645 #: ../fish/guestfish-actions.pod:4244
15650 #: ../fish/guestfish-actions.pod:4246
15658 #: ../fish/guestfish-actions.pod:4248 ../src/guestfs-actions.pod:6590
15659 msgid "This command reads the target of a symbolic link."
15663 #: ../fish/guestfish-actions.pod:4250
15664 msgid "readlinklist"
15668 #: ../fish/guestfish-actions.pod:4252
15671 " readlinklist path 'names ...'\n"
15676 #: ../fish/guestfish-actions.pod:4254 ../src/guestfs-actions.pod:6604
15678 "This call allows you to do a C<readlink> operation on multiple files, where "
15679 "all files are in the directory C<path>. C<names> is the list of files from "
15684 #: ../fish/guestfish-actions.pod:4258 ../src/guestfs-actions.pod:6608
15686 "On return you get a list of strings, with a one-to-one correspondence to the "
15687 "C<names> list. Each string is the value of the symbolic link."
15691 #: ../fish/guestfish-actions.pod:4262 ../src/guestfs-actions.pod:6612
15693 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15694 "result string is the empty string C<\"\">. However the whole operation is "
15695 "completed even if there were C<readlink(2)> errors, and so you can call this "
15696 "function with names where you don't know if they are symbolic links already "
15697 "(albeit slightly less efficient)."
15701 #: ../fish/guestfish-actions.pod:4269 ../src/guestfs-actions.pod:6619
15703 "This call is intended for programs that want to efficiently list a directory "
15704 "contents without making many round-trips. Very long directory listings "
15705 "might cause the protocol message size to be exceeded, causing this call to "
15706 "fail. The caller must split up such requests into smaller groups of names."
15710 #: ../fish/guestfish-actions.pod:4276
15715 #: ../fish/guestfish-actions.pod:4278
15723 #: ../fish/guestfish-actions.pod:4280 ../src/guestfs-actions.pod:6638
15725 "Return the canonicalized absolute pathname of C<path>. The returned path "
15726 "has no C<.>, C<..> or symbolic link path elements."
15730 #: ../fish/guestfish-actions.pod:4283
15731 msgid "removexattr"
15735 #: ../fish/guestfish-actions.pod:4285
15738 " removexattr xattr path\n"
15743 #: ../fish/guestfish-actions.pod:4287 ../src/guestfs-actions.pod:6653
15745 "This call removes the extended attribute named C<xattr> of the file C<path>."
15749 #: ../fish/guestfish-actions.pod:4290
15750 msgid "See also: L</lremovexattr>, L<attr(5)>."
15754 #: ../fish/guestfish-actions.pod:4292
15759 #: ../fish/guestfish-actions.pod:4294
15762 " resize2fs device\n"
15767 #: ../fish/guestfish-actions.pod:4296 ../src/guestfs-actions.pod:6668
15769 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15770 "underlying device."
15774 #: ../fish/guestfish-actions.pod:4299
15776 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
15777 "before calling this command. For unknown reasons C<resize2fs> sometimes "
15778 "gives an error about this and sometimes not. In any case, it is always safe "
15779 "to call L</e2fsck-f> before calling this function."
15783 #: ../fish/guestfish-actions.pod:4305
15784 msgid "resize2fs-M"
15788 #: ../fish/guestfish-actions.pod:4307
15791 " resize2fs-M device\n"
15796 #: ../fish/guestfish-actions.pod:4309
15798 "This command is the same as L</resize2fs>, but the filesystem is resized to "
15799 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
15804 #: ../fish/guestfish-actions.pod:4313
15806 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
15807 "and read the C<Block size> and C<Block count> values. These two numbers, "
15808 "multiplied together, give the resulting size of the minimal filesystem in "
15813 #: ../fish/guestfish-actions.pod:4318
15814 msgid "resize2fs-size"
15818 #: ../fish/guestfish-actions.pod:4320
15821 " resize2fs-size device size\n"
15826 #: ../fish/guestfish-actions.pod:4322
15828 "This command is the same as L</resize2fs> except that it allows you to "
15829 "specify the new size (in bytes) explicitly."
15833 #: ../fish/guestfish-actions.pod:4325
15838 #: ../fish/guestfish-actions.pod:4327
15846 #: ../fish/guestfish-actions.pod:4329 ../src/guestfs-actions.pod:6720
15847 msgid "Remove the single file C<path>."
15851 #: ../fish/guestfish-actions.pod:4331
15856 #: ../fish/guestfish-actions.pod:4333
15864 #: ../fish/guestfish-actions.pod:4335 ../src/guestfs-actions.pod:6732
15866 "Remove the file or directory C<path>, recursively removing the contents if "
15867 "its a directory. This is like the C<rm -rf> shell command."
15871 #: ../fish/guestfish-actions.pod:4339
15876 #: ../fish/guestfish-actions.pod:4341
15884 #: ../fish/guestfish-actions.pod:4343 ../src/guestfs-actions.pod:6746
15885 msgid "Remove the single directory C<path>."
15889 #: ../fish/guestfish-actions.pod:4345
15890 msgid "rmmountpoint"
15894 #: ../fish/guestfish-actions.pod:4347
15897 " rmmountpoint exemptpath\n"
15902 #: ../fish/guestfish-actions.pod:4349
15904 "This calls removes a mountpoint that was previously created with L</"
15905 "mkmountpoint>. See L</mkmountpoint> for full details."
15909 #: ../fish/guestfish-actions.pod:4353
15910 msgid "scrub-device"
15914 #: ../fish/guestfish-actions.pod:4355
15917 " scrub-device device\n"
15922 #: ../fish/guestfish-actions.pod:4357 ../src/guestfs-actions.pod:6772
15924 "This command writes patterns over C<device> to make data retrieval more "
15929 #: ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4372
15930 #: ../fish/guestfish-actions.pod:4385 ../src/guestfs-actions.pod:6775
15931 #: ../src/guestfs-actions.pod:6793 ../src/guestfs-actions.pod:6812
15933 "It is an interface to the L<scrub(1)> program. See that manual page for "
15938 #: ../fish/guestfish-actions.pod:4363
15943 #: ../fish/guestfish-actions.pod:4365
15946 " scrub-file file\n"
15951 #: ../fish/guestfish-actions.pod:4367 ../src/guestfs-actions.pod:6788
15953 "This command writes patterns over a file to make data retrieval more "
15958 #: ../fish/guestfish-actions.pod:4370 ../src/guestfs-actions.pod:6791
15959 msgid "The file is I<removed> after scrubbing."
15963 #: ../fish/guestfish-actions.pod:4375
15964 msgid "scrub-freespace"
15968 #: ../fish/guestfish-actions.pod:4377
15971 " scrub-freespace dir\n"
15976 #: ../fish/guestfish-actions.pod:4379
15978 "This command creates the directory C<dir> and then fills it with files until "
15979 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
15980 "deletes them. The intention is to scrub any free space on the partition "
15981 "containing C<dir>."
15985 #: ../fish/guestfish-actions.pod:4388
15990 #: ../fish/guestfish-actions.pod:4390
15995 #: ../fish/guestfish-actions.pod:4392
15998 " set-append append\n"
16003 #: ../fish/guestfish-actions.pod:4394 ../src/guestfs-actions.pod:6825
16005 "This function is used to add additional options to the guest kernel command "
16010 #: ../fish/guestfish-actions.pod:4397 ../src/guestfs-actions.pod:6828
16012 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16013 "environment variable."
16017 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6831
16019 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16020 "(libguestfs always adds a few of its own)."
16024 #: ../fish/guestfish-actions.pod:4403
16025 msgid "set-attach-method"
16029 #: ../fish/guestfish-actions.pod:4405
16030 msgid "attach-method"
16034 #: ../fish/guestfish-actions.pod:4407
16037 " set-attach-method attachmethod\n"
16042 #: ../fish/guestfish-actions.pod:4409 ../src/guestfs-actions.pod:6844
16044 "Set the method that libguestfs uses to connect to the back end guestfsd "
16045 "daemon. Possible methods are:"
16049 #: ../fish/guestfish-actions.pod:4414 ../src/guestfs-actions.pod:6849
16050 #: ../src/guestfs.pod:2916
16051 msgid "C<appliance>"
16055 #: ../fish/guestfish-actions.pod:4416 ../src/guestfs-actions.pod:6851
16057 "Launch an appliance and connect to it. This is the ordinary method and the "
16062 #: ../fish/guestfish-actions.pod:4419 ../src/guestfs-actions.pod:6854
16063 msgid "C<unix:I<path>>"
16067 #: ../fish/guestfish-actions.pod:4421 ../src/guestfs-actions.pod:6856
16068 msgid "Connect to the Unix domain socket I<path>."
16072 #: ../fish/guestfish-actions.pod:4423 ../src/guestfs-actions.pod:6858
16074 "This method lets you connect to an existing daemon or (using virtio-serial) "
16075 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16076 "RUNNING DAEMONS>."
16080 #: ../fish/guestfish-actions.pod:4429
16081 msgid "set-autosync"
16085 #: ../fish/guestfish-actions.pod:4431
16090 #: ../fish/guestfish-actions.pod:4433
16093 " set-autosync true|false\n"
16098 #: ../fish/guestfish-actions.pod:4435 ../src/guestfs-actions.pod:6874
16100 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16101 "effort attempt to make filesystems consistent and synchronized when the "
16102 "handle is closed (also if the program exits without closing handles)."
16106 #: ../fish/guestfish-actions.pod:4440 ../src/guestfs-actions.pod:6879
16108 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16109 "disabled by default)."
16113 #: ../fish/guestfish-actions.pod:4443
16118 #: ../fish/guestfish-actions.pod:4445
16123 #: ../fish/guestfish-actions.pod:4447
16126 " set-direct true|false\n"
16131 #: ../fish/guestfish-actions.pod:4449 ../src/guestfs-actions.pod:6892
16133 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16134 "passed directly through to the appliance once it is launched."
16138 #: ../fish/guestfish-actions.pod:4453
16140 "One consequence of this is that log messages aren't caught by the library "
16141 "and handled by L</set-log-message-callback>, but go straight to stdout."
16145 #: ../fish/guestfish-actions.pod:4457 ../src/guestfs-actions.pod:6900
16146 msgid "You probably don't want to use this unless you know what you are doing."
16150 #: ../fish/guestfish-actions.pod:4460 ../src/guestfs-actions.pod:6903
16151 msgid "The default is disabled."
16155 #: ../fish/guestfish-actions.pod:4462
16156 msgid "set-e2label"
16160 #: ../fish/guestfish-actions.pod:4464
16163 " set-e2label device label\n"
16168 #: ../fish/guestfish-actions.pod:4466 ../src/guestfs-actions.pod:6916
16170 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16171 "C<label>. Filesystem labels are limited to 16 characters."
16175 #: ../fish/guestfish-actions.pod:4470
16177 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
16178 "label on a filesystem."
16182 #: ../fish/guestfish-actions.pod:4473
16187 #: ../fish/guestfish-actions.pod:4475
16190 " set-e2uuid device uuid\n"
16195 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6934
16197 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16198 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16199 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16203 #: ../fish/guestfish-actions.pod:4482
16205 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
16206 "UUID of a filesystem."
16210 #: ../fish/guestfish-actions.pod:4485
16211 msgid "set-memsize"
16215 #: ../fish/guestfish-actions.pod:4487
16220 #: ../fish/guestfish-actions.pod:4489
16223 " set-memsize memsize\n"
16228 #: ../fish/guestfish-actions.pod:4491
16230 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16231 "This only has any effect if called before L</launch>."
16235 #: ../fish/guestfish-actions.pod:4495 ../src/guestfs-actions.pod:6956
16237 "You can also change this by setting the environment variable "
16238 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16242 #: ../fish/guestfish-actions.pod:4502
16243 msgid "set-network"
16247 #: ../fish/guestfish-actions.pod:4504
16252 #: ../fish/guestfish-actions.pod:4506
16255 " set-network true|false\n"
16260 #: ../fish/guestfish-actions.pod:4508 ../src/guestfs-actions.pod:6973
16262 "If C<network> is true, then the network is enabled in the libguestfs "
16263 "appliance. The default is false."
16267 #: ../fish/guestfish-actions.pod:4511 ../src/guestfs-actions.pod:6976
16269 "This affects whether commands are able to access the network (see L<guestfs"
16270 "(3)/RUNNING COMMANDS>)."
16274 #: ../fish/guestfish-actions.pod:4514
16276 "You must call this before calling L</launch>, otherwise it has no effect."
16280 #: ../fish/guestfish-actions.pod:4517
16285 #: ../fish/guestfish-actions.pod:4521
16288 " set-path searchpath\n"
16293 #: ../fish/guestfish-actions.pod:4523 ../src/guestfs-actions.pod:6992
16294 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16298 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6994
16300 "The default is C<$libdir/guestfs> unless overridden by setting "
16301 "C<LIBGUESTFS_PATH> environment variable."
16305 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6997
16306 msgid "Setting C<path> to C<NULL> restores the default path."
16310 #: ../fish/guestfish-actions.pod:4530
16315 #: ../fish/guestfish-actions.pod:4532
16320 #: ../fish/guestfish-actions.pod:4534
16323 " set-pgroup true|false\n"
16328 #: ../fish/guestfish-actions.pod:4536 ../src/guestfs-actions.pod:7009
16330 "If C<pgroup> is true, child processes are placed into their own process "
16335 #: ../fish/guestfish-actions.pod:4539 ../src/guestfs-actions.pod:7012
16337 "The practical upshot of this is that signals like C<SIGINT> (from users "
16338 "pressing C<^C>) won't be received by the child process."
16342 #: ../fish/guestfish-actions.pod:4542 ../src/guestfs-actions.pod:7015
16344 "The default for this flag is false, because usually you want C<^C> to kill "
16349 #: ../fish/guestfish-actions.pod:4545
16354 #: ../fish/guestfish-actions.pod:4547
16359 #: ../fish/guestfish-actions.pod:4549
16367 #: ../fish/guestfish-actions.pod:4551 ../src/guestfs-actions.pod:7028
16368 msgid "Set the qemu binary that we will use."
16372 #: ../fish/guestfish-actions.pod:4553 ../src/guestfs-actions.pod:7030
16374 "The default is chosen when the library was compiled by the configure script."
16378 #: ../fish/guestfish-actions.pod:4556 ../src/guestfs-actions.pod:7033
16380 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16385 #: ../fish/guestfish-actions.pod:4559 ../src/guestfs-actions.pod:7036
16386 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16390 #: ../fish/guestfish-actions.pod:4561 ../src/guestfs-actions.pod:7038
16392 "Note that you should call this function as early as possible after creating "
16393 "the handle. This is because some pre-launch operations depend on testing "
16394 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16395 "don't retest features, and so you might see inconsistent results. Using the "
16396 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16397 "the qemu binary at the same time as the handle is created."
16401 #: ../fish/guestfish-actions.pod:4569
16402 msgid "set-recovery-proc"
16406 #: ../fish/guestfish-actions.pod:4571
16407 msgid "recovery-proc"
16411 #: ../fish/guestfish-actions.pod:4573
16414 " set-recovery-proc true|false\n"
16419 #: ../fish/guestfish-actions.pod:4575
16421 "If this is called with the parameter C<false> then L</launch> does not "
16422 "create a recovery process. The purpose of the recovery process is to stop "
16423 "runaway qemu processes in the case where the main program aborts abruptly."
16427 #: ../fish/guestfish-actions.pod:4580
16429 "This only has any effect if called before L</launch>, and the default is "
16434 #: ../fish/guestfish-actions.pod:4583 ../src/guestfs-actions.pod:7064
16436 "About the only time when you would want to disable this is if the main "
16437 "process will fork itself into the background (\"daemonize\" itself). In "
16438 "this case the recovery process thinks that the main program has disappeared "
16439 "and so kills qemu, which is not very helpful."
16443 #: ../fish/guestfish-actions.pod:4589
16444 msgid "set-selinux"
16448 #: ../fish/guestfish-actions.pod:4591
16453 #: ../fish/guestfish-actions.pod:4593
16456 " set-selinux true|false\n"
16461 #: ../fish/guestfish-actions.pod:4595 ../src/guestfs-actions.pod:7080
16463 "This sets the selinux flag that is passed to the appliance at boot time. "
16464 "The default is C<selinux=0> (disabled)."
16468 #: ../fish/guestfish-actions.pod:4598 ../src/guestfs-actions.pod:7083
16470 "Note that if SELinux is enabled, it is always in Permissive mode "
16471 "(C<enforcing=0>)."
16475 #: ../fish/guestfish-actions.pod:4604
16480 #: ../fish/guestfish-actions.pod:4606
16485 #: ../fish/guestfish-actions.pod:4608
16493 #: ../fish/guestfish-actions.pod:4610 ../src/guestfs-actions.pod:7099
16495 "Change the number of virtual CPUs assigned to the appliance. The default is "
16496 "C<1>. Increasing this may improve performance, though often it has no "
16501 #: ../fish/guestfish-actions.pod:4614
16502 msgid "This function must be called before L</launch>."
16506 #: ../fish/guestfish-actions.pod:4616
16511 #: ../fish/guestfish-actions.pod:4618
16516 #: ../fish/guestfish-actions.pod:4620
16519 " set-trace true|false\n"
16524 #: ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:7115
16526 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16527 "return values are traced."
16531 #: ../fish/guestfish-actions.pod:4625 ../src/guestfs-actions.pod:7118
16533 "If you want to trace C API calls into libguestfs (and other libraries) then "
16534 "possibly a better way is to use the external ltrace(1) command."
16538 #: ../fish/guestfish-actions.pod:4629 ../src/guestfs-actions.pod:7122
16540 "Command traces are disabled unless the environment variable "
16541 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16545 #: ../fish/guestfish-actions.pod:4632
16547 "Trace messages are normally sent to C<stderr>, unless you register a "
16548 "callback to send them somewhere else (see L</set-event-callback>)."
16552 #: ../fish/guestfish-actions.pod:4636
16553 msgid "set-verbose"
16557 #: ../fish/guestfish-actions.pod:4638
16562 #: ../fish/guestfish-actions.pod:4640
16565 " set-verbose true|false\n"
16570 #: ../fish/guestfish-actions.pod:4642 ../src/guestfs-actions.pod:7139
16571 msgid "If C<verbose> is true, this turns on verbose messages."
16575 #: ../fish/guestfish-actions.pod:4644 ../src/guestfs-actions.pod:7141
16577 "Verbose messages are disabled unless the environment variable "
16578 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16582 #: ../fish/guestfish-actions.pod:4647
16584 "Verbose messages are normally sent to C<stderr>, unless you register a "
16585 "callback to send them somewhere else (see L</set-event-callback>)."
16589 #: ../fish/guestfish-actions.pod:4651
16594 #: ../fish/guestfish-actions.pod:4653
16597 " setcon context\n"
16602 #: ../fish/guestfish-actions.pod:4655 ../src/guestfs-actions.pod:7158
16604 "This sets the SELinux security context of the daemon to the string "
16609 #: ../fish/guestfish-actions.pod:4658 ../src/guestfs-actions.pod:7161
16610 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16614 #: ../fish/guestfish-actions.pod:4660
16619 #: ../fish/guestfish-actions.pod:4662
16622 " setxattr xattr val vallen path\n"
16627 #: ../fish/guestfish-actions.pod:4664 ../src/guestfs-actions.pod:7176
16629 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16630 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16634 #: ../fish/guestfish-actions.pod:4668
16635 msgid "See also: L</lsetxattr>, L<attr(5)>."
16639 #: ../fish/guestfish-actions.pod:4670
16644 #: ../fish/guestfish-actions.pod:4672
16647 " sfdisk device cyls heads sectors 'lines ...'\n"
16652 #: ../fish/guestfish-actions.pod:4674 ../src/guestfs-actions.pod:7203
16654 "This is a direct interface to the L<sfdisk(8)> program for creating "
16655 "partitions on block devices."
16659 #: ../fish/guestfish-actions.pod:4677 ../src/guestfs-actions.pod:7206
16660 msgid "C<device> should be a block device, for example C</dev/sda>."
16664 #: ../fish/guestfish-actions.pod:4679 ../src/guestfs-actions.pod:7208
16666 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16667 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
16668 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16669 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16670 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16671 "the kernel) cannot work out the right geometry and you will need to tell it."
16675 #: ../fish/guestfish-actions.pod:4687 ../src/guestfs-actions.pod:7216
16677 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16678 "refer to the L<sfdisk(8)> manpage."
16682 #: ../fish/guestfish-actions.pod:4690 ../src/guestfs-actions.pod:7219
16684 "To create a single partition occupying the whole disk, you would pass "
16685 "C<lines> as a single element list, when the single element being the string "
16690 #: ../fish/guestfish-actions.pod:4694
16691 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
16695 #: ../fish/guestfish-actions.pod:4697 ../fish/guestfish-actions.pod:4717
16696 #: ../fish/guestfish-actions.pod:4736
16698 "I<This function is deprecated.> In new code, use the L</part_add> call "
16703 #: ../fish/guestfish-actions.pod:4704
16708 #: ../fish/guestfish-actions.pod:4706
16711 " sfdiskM device 'lines ...'\n"
16716 #: ../fish/guestfish-actions.pod:4708
16718 "This is a simplified interface to the L</sfdisk> command, where partition "
16719 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
16720 "you don't need to specify the cyls, heads and sectors parameters which were "
16721 "rarely if ever used anyway."
16725 #: ../fish/guestfish-actions.pod:4714
16726 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
16730 #: ../fish/guestfish-actions.pod:4724
16735 #: ../fish/guestfish-actions.pod:4726
16738 " sfdisk-N device partnum cyls heads sectors line\n"
16743 #: ../fish/guestfish-actions.pod:4728 ../src/guestfs-actions.pod:7275
16745 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16746 "(note: C<n> counts from 1)."
16750 #: ../fish/guestfish-actions.pod:4731
16752 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
16753 "cyls/heads/sectors parameters."
16757 #: ../fish/guestfish-actions.pod:4734
16758 msgid "See also: L</part-add>"
16762 #: ../fish/guestfish-actions.pod:4743
16763 msgid "sfdisk-disk-geometry"
16767 #: ../fish/guestfish-actions.pod:4745
16770 " sfdisk-disk-geometry device\n"
16775 #: ../fish/guestfish-actions.pod:4747
16777 "This displays the disk geometry of C<device> read from the partition table. "
16778 "Especially in the case where the underlying block device has been resized, "
16779 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
16780 "kernel-geometry>)."
16784 #: ../fish/guestfish-actions.pod:4752 ../fish/guestfish-actions.pod:4761
16785 #: ../src/guestfs-actions.pod:7298 ../src/guestfs-actions.pod:7314
16786 msgid "The result is in human-readable format, and not designed to be parsed."
16790 #: ../fish/guestfish-actions.pod:4755
16791 msgid "sfdisk-kernel-geometry"
16795 #: ../fish/guestfish-actions.pod:4757
16798 " sfdisk-kernel-geometry device\n"
16803 #: ../fish/guestfish-actions.pod:4759 ../src/guestfs-actions.pod:7312
16804 msgid "This displays the kernel's idea of the geometry of C<device>."
16808 #: ../fish/guestfish-actions.pod:4764
16813 #: ../fish/guestfish-actions.pod:4766
16816 " sfdisk-l device\n"
16821 #: ../fish/guestfish-actions.pod:4768 ../src/guestfs-actions.pod:7335
16823 "This displays the partition table on C<device>, in the human-readable output "
16824 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16828 #: ../fish/guestfish-actions.pod:4772
16829 msgid "See also: L</part-list>"
16833 #: ../fish/guestfish-actions.pod:4774
16835 "I<This function is deprecated.> In new code, use the L</part_list> call "
16840 #: ../fish/guestfish-actions.pod:4781
16845 #: ../fish/guestfish-actions.pod:4783
16853 #: ../fish/guestfish-actions.pod:4785 ../src/guestfs-actions.pod:7352
16855 "This call runs a command from the guest filesystem via the guest's C</bin/"
16860 #: ../fish/guestfish-actions.pod:4788
16861 msgid "This is like L</command>, but passes the command to:"
16865 #: ../fish/guestfish-actions.pod:4790 ../src/guestfs-actions.pod:7357
16868 " /bin/sh -c \"command\"\n"
16873 #: ../fish/guestfish-actions.pod:4792 ../src/guestfs-actions.pod:7359
16875 "Depending on the guest's shell, this usually results in wildcards being "
16876 "expanded, shell expressions being interpolated and so on."
16880 #: ../fish/guestfish-actions.pod:4796
16881 msgid "All the provisos about L</command> apply to this call."
16885 #: ../fish/guestfish-actions.pod:4798
16890 #: ../fish/guestfish-actions.pod:4800
16893 " sh-lines command\n"
16898 #: ../fish/guestfish-actions.pod:4802
16899 msgid "This is the same as L</sh>, but splits the result into a list of lines."
16903 #: ../fish/guestfish-actions.pod:4805
16904 msgid "See also: L</command-lines>"
16908 #: ../fish/guestfish-actions.pod:4807
16913 #: ../fish/guestfish-actions.pod:4809
16921 #: ../fish/guestfish-actions.pod:4811 ../src/guestfs-actions.pod:7393
16922 msgid "Sleep for C<secs> seconds."
16926 #: ../fish/guestfish-actions.pod:4813
16931 #: ../fish/guestfish-actions.pod:4815
16939 #: ../fish/guestfish-actions.pod:4819 ../src/guestfs-actions.pod:7407
16940 msgid "This is the same as the C<stat(2)> system call."
16944 #: ../fish/guestfish-actions.pod:4821
16949 #: ../fish/guestfish-actions.pod:4823
16957 #: ../fish/guestfish-actions.pod:4825 ../src/guestfs-actions.pod:7421
16959 "Returns file system statistics for any mounted file system. C<path> should "
16960 "be a file or directory in the mounted file system (typically it is the mount "
16961 "point itself, but it doesn't need to be)."
16965 #: ../fish/guestfish-actions.pod:4829 ../src/guestfs-actions.pod:7425
16966 msgid "This is the same as the C<statvfs(2)> system call."
16970 #: ../fish/guestfish-actions.pod:4831
16975 #: ../fish/guestfish-actions.pod:4833
16983 #: ../fish/guestfish-actions.pod:4835 ../src/guestfs-actions.pod:7439
16985 "This runs the L<strings(1)> command on a file and returns the list of "
16986 "printable strings found."
16990 #: ../fish/guestfish-actions.pod:4841
16995 #: ../fish/guestfish-actions.pod:4843
16998 " strings-e encoding path\n"
17003 #: ../fish/guestfish-actions.pod:4845
17005 "This is like the L</strings> command, but allows you to specify the encoding "
17006 "of strings that are looked for in the source file C<path>."
17010 #: ../fish/guestfish-actions.pod:4849 ../src/guestfs-actions.pod:7462
17011 msgid "Allowed encodings are:"
17015 #: ../fish/guestfish-actions.pod:4853 ../src/guestfs-actions.pod:7466
17020 #: ../fish/guestfish-actions.pod:4855
17022 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17023 "ISO-8859-X (this is what L</strings> uses)."
17027 #: ../fish/guestfish-actions.pod:4858 ../src/guestfs-actions.pod:7471
17032 #: ../fish/guestfish-actions.pod:4860 ../src/guestfs-actions.pod:7473
17033 msgid "Single 8-bit-byte characters."
17037 #: ../fish/guestfish-actions.pod:4862 ../src/guestfs-actions.pod:7475
17042 #: ../fish/guestfish-actions.pod:4864 ../src/guestfs-actions.pod:7477
17043 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17047 #: ../fish/guestfish-actions.pod:4867 ../src/guestfs-actions.pod:7480
17048 msgid "l (lower case letter L)"
17052 #: ../fish/guestfish-actions.pod:4869 ../src/guestfs-actions.pod:7482
17054 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17055 "examining binaries in Windows guests."
17059 #: ../fish/guestfish-actions.pod:4872 ../src/guestfs-actions.pod:7485
17064 #: ../fish/guestfish-actions.pod:4874 ../src/guestfs-actions.pod:7487
17065 msgid "32-bit big endian such as UCS-4BE."
17069 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7489
17074 #: ../fish/guestfish-actions.pod:4878 ../src/guestfs-actions.pod:7491
17075 msgid "32-bit little endian such as UCS-4LE."
17079 #: ../fish/guestfish-actions.pod:4882 ../src/guestfs-actions.pod:7495
17080 msgid "The returned strings are transcoded to UTF-8."
17084 #: ../fish/guestfish-actions.pod:4887
17085 msgid "swapoff-device"
17089 #: ../fish/guestfish-actions.pod:4889
17092 " swapoff-device device\n"
17097 #: ../fish/guestfish-actions.pod:4891
17099 "This command disables the libguestfs appliance swap device or partition "
17100 "named C<device>. See L</swapon-device>."
17104 #: ../fish/guestfish-actions.pod:4895
17105 msgid "swapoff-file"
17109 #: ../fish/guestfish-actions.pod:4897
17112 " swapoff-file file\n"
17117 #: ../fish/guestfish-actions.pod:4899 ../src/guestfs-actions.pod:7526
17118 msgid "This command disables the libguestfs appliance swap on file."
17122 #: ../fish/guestfish-actions.pod:4901
17123 msgid "swapoff-label"
17127 #: ../fish/guestfish-actions.pod:4903
17130 " swapoff-label label\n"
17135 #: ../fish/guestfish-actions.pod:4905 ../src/guestfs-actions.pod:7538
17137 "This command disables the libguestfs appliance swap on labeled swap "
17142 #: ../fish/guestfish-actions.pod:4908
17143 msgid "swapoff-uuid"
17147 #: ../fish/guestfish-actions.pod:4910
17150 " swapoff-uuid uuid\n"
17155 #: ../fish/guestfish-actions.pod:4912 ../src/guestfs-actions.pod:7551
17157 "This command disables the libguestfs appliance swap partition with the given "
17162 #: ../fish/guestfish-actions.pod:4915
17163 msgid "swapon-device"
17167 #: ../fish/guestfish-actions.pod:4917
17170 " swapon-device device\n"
17175 #: ../fish/guestfish-actions.pod:4919
17177 "This command enables the libguestfs appliance to use the swap device or "
17178 "partition named C<device>. The increased memory is made available for all "
17179 "commands, for example those run using L</command> or L</sh>."
17183 #: ../fish/guestfish-actions.pod:4924 ../src/guestfs-actions.pod:7569
17185 "Note that you should not swap to existing guest swap partitions unless you "
17186 "know what you are doing. They may contain hibernation information, or other "
17187 "information that the guest doesn't want you to trash. You also risk leaking "
17188 "information about the host to the guest this way. Instead, attach a new "
17189 "host device to the guest and swap on that."
17193 #: ../fish/guestfish-actions.pod:4931
17194 msgid "swapon-file"
17198 #: ../fish/guestfish-actions.pod:4933
17201 " swapon-file file\n"
17206 #: ../fish/guestfish-actions.pod:4935
17208 "This command enables swap to a file. See L</swapon-device> for other notes."
17212 #: ../fish/guestfish-actions.pod:4938
17213 msgid "swapon-label"
17217 #: ../fish/guestfish-actions.pod:4940
17220 " swapon-label label\n"
17225 #: ../fish/guestfish-actions.pod:4942
17227 "This command enables swap to a labeled swap partition. See L</swapon-"
17228 "device> for other notes."
17232 #: ../fish/guestfish-actions.pod:4945
17233 msgid "swapon-uuid"
17237 #: ../fish/guestfish-actions.pod:4947
17240 " swapon-uuid uuid\n"
17245 #: ../fish/guestfish-actions.pod:4949
17247 "This command enables swap to a swap partition with the given UUID. See L</"
17248 "swapon-device> for other notes."
17252 #: ../fish/guestfish-actions.pod:4952
17257 #: ../fish/guestfish-actions.pod:4954
17265 #: ../fish/guestfish-actions.pod:4956 ../src/guestfs-actions.pod:7624
17267 "This syncs the disk, so that any writes are flushed through to the "
17268 "underlying disk image."
17272 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7627
17274 "You should always call this if you have modified a disk image, before "
17275 "closing the handle."
17279 #: ../fish/guestfish-actions.pod:4962
17284 #: ../fish/guestfish-actions.pod:4964
17292 #: ../fish/guestfish-actions.pod:4966 ../src/guestfs-actions.pod:7640
17294 "This command returns up to the last 10 lines of a file as a list of strings."
17298 #: ../fish/guestfish-actions.pod:4972
17303 #: ../fish/guestfish-actions.pod:4974
17306 " tail-n nrlines path\n"
17311 #: ../fish/guestfish-actions.pod:4976 ../src/guestfs-actions.pod:7659
17313 "If the parameter C<nrlines> is a positive number, this returns the last "
17314 "C<nrlines> lines of the file C<path>."
17318 #: ../fish/guestfish-actions.pod:4979 ../src/guestfs-actions.pod:7662
17320 "If the parameter C<nrlines> is a negative number, this returns lines from "
17321 "the file C<path>, starting with the C<-nrlines>th line."
17325 #: ../fish/guestfish-actions.pod:4987
17330 #: ../fish/guestfish-actions.pod:4989
17333 " tar-in (tarfile|-) directory\n"
17338 #: ../fish/guestfish-actions.pod:4991 ../src/guestfs-actions.pod:7683
17340 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17341 "tar file) into C<directory>."
17345 #: ../fish/guestfish-actions.pod:4994
17346 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
17350 #: ../fish/guestfish-actions.pod:4999
17355 #: ../fish/guestfish-actions.pod:5001
17358 " tar-out directory (tarfile|-)\n"
17363 #: ../fish/guestfish-actions.pod:5003 ../src/guestfs-actions.pod:7700
17365 "This command packs the contents of C<directory> and downloads it to local "
17370 #: ../fish/guestfish-actions.pod:5006
17371 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
17375 #: ../fish/guestfish-actions.pod:5011
17380 #: ../fish/guestfish-actions.pod:5013
17383 " tgz-in (tarball|-) directory\n"
17388 #: ../fish/guestfish-actions.pod:5015 ../src/guestfs-actions.pod:7717
17390 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17391 "tar file) into C<directory>."
17395 #: ../fish/guestfish-actions.pod:5018
17396 msgid "To upload an uncompressed tarball, use L</tar-in>."
17400 #: ../fish/guestfish-actions.pod:5022
17405 #: ../fish/guestfish-actions.pod:5024
17408 " tgz-out directory (tarball|-)\n"
17413 #: ../fish/guestfish-actions.pod:5026 ../src/guestfs-actions.pod:7733
17415 "This command packs the contents of C<directory> and downloads it to local "
17420 #: ../fish/guestfish-actions.pod:5029
17421 msgid "To download an uncompressed tarball, use L</tar-out>."
17425 #: ../fish/guestfish-actions.pod:5033
17430 #: ../fish/guestfish-actions.pod:5035
17438 #: ../fish/guestfish-actions.pod:5037 ../src/guestfs-actions.pod:7748
17440 "Touch acts like the L<touch(1)> command. It can be used to update the "
17441 "timestamps on a file, or, if the file does not exist, to create a new zero-"
17446 #: ../fish/guestfish-actions.pod:5041 ../src/guestfs-actions.pod:7752
17448 "This command only works on regular files, and will fail on other file types "
17449 "such as directories, symbolic links, block special etc."
17453 #: ../fish/guestfish-actions.pod:5044
17458 #: ../fish/guestfish-actions.pod:5046
17466 #: ../fish/guestfish-actions.pod:5048 ../src/guestfs-actions.pod:7765
17468 "This command truncates C<path> to a zero-length file. The file must exist "
17473 #: ../fish/guestfish-actions.pod:5051
17474 msgid "truncate-size"
17478 #: ../fish/guestfish-actions.pod:5053
17481 " truncate-size path size\n"
17486 #: ../fish/guestfish-actions.pod:5055 ../src/guestfs-actions.pod:7779
17488 "This command truncates C<path> to size C<size> bytes. The file must exist "
17493 #: ../fish/guestfish-actions.pod:5058
17495 "If the current file size is less than C<size> then the file is extended to "
17496 "the required size with zero bytes. This creates a sparse file (ie. disk "
17497 "blocks are not allocated for the file until you write to it). To create a "
17498 "non-sparse file of zeroes, use L</fallocate64> instead."
17502 #: ../fish/guestfish-actions.pod:5064
17507 #: ../fish/guestfish-actions.pod:5066
17510 " tune2fs device [force:true|false] [maxmountcount:N] [mountcount:N] [errorbehavior:..] [group:N] [intervalbetweenchecks:N] [reservedblockspercentage:N] [lastmounteddirectory:..] [reservedblockscount:N] [user:N]\n"
17515 #: ../fish/guestfish-actions.pod:5068 ../src/guestfs-actions.pod:7815
17517 "This call allows you to adjust various filesystem parameters of an ext2/ext3/"
17518 "ext4 filesystem called C<device>."
17522 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7824
17524 "Force tune2fs to complete the operation even in the face of errors. This is "
17525 "the same as the tune2fs C<-f> option."
17529 #: ../fish/guestfish-actions.pod:5080 ../src/guestfs-actions.pod:7827
17530 msgid "C<maxmountcount>"
17534 #: ../fish/guestfish-actions.pod:5082 ../src/guestfs-actions.pod:7829
17536 "Set the number of mounts after which the filesystem is checked by L<e2fsck(8)"
17537 ">. If this is C<0> then the number of mounts is disregarded. This is the "
17538 "same as the tune2fs C<-c> option."
17542 #: ../fish/guestfish-actions.pod:5086 ../src/guestfs-actions.pod:7833
17543 msgid "C<mountcount>"
17547 #: ../fish/guestfish-actions.pod:5088 ../src/guestfs-actions.pod:7835
17549 "Set the number of times the filesystem has been mounted. This is the same "
17550 "as the tune2fs C<-C> option."
17554 #: ../fish/guestfish-actions.pod:5091 ../src/guestfs-actions.pod:7838
17555 msgid "C<errorbehavior>"
17559 #: ../fish/guestfish-actions.pod:5093 ../src/guestfs-actions.pod:7840
17561 "Change the behavior of the kernel code when errors are detected. Possible "
17562 "values currently are: C<continue>, C<remount-ro>, C<panic>. In practice "
17563 "these options don't really make any difference, particularly for write "
17568 #: ../fish/guestfish-actions.pod:5098 ../src/guestfs-actions.pod:7845
17569 msgid "This is the same as the tune2fs C<-e> option."
17573 #: ../fish/guestfish-actions.pod:5100 ../src/guestfs-actions.pod:7847
17578 #: ../fish/guestfish-actions.pod:5102 ../src/guestfs-actions.pod:7849
17580 "Set the group which can use reserved filesystem blocks. This is the same as "
17581 "the tune2fs C<-g> option except that it can only be specified as a number."
17585 #: ../fish/guestfish-actions.pod:5106 ../src/guestfs-actions.pod:7853
17586 msgid "C<intervalbetweenchecks>"
17590 #: ../fish/guestfish-actions.pod:5108 ../src/guestfs-actions.pod:7855
17592 "Adjust the maximal time between two filesystem checks (in seconds). If the "
17593 "option is passed as C<0> then time-dependent checking is disabled."
17597 #: ../fish/guestfish-actions.pod:5112 ../src/guestfs-actions.pod:7859
17598 msgid "This is the same as the tune2fs C<-i> option."
17602 #: ../fish/guestfish-actions.pod:5114 ../src/guestfs-actions.pod:7861
17603 msgid "C<reservedblockspercentage>"
17607 #: ../fish/guestfish-actions.pod:5116 ../src/guestfs-actions.pod:7863
17609 "Set the percentage of the filesystem which may only be allocated by "
17610 "privileged processes. This is the same as the tune2fs C<-m> option."
17614 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7867
17615 msgid "C<lastmounteddirectory>"
17619 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7869
17621 "Set the last mounted directory. This is the same as the tune2fs C<-M> "
17626 #: ../fish/guestfish-actions.pod:5125 ../src/guestfs-actions.pod:7872
17628 "C<reservedblockscount> Set the number of reserved filesystem blocks. This "
17629 "is the same as the tune2fs C<-r> option."
17633 #: ../fish/guestfish-actions.pod:5129 ../src/guestfs-actions.pod:7876
17638 #: ../fish/guestfish-actions.pod:5131 ../src/guestfs-actions.pod:7878
17640 "Set the user who can use the reserved filesystem blocks. This is the same "
17641 "as the tune2fs C<-u> option except that it can only be specified as a number."
17645 #: ../fish/guestfish-actions.pod:5137
17647 "To get the current values of filesystem parameters, see L</tune2fs-l>. For "
17648 "precise details of how tune2fs works, see the L<tune2fs(8)> man page."
17652 #: ../fish/guestfish-actions.pod:5143
17657 #: ../fish/guestfish-actions.pod:5145
17660 " tune2fs-l device\n"
17665 #: ../fish/guestfish-actions.pod:5147 ../src/guestfs-actions.pod:7920
17667 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17672 #: ../fish/guestfish-actions.pod:5150 ../src/guestfs-actions.pod:7923
17674 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17675 "for more details. The list of fields returned isn't clearly defined, and "
17676 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17677 "and the filesystem itself."
17681 #: ../fish/guestfish-actions.pod:5155
17686 #: ../fish/guestfish-actions.pod:5157
17689 " txz-in (tarball|-) directory\n"
17694 #: ../fish/guestfish-actions.pod:5159 ../src/guestfs-actions.pod:7943
17696 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17697 "tar file) into C<directory>."
17701 #: ../fish/guestfish-actions.pod:5164
17706 #: ../fish/guestfish-actions.pod:5166
17709 " txz-out directory (tarball|-)\n"
17714 #: ../fish/guestfish-actions.pod:5168 ../src/guestfs-actions.pod:7957
17716 "This command packs the contents of C<directory> and downloads it to local "
17717 "file C<tarball> (as an xz compressed tar archive)."
17721 #: ../fish/guestfish-actions.pod:5173
17726 #: ../fish/guestfish-actions.pod:5175
17734 #: ../fish/guestfish-actions.pod:5177 ../src/guestfs-actions.pod:7970
17736 "This function sets the mask used for creating new files and device nodes to "
17741 #: ../fish/guestfish-actions.pod:5180 ../src/guestfs-actions.pod:7973
17743 "Typical umask values would be C<022> which creates new files with "
17744 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17745 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17749 #: ../fish/guestfish-actions.pod:5185 ../src/guestfs-actions.pod:7978
17751 "The default umask is C<022>. This is important because it means that "
17752 "directories and device nodes will be created with C<0644> or C<0755> mode "
17753 "even if you specify C<0777>."
17757 #: ../fish/guestfish-actions.pod:5189
17758 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
17762 #: ../fish/guestfish-actions.pod:5192 ../src/guestfs-actions.pod:7985
17763 msgid "This call returns the previous umask."
17767 #: ../fish/guestfish-actions.pod:5194
17772 #: ../fish/guestfish-actions.pod:5196
17777 #: ../fish/guestfish-actions.pod:5198
17780 " umount pathordevice\n"
17785 #: ../fish/guestfish-actions.pod:5200 ../src/guestfs-actions.pod:7997
17787 "This unmounts the given filesystem. The filesystem may be specified either "
17788 "by its mountpoint (path) or the device which contains the filesystem."
17792 #: ../fish/guestfish-actions.pod:5204
17797 #: ../fish/guestfish-actions.pod:5206
17798 msgid "unmount-all"
17802 #: ../fish/guestfish-actions.pod:5208
17810 #: ../fish/guestfish-actions.pod:5210 ../src/guestfs-actions.pod:8010
17811 msgid "This unmounts all mounted filesystems."
17815 #: ../fish/guestfish-actions.pod:5212 ../src/guestfs-actions.pod:8012
17816 msgid "Some internal mounts are not unmounted by this call."
17820 #: ../fish/guestfish-actions.pod:5214
17825 #: ../fish/guestfish-actions.pod:5216
17828 " upload (filename|-) remotefilename\n"
17833 #: ../fish/guestfish-actions.pod:5218 ../fish/guestfish-actions.pod:5231
17834 #: ../src/guestfs-actions.pod:8025 ../src/guestfs-actions.pod:8049
17835 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17839 #: ../fish/guestfish-actions.pod:5223
17840 msgid "See also L</download>."
17844 #: ../fish/guestfish-actions.pod:5227
17845 msgid "upload-offset"
17849 #: ../fish/guestfish-actions.pod:5229
17852 " upload-offset (filename|-) remotefilename offset\n"
17857 #: ../fish/guestfish-actions.pod:5234 ../src/guestfs-actions.pod:8052
17859 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17860 "The intention is to overwrite parts of existing files or devices, although "
17861 "if a non-existant file is specified then it is created with a \"hole\" "
17862 "before C<offset>. The size of the data written is implicit in the size of "
17863 "the source C<filename>."
17867 #: ../fish/guestfish-actions.pod:5241
17869 "Note that there is no limit on the amount of data that can be uploaded with "
17870 "this call, unlike with L</pwrite>, and this call always writes the full "
17871 "amount unless an error occurs."
17875 #: ../fish/guestfish-actions.pod:5246
17876 msgid "See also L</upload>, L</pwrite>."
17880 #: ../fish/guestfish-actions.pod:5250
17885 #: ../fish/guestfish-actions.pod:5252
17888 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
17893 #: ../fish/guestfish-actions.pod:5254 ../src/guestfs-actions.pod:8085
17894 msgid "This command sets the timestamps of a file with nanosecond precision."
17898 #: ../fish/guestfish-actions.pod:5257 ../src/guestfs-actions.pod:8088
17900 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17905 #: ../fish/guestfish-actions.pod:5260 ../src/guestfs-actions.pod:8091
17907 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17908 "nanoseconds from the epoch."
17912 #: ../fish/guestfish-actions.pod:5263 ../src/guestfs-actions.pod:8094
17914 "If the C<*nsecs> field contains the special value C<-1> then the "
17915 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17916 "ignored in this case)."
17920 #: ../fish/guestfish-actions.pod:5267 ../src/guestfs-actions.pod:8098
17922 "If the C<*nsecs> field contains the special value C<-2> then the "
17923 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17928 #: ../fish/guestfish-actions.pod:5271
17933 #: ../fish/guestfish-actions.pod:5273
17941 #: ../fish/guestfish-actions.pod:5275 ../src/guestfs-actions.pod:8111
17943 "Return the libguestfs version number that the program is linked against."
17947 #: ../fish/guestfish-actions.pod:5278 ../src/guestfs-actions.pod:8114
17949 "Note that because of dynamic linking this is not necessarily the version of "
17950 "libguestfs that you compiled against. You can compile the program, and then "
17951 "at runtime dynamically link against a completely different C<libguestfs.so> "
17956 #: ../fish/guestfish-actions.pod:5283 ../src/guestfs-actions.pod:8119
17958 "This call was added in version C<1.0.58>. In previous versions of "
17959 "libguestfs there was no way to get the version number. From C code you can "
17960 "use dynamic linker functions to find out if this symbol exists (if it "
17961 "doesn't, then it's an earlier version)."
17965 #: ../fish/guestfish-actions.pod:5289 ../src/guestfs-actions.pod:8125
17967 "The call returns a structure with four elements. The first three (C<major>, "
17968 "C<minor> and C<release>) are numbers and correspond to the usual version "
17969 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17970 "but may be used for distro-specific information."
17974 #: ../fish/guestfish-actions.pod:5295 ../src/guestfs-actions.pod:8131
17976 "To construct the original version string: C<$major.$minor.$release$extra>"
17980 #: ../fish/guestfish-actions.pod:5298 ../src/guestfs-actions.pod:8134
17981 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17985 #: ../fish/guestfish-actions.pod:5300
17987 "I<Note:> Don't use this call to test for availability of features. In "
17988 "enterprise distributions we backport features from later versions into "
17989 "earlier versions, making this an unreliable way to test for features. Use "
17990 "L</available> instead."
17994 #: ../fish/guestfish-actions.pod:5306
17999 #: ../fish/guestfish-actions.pod:5308
18002 " vfs-label device\n"
18007 #: ../fish/guestfish-actions.pod:5310 ../src/guestfs-actions.pod:8154
18008 msgid "This returns the filesystem label of the filesystem on C<device>."
18012 #: ../fish/guestfish-actions.pod:5313 ../src/guestfs-actions.pod:8157
18013 msgid "If the filesystem is unlabeled, this returns the empty string."
18017 #: ../fish/guestfish-actions.pod:5315
18018 msgid "To find a filesystem from the label, use L</findfs-label>."
18022 #: ../fish/guestfish-actions.pod:5317
18027 #: ../fish/guestfish-actions.pod:5319
18030 " vfs-type device\n"
18035 #: ../fish/guestfish-actions.pod:5321 ../src/guestfs-actions.pod:8172
18037 "This command gets the filesystem type corresponding to the filesystem on "
18042 #: ../fish/guestfish-actions.pod:5324 ../src/guestfs-actions.pod:8175
18044 "For most filesystems, the result is the name of the Linux VFS module which "
18045 "would be used to mount this filesystem if you mounted it without specifying "
18046 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18050 #: ../fish/guestfish-actions.pod:5329
18055 #: ../fish/guestfish-actions.pod:5331
18058 " vfs-uuid device\n"
18063 #: ../fish/guestfish-actions.pod:5333 ../src/guestfs-actions.pod:8191
18064 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18068 #: ../fish/guestfish-actions.pod:5336 ../src/guestfs-actions.pod:8194
18069 msgid "If the filesystem does not have a UUID, this returns the empty string."
18073 #: ../fish/guestfish-actions.pod:5338
18074 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
18078 #: ../fish/guestfish-actions.pod:5340
18079 msgid "vg-activate"
18083 #: ../fish/guestfish-actions.pod:5342
18086 " vg-activate true|false 'volgroups ...'\n"
18091 #: ../fish/guestfish-actions.pod:5344 ../src/guestfs-actions.pod:8210
18093 "This command activates or (if C<activate> is false) deactivates all logical "
18094 "volumes in the listed volume groups C<volgroups>."
18098 #: ../fish/guestfish-actions.pod:5347 ../src/guestfs-actions.pod:8213
18099 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18103 #: ../fish/guestfish-actions.pod:5349 ../src/guestfs-actions.pod:8215
18105 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18106 "activated or deactivated."
18110 #: ../fish/guestfish-actions.pod:5352
18111 msgid "vg-activate-all"
18115 #: ../fish/guestfish-actions.pod:5354
18118 " vg-activate-all true|false\n"
18123 #: ../fish/guestfish-actions.pod:5356 ../src/guestfs-actions.pod:8228
18125 "This command activates or (if C<activate> is false) deactivates all logical "
18126 "volumes in all volume groups."
18130 #: ../fish/guestfish-actions.pod:5359 ../src/guestfs-actions.pod:8231
18131 msgid "This command is the same as running C<vgchange -a y|n>"
18135 #: ../fish/guestfish-actions.pod:5361
18140 #: ../fish/guestfish-actions.pod:5363
18143 " vgcreate volgroup 'physvols ...'\n"
18148 #: ../fish/guestfish-actions.pod:5365 ../src/guestfs-actions.pod:8244
18150 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18151 "of physical volumes C<physvols>."
18155 #: ../fish/guestfish-actions.pod:5368
18160 #: ../fish/guestfish-actions.pod:5370
18163 " vglvuuids vgname\n"
18168 #: ../fish/guestfish-actions.pod:5372 ../src/guestfs-actions.pod:8257
18170 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18171 "volumes created in this volume group."
18175 #: ../fish/guestfish-actions.pod:5375
18177 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
18178 "logical volumes and volume groups."
18182 #: ../fish/guestfish-actions.pod:5378
18183 msgid "See also L</vgpvuuids>."
18187 #: ../fish/guestfish-actions.pod:5380
18192 #: ../fish/guestfish-actions.pod:5382
18195 " vgpvuuids vgname\n"
18200 #: ../fish/guestfish-actions.pod:5384 ../src/guestfs-actions.pod:8277
18202 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18203 "volumes that this volume group resides on."
18207 #: ../fish/guestfish-actions.pod:5387
18209 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
18210 "physical volumes and volume groups."
18214 #: ../fish/guestfish-actions.pod:5390
18215 msgid "See also L</vglvuuids>."
18219 #: ../fish/guestfish-actions.pod:5392
18224 #: ../fish/guestfish-actions.pod:5394
18227 " vgremove vgname\n"
18232 #: ../fish/guestfish-actions.pod:5396 ../src/guestfs-actions.pod:8297
18233 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18237 #: ../fish/guestfish-actions.pod:5398 ../src/guestfs-actions.pod:8299
18239 "This also forcibly removes all logical volumes in the volume group (if any)."
18243 #: ../fish/guestfish-actions.pod:5401
18248 #: ../fish/guestfish-actions.pod:5403
18251 " vgrename volgroup newvolgroup\n"
18256 #: ../fish/guestfish-actions.pod:5405 ../src/guestfs-actions.pod:8313
18257 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18261 #: ../fish/guestfish-actions.pod:5407
18266 #: ../fish/guestfish-actions.pod:5409
18274 #: ../fish/guestfish-actions.pod:5411 ../src/guestfs-actions.pod:8324
18276 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18281 #: ../fish/guestfish-actions.pod:5414 ../src/guestfs-actions.pod:8327
18283 "This returns a list of just the volume group names that were detected (eg. "
18288 #: ../fish/guestfish-actions.pod:5417
18289 msgid "See also L</vgs-full>."
18293 #: ../fish/guestfish-actions.pod:5419
18298 #: ../fish/guestfish-actions.pod:5421
18306 #: ../fish/guestfish-actions.pod:5423 ../src/guestfs-actions.pod:8343
18308 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18309 "> command. The \"full\" version includes all fields."
18313 #: ../fish/guestfish-actions.pod:5426
18318 #: ../fish/guestfish-actions.pod:5428
18326 #: ../fish/guestfish-actions.pod:5430 ../src/guestfs-actions.pod:8357
18328 "This rescans all block devices and rebuilds the list of LVM physical "
18329 "volumes, volume groups and logical volumes."
18333 #: ../fish/guestfish-actions.pod:5433
18338 #: ../fish/guestfish-actions.pod:5435
18346 #: ../fish/guestfish-actions.pod:5437 ../src/guestfs-actions.pod:8370
18347 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18351 #: ../fish/guestfish-actions.pod:5439
18356 #: ../fish/guestfish-actions.pod:5441
18364 #: ../fish/guestfish-actions.pod:5443 ../src/guestfs-actions.pod:8410
18366 "This command counts the characters in a file, using the C<wc -c> external "
18371 #: ../fish/guestfish-actions.pod:5446
18376 #: ../fish/guestfish-actions.pod:5448
18384 #: ../fish/guestfish-actions.pod:5450 ../src/guestfs-actions.pod:8423
18386 "This command counts the lines in a file, using the C<wc -l> external command."
18390 #: ../fish/guestfish-actions.pod:5453
18395 #: ../fish/guestfish-actions.pod:5455
18403 #: ../fish/guestfish-actions.pod:5457 ../src/guestfs-actions.pod:8436
18405 "This command counts the words in a file, using the C<wc -w> external command."
18409 #: ../fish/guestfish-actions.pod:5460
18414 #: ../fish/guestfish-actions.pod:5462
18417 " write path content\n"
18422 #: ../fish/guestfish-actions.pod:5464 ../src/guestfs-actions.pod:8451
18424 "This call creates a file called C<path>. The content of the file is the "
18425 "string C<content> (which can contain any 8 bit data)."
18429 #: ../fish/guestfish-actions.pod:5467
18430 msgid "See also L</write-append>."
18434 #: ../fish/guestfish-actions.pod:5472
18435 msgid "write-append"
18439 #: ../fish/guestfish-actions.pod:5474
18442 " write-append path content\n"
18447 #: ../fish/guestfish-actions.pod:5476 ../src/guestfs-actions.pod:8471
18449 "This call appends C<content> to the end of file C<path>. If C<path> does "
18450 "not exist, then a new file is created."
18454 #: ../fish/guestfish-actions.pod:5479
18455 msgid "See also L</write>."
18459 #: ../fish/guestfish-actions.pod:5484
18464 #: ../fish/guestfish-actions.pod:5486
18467 " write-file path content size\n"
18472 #: ../fish/guestfish-actions.pod:5488 ../src/guestfs-actions.pod:8498
18474 "This call creates a file called C<path>. The contents of the file is the "
18475 "string C<content> (which can contain any 8 bit data), with length C<size>."
18479 #: ../fish/guestfish-actions.pod:5492 ../src/guestfs-actions.pod:8502
18481 "As a special case, if C<size> is C<0> then the length is calculated using "
18482 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18486 #: ../fish/guestfish-actions.pod:5496 ../src/guestfs-actions.pod:8506
18488 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18489 "I<not> work, even if the length is specified."
18493 #: ../fish/guestfish-actions.pod:5502
18495 "I<This function is deprecated.> In new code, use the L</write> call instead."
18499 #: ../fish/guestfish-actions.pod:5509
18504 #: ../fish/guestfish-actions.pod:5511
18507 " zegrep regex path\n"
18512 #: ../fish/guestfish-actions.pod:5513 ../src/guestfs-actions.pod:8523
18514 "This calls the external C<zegrep> program and returns the matching lines."
18518 #: ../fish/guestfish-actions.pod:5519
18523 #: ../fish/guestfish-actions.pod:5521
18526 " zegrepi regex path\n"
18531 #: ../fish/guestfish-actions.pod:5523 ../src/guestfs-actions.pod:8542
18533 "This calls the external C<zegrep -i> program and returns the matching lines."
18537 #: ../fish/guestfish-actions.pod:5529
18542 #: ../fish/guestfish-actions.pod:5531
18550 #: ../fish/guestfish-actions.pod:5533 ../src/guestfs-actions.pod:8560
18551 msgid "This command writes zeroes over the first few blocks of C<device>."
18555 #: ../fish/guestfish-actions.pod:5535 ../src/guestfs-actions.pod:8562
18557 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18558 "securely wipe the device). It should be sufficient to remove any partition "
18559 "tables, filesystem superblocks and so on."
18563 #: ../fish/guestfish-actions.pod:5539 ../fish/guestfish-actions.pod:5554
18564 #: ../src/guestfs-actions.pod:8566 ../src/guestfs-actions.pod:8592
18566 "If blocks are already zero, then this command avoids writing zeroes. This "
18567 "prevents the underlying device from becoming non-sparse or growing "
18572 #: ../fish/guestfish-actions.pod:5543
18573 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
18577 #: ../fish/guestfish-actions.pod:5546
18578 msgid "zero-device"
18582 #: ../fish/guestfish-actions.pod:5548
18585 " zero-device device\n"
18590 #: ../fish/guestfish-actions.pod:5550
18592 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
18593 "which just zeroes the first few blocks of a device."
18597 #: ../fish/guestfish-actions.pod:5558
18602 #: ../fish/guestfish-actions.pod:5560
18605 " zerofree device\n"
18610 #: ../fish/guestfish-actions.pod:5562 ../src/guestfs-actions.pod:8611
18612 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18613 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18614 "possible to compress the filesystem more effectively."
18618 #: ../fish/guestfish-actions.pod:5567 ../src/guestfs-actions.pod:8616
18619 msgid "You should B<not> run this program if the filesystem is mounted."
18623 #: ../fish/guestfish-actions.pod:5570 ../src/guestfs-actions.pod:8619
18625 "It is possible that using this program can damage the filesystem or data on "
18630 #: ../fish/guestfish-actions.pod:5573
18635 #: ../fish/guestfish-actions.pod:5575
18638 " zfgrep pattern path\n"
18643 #: ../fish/guestfish-actions.pod:5577 ../src/guestfs-actions.pod:8633
18645 "This calls the external C<zfgrep> program and returns the matching lines."
18649 #: ../fish/guestfish-actions.pod:5583
18654 #: ../fish/guestfish-actions.pod:5585
18657 " zfgrepi pattern path\n"
18662 #: ../fish/guestfish-actions.pod:5587 ../src/guestfs-actions.pod:8652
18664 "This calls the external C<zfgrep -i> program and returns the matching lines."
18668 #: ../fish/guestfish-actions.pod:5593
18673 #: ../fish/guestfish-actions.pod:5595
18676 " zfile meth path\n"
18681 #: ../fish/guestfish-actions.pod:5597 ../src/guestfs-actions.pod:8678
18683 "This command runs C<file> after first decompressing C<path> using C<method>."
18687 #: ../fish/guestfish-actions.pod:5600 ../src/guestfs-actions.pod:8681
18688 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18692 #: ../fish/guestfish-actions.pod:5602
18694 "Since 1.0.63, use L</file> instead which can now process compressed files."
18698 #: ../fish/guestfish-actions.pod:5605
18700 "I<This function is deprecated.> In new code, use the L</file> call instead."
18704 #: ../fish/guestfish-actions.pod:5612
18709 #: ../fish/guestfish-actions.pod:5614
18712 " zgrep regex path\n"
18717 #: ../fish/guestfish-actions.pod:5616 ../src/guestfs-actions.pod:8698
18719 "This calls the external C<zgrep> program and returns the matching lines."
18723 #: ../fish/guestfish-actions.pod:5622
18728 #: ../fish/guestfish-actions.pod:5624
18731 " zgrepi regex path\n"
18736 #: ../fish/guestfish-actions.pod:5626 ../src/guestfs-actions.pod:8717
18738 "This calls the external C<zgrep -i> program and returns the matching lines."
18742 #: ../fish/guestfish-commands.pod:1
18747 #: ../fish/guestfish-commands.pod:3
18752 #: ../fish/guestfish-commands.pod:5
18755 " alloc filename size\n"
18760 #: ../fish/guestfish-commands.pod:7
18762 "This creates an empty (zeroed) file of the given size, and then adds so it "
18763 "can be further examined."
18767 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
18768 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
18772 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
18773 msgid "Size can be specified using standard suffixes, eg. C<1M>."
18777 #: ../fish/guestfish-commands.pod:14
18779 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
18780 "image, see L</PREPARED DISK IMAGES>."
18784 #: ../fish/guestfish-commands.pod:17
18789 #: ../fish/guestfish-commands.pod:19
18792 " copy-in local [local ...] /remotedir\n"
18797 #: ../fish/guestfish-commands.pod:21
18799 "C<copy-in> copies local files or directories recursively into the disk "
18800 "image, placing them in the directory called C</remotedir> (which must "
18801 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
18802 "other commands as necessary."
18806 #: ../fish/guestfish-commands.pod:26
18808 "Multiple local files and directories can be specified, but the last "
18809 "parameter must always be a remote directory. Wildcards cannot be used."
18813 #: ../fish/guestfish-commands.pod:30
18818 #: ../fish/guestfish-commands.pod:32
18821 " copy-out remote [remote ...] localdir\n"
18826 #: ../fish/guestfish-commands.pod:34
18828 "C<copy-out> copies remote files or directories recursively out of the disk "
18829 "image, placing them on the host disk in a local directory called C<localdir> "
18830 "(which must exist). This guestfish meta-command turns into a sequence of L</"
18831 "download>, L</tar-out> and other commands as necessary."
18835 #: ../fish/guestfish-commands.pod:40
18837 "Multiple remote files and directories can be specified, but the last "
18838 "parameter must always be a local directory. To download to the current "
18839 "directory, use C<.> as in:"
18843 #: ../fish/guestfish-commands.pod:44
18846 " copy-out /home .\n"
18851 #: ../fish/guestfish-commands.pod:46
18853 "Wildcards cannot be used in the ordinary command, but you can use them with "
18854 "the help of L</glob> like this:"
18858 #: ../fish/guestfish-commands.pod:49
18861 " glob copy-out /home/* .\n"
18866 #: ../fish/guestfish-commands.pod:51
18871 #: ../fish/guestfish-commands.pod:53
18874 " display filename\n"
18879 #: ../fish/guestfish-commands.pod:55
18881 "Use C<display> (a graphical display program) to display an image file. It "
18882 "downloads the file, and runs C<display> on it."
18886 #: ../fish/guestfish-commands.pod:58
18888 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
18889 "environment variable. For example to use the GNOME display program:"
18893 #: ../fish/guestfish-commands.pod:61
18896 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
18901 #: ../fish/guestfish-commands.pod:63
18902 msgid "See also L<display(1)>."
18906 #: ../fish/guestfish-commands.pod:65
18911 #: ../fish/guestfish-commands.pod:67
18914 " echo [params ...]\n"
18919 #: ../fish/guestfish-commands.pod:69
18920 msgid "This echos the parameters to the terminal."
18924 #: ../fish/guestfish-commands.pod:71
18929 #: ../fish/guestfish-commands.pod:73
18934 #: ../fish/guestfish-commands.pod:75
18939 #: ../fish/guestfish-commands.pod:77
18947 #: ../fish/guestfish-commands.pod:79
18949 "This is used to edit a file. It downloads the file, edits it locally using "
18950 "your editor, then uploads the result."
18954 #: ../fish/guestfish-commands.pod:82
18956 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
18957 "or C<emacs> you will get those corresponding editors."
18961 #: ../fish/guestfish-commands.pod:86
18966 #: ../fish/guestfish-commands.pod:88
18969 " glob command args...\n"
18974 #: ../fish/guestfish-commands.pod:90
18976 "Expand wildcards in any paths in the args list, and run C<command> "
18977 "repeatedly on each matching path."
18981 #: ../fish/guestfish-commands.pod:93
18982 msgid "See L</WILDCARDS AND GLOBBING>."
18986 #: ../fish/guestfish-commands.pod:95
18991 #: ../fish/guestfish-commands.pod:97
18994 " hexedit <filename|device>\n"
18995 " hexedit <filename|device> <max>\n"
18996 " hexedit <filename|device> <start> <max>\n"
19001 #: ../fish/guestfish-commands.pod:101
19003 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
19008 #: ../fish/guestfish-commands.pod:104
19010 "This command works by downloading potentially the whole file or device, "
19011 "editing it locally, then uploading it. If the file or device is large, you "
19012 "have to specify which part you wish to edit by using C<max> and/or C<start> "
19013 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
19014 "usual modifiers allowed such as C<1M> (1 megabyte)."
19018 #: ../fish/guestfish-commands.pod:111
19019 msgid "For example to edit the first few sectors of a disk you might do:"
19023 #: ../fish/guestfish-commands.pod:114
19026 " hexedit /dev/sda 1M\n"
19031 #: ../fish/guestfish-commands.pod:116
19033 "which would allow you to edit anywhere within the first megabyte of the disk."
19037 #: ../fish/guestfish-commands.pod:119
19038 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
19042 #: ../fish/guestfish-commands.pod:121
19045 " hexedit /dev/sda1 0x400 0x400\n"
19050 #: ../fish/guestfish-commands.pod:123
19051 msgid "(assuming the superblock is in the standard location)."
19055 #: ../fish/guestfish-commands.pod:125
19057 "This command requires the external L<hexedit(1)> program. You can specify "
19058 "another program to use by setting the C<HEXEDITOR> environment variable."
19062 #: ../fish/guestfish-commands.pod:129
19063 msgid "See also L</hexdump>."
19067 #: ../fish/guestfish-commands.pod:131
19072 #: ../fish/guestfish-commands.pod:133
19080 #: ../fish/guestfish-commands.pod:135
19082 "Change the local directory, ie. the current directory of guestfish itself."
19086 #: ../fish/guestfish-commands.pod:138
19087 msgid "Note that C<!cd> won't do what you might expect."
19091 #: ../fish/guestfish-commands.pod:140
19096 #: ../fish/guestfish-commands.pod:142
19101 #: ../fish/guestfish-commands.pod:144
19109 #: ../fish/guestfish-commands.pod:146
19110 msgid "Opens the manual page for guestfish."
19114 #: ../fish/guestfish-commands.pod:148
19119 #: ../fish/guestfish-commands.pod:150
19124 #: ../fish/guestfish-commands.pod:152
19132 #: ../fish/guestfish-commands.pod:154
19140 #: ../fish/guestfish-commands.pod:156
19141 msgid "This is used to view a file."
19145 #: ../fish/guestfish-commands.pod:158
19147 "The default viewer is C<$PAGER>. However if you use the alternate command "
19148 "C<less> you will get the C<less> command specifically."
19152 #: ../fish/guestfish-commands.pod:161
19157 #: ../fish/guestfish-commands.pod:163
19165 #: ../fish/guestfish-commands.pod:165
19167 "Close and reopen the libguestfs handle. It is not necessary to use this "
19168 "normally, because the handle is closed properly when guestfish exits. "
19169 "However this is occasionally useful for testing."
19173 #: ../fish/guestfish-commands.pod:169
19178 #: ../fish/guestfish-commands.pod:171
19181 " setenv VAR value\n"
19186 #: ../fish/guestfish-commands.pod:173
19187 msgid "Set the environment variable C<VAR> to the string C<value>."
19191 #: ../fish/guestfish-commands.pod:175
19193 "To print the value of an environment variable use a shell command such as:"
19197 #: ../fish/guestfish-commands.pod:178
19205 #: ../fish/guestfish-commands.pod:180
19210 #: ../fish/guestfish-commands.pod:182
19213 " sparse filename size\n"
19218 #: ../fish/guestfish-commands.pod:184
19220 "This creates an empty sparse file of the given size, and then adds so it can "
19221 "be further examined."
19225 #: ../fish/guestfish-commands.pod:187
19227 "In all respects it works the same as the L</alloc> command, except that the "
19228 "image file is allocated sparsely, which means that disk blocks are not "
19229 "assigned to the file until they are needed. Sparse disk files only use "
19230 "space when written to, but they are slower and there is a danger you could "
19231 "run out of real disk space during a write operation."
19235 #: ../fish/guestfish-commands.pod:197
19240 #: ../fish/guestfish-commands.pod:199
19248 #: ../fish/guestfish-commands.pod:201
19250 "This command returns a list of the optional groups known to the daemon, and "
19251 "indicates which ones are supported by this build of the libguestfs appliance."
19255 #: ../fish/guestfish-commands.pod:205
19256 msgid "See also L<guestfs(3)/AVAILABILITY>."
19260 #: ../fish/guestfish-commands.pod:207
19265 #: ../fish/guestfish-commands.pod:209
19268 " time command args...\n"
19273 #: ../fish/guestfish-commands.pod:211
19275 "Run the command as usual, but print the elapsed time afterwards. This can "
19276 "be useful for benchmarking operations."
19280 #: ../fish/guestfish-commands.pod:214
19285 #: ../fish/guestfish-commands.pod:216
19293 #: ../fish/guestfish-commands.pod:218
19294 msgid "Remove C<VAR> from the environment."
19298 #: ../fish/guestfish.pod:5
19299 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19303 #: ../fish/guestfish.pod:9
19306 " guestfish [--options] [commands]\n"
19311 #: ../fish/guestfish.pod:11
19319 #: ../fish/guestfish.pod:13
19322 " guestfish [--ro|--rw] -a disk.img\n"
19327 #: ../fish/guestfish.pod:15
19330 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19335 #: ../fish/guestfish.pod:17
19338 " guestfish -d libvirt-domain\n"
19343 #: ../fish/guestfish.pod:19
19346 " guestfish [--ro|--rw] -a disk.img -i\n"
19351 #: ../fish/guestfish.pod:21
19354 " guestfish -d libvirt-domain -i\n"
19359 #: ../fish/guestfish.pod:25
19361 "Using guestfish in read/write mode on live virtual machines can be "
19362 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19363 "option to use guestfish safely if the disk image or virtual machine might be "
19368 #: ../fish/guestfish.pod:32
19370 "Guestfish is a shell and command-line tool for examining and modifying "
19371 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19372 "functionality of the guestfs API, see L<guestfs(3)>."
19376 #: ../fish/guestfish.pod:36
19378 "Guestfish gives you structured access to the libguestfs API, from shell "
19379 "scripts or the command line or interactively. If you want to rescue a "
19380 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19385 #: ../fish/guestfish.pod:43
19386 msgid "As an interactive shell"
19390 #: ../fish/guestfish.pod:45
19398 #: ../fish/guestfish.pod:47
19401 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19402 " editing virtual machine filesystems.\n"
19407 #: ../fish/guestfish.pod:50
19410 " Type: 'help' for a list of commands\n"
19411 " 'man' to read the manual\n"
19412 " 'quit' to quit the shell\n"
19417 #: ../fish/guestfish.pod:54
19420 " ><fs> add-ro disk.img\n"
19422 " ><fs> list-filesystems\n"
19423 " /dev/sda1: ext4\n"
19424 " /dev/vg_guest/lv_root: ext4\n"
19425 " /dev/vg_guest/lv_swap: swap\n"
19426 " ><fs> mount /dev/vg_guest/lv_root /\n"
19427 " ><fs> cat /etc/fstab\n"
19429 " # Created by anaconda\n"
19436 #: ../fish/guestfish.pod:67
19437 msgid "From shell scripts"
19441 #: ../fish/guestfish.pod:69
19442 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19446 #: ../fish/guestfish.pod:71
19449 " guestfish <<_EOF_\n"
19452 " mount /dev/vg_guest/lv_root /\n"
19453 " write /etc/motd \"Welcome, new users\"\n"
19459 #: ../fish/guestfish.pod:78
19460 msgid "List the LVM logical volumes in a disk image:"
19464 #: ../fish/guestfish.pod:80
19467 " guestfish -a disk.img --ro <<_EOF_\n"
19475 #: ../fish/guestfish.pod:85
19476 msgid "List all the filesystems in a disk image:"
19480 #: ../fish/guestfish.pod:87
19483 " guestfish -a disk.img --ro <<_EOF_\n"
19485 " list-filesystems\n"
19491 #: ../fish/guestfish.pod:92
19492 msgid "On one command line"
19496 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
19497 msgid "Update C</etc/resolv.conf> in a guest:"
19501 #: ../fish/guestfish.pod:96
19505 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19506 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19511 #: ../fish/guestfish.pod:100
19512 msgid "Edit C</boot/grub/grub.conf> interactively:"
19516 #: ../fish/guestfish.pod:102
19519 " guestfish --rw --add disk.img \\\n"
19520 " --mount /dev/vg_guest/lv_root \\\n"
19521 " --mount /dev/sda1:/boot \\\n"
19522 " edit /boot/grub/grub.conf\n"
19527 #: ../fish/guestfish.pod:107
19528 msgid "Mount disks automatically"
19532 #: ../fish/guestfish.pod:109
19534 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
19538 #: ../fish/guestfish.pod:112
19541 " guestfish --ro -a disk.img -i cat /etc/group\n"
19546 #: ../fish/guestfish.pod:114
19549 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19554 #: ../fish/guestfish.pod:116
19555 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19559 #: ../fish/guestfish.pod:118
19562 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19567 #: ../fish/guestfish.pod:120
19568 msgid "As a script interpreter"
19572 #: ../fish/guestfish.pod:122
19573 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19577 #: ../fish/guestfish.pod:124
19580 " #!/usr/bin/guestfish -f\n"
19581 " sparse test1.img 100M\n"
19583 " part-disk /dev/sda mbr\n"
19584 " mkfs ext2 /dev/sda1\n"
19589 #: ../fish/guestfish.pod:130
19590 msgid "Start with a prepared disk"
19594 #: ../fish/guestfish.pod:132
19596 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19597 "single ext2-formatted partition:"
19601 #: ../fish/guestfish.pod:135 ../src/guestfs.pod:2243
19604 " guestfish -N fs\n"
19609 #: ../fish/guestfish.pod:137
19610 msgid "To list what is available do:"
19614 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1042
19617 " guestfish -N help | less\n"
19622 #: ../fish/guestfish.pod:141
19623 msgid "Remote control"
19627 #: ../fish/guestfish.pod:143
19630 " eval \"`guestfish --listen`\"\n"
19631 " guestfish --remote add-ro disk.img\n"
19632 " guestfish --remote run\n"
19633 " guestfish --remote lvs\n"
19638 #: ../fish/guestfish.pod:154
19639 msgid "Displays general help on options."
19643 #: ../fish/guestfish.pod:158
19644 msgid "B<--cmd-help>"
19648 #: ../fish/guestfish.pod:160
19649 msgid "Lists all available guestfish commands."
19653 #: ../fish/guestfish.pod:162
19658 #: ../fish/guestfish.pod:164
19659 msgid "B<--cmd-help cmd>"
19663 #: ../fish/guestfish.pod:166
19664 msgid "Displays detailed help on a single command C<cmd>."
19668 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
19669 msgid "B<-a image>"
19673 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
19674 msgid "B<--add image>"
19678 #: ../fish/guestfish.pod:172
19679 msgid "Add a block device or virtual machine image to the shell."
19683 #: ../fish/guestfish.pod:177
19685 "Using this flag is mostly equivalent to using the C<add> command, with "
19686 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19687 "the I<--format=...> flag was given."
19691 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
19693 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19694 "URI to use. The default is to use the default libvirt connection."
19698 #: ../fish/guestfish.pod:189
19703 #: ../fish/guestfish.pod:191
19705 "If using the I<--listen> option and a csh-like shell, use this option. See "
19706 "section L</REMOTE CONTROL AND CSH> below."
19710 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
19711 msgid "B<-d libvirt-domain>"
19715 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
19716 msgid "B<--domain libvirt-domain>"
19720 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
19722 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19723 "used, then any libvirt domain can be used. However in write mode, only "
19724 "libvirt domains which are shut down can be named here."
19728 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
19729 msgid "Domain UUIDs can be used instead of names."
19733 #: ../fish/guestfish.pod:204
19735 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19736 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19737 "if the I<--format:...> flag was given."
19741 #: ../fish/guestfish.pod:208
19746 #: ../fish/guestfish.pod:210
19747 msgid "B<--no-dest-paths>"
19751 #: ../fish/guestfish.pod:212
19753 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19754 "to hit the tab key to complete paths on the guest filesystem, but this "
19755 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19756 "allow this feature to be disabled."
19760 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
19762 "When prompting for keys and passphrases, guestfish normally turns echoing "
19763 "off so you cannot see what you are typing. If you are not worried about "
19764 "Tempest attacks and there is no one else in the room you can specify this "
19765 "flag to see what you are typing."
19769 #: ../fish/guestfish.pod:224
19774 #: ../fish/guestfish.pod:226
19775 msgid "B<--file file>"
19779 #: ../fish/guestfish.pod:228
19780 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19784 #: ../fish/guestfish.pod:231
19787 " #!/usr/bin/guestfish -f\n"
19792 #: ../fish/guestfish.pod:244
19795 " guestfish --format=raw -a disk.img\n"
19800 #: ../fish/guestfish.pod:248
19803 " guestfish --format=raw -a disk.img --format -a another.img\n"
19808 #: ../fish/guestfish.pod:253
19810 "If you have untrusted raw-format guest disk images, you should use this "
19811 "option to specify the disk format. This avoids a possible security problem "
19812 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19816 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
19817 msgid "B<--inspector>"
19821 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
19823 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19824 "system and mount filesystems as they would be mounted on the real virtual "
19829 #: ../fish/guestfish.pod:266
19830 msgid "Typical usage is either:"
19834 #: ../fish/guestfish.pod:268
19837 " guestfish -d myguest -i\n"
19842 #: ../fish/guestfish.pod:270
19843 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19847 #: ../fish/guestfish.pod:272
19850 " guestfish --ro -d myguest -i\n"
19855 #: ../fish/guestfish.pod:274
19856 msgid "(for active domains, readonly), or specify the block device directly:"
19860 #: ../fish/guestfish.pod:276
19863 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19868 #: ../fish/guestfish.pod:278
19870 "Note that the command line syntax changed slightly over older versions of "
19871 "guestfish. You can still use the old syntax:"
19875 #: ../fish/guestfish.pod:281
19878 " guestfish [--ro] -i disk.img\n"
19883 #: ../fish/guestfish.pod:283
19886 " guestfish [--ro] -i libvirt-domain\n"
19891 #: ../fish/guestfish.pod:285
19893 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19894 "then using other commands to mount the filesystems that were found."
19898 #: ../fish/guestfish.pod:294
19899 msgid "B<--listen>"
19903 #: ../fish/guestfish.pod:296
19905 "Fork into the background and listen for remote commands. See section L</"
19906 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19910 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
19915 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
19917 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
19918 "ATTACHING TO RUNNING DAEMONS>)."
19922 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
19923 msgid "B<-m dev[:mountpoint[:options]]>"
19927 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
19928 msgid "B<--mount dev[:mountpoint[:options]]>"
19932 #: ../fish/guestfish.pod:308
19933 msgid "Mount the named partition or logical volume on the given mountpoint."
19937 #: ../fish/guestfish.pod:310
19938 msgid "If the mountpoint is omitted, it defaults to C</>."
19942 #: ../fish/guestfish.pod:312
19943 msgid "You have to mount something on C</> before most commands will work."
19947 #: ../fish/guestfish.pod:314
19949 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19954 #: ../fish/guestfish.pod:317
19956 "If you don't know what filesystems a disk image contains, you can either run "
19957 "guestfish without this option, then list the partitions, filesystems and LVs "
19958 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19959 "commands), or you can use the L<virt-filesystems(1)> program."
19963 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
19965 "The third (and rarely used) part of the mount parameter is the list of mount "
19966 "options used to mount the underlying filesystem. If this is not given, then "
19967 "the mount options are either the empty string or C<ro> (the latter if the "
19968 "I<--ro> flag is used). By specifying the mount options, you override this "
19969 "default choice. Probably the only time you would use this is to enable ACLs "
19970 "and/or extended attributes if the filesystem can support them:"
19974 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
19977 " -m /dev/sda1:/:acl,user_xattr\n"
19982 #: ../fish/guestfish.pod:333
19983 msgid "Using this flag is equivalent to using the C<mount-options> command."
19987 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202
19988 #: ../resize/virt-resize.pod:441
19993 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
19994 msgid "B<--no-sync>"
19998 #: ../fish/guestfish.pod:339
20000 "Disable autosync. This is enabled by default. See the discussion of "
20001 "autosync in the L<guestfs(3)> manpage."
20005 #: ../fish/guestfish.pod:342
20010 #: ../fish/guestfish.pod:344
20011 msgid "B<--new type>"
20015 #: ../fish/guestfish.pod:346
20020 #: ../fish/guestfish.pod:348
20022 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20023 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20024 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20029 #: ../fish/guestfish.pod:353
20030 msgid "B<--progress-bars>"
20034 #: ../fish/guestfish.pod:355
20035 msgid "Enable progress bars, even when guestfish is used non-interactively."
20039 #: ../fish/guestfish.pod:357
20041 "Progress bars are enabled by default when guestfish is used as an "
20042 "interactive shell."
20046 #: ../fish/guestfish.pod:360
20047 msgid "B<--no-progress-bars>"
20051 #: ../fish/guestfish.pod:362
20052 msgid "Disable progress bars."
20056 #: ../fish/guestfish.pod:364
20057 msgid "B<--remote[=pid]>"
20061 #: ../fish/guestfish.pod:366
20063 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20064 "CONTROL GUESTFISH OVER A SOCKET> below."
20068 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248
20069 #: ../rescue/virt-rescue.pod:189
20074 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250
20075 #: ../rescue/virt-rescue.pod:191
20080 #: ../fish/guestfish.pod:373
20082 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20083 "mounts are done read-only."
20087 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:195
20089 "The option must always be used if the disk image or virtual machine might be "
20090 "running, and is generally recommended in cases where you don't need write "
20091 "access to the disk."
20095 #: ../fish/guestfish.pod:380
20097 "Note that prepared disk images created with I<-N> are not affected by this "
20098 "option. Also commands like C<add> are not affected - you have to specify "
20099 "the C<readonly:true> option explicitly if you need it."
20103 #: ../fish/guestfish.pod:384
20104 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20108 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262
20109 #: ../rescue/virt-rescue.pod:201
20110 msgid "B<--selinux>"
20114 #: ../fish/guestfish.pod:388
20115 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20119 #: ../fish/guestfish.pod:394
20121 "Enable very verbose messages. This is particularly useful if you find a bug."
20125 #: ../fish/guestfish.pod:401
20126 msgid "Display the guestfish / libguestfs version number and exit."
20130 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278
20131 #: ../rescue/virt-rescue.pod:231
20136 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280
20137 #: ../rescue/virt-rescue.pod:233
20142 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
20144 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20145 "mounts are done read-write."
20149 #: ../fish/guestfish.pod:410
20150 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20154 #: ../fish/guestfish.pod:414
20155 msgid "Echo each command before executing it."
20159 #: ../fish/guestfish.pod:418
20160 msgid "COMMANDS ON COMMAND LINE"
20164 #: ../fish/guestfish.pod:420
20166 "Any additional (non-option) arguments are treated as commands to execute."
20170 #: ../fish/guestfish.pod:423
20172 "Commands to execute should be separated by a colon (C<:>), where the colon "
20173 "is a separate parameter. Thus:"
20177 #: ../fish/guestfish.pod:426
20180 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20185 #: ../fish/guestfish.pod:428
20187 "If there are no additional arguments, then we enter a shell, either an "
20188 "interactive shell with a prompt (if the input is a terminal) or a non-"
20189 "interactive shell."
20193 #: ../fish/guestfish.pod:432
20195 "In either command line mode or non-interactive shell, the first command that "
20196 "gives an error causes the whole shell to exit. In interactive mode (with a "
20197 "prompt) if a command fails, you can continue to enter commands."
20201 #: ../fish/guestfish.pod:437
20202 msgid "USING launch (OR run)"
20206 #: ../fish/guestfish.pod:439
20208 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20209 "then launch it, then mount any disks you need, and finally issue actions/"
20210 "commands. So the general order of the day is:"
20214 #: ../fish/guestfish.pod:447
20215 msgid "add or -a/--add"
20219 #: ../fish/guestfish.pod:451
20220 msgid "launch (aka run)"
20224 #: ../fish/guestfish.pod:455
20225 msgid "mount or -m/--mount"
20229 #: ../fish/guestfish.pod:459
20230 msgid "any other commands"
20234 #: ../fish/guestfish.pod:463
20236 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20237 "guest before mounting or performing any other commands."
20241 #: ../fish/guestfish.pod:466
20243 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20244 "I<--new> options were given then C<run> is done automatically, simply "
20245 "because guestfish can't perform the action you asked for without doing this."
20249 #: ../fish/guestfish.pod:471
20250 msgid "OPENING DISKS FOR READ AND WRITE"
20254 #: ../fish/guestfish.pod:473
20256 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20257 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20258 "I<-i> and I<-m> open disk images read-only or for writing."
20262 #: ../fish/guestfish.pod:478
20264 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20265 "opening disk images supplied on the command line for write. To open a disk "
20266 "image read-only you have to do I<-a image --ro>."
20270 #: ../fish/guestfish.pod:482
20272 "This matters: If you accidentally open a live VM disk image writable then "
20273 "you will cause irreversible disk corruption."
20277 #: ../fish/guestfish.pod:485
20279 "In a future libguestfs we intend to change the default the other way. Disk "
20280 "images will be opened read-only. You will have to either specify "
20281 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20282 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20283 "access for disk images specified by those other command line options."
20287 #: ../fish/guestfish.pod:492
20289 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20290 "which does nothing (it is already the default). However it is highly "
20291 "recommended that you use this option to indicate that you need write access, "
20292 "and prepare your scripts for the day when this option will be required for "
20297 #: ../fish/guestfish.pod:498
20299 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20300 "other libguestfs program apart from guestfish and guestmount."
20304 #: ../fish/guestfish.pod:501
20309 #: ../fish/guestfish.pod:503
20311 "You can quote ordinary parameters using either single or double quotes. For "
20316 #: ../fish/guestfish.pod:506
20319 " add \"file with a space.img\"\n"
20324 #: ../fish/guestfish.pod:508
20327 " rm '/file name'\n"
20332 #: ../fish/guestfish.pod:510
20340 #: ../fish/guestfish.pod:512
20342 "A few commands require a list of strings to be passed. For these, use a "
20343 "whitespace-separated list, enclosed in quotes. Strings containing "
20344 "whitespace to be passed through must be enclosed in single quotes. A "
20345 "literal single quote must be escaped with a backslash."
20349 #: ../fish/guestfish.pod:517
20352 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20353 " command \"/bin/echo 'foo bar'\"\n"
20354 " command \"/bin/echo \\'foo\\'\"\n"
20359 #: ../fish/guestfish.pod:521
20360 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
20364 #: ../fish/guestfish.pod:523
20366 "In double-quoted arguments (only) use backslash to insert special characters:"
20370 #: ../fish/guestfish.pod:528
20375 #: ../fish/guestfish.pod:530
20376 msgid "Alert (bell) character."
20380 #: ../fish/guestfish.pod:532
20385 #: ../fish/guestfish.pod:534
20386 msgid "Backspace character."
20390 #: ../fish/guestfish.pod:536
20395 #: ../fish/guestfish.pod:538
20396 msgid "Form feed character."
20400 #: ../fish/guestfish.pod:540
20405 #: ../fish/guestfish.pod:542
20406 msgid "Newline character."
20410 #: ../fish/guestfish.pod:544
20415 #: ../fish/guestfish.pod:546
20416 msgid "Carriage return character."
20420 #: ../fish/guestfish.pod:548
20425 #: ../fish/guestfish.pod:550
20426 msgid "Horizontal tab character."
20430 #: ../fish/guestfish.pod:552
20435 #: ../fish/guestfish.pod:554
20436 msgid "Vertical tab character."
20440 #: ../fish/guestfish.pod:556
20445 #: ../fish/guestfish.pod:558
20446 msgid "A literal double quote character."
20450 #: ../fish/guestfish.pod:560
20455 #: ../fish/guestfish.pod:562
20457 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
20462 #: ../fish/guestfish.pod:565
20467 #: ../fish/guestfish.pod:567
20469 "A character with hex value I<hh>. There must be precisely 2 hex digits."
20473 #: ../fish/guestfish.pod:570
20475 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
20480 #: ../fish/guestfish.pod:573
20485 #: ../fish/guestfish.pod:575
20486 msgid "A literal backslash character."
20490 #: ../fish/guestfish.pod:579
20491 msgid "OPTIONAL ARGUMENTS"
20495 #: ../fish/guestfish.pod:581
20497 "Some commands take optional arguments. These arguments appear in this "
20498 "documentation as C<[argname:..]>. You can use them as in these examples:"
20502 #: ../fish/guestfish.pod:585
20505 " add-drive-opts filename\n"
20510 #: ../fish/guestfish.pod:587
20513 " add-drive-opts filename readonly:true\n"
20518 #: ../fish/guestfish.pod:589
20521 " add-drive-opts filename format:qcow2 readonly:false\n"
20526 #: ../fish/guestfish.pod:591
20528 "Each optional argument can appear at most once. All optional arguments must "
20529 "appear after the required ones."
20533 #: ../fish/guestfish.pod:594
20538 #: ../fish/guestfish.pod:596
20540 "This section applies to all commands which can take integers as parameters."
20544 #: ../fish/guestfish.pod:599
20545 msgid "SIZE SUFFIX"
20549 #: ../fish/guestfish.pod:601
20551 "When the command takes a parameter measured in bytes, you can use one of the "
20552 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20556 #: ../fish/guestfish.pod:607
20557 msgid "B<k> or B<K> or B<KiB>"
20561 #: ../fish/guestfish.pod:609
20562 msgid "The size in kilobytes (multiplied by 1024)."
20566 #: ../fish/guestfish.pod:611
20571 #: ../fish/guestfish.pod:613
20572 msgid "The size in SI 1000 byte units."
20576 #: ../fish/guestfish.pod:615
20577 msgid "B<M> or B<MiB>"
20581 #: ../fish/guestfish.pod:617
20582 msgid "The size in megabytes (multiplied by 1048576)."
20586 #: ../fish/guestfish.pod:619
20591 #: ../fish/guestfish.pod:621
20592 msgid "The size in SI 1000000 byte units."
20596 #: ../fish/guestfish.pod:623
20597 msgid "B<G> or B<GiB>"
20601 #: ../fish/guestfish.pod:625
20602 msgid "The size in gigabytes (multiplied by 2**30)."
20606 #: ../fish/guestfish.pod:627
20611 #: ../fish/guestfish.pod:629
20612 msgid "The size in SI 10**9 byte units."
20616 #: ../fish/guestfish.pod:631
20617 msgid "B<T> or B<TiB>"
20621 #: ../fish/guestfish.pod:633
20622 msgid "The size in terabytes (multiplied by 2**40)."
20626 #: ../fish/guestfish.pod:635
20631 #: ../fish/guestfish.pod:637
20632 msgid "The size in SI 10**12 byte units."
20636 #: ../fish/guestfish.pod:639
20637 msgid "B<P> or B<PiB>"
20641 #: ../fish/guestfish.pod:641
20642 msgid "The size in petabytes (multiplied by 2**50)."
20646 #: ../fish/guestfish.pod:643
20651 #: ../fish/guestfish.pod:645
20652 msgid "The size in SI 10**15 byte units."
20656 #: ../fish/guestfish.pod:647
20657 msgid "B<E> or B<EiB>"
20661 #: ../fish/guestfish.pod:649
20662 msgid "The size in exabytes (multiplied by 2**60)."
20666 #: ../fish/guestfish.pod:651
20671 #: ../fish/guestfish.pod:653
20672 msgid "The size in SI 10**18 byte units."
20676 #: ../fish/guestfish.pod:655
20677 msgid "B<Z> or B<ZiB>"
20681 #: ../fish/guestfish.pod:657
20682 msgid "The size in zettabytes (multiplied by 2**70)."
20686 #: ../fish/guestfish.pod:659
20691 #: ../fish/guestfish.pod:661
20692 msgid "The size in SI 10**21 byte units."
20696 #: ../fish/guestfish.pod:663
20697 msgid "B<Y> or B<YiB>"
20701 #: ../fish/guestfish.pod:665
20702 msgid "The size in yottabytes (multiplied by 2**80)."
20706 #: ../fish/guestfish.pod:667
20711 #: ../fish/guestfish.pod:669
20712 msgid "The size in SI 10**24 byte units."
20716 #: ../fish/guestfish.pod:675
20719 " truncate-size /file 1G\n"
20724 #: ../fish/guestfish.pod:677
20725 msgid "would truncate the file to 1 gigabyte."
20729 #: ../fish/guestfish.pod:679
20731 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
20732 "the parameter to L</memsize> is specified in megabytes already). Adding a "
20733 "suffix will probably not do what you expect."
20737 #: ../fish/guestfish.pod:683
20738 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20742 #: ../fish/guestfish.pod:685
20744 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20745 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20749 #: ../fish/guestfish.pod:688
20752 " 1234 decimal number 1234\n"
20753 " 02322 octal number, equivalent to decimal 1234\n"
20754 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20759 #: ../fish/guestfish.pod:692
20761 "When using the C<chmod> command, you almost always want to specify an octal "
20762 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20763 "L<chmod(1)> program):"
20767 #: ../fish/guestfish.pod:696
20770 " chmod 0777 /public # OK\n"
20771 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20776 #: ../fish/guestfish.pod:699
20778 "Commands that return numbers usually print them in decimal, but some "
20779 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20780 "octal, preceeded by C<0>)."
20784 #: ../fish/guestfish.pod:703
20785 msgid "WILDCARDS AND GLOBBING"
20789 #: ../fish/guestfish.pod:705
20791 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20792 "(globbing) by default. So for example the following will not do what you "
20797 #: ../fish/guestfish.pod:709
20805 #: ../fish/guestfish.pod:711
20807 "Assuming you don't have a directory called literally C</home/*> then the "
20808 "above command will return an error."
20812 #: ../fish/guestfish.pod:714
20813 msgid "To perform wildcard expansion, use the C<glob> command."
20817 #: ../fish/guestfish.pod:716
20820 " glob rm-rf /home/*\n"
20825 #: ../fish/guestfish.pod:718
20827 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20828 "many times), equivalent to:"
20832 #: ../fish/guestfish.pod:721
20835 " rm-rf /home/jim\n"
20836 " rm-rf /home/joe\n"
20837 " rm-rf /home/mary\n"
20842 #: ../fish/guestfish.pod:725
20843 msgid "C<glob> only works on simple guest paths and not on device names."
20847 #: ../fish/guestfish.pod:727
20849 "If you have several parameters, each containing a wildcard, then glob will "
20850 "perform a Cartesian product."
20854 #: ../fish/guestfish.pod:730
20859 #: ../fish/guestfish.pod:732
20861 "Any line which starts with a I<#> character is treated as a comment and "
20862 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20863 "a command. For example:"
20867 #: ../fish/guestfish.pod:736
20870 " # this is a comment\n"
20871 " # this is a comment\n"
20872 " foo # NOT a comment\n"
20877 #: ../fish/guestfish.pod:740
20878 msgid "Blank lines are also ignored."
20882 #: ../fish/guestfish.pod:742
20883 msgid "RUNNING COMMANDS LOCALLY"
20887 #: ../fish/guestfish.pod:744
20889 "Any line which starts with a I<!> character is treated as a command sent to "
20890 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20894 #: ../fish/guestfish.pod:748
20898 " tgz-out /remote local/remote-data.tar.gz\n"
20903 #: ../fish/guestfish.pod:751
20905 "will create a directory C<local> on the host, and then export the contents "
20906 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20907 "(See C<tgz-out>)."
20911 #: ../fish/guestfish.pod:755
20913 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20914 "effect, due to the way that subprocesses work in Unix."
20918 #: ../fish/guestfish.pod:758
20919 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20923 #: ../fish/guestfish.pod:760
20925 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20926 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20927 "and executed as guestfish commands."
20931 #: ../fish/guestfish.pod:764
20933 "Thus you can use shell script to construct arbitrary guestfish commands "
20934 "which are then parsed by guestfish."
20938 #: ../fish/guestfish.pod:767
20940 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20941 "through C</foo.100>) using guestfish commands alone. However this is simple "
20942 "if we use a shell script to create the guestfish commands for us:"
20946 #: ../fish/guestfish.pod:772
20949 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20954 #: ../fish/guestfish.pod:774
20955 msgid "or with names like C</foo.001>:"
20959 #: ../fish/guestfish.pod:776
20962 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20967 #: ../fish/guestfish.pod:778
20969 "When using guestfish interactively it can be helpful to just run the shell "
20970 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20971 "ordinary I<!> local command), see what guestfish commands it would run, and "
20972 "when you are happy with those prepend the C<E<lt>> character to run the "
20973 "guestfish commands for real."
20977 #: ../fish/guestfish.pod:784
20982 #: ../fish/guestfish.pod:786
20984 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20985 "command (a guestfish command) to the second command (any host command). For "
20990 #: ../fish/guestfish.pod:790
20993 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20998 #: ../fish/guestfish.pod:792
21000 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21001 "program). The above command would list all accounts in the guest filesystem "
21002 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21006 #: ../fish/guestfish.pod:797
21009 " hexdump /bin/ls | head\n"
21010 " list-devices | tail -1\n"
21011 " tgz-out / - | tar ztf -\n"
21016 #: ../fish/guestfish.pod:801
21018 "The space before the pipe symbol is required, any space after the pipe "
21019 "symbol is optional. Everything after the pipe symbol is just passed "
21020 "straight to the host shell, so it can contain redirections, globs and "
21021 "anything else that makes sense on the host side."
21025 #: ../fish/guestfish.pod:806
21027 "To use a literal argument which begins with a pipe symbol, you have to quote "
21032 #: ../fish/guestfish.pod:809
21040 #: ../fish/guestfish.pod:811
21041 msgid "HOME DIRECTORIES"
21045 #: ../fish/guestfish.pod:813
21047 "If a parameter starts with the character C<~> then the tilde may be expanded "
21048 "as a home directory path (either C<~> for the current user's home directory, "
21049 "or C<~user> for another user)."
21053 #: ../fish/guestfish.pod:817
21055 "Note that home directory expansion happens for users known I<on the host>, "
21056 "not in the guest filesystem."
21060 #: ../fish/guestfish.pod:820
21062 "To use a literal argument which begins with a tilde, you have to quote it, "
21067 #: ../fish/guestfish.pod:823
21075 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:534
21076 msgid "ENCRYPTED DISKS"
21080 #: ../fish/guestfish.pod:827
21082 "Libguestfs has some support for Linux guests encrypted according to the "
21083 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21084 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
21085 "LUKS is supported."
21089 #: ../fish/guestfish.pod:832
21090 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21094 #: ../fish/guestfish.pod:834
21097 " ><fs> vfs-type /dev/sda2\n"
21103 #: ../fish/guestfish.pod:837
21105 "Then open those devices using L</luks-open>. This creates a device-mapper "
21106 "device called C</dev/mapper/luksdev>."
21110 #: ../fish/guestfish.pod:840
21113 " ><fs> luks-open /dev/sda2 luksdev\n"
21114 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21119 #: ../fish/guestfish.pod:843
21121 "Finally you have to tell LVM to scan for volume groups on the newly created "
21126 #: ../fish/guestfish.pod:846
21130 " vg-activate-all true\n"
21135 #: ../fish/guestfish.pod:849
21136 msgid "The logical volume(s) can now be mounted in the usual way."
21140 #: ../fish/guestfish.pod:851
21142 "Before closing a LUKS device you must unmount any logical volumes on it and "
21143 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21144 "one. Then you can close the mapper device:"
21148 #: ../fish/guestfish.pod:855
21151 " vg-activate false /dev/VG\n"
21152 " luks-close /dev/mapper/luksdev\n"
21157 #: ../fish/guestfish.pod:860
21159 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21160 "letters and paths (with some limitations). The following commands are "
21165 #: ../fish/guestfish.pod:864
21168 " file /WINDOWS/system32/config/system.LOG\n"
21173 #: ../fish/guestfish.pod:866
21176 " file win:\\windows\\system32\\config\\system.log\n"
21181 #: ../fish/guestfish.pod:868
21184 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21189 #: ../fish/guestfish.pod:870
21191 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21192 "where the drive is mounted, prepending that to the path, changing all "
21193 "backslash characters to forward slash, then resolving the result using L</"
21194 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
21195 "the parameter might be rewritten like this:"
21199 #: ../fish/guestfish.pod:876
21202 " win:e:\\foo\\bar => /e/FOO/bar\n"
21207 #: ../fish/guestfish.pod:878
21208 msgid "This only works in argument positions that expect a path."
21212 #: ../fish/guestfish.pod:880
21213 msgid "UPLOADING AND DOWNLOADING FILES"
21217 #: ../fish/guestfish.pod:882
21219 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21220 "others which upload from or download to a local file, you can use the "
21221 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21225 #: ../fish/guestfish.pod:886
21233 #: ../fish/guestfish.pod:888
21235 "reads stdin and creates from that a file C</foo> in the disk image, and:"
21239 #: ../fish/guestfish.pod:891
21242 " tar-out /etc - | tar tf -\n"
21247 #: ../fish/guestfish.pod:893
21249 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21250 "command (see L</PIPES>)."
21254 #: ../fish/guestfish.pod:896
21256 "When using C<-> to read from stdin, the input is read up to the end of "
21257 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21258 "some arbitrary end marker:"
21262 #: ../fish/guestfish.pod:900
21265 " upload -<<END /foo\n"
21274 #: ../fish/guestfish.pod:906
21276 "Any string of characters can be used instead of C<END>. The end marker must "
21277 "appear on a line of its own, without any preceeding or following characters "
21278 "(not even spaces)."
21282 #: ../fish/guestfish.pod:910
21284 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21285 "upload local files (so-called \"FileIn\" parameters in the generator)."
21289 #: ../fish/guestfish.pod:913
21290 msgid "EXIT ON ERROR BEHAVIOUR"
21294 #: ../fish/guestfish.pod:915
21296 "By default, guestfish will ignore any errors when in interactive mode (ie. "
21297 "taking commands from a human over a tty), and will exit on the first error "
21298 "in non-interactive mode (scripts, commands given on the command line)."
21302 #: ../fish/guestfish.pod:920
21304 "If you prefix a command with a I<-> character, then that command will not "
21305 "cause guestfish to exit, even if that (one) command returns an error."
21309 #: ../fish/guestfish.pod:924
21310 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21314 #: ../fish/guestfish.pod:926
21316 "Guestfish can be remote-controlled over a socket. This is useful "
21317 "particularly in shell scripts where you want to make several different "
21318 "changes to a filesystem, but you don't want the overhead of starting up a "
21319 "guestfish process each time."
21323 #: ../fish/guestfish.pod:931
21324 msgid "Start a guestfish server process using:"
21328 #: ../fish/guestfish.pod:933
21331 " eval \"`guestfish --listen`\"\n"
21336 #: ../fish/guestfish.pod:935
21337 msgid "and then send it commands by doing:"
21341 #: ../fish/guestfish.pod:937
21344 " guestfish --remote cmd [...]\n"
21349 #: ../fish/guestfish.pod:939
21350 msgid "To cause the server to exit, send it the exit command:"
21354 #: ../fish/guestfish.pod:943
21356 "Note that the server will normally exit if there is an error in a command. "
21357 "You can change this in the usual way. See section L</EXIT ON ERROR "
21362 #: ../fish/guestfish.pod:947
21363 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21367 #: ../fish/guestfish.pod:949
21369 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21370 "is how the I<--remote> option knows where to send the commands. You can "
21371 "have several guestfish listener processes running using:"
21375 #: ../fish/guestfish.pod:953
21378 " eval \"`guestfish --listen`\"\n"
21379 " pid1=$GUESTFISH_PID\n"
21380 " eval \"`guestfish --listen`\"\n"
21381 " pid2=$GUESTFISH_PID\n"
21383 " guestfish --remote=$pid1 cmd\n"
21384 " guestfish --remote=$pid2 cmd\n"
21389 #: ../fish/guestfish.pod:961
21390 msgid "REMOTE CONTROL AND CSH"
21394 #: ../fish/guestfish.pod:963
21396 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21401 #: ../fish/guestfish.pod:966
21404 " eval \"`guestfish --listen --csh`\"\n"
21409 #: ../fish/guestfish.pod:968
21410 msgid "REMOTE CONTROL DETAILS"
21414 #: ../fish/guestfish.pod:970
21416 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
21417 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
21418 "and C<$PID> is the process ID of the server."
21422 #: ../fish/guestfish.pod:974
21423 msgid "Guestfish client and server versions must match exactly."
21427 #: ../fish/guestfish.pod:976
21428 msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
21432 #: ../fish/guestfish.pod:978
21434 "From Bash, you can use the following code which creates a guestfish "
21435 "instance, correctly quotes the command line, handles failure to start, and "
21436 "cleans up guestfish when the script exits:"
21440 #: ../fish/guestfish.pod:982 ../src/guestfs.pod:980
21448 #: ../fish/guestfish.pod:986
21451 " guestfish[0]=\"guestfish\"\n"
21452 " guestfish[1]=\"--listen\"\n"
21453 " guestfish[2]=\"--ro\"\n"
21454 " guestfish[3]=\"-a\"\n"
21455 " guestfish[4]=\"disk.img\"\n"
21460 #: ../fish/guestfish.pod:992
21463 " GUESTFISH_PID=\n"
21464 " eval $(\"${guestfish[@]}\")\n"
21465 " if [ -z \"$GUESTFISH_PID\" ]; then\n"
21466 " echo \"error: guestfish didn't start up, see error messages above\"\n"
21473 #: ../fish/guestfish.pod:999
21476 " cleanup_guestfish ()\n"
21478 " guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
21480 " trap cleanup_guestfish EXIT ERR\n"
21485 #: ../fish/guestfish.pod:1005
21488 " guestfish --remote -- run\n"
21493 #: ../fish/guestfish.pod:1007
21501 #: ../fish/guestfish.pod:1009
21502 msgid "REMOTE CONTROL RUN COMMAND HANGING"
21506 #: ../fish/guestfish.pod:1011
21508 "Using the C<run> (or C<launch>) command remotely in a command substitution "
21509 "context hangs, ie. don't do (note the backquotes):"
21513 #: ../fish/guestfish.pod:1014
21516 " a=`guestfish --remote run`\n"
21521 #: ../fish/guestfish.pod:1016
21523 "Since the C<run> command produces no output on stdout, this is not useful "
21524 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
21529 #: ../fish/guestfish.pod:1020
21530 msgid "PREPARED DISK IMAGES"
21534 #: ../fish/guestfish.pod:1022
21536 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21537 "preformatted disk images that guestfish can make for you to save typing. "
21538 "This is particularly useful for testing purposes. This option is used "
21539 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21540 "can be mixed with I<-a>)."
21544 #: ../fish/guestfish.pod:1028
21546 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21547 "the second and so on. Existing files in the current directory are "
21552 #: ../fish/guestfish.pod:1032
21554 "The type briefly describes how the disk should be sized, partitioned, how "
21555 "filesystem(s) should be created, and how content should be added. "
21556 "Optionally the type can be followed by extra parameters, separated by C<:> "
21557 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
21558 "allocated disk, containing a single partition, with the partition formatted "
21559 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
21564 #: ../fish/guestfish.pod:1040
21565 msgid "To list the available types and any extra parameters they take, run:"
21569 #: ../fish/guestfish.pod:1044
21571 "Note that the prepared filesystem is not mounted. You would usually have to "
21572 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21576 #: ../fish/guestfish.pod:1048
21578 "If any I<-N> or I<--new> options are given, the guest is automatically "
21583 #: ../fish/guestfish.pod:1053
21584 msgid "Create a 100MB disk with an ext4-formatted partition:"
21588 #: ../fish/guestfish.pod:1055
21591 " guestfish -N fs:ext4\n"
21596 #: ../fish/guestfish.pod:1057
21597 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21601 #: ../fish/guestfish.pod:1059
21604 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21609 #: ../fish/guestfish.pod:1061
21610 msgid "Create a blank 200MB disk:"
21614 #: ../fish/guestfish.pod:1063
21617 " guestfish -N disk:200M\n"
21622 #: ../fish/guestfish.pod:1065
21623 msgid "PROGRESS BARS"
21627 #: ../fish/guestfish.pod:1067
21629 "Some (not all) long-running commands send progress notification messages as "
21630 "they are running. Guestfish turns these messages into progress bars."
21634 #: ../fish/guestfish.pod:1071
21636 "When a command that supports progress bars takes longer than two seconds to "
21637 "run, and if progress bars are enabled, then you will see one appearing below "
21642 #: ../fish/guestfish.pod:1075
21645 " ><fs> copy-size /large-file /another-file 2048M\n"
21646 " / 10% [#####-----------------------------------------] 00:30\n"
21651 #: ../fish/guestfish.pod:1078
21653 "The spinner on the left hand side moves round once for every progress "
21654 "notification received from the backend. This is a (reasonably) golden "
21655 "assurance that the command is \"doing something\" even if the progress bar "
21656 "is not moving, because the command is able to send the progress "
21657 "notifications. When the bar reaches 100% and the command finishes, the "
21658 "spinner disappears."
21662 #: ../fish/guestfish.pod:1085
21664 "Progress bars are enabled by default when guestfish is used interactively. "
21665 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21666 "and you can disable them completely using I<--no-progress-bars>."
21670 #: ../fish/guestfish.pod:1090
21671 msgid "GUESTFISH COMMANDS"
21675 #: ../fish/guestfish.pod:1092
21677 "The commands in this section are guestfish convenience commands, in other "
21678 "words, they are not part of the L<guestfs(3)> API."
21682 #: ../fish/guestfish.pod:1095
21687 #: ../fish/guestfish.pod:1097
21696 #: ../fish/guestfish.pod:1100
21697 msgid "Without any parameter, this provides general help."
21701 #: ../fish/guestfish.pod:1102
21702 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21706 #: ../fish/guestfish.pod:1104
21707 msgid "quit | exit"
21711 #: ../fish/guestfish.pod:1106
21712 msgid "This exits guestfish. You can also use C<^D> key."
21716 #: ../fish/guestfish.pod:1108
21717 msgid "@FISH_COMMANDS@"
21721 #: ../fish/guestfish.pod:1110
21726 #: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1520
21731 #: ../fish/guestfish.pod:1116
21733 "guestfish returns 0 if the commands completed without error, or 1 if there "
21738 #: ../fish/guestfish.pod:1123
21743 #: ../fish/guestfish.pod:1125
21745 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21750 #: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3218
21751 msgid "FEBOOTSTRAP_KERNEL"
21755 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3220
21756 msgid "FEBOOTSTRAP_MODULES"
21760 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3222
21762 "These two environment variables allow the kernel that libguestfs uses in the "
21763 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
21764 "most recent host kernel is chosen. For more information about kernel "
21765 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
21766 "available in febootstrap E<ge> 3.8."
21770 #: ../fish/guestfish.pod:1138
21771 msgid "GUESTFISH_DISPLAY_IMAGE"
21775 #: ../fish/guestfish.pod:1140
21777 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
21778 "If not set, it uses L<display(1)>."
21782 #: ../fish/guestfish.pod:1143
21783 msgid "GUESTFISH_PID"
21787 #: ../fish/guestfish.pod:1145
21789 "Used with the I<--remote> option to specify the remote guestfish process to "
21790 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21794 #: ../fish/guestfish.pod:1149
21799 #: ../fish/guestfish.pod:1151
21801 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21802 "not specified, the external L<hexedit(1)> program is used."
21806 #: ../fish/guestfish.pod:1155
21811 #: ../fish/guestfish.pod:1157
21813 "If compiled with GNU readline support, various files in the home directory "
21814 "can be used. See L</FILES>."
21818 #: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3228
21819 msgid "LIBGUESTFS_APPEND"
21823 #: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3230
21824 msgid "Pass additional options to the guest kernel."
21828 #: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3232
21829 msgid "LIBGUESTFS_DEBUG"
21833 #: ../fish/guestfish.pod:1166
21835 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21836 "effect as using the B<-v> option."
21840 #: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3237
21841 msgid "LIBGUESTFS_MEMSIZE"
21845 #: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3239
21847 "Set the memory allocated to the qemu process, in megabytes. For example:"
21851 #: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3242
21854 " LIBGUESTFS_MEMSIZE=700\n"
21859 #: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3244
21860 msgid "LIBGUESTFS_PATH"
21864 #: ../fish/guestfish.pod:1178
21866 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21867 "the discussion of paths in L<guestfs(3)>."
21871 #: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3249
21872 msgid "LIBGUESTFS_QEMU"
21876 #: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3251
21878 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
21879 "which was found at compile time by the configure script is used."
21883 #: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3257
21884 msgid "LIBGUESTFS_TRACE"
21888 #: ../fish/guestfish.pod:1189
21889 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21893 #: ../fish/guestfish.pod:1191
21898 #: ../fish/guestfish.pod:1193
21900 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21905 #: ../fish/guestfish.pod:1196 ../sparsify/virt-sparsify.pod:260
21906 #: ../src/guestfs.pod:3262
21911 #: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3264
21913 "Location of temporary directory, defaults to C</tmp> except for the cached "
21914 "supermin appliance which defaults to C</var/tmp>."
21918 #: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3267
21920 "If libguestfs was compiled to use the supermin appliance then the real "
21921 "appliance is cached in this directory, shared between all handles belonging "
21922 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
21923 "use in case C</var/tmp> is not large enough."
21927 #: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297
21928 #: ../rescue/virt-rescue.pod:310
21933 #: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301
21934 #: ../rescue/virt-rescue.pod:314
21935 msgid "$HOME/.libguestfs-tools.rc"
21939 #: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303
21940 #: ../rescue/virt-rescue.pod:316
21941 msgid "/etc/libguestfs-tools.conf"
21945 #: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305
21946 #: ../rescue/virt-rescue.pod:318
21948 "This configuration file controls the default read-only or read-write mode "
21949 "(I<--ro> or I<--rw>)."
21953 #: ../fish/guestfish.pod:1220
21954 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21958 #: ../fish/guestfish.pod:1222
21959 msgid "$HOME/.guestfish"
21963 #: ../fish/guestfish.pod:1224
21965 "If compiled with GNU readline support, then the command history is saved in "
21970 #: ../fish/guestfish.pod:1227
21971 msgid "$HOME/.inputrc"
21975 #: ../fish/guestfish.pod:1229
21976 msgid "/etc/inputrc"
21980 #: ../fish/guestfish.pod:1231
21982 "If compiled with GNU readline support, then these files can be used to "
21983 "configure readline. For further information, please see L<readline(3)/"
21984 "INITIALIZATION FILE>."
21988 #: ../fish/guestfish.pod:1235
21989 msgid "To write rules which only apply to guestfish, use:"
21993 #: ../fish/guestfish.pod:1237
22003 #: ../fish/guestfish.pod:1241
22005 "Variables that you can set in inputrc that change the behaviour of guestfish "
22006 "in useful ways include:"
22010 #: ../fish/guestfish.pod:1246
22011 msgid "completion-ignore-case (default: on)"
22015 #: ../fish/guestfish.pod:1248
22017 "By default, guestfish will ignore case when tab-completing paths on the "
22022 #: ../fish/guestfish.pod:1251
22025 " set completion-ignore-case off\n"
22030 #: ../fish/guestfish.pod:1253
22031 msgid "to make guestfish case sensitive."
22035 #: ../fish/guestfish.pod:1257
22040 #: ../fish/guestfish.pod:1259
22041 msgid "test2.img (etc)"
22045 #: ../fish/guestfish.pod:1261
22047 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22048 "will be created in the file C<test1.img> in the current directory. The "
22049 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22050 "the same name will be overwritten."
22054 #: ../fish/guestfish.pod:1270
22056 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-alignment-scan(1)>, L<virt-"
22057 "cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit"
22058 "(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems"
22059 "(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
22060 "rescue(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, L<virt-sysprep(1)>, "
22061 "L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, "
22062 "L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
22066 #: ../fish/guestfish.pod:1302 ../src/guestfs.pod:3360
22067 #: ../test-tool/libguestfs-test-tool.pod:112
22068 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
22072 #: ../fish/virt-copy-in.pod:5
22074 "virt-copy-in - Copy files and directories into a virtual machine disk image."
22078 #: ../fish/virt-copy-in.pod:9
22081 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
22086 #: ../fish/virt-copy-in.pod:11
22089 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
22094 #: ../fish/virt-copy-in.pod:15
22096 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
22097 "causing disk corruption. The virtual machine must be shut down before you "
22098 "use this command."
22102 #: ../fish/virt-copy-in.pod:21
22104 "C<virt-copy-in> copies files and directories from the local disk into a "
22105 "virtual machine disk image or named libvirt domain."
22109 #: ../fish/virt-copy-in.pod:24
22111 "You can give one of more filenames and directories on the command line. "
22112 "Directories are copied in recursively. The final parameter must be the "
22113 "destination directory in the disk image which must be an absolute path "
22114 "starting with a C</> character."
22118 #: ../fish/virt-copy-in.pod:33
22121 " virt-copy-in -d MyGuest resolv.conf /etc\n"
22126 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
22127 msgid "Upload a home directory to a guest:"
22131 #: ../fish/virt-copy-in.pod:37
22134 " virt-copy-in -d MyGuest skel /home\n"
22139 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
22140 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
22141 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
22145 #: ../fish/virt-copy-in.pod:41
22147 "This command is just a simple shell script wrapper around the L<guestfish(1)"
22148 "> C<copy-in> command. For anything more complex than a trivial copy, you "
22149 "are probably better off using guestfish directly."
22153 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
22154 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
22156 "Since the shell script just passes options straight to guestfish, read "
22157 "L<guestfish(1)> to see the full list of options."
22161 #: ../fish/virt-copy-in.pod:52
22163 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
22164 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
22168 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
22169 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
22170 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
22174 #: ../fish/virt-copy-out.pod:5
22176 "virt-copy-out - Copy files and directories out of a virtual machine disk "
22181 #: ../fish/virt-copy-out.pod:9
22184 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
22189 #: ../fish/virt-copy-out.pod:11
22192 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
22197 #: ../fish/virt-copy-out.pod:15
22199 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
22200 "image or named libvirt domain."
22204 #: ../fish/virt-copy-out.pod:18
22206 "You can give one of more filenames and directories on the command line. "
22207 "Directories are copied out recursively."
22211 #: ../fish/virt-copy-out.pod:23
22212 msgid "Download the home directories from a virtual machine:"
22216 #: ../fish/virt-copy-out.pod:25
22220 " virt-copy-out -d MyGuest /home homes\n"
22225 #: ../fish/virt-copy-out.pod:30
22227 "This command is just a simple shell script wrapper around the L<guestfish(1)"
22228 "> C<copy-out> command. For anything more complex than a trivial copy, you "
22229 "are probably better off using guestfish directly."
22233 #: ../fish/virt-copy-out.pod:41
22235 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
22236 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
22240 #: ../fish/virt-tar-in.pod:5
22241 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
22245 #: ../fish/virt-tar-in.pod:9
22248 " virt-tar-in -a disk.img data.tar /destination\n"
22253 #: ../fish/virt-tar-in.pod:11
22256 " virt-tar-in -d domain data.tar /destination\n"
22261 #: ../fish/virt-tar-in.pod:13
22264 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
22269 #: ../fish/virt-tar-in.pod:17
22271 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
22272 "causing disk corruption. The virtual machine must be shut down before you "
22273 "use this command."
22277 #: ../fish/virt-tar-in.pod:23
22279 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
22280 "image or named libvirt domain."
22284 #: ../fish/virt-tar-in.pod:26
22286 "The first parameter is the tar file. Use C<-> to read the tar file from "
22287 "standard input. The second parameter is the absolute target directory to "
22292 #: ../fish/virt-tar-in.pod:34
22295 " virt-tar-in -d MyGuest homes.tar /home\n"
22300 #: ../fish/virt-tar-in.pod:38
22302 "This command is just a simple shell script wrapper around the L<guestfish(1)"
22303 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
22304 "probably better off using guestfish directly."
22308 #: ../fish/virt-tar-in.pod:49
22310 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
22311 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
22316 #: ../fish/virt-tar-out.pod:5
22318 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
22322 #: ../fish/virt-tar-out.pod:9
22325 " virt-tar-out -a disk.img /dir files.tar\n"
22330 #: ../fish/virt-tar-out.pod:11
22333 " virt-tar-out -d domain /dir files.tar\n"
22338 #: ../fish/virt-tar-out.pod:13
22341 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
22346 #: ../fish/virt-tar-out.pod:17
22348 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
22352 #: ../fish/virt-tar-out.pod:20
22354 "The first parameter is the absolute path of the virtual machine directory. "
22355 "The second parameter is the tar file to write. Use C<-> to write to "
22360 #: ../fish/virt-tar-out.pod:26
22361 msgid "Download the home directories from a guest:"
22365 #: ../fish/virt-tar-out.pod:28
22368 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
22373 #: ../fish/virt-tar-out.pod:32
22375 "This command is just a simple shell script wrapper around the L<guestfish(1)"
22376 "> C<tar-out> command. For anything more complex than a trivial copy, you "
22377 "are probably better off using guestfish directly."
22381 #: ../fish/virt-tar-out.pod:43
22383 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
22384 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
22388 #: ../fuse/guestmount.pod:5
22390 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
22394 #: ../fuse/guestmount.pod:9
22397 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
22402 #: ../fuse/guestmount.pod:11
22405 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
22410 #: ../fuse/guestmount.pod:13
22413 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
22418 #: ../fuse/guestmount.pod:17
22420 "You must I<not> use C<guestmount> in read-write mode on live virtual "
22421 "machines. If you do this, you risk disk corruption in the VM."
22425 #: ../fuse/guestmount.pod:22
22427 "The guestmount program can be used to mount virtual machine filesystems and "
22428 "other disk images on the host. It uses libguestfs for access to the guest "
22429 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
22430 "a mountable device."
22434 #: ../fuse/guestmount.pod:27
22436 "Along with other options, you have to give at least one device (I<-a> "
22437 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
22438 "option) or use the I<-i> inspection option or the I<--live> option. How "
22439 "this works is better explained in the L<guestfish(1)> manual page, or by "
22440 "looking at the examples below."
22444 #: ../fuse/guestmount.pod:33
22446 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
22447 "by you, and the filesystem will not be visible to any other users unless you "
22448 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
22449 "the filesystem, use the C<fusermount -u> command."
22453 #: ../fuse/guestmount.pod:41
22455 "For a typical Windows guest which has its main filesystem on the first "
22460 #: ../fuse/guestmount.pod:44
22463 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
22468 #: ../fuse/guestmount.pod:46
22470 "For a typical Linux guest which has a /boot filesystem on the first "
22471 "partition, and the root filesystem on a logical volume:"
22475 #: ../fuse/guestmount.pod:49
22478 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
22483 #: ../fuse/guestmount.pod:51
22484 msgid "To get libguestfs to detect guest mountpoints for you:"
22488 #: ../fuse/guestmount.pod:53
22491 " guestmount -a guest.img -i --ro /mnt\n"
22496 #: ../fuse/guestmount.pod:55
22497 msgid "For a libvirt guest called \"Guest\" you could do:"
22501 #: ../fuse/guestmount.pod:57
22504 " guestmount -d Guest -i --ro /mnt\n"
22509 #: ../fuse/guestmount.pod:59
22511 "If you don't know what filesystems are contained in a guest or disk image, "
22512 "use L<virt-filesystems(1)> first:"
22516 #: ../fuse/guestmount.pod:62
22519 " virt-filesystems MyGuest\n"
22524 #: ../fuse/guestmount.pod:64
22526 "If you want to trace the libguestfs calls but without excessive debugging "
22527 "information, we recommend:"
22531 #: ../fuse/guestmount.pod:67
22534 " guestmount [...] --trace /mnt\n"
22539 #: ../fuse/guestmount.pod:69
22540 msgid "If you want to debug the program, we recommend:"
22544 #: ../fuse/guestmount.pod:71
22547 " guestmount [...] --trace --verbose /mnt\n"
22552 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:96
22553 #: ../resize/virt-resize.pod:627
22558 #: ../fuse/guestmount.pod:75
22559 msgid "Other users cannot see the filesystem by default"
22563 #: ../fuse/guestmount.pod:77
22565 "If you mount a filesystem as one user (eg. root), then other users will not "
22566 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
22567 "option when mounting:"
22571 #: ../fuse/guestmount.pod:81
22574 " sudo guestmount [...] -o allow_other /mnt\n"
22579 #: ../fuse/guestmount.pod:83
22580 msgid "Enabling FUSE"
22584 #: ../fuse/guestmount.pod:85
22586 "On some distros, you may need to add yourself to a special group (eg. "
22587 "C<fuse>) before you can use any FUSE filesystem. This is necessary on "
22588 "Debian and derivatives."
22592 #: ../fuse/guestmount.pod:89
22594 "On other distros, no special group is required. It is not necessary on "
22595 "Fedora or Red Hat Enterprise Linux."
22599 #: ../fuse/guestmount.pod:100
22600 msgid "Add a block device or virtual machine image."
22604 #: ../fuse/guestmount.pod:123
22605 msgid "B<--dir-cache-timeout N>"
22609 #: ../fuse/guestmount.pod:125
22611 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
22612 "seconds. The readdir cache [actually, there are several semi-independent "
22613 "caches] is populated after a readdir(2) call with the stat and extended "
22614 "attributes of the files in the directory, in anticipation that they will be "
22615 "requested soon after."
22619 #: ../fuse/guestmount.pod:131
22621 "There is also a different attribute cache implemented by FUSE (see the FUSE "
22622 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
22623 "requests, only cache existing ones."
22627 #: ../fuse/guestmount.pod:151
22629 "If you have untrusted raw-format guest disk images, you should use this "
22630 "option to specify the disk format. This avoids a possible security problem "
22631 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
22632 "guestfs_add_drive_opts>."
22636 #: ../fuse/guestmount.pod:156
22637 msgid "B<--fuse-help>"
22641 #: ../fuse/guestmount.pod:158
22642 msgid "Display help on special FUSE options (see I<-o> below)."
22646 #: ../fuse/guestmount.pod:162
22647 msgid "Display brief help and exit."
22651 #: ../fuse/guestmount.pod:186
22653 "Mount the named partition or logical volume on the given mountpoint B<in the "
22654 "guest> (this has nothing to do with mountpoints in the host)."
22658 #: ../fuse/guestmount.pod:189
22660 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
22661 "something on C</>."
22665 #: ../fuse/guestmount.pod:206
22667 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
22668 "unmounted. If you specify this option, then we don't attempt to sync the "
22669 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
22673 #: ../fuse/guestmount.pod:211
22674 msgid "B<-o option>"
22678 #: ../fuse/guestmount.pod:213
22679 msgid "B<--option option>"
22683 #: ../fuse/guestmount.pod:215
22684 msgid "Pass extra options to FUSE."
22688 #: ../fuse/guestmount.pod:217
22690 "To get a list of all the extra options supported by FUSE, use the command "
22691 "below. Note that only the FUSE I<-o> options can be passed, and only some "
22692 "of them are a good idea."
22696 #: ../fuse/guestmount.pod:221
22699 " guestmount --fuse-help\n"
22704 #: ../fuse/guestmount.pod:223
22705 msgid "Some potentially useful FUSE options:"
22709 #: ../fuse/guestmount.pod:227
22710 msgid "B<-o allow_other>"
22714 #: ../fuse/guestmount.pod:229
22715 msgid "Allow other users to see the filesystem."
22719 #: ../fuse/guestmount.pod:231
22720 msgid "B<-o attr_timeout=N>"
22724 #: ../fuse/guestmount.pod:233
22725 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
22729 #: ../fuse/guestmount.pod:235
22730 msgid "B<-o kernel_cache>"
22734 #: ../fuse/guestmount.pod:237
22736 "Allow the kernel to cache files (reduces the number of reads that have to go "
22737 "through the L<guestfs(3)> API). This is generally a good idea if you can "
22738 "afford the extra memory usage."
22742 #: ../fuse/guestmount.pod:241
22743 msgid "B<-o uid=N> B<-o gid=N>"
22747 #: ../fuse/guestmount.pod:243
22749 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
22750 "the chosen values."
22754 #: ../fuse/guestmount.pod:252
22756 "Add devices and mount everything read-only. Also disallow writes and make "
22757 "the disk appear read-only to FUSE."
22761 #: ../fuse/guestmount.pod:255
22763 "This is highly recommended if you are not going to edit the guest disk. If "
22764 "the guest is running and this option is I<not> supplied, then there is a "
22765 "strong risk of disk corruption in the guest. We try to prevent this from "
22766 "happening, but it is not always possible."
22770 #: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:199
22771 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
22775 #: ../fuse/guestmount.pod:264
22776 msgid "Enable SELinux support for the guest."
22780 #: ../fuse/guestmount.pod:270
22781 msgid "Enable verbose messages from underlying libguestfs."
22785 #: ../fuse/guestmount.pod:276
22786 msgid "Display the program version and exit."
22790 #: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308
22791 #: ../rescue/virt-rescue.pod:238 ../rescue/virt-rescue.pod:321
22792 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
22796 #: ../fuse/guestmount.pod:289
22801 #: ../fuse/guestmount.pod:291
22802 msgid "Trace libguestfs calls and entry into each FUSE function."
22806 #: ../fuse/guestmount.pod:293
22807 msgid "This also stops the daemon from forking into the background."
22811 #: ../fuse/guestmount.pod:319
22813 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
22814 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
22819 #: ../fuse/guestmount.pod:334
22820 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
22824 #: ../inspector/virt-inspector.pod:5
22826 "virt-inspector - Display operating system version and other information "
22827 "about a virtual machine"
22831 #: ../inspector/virt-inspector.pod:9
22834 " virt-inspector [--options] -d domname\n"
22839 #: ../inspector/virt-inspector.pod:11
22842 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
22847 #: ../inspector/virt-inspector.pod:15
22850 " virt-inspector domname\n"
22855 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:148
22858 " virt-inspector disk.img [disk.img ...]\n"
22863 #: ../inspector/virt-inspector.pod:21
22865 "B<virt-inspector> examines a virtual machine or disk image and tries to "
22866 "determine the version of the operating system and other information about "
22867 "the virtual machine."
22871 #: ../inspector/virt-inspector.pod:25
22872 msgid "Virt-inspector produces XML output for feeding into other programs."
22876 #: ../inspector/virt-inspector.pod:27
22878 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
22879 "the libvirt domain (see: C<virsh list --all>)."
22883 #: ../inspector/virt-inspector.pod:30
22885 "You can also run virt-inspector directly on disk images from a single "
22886 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
22887 "has several block devices, in which case you should list several I<-a> "
22888 "options one after another, with the first corresponding to the guest's C</"
22889 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
22893 #: ../inspector/virt-inspector.pod:37
22895 "You can also run virt-inspector on install disks, live CDs, bootable USB "
22896 "keys and similar."
22900 #: ../inspector/virt-inspector.pod:40
22902 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
22903 "inspect several virtual machines, you have to run virt-inspector several "
22904 "times (for example, from a shell script for-loop)."
22908 #: ../inspector/virt-inspector.pod:45
22910 "Because virt-inspector needs direct access to guest images, it won't "
22911 "normally work over remote libvirt connections."
22915 #: ../inspector/virt-inspector.pod:48
22917 "All of the information available from virt-inspector is also available "
22918 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
22919 "The same information can also be fetched using guestfish or via libguestfs "
22920 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
22921 "WITH OTHER PROGRAMMING LANGUAGES>)."
22925 #: ../inspector/virt-inspector.pod:81
22927 "Libvirt is only used if you specify a C<domname> on the command line. If "
22928 "you specify guest block devices directly (I<-a>), then libvirt is not used "
22933 #: ../inspector/virt-inspector.pod:94
22935 "When prompting for keys and passphrases, virt-inspector normally turns "
22936 "echoing off so you cannot see what you are typing. If you are not worried "
22937 "about Tempest attacks and there is no one else in the room you can specify "
22938 "this flag to see what you are typing."
22942 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
22943 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
22944 #: ../tools/virt-win-reg.pl:144
22946 "Specify the format of disk images given on the command line. If this is "
22947 "omitted then the format is autodetected from the content of the disk image."
22951 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
22952 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
22953 #: ../tools/virt-win-reg.pl:148
22955 "If disk images are requested from libvirt, then this program asks libvirt "
22956 "for this information. In this case, the value of the format parameter is "
22961 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:397
22962 #: ../resize/virt-resize.pod:489 ../sparsify/virt-sparsify.pod:144
22963 #: ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102
22964 #: ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
22966 "If working with untrusted raw-format guest disk images, you should ensure "
22967 "the format is always specified."
22971 #: ../inspector/virt-inspector.pod:135
22972 msgid "B<--xpath> query"
22976 #: ../inspector/virt-inspector.pod:137
22978 "Perform an XPath query on the XML on stdin, and print the result on stdout. "
22979 "In this mode virt-inspector simply runs an XPath query; all other inspection "
22980 "functions are disabled. See L</XPATH QUERIES> below for some examples."
22984 #: ../inspector/virt-inspector.pod:146
22985 msgid "Previous versions of virt-inspector allowed you to write either:"
22989 #: ../inspector/virt-inspector.pod:152
22992 " virt-inspector guestname\n"
22997 #: ../inspector/virt-inspector.pod:160
23002 #: ../inspector/virt-inspector.pod:162
23004 "The virt-inspector XML is described precisely in a RELAX NG schema file "
23005 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
23006 "just an overview."
23010 #: ../inspector/virt-inspector.pod:166
23012 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
23013 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
23014 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
23015 "which is vanishingly rare in real world VMs."
23019 #: ../inspector/virt-inspector.pod:171
23020 msgid "E<lt>operatingsystemE<gt>"
23024 #: ../inspector/virt-inspector.pod:173
23026 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
23027 "describe the operating system, its architecture, the descriptive \"product "
23028 "name\" string, the type of OS and so on, as in this example:"
23032 #: ../inspector/virt-inspector.pod:177
23035 " <operatingsystems>\n"
23036 " <operatingsystem>\n"
23037 " <root>/dev/sda2</root>\n"
23038 " <name>windows</name>\n"
23039 " <arch>i386</arch>\n"
23040 " <distro>windows</distro>\n"
23041 " <product_name>Windows 7 Enterprise</product_name>\n"
23042 " <product_variant>Client</product_variant>\n"
23043 " <major_version>6</major_version>\n"
23044 " <minor_version>1</minor_version>\n"
23045 " <windows_systemroot>/Windows</windows_systemroot>\n"
23046 " <format>installed</format>\n"
23051 #: ../inspector/virt-inspector.pod:190
23053 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
23054 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
23055 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
23056 "architecture. The other fields are fairly self-explanatory, but because "
23057 "these fields are taken directly from the libguestfs inspection API you can "
23058 "find precise information from L<guestfs(3)/INSPECTION>."
23062 #: ../inspector/virt-inspector.pod:198
23064 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
23065 "of view of libguestfs (block devices may have completely different names "
23066 "inside the VM itself)."
23070 #: ../inspector/virt-inspector.pod:202
23071 msgid "E<lt>mountpointsE<gt>"
23075 #: ../inspector/virt-inspector.pod:204
23077 "Un*x-like guests typically have multiple filesystems which are mounted at "
23078 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
23079 "element which looks like this:"
23083 #: ../inspector/virt-inspector.pod:208
23086 " <operatingsystems>\n"
23087 " <operatingsystem>\n"
23090 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
23091 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
23092 " </mountpoints>\n"
23097 #: ../inspector/virt-inspector.pod:216
23099 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
23100 "and may have completely different names inside the guest. Only mountable "
23101 "filesystems appear in this list, not things like swap devices."
23105 #: ../inspector/virt-inspector.pod:221
23106 msgid "E<lt>filesystemsE<gt>"
23110 #: ../inspector/virt-inspector.pod:223
23112 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
23113 "filesystems belonging to the guest, including swap and empty partitions. "
23114 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
23115 "this OS or shared with this OS and other OSes)."
23119 #: ../inspector/virt-inspector.pod:229
23120 msgid "You might see something like this:"
23124 #: ../inspector/virt-inspector.pod:231
23127 " <operatingsystems>\n"
23128 " <operatingsystem>\n"
23131 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
23132 " <type>ext4</type>\n"
23133 " <label>Fedora-13-x86_64</label>\n"
23134 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
23140 #: ../inspector/virt-inspector.pod:241
23142 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
23143 "the label, and the UUID."
23147 #: ../inspector/virt-inspector.pod:244
23148 msgid "E<lt>applicationsE<gt>"
23152 #: ../inspector/virt-inspector.pod:246
23154 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
23155 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
23160 #: ../inspector/virt-inspector.pod:250
23162 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
23163 "Typical values would be C<rpm> and C<deb>."
23167 #: ../inspector/virt-inspector.pod:253
23169 "E<lt>package_managementE<gt>, if present, describes the package manager. "
23170 "Typical values include C<yum>, C<up2date> and C<apt>"
23174 #: ../inspector/virt-inspector.pod:256
23175 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
23179 #: ../inspector/virt-inspector.pod:259
23182 " <operatingsystems>\n"
23183 " <operatingsystem>\n"
23185 " <applications>\n"
23187 " <name>coreutils</name>\n"
23188 " <version>8.5</version>\n"
23189 " <release>1</release>\n"
23190 " </application>\n"
23195 #: ../inspector/virt-inspector.pod:269
23197 "The version and release fields may not be available for some types guests. "
23198 "Other fields are possible, see L<guestfs(3)/"
23199 "guestfs_inspect_list_applications>."
23203 #: ../inspector/virt-inspector.pod:273
23204 msgid "E<lt>drive_mappingsE<gt>"
23208 #: ../inspector/virt-inspector.pod:275
23210 "For operating systems like Windows which use drive letters, virt-inspector "
23211 "is able to find out how drive letters map to filesystems."
23215 #: ../inspector/virt-inspector.pod:279
23218 " <operatingsystems>\n"
23219 " <operatingsystem>\n"
23221 " <drive_mappings>\n"
23222 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
23223 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
23224 " </drive_mappings>\n"
23229 #: ../inspector/virt-inspector.pod:287
23231 "In the example above, drive C maps to the filesystem on the second partition "
23232 "on the first disk, and drive E maps to the filesystem on the first partition "
23233 "on the second disk."
23237 #: ../inspector/virt-inspector.pod:291
23239 "Note that this only covers permanent local filesystem mappings, not things "
23240 "like network shares. Furthermore NTFS volume mount points may not be listed "
23245 #: ../inspector/virt-inspector.pod:295
23246 msgid "E<lt>iconE<gt>"
23250 #: ../inspector/virt-inspector.pod:297
23252 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
23253 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
23254 "very large and high quality."
23258 #: ../inspector/virt-inspector.pod:301
23261 " <operatingsystems>\n"
23262 " <operatingsystem>\n"
23265 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
23266 " [... many lines of base64 data ...]\n"
23272 #: ../inspector/virt-inspector.pod:309
23274 "To display the icon, you have to extract it and convert the base64 data back "
23275 "to a binary file. Use an XPath query or simply an editor to extract the "
23276 "data, then use the coreutils L<base64(1)> program to do the conversion back "
23281 #: ../inspector/virt-inspector.pod:314
23284 " base64 -i -d < icon.data > icon.png\n"
23289 #: ../inspector/virt-inspector.pod:316
23290 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
23294 #: ../inspector/virt-inspector.pod:318
23296 "Virt-inspector can detect some operating system installers on install disks, "
23297 "live CDs, bootable USB keys and more."
23301 #: ../inspector/virt-inspector.pod:321
23303 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
23304 "fields may be present to indicate a live CD, network installer, or one part "
23305 "of a multipart CD. For example:"
23309 #: ../inspector/virt-inspector.pod:325
23312 " <operatingsystems>\n"
23313 " <operatingsystem>\n"
23314 " <root>/dev/sda</root>\n"
23315 " <name>linux</name>\n"
23316 " <arch>i386</arch>\n"
23317 " <distro>ubuntu</distro>\n"
23318 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
23319 " <major_version>10</major_version>\n"
23320 " <minor_version>10</minor_version>\n"
23321 " <format>installer</format>\n"
23327 #: ../inspector/virt-inspector.pod:337
23328 msgid "XPATH QUERIES"
23332 #: ../inspector/virt-inspector.pod:339
23334 "Virt-inspector includes built in support for running XPath queries. The "
23335 "reason for including XPath support directly in virt-inspector is simply that "
23336 "there are no good and widely available command line programs that can do "
23337 "XPath queries. The only good one is L<xmlstarlet(1)> and that is not "
23338 "available on Red Hat Enterprise Linux."
23342 #: ../inspector/virt-inspector.pod:346
23344 "To perform an XPath query, use the I<--xpath> option. Note that in this "
23345 "mode, virt-inspector simply reads XML from stdin and outputs the query "
23346 "result on stdout. All other inspection features are disabled in this mode."
23350 #: ../inspector/virt-inspector.pod:353
23353 " $ virt-inspector -d Guest | virt-inspector --xpath '//filesystems'\n"
23355 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
23356 " <type>ext4</type>\n"
23362 #: ../inspector/virt-inspector.pod:359
23365 " $ virt-inspector -d Guest | \\\n"
23366 " virt-inspector --xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
23372 #: ../inspector/virt-inspector.pod:363
23375 " $ virt-inspector -d Guest | \\\n"
23376 " virt-inspector --xpath 'string(//icon)' | base64 -i -d | display -\n"
23377 " [displays the guest icon, if there is one]\n"
23382 #: ../inspector/virt-inspector.pod:374
23383 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
23387 #: ../inspector/virt-inspector.pod:376
23389 "Early versions of libguestfs shipped with a different virt-inspector program "
23390 "written in Perl (the current version is written in C). The XML output of "
23391 "the Perl virt-inspector was different and it could also output in other "
23392 "formats like text."
23396 #: ../inspector/virt-inspector.pod:381
23398 "The old virt-inspector is no longer supported or shipped with libguestfs."
23402 #: ../inspector/virt-inspector.pod:384
23404 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
23405 "versions of virt-inspector with different names:"
23409 #: ../inspector/virt-inspector.pod:387
23412 " virt-inspector Old Perl version.\n"
23413 " virt-inspector2 New C version.\n"
23418 #: ../inspector/virt-inspector.pod:397
23420 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
23421 ">, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
23425 #: ../inspector/virt-inspector.pod:414
23426 msgid "Matthew Booth L<mbooth@redhat.com>"
23430 #: ../java/examples/guestfs-java.pod:5
23431 msgid "guestfs-java - How to use libguestfs from Java"
23435 #: ../java/examples/guestfs-java.pod:9
23438 " import com.redhat.et.libguestfs.*;\n"
23443 #: ../java/examples/guestfs-java.pod:11
23446 " GuestFS g = new GuestFS ();\n"
23447 " g.add_drive_opts (\"disk.img\", null);\n"
23453 #: ../java/examples/guestfs-java.pod:17
23455 "This manual page documents how to call libguestfs from the Java programming "
23456 "language. This page just documents the differences from the C API and gives "
23457 "some examples. If you are not familiar with using libguestfs, you also need "
23458 "to read L<guestfs(3)>."
23462 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
23463 msgid "CLOSING THE HANDLE"
23467 #: ../java/examples/guestfs-java.pod:24
23469 "The handle is closed when it is reaped by the garbage collector. Because "
23470 "libguestfs handles include a lot of state, it is also possible to close (and "
23471 "hence free) them explicitly by calling the C<close> method."
23475 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
23476 #: ../python/examples/guestfs-python.pod:21
23477 #: ../ruby/examples/guestfs-ruby.pod:22
23482 #: ../java/examples/guestfs-java.pod:31
23484 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
23485 "exception. This has a single parameter which is the error message (a "
23490 #: ../java/examples/guestfs-java.pod:35
23491 msgid "Calling any method on a closed handle raises the same exception."
23495 #: ../java/examples/guestfs-java.pod:47
23497 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-ocaml"
23498 "(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
23499 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
23503 #: ../ocaml/examples/guestfs-ocaml.pod:5
23504 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
23508 #: ../ocaml/examples/guestfs-ocaml.pod:9
23509 msgid "Module style:"
23513 #: ../ocaml/examples/guestfs-ocaml.pod:11
23516 " let g = Guestfs.create () in\n"
23517 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
23518 " Guestfs.launch g;\n"
23523 #: ../ocaml/examples/guestfs-ocaml.pod:15
23524 msgid "Object-oriented style:"
23528 #: ../ocaml/examples/guestfs-ocaml.pod:17
23531 " let g = new Guestfs.guestfs () in\n"
23532 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
23538 #: ../ocaml/examples/guestfs-ocaml.pod:21
23541 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
23543 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
23548 #: ../ocaml/examples/guestfs-ocaml.pod:27
23550 "This manual page documents how to call libguestfs from the OCaml programming "
23551 "language. This page just documents the differences from the C API and gives "
23552 "some examples. If you are not familiar with using libguestfs, you also need "
23553 "to read L<guestfs(3)>."
23557 #: ../ocaml/examples/guestfs-ocaml.pod:32
23558 msgid "PROGRAMMING STYLES"
23562 #: ../ocaml/examples/guestfs-ocaml.pod:34
23564 "There are two different programming styles supported by the OCaml bindings. "
23565 "You can use a module style, with each C function mapped to an OCaml function:"
23569 #: ../ocaml/examples/guestfs-ocaml.pod:38
23572 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
23577 #: ../ocaml/examples/guestfs-ocaml.pod:40
23582 #: ../ocaml/examples/guestfs-ocaml.pod:42
23585 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
23590 #: ../ocaml/examples/guestfs-ocaml.pod:44
23592 "Alternately you can use an object-oriented style, calling methods on the "
23593 "class C<Guestfs.guestfs>:"
23597 #: ../ocaml/examples/guestfs-ocaml.pod:47
23600 " method set_verbose : bool -> unit\n"
23605 #: ../ocaml/examples/guestfs-ocaml.pod:49
23607 "The object-oriented style is usually briefer, and the minor performance "
23608 "penalty isn't noticable in the general overhead of performing libguestfs "
23613 #: ../ocaml/examples/guestfs-ocaml.pod:55
23615 "The handle is closed when it is reaped by the garbage collector. Because "
23616 "libguestfs handles include a lot of state, it is also possible to close (and "
23617 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
23622 #: ../ocaml/examples/guestfs-ocaml.pod:62
23624 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
23625 "exception. This has a single parameter which is the error message (a "
23630 #: ../ocaml/examples/guestfs-ocaml.pod:66
23632 "Calling any function/method on a closed handle raises C<Guestfs."
23633 "Handle_closed>. The single parameter is the name of the function that you "
23638 #: ../ocaml/examples/guestfs-ocaml.pod:80
23640 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
23641 "(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
23642 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
23646 #: ../perl/examples/guestfs-perl.pod:5
23647 msgid "guestfs-perl - How to use libguestfs from Perl"
23651 #: ../perl/examples/guestfs-perl.pod:9
23654 " use Sys::Guestfs;\n"
23659 #: ../perl/examples/guestfs-perl.pod:11
23662 " my $h = Sys::Guestfs->new ();\n"
23663 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
23664 " $h->launch ();\n"
23665 " $h->mount_options ('', '/dev/sda1', '/');\n"
23666 " $h->touch ('/hello');\n"
23672 #: ../perl/examples/guestfs-perl.pod:20
23674 "This manual page documents how to call libguestfs from the Perl programming "
23675 "language. This page just documents the differences from the C API and gives "
23676 "some examples. If you are not familiar with using libguestfs, you also need "
23677 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
23681 #: ../perl/examples/guestfs-perl.pod:26
23686 #: ../perl/examples/guestfs-perl.pod:28
23688 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
23693 #: ../perl/examples/guestfs-perl.pod:41
23695 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang"
23696 "(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
23697 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
23701 #: ../python/examples/guestfs-python.pod:5
23702 msgid "guestfs-python - How to use libguestfs from Python"
23706 #: ../python/examples/guestfs-python.pod:9
23709 " import guestfs\n"
23710 " g = guestfs.GuestFS ()\n"
23711 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
23717 #: ../python/examples/guestfs-python.pod:16
23719 "This manual page documents how to call libguestfs from the Python "
23720 "programming language. This page just documents the differences from the C "
23721 "API and gives some examples. If you are not familiar with using libguestfs, "
23722 "you also need to read L<guestfs(3)>."
23726 #: ../python/examples/guestfs-python.pod:23
23728 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
23729 "single string argument which is the error message."
23733 #: ../python/examples/guestfs-python.pod:26
23734 msgid "MORE DOCUMENTATION"
23738 #: ../python/examples/guestfs-python.pod:28
23743 #: ../python/examples/guestfs-python.pod:30
23747 " >>> import guestfs\n"
23748 " >>> help (guestfs)\n"
23753 #: ../python/examples/guestfs-python.pod:44
23755 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
23756 "(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
23757 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
23761 #: ../rescue/virt-rescue.pod:5
23762 msgid "virt-rescue - Run a rescue shell on a virtual machine"
23766 #: ../rescue/virt-rescue.pod:9
23769 " virt-rescue [--options] -d domname\n"
23774 #: ../rescue/virt-rescue.pod:11
23777 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
23782 #: ../rescue/virt-rescue.pod:13
23785 " virt-rescue --suggest (-d domname | -a disk.img ...)\n"
23790 #: ../rescue/virt-rescue.pod:17
23793 " virt-rescue [--options] domname\n"
23798 #: ../rescue/virt-rescue.pod:19
23801 " virt-rescue [--options] disk.img [disk.img ...]\n"
23806 #: ../rescue/virt-rescue.pod:23
23808 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
23809 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
23810 "you from doing this, but doesn't catch all cases."
23814 #: ../rescue/virt-rescue.pod:27
23816 "However if you use the I<--ro> (read only) option, then you can attach a "
23817 "shell to a live virtual machine. The results might be strange or "
23818 "inconsistent at times but you won't get disk corruption."
23822 #: ../rescue/virt-rescue.pod:33
23824 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
23825 "need for a CD. virt-rescue gives you a rescue shell and some simple "
23826 "recovery tools which you can use to examine or rescue a virtual machine or "
23831 #: ../rescue/virt-rescue.pod:38
23833 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
23834 "on disk image(s):"
23838 #: ../rescue/virt-rescue.pod:41
23841 " virt-rescue -d GuestName\n"
23846 #: ../rescue/virt-rescue.pod:43
23849 " virt-rescue --ro -a /path/to/disk.img\n"
23854 #: ../rescue/virt-rescue.pod:45
23857 " virt-rescue -a /dev/sdc\n"
23862 #: ../rescue/virt-rescue.pod:47
23863 msgid "For live VMs you I<must> use the --ro option."
23867 #: ../rescue/virt-rescue.pod:49
23869 "When you run virt-rescue on a virtual machine or disk image, you are placed "
23870 "in an interactive bash shell where you can use many ordinary Linux "
23871 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
23872 "appliance. You must mount the virtual machine's filesystems by hand. There "
23873 "is an empty directory called C</sysroot> where you can mount filesystems."
23877 #: ../rescue/virt-rescue.pod:56
23879 "You can get virt-rescue to suggest mount commands for you by using the I<--"
23880 "suggest> option (in another terminal):"
23884 #: ../rescue/virt-rescue.pod:59
23887 " $ virt-rescue --suggest -d Fedora15\n"
23888 " Inspecting the virtual machine or disk image ...\n"
23893 #: ../rescue/virt-rescue.pod:62
23896 " This disk contains one or more operating systems. You can use these\n"
23897 " mount commands in virt-rescue (at the ><rescue> prompt) to mount the\n"
23903 #: ../rescue/virt-rescue.pod:66
23906 " # /dev/vg_f15x32/lv_root is the root of a linux operating system\n"
23907 " # type: linux, distro: fedora, version: 15.0\n"
23908 " # Fedora release 15 (Lovelock)\n"
23913 #: ../rescue/virt-rescue.pod:70
23916 " mount /dev/vg_f15x32/lv_root /sysroot/\n"
23917 " mount /dev/vda1 /sysroot/boot\n"
23918 " mount --bind /dev /sysroot/dev\n"
23919 " mount --bind /dev/pts /sysroot/dev/pts\n"
23920 " mount --bind /proc /sysroot/proc\n"
23921 " mount --bind /sys /sysroot/sys\n"
23926 #: ../rescue/virt-rescue.pod:77
23928 "Another way is to list the logical volumes (with L<lvs(8)>) and partitions "
23929 "(with L<parted(8)>) and mount them by hand:"
23933 #: ../rescue/virt-rescue.pod:80
23937 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
23938 " lv_root vg_f15x32 -wi-a- 8.83G\n"
23939 " lv_swap vg_f15x32 -wi-a- 992.00M\n"
23940 " ><rescue> mount /dev/vg_f15x32/lv_root /sysroot\n"
23941 " ><rescue> mount /dev/vda1 /sysroot/boot\n"
23942 " ><rescue> ls /sysroot\n"
23947 #: ../rescue/virt-rescue.pod:88
23949 "Another command to list available filesystems is L<virt-filesystems(1)>."
23953 #: ../rescue/virt-rescue.pod:91
23955 "To run commands in a Linux guest (for example, grub), you should chroot into "
23956 "the /sysroot directory first:"
23960 #: ../rescue/virt-rescue.pod:94
23963 " ><rescue> chroot /sysroot\n"
23968 #: ../rescue/virt-rescue.pod:98
23970 "Virt-rescue can be used on I<any> disk image file or device, not just a "
23971 "virtual machine. For example you can use it on a blank file if you want to "
23972 "partition that file (although we would recommend using L<guestfish(1)> "
23973 "instead as it is more suitable for this purpose). You can even use virt-"
23974 "rescue on things like SD cards."
23978 #: ../rescue/virt-rescue.pod:104
23980 "Virt-rescue does not require root. You only need to run it as root if you "
23981 "need root to open the disk image."
23985 #: ../rescue/virt-rescue.pod:107
23987 "This tool is just designed for quick interactive hacking on a virtual "
23988 "machine. For more structured access to a virtual machine disk image, you "
23989 "should use L<guestfs(3)>. To get a structured shell that you can use to "
23990 "make scripted changes to guests, use L<guestfish(1)>."
23994 #: ../rescue/virt-rescue.pod:131
23995 msgid "B<--append kernelopts>"
23999 #: ../rescue/virt-rescue.pod:133
24000 msgid "Pass additional options to the rescue kernel."
24004 #: ../rescue/virt-rescue.pod:163
24007 " virt-rescue --format=raw -a disk.img\n"
24012 #: ../rescue/virt-rescue.pod:167
24015 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
24020 #: ../rescue/virt-rescue.pod:176
24025 #: ../rescue/virt-rescue.pod:178
24026 msgid "B<--memsize MB>"
24030 #: ../rescue/virt-rescue.pod:180
24032 "Change the amount of memory allocated to the rescue system. The default is "
24033 "set by libguestfs and is small but adequate for running system tools. The "
24034 "occasional program might need more memory. The parameter is specified in "
24039 #: ../rescue/virt-rescue.pod:185
24040 msgid "B<--network>"
24044 #: ../rescue/virt-rescue.pod:187
24045 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
24049 #: ../rescue/virt-rescue.pod:193
24050 msgid "Open the image read-only."
24054 #: ../rescue/virt-rescue.pod:203
24056 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
24057 "SELINUX> before using this option."
24061 #: ../rescue/virt-rescue.pod:206
24066 #: ../rescue/virt-rescue.pod:208
24067 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
24071 #: ../rescue/virt-rescue.pod:210
24072 msgid "B<--suggest>"
24076 #: ../rescue/virt-rescue.pod:212
24078 "Inspect the disk image and suggest what mount commands should be used to "
24079 "mount the disks. You should use the I<--suggest> option in a second "
24080 "terminal, then paste the commands into another virt-rescue."
24084 #: ../rescue/virt-rescue.pod:216
24086 "This option implies I<--ro> and is safe to use even if the guest is up or if "
24087 "another virt-rescue is running."
24091 #: ../rescue/virt-rescue.pod:235
24093 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
24094 "are done read-write."
24098 #: ../rescue/virt-rescue.pod:248
24099 msgid "Previous versions of virt-rescue allowed you to write either:"
24103 #: ../rescue/virt-rescue.pod:250
24106 " virt-rescue disk.img [disk.img ...]\n"
24111 #: ../rescue/virt-rescue.pod:254
24114 " virt-rescue guestname\n"
24119 #: ../rescue/virt-rescue.pod:262
24124 #: ../rescue/virt-rescue.pod:264
24126 "Adding the I<--network> option enables QEMU user networking in the rescue "
24127 "appliance. There are some differences between user networking and ordinary "
24132 #: ../rescue/virt-rescue.pod:270
24133 msgid "ping does not work"
24137 #: ../rescue/virt-rescue.pod:272
24139 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
24140 "send the ping packets, and because virt-rescue must be able to run as non-"
24141 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
24142 "The ping command will appear to resolve addresses but will not be able to "
24143 "send or receive any packets. This does not mean that the network is not "
24148 #: ../rescue/virt-rescue.pod:279
24149 msgid "cannot receive connections"
24153 #: ../rescue/virt-rescue.pod:281
24154 msgid "QEMU user networking cannot receive incoming connections."
24158 #: ../rescue/virt-rescue.pod:283
24159 msgid "making TCP connections"
24163 #: ../rescue/virt-rescue.pod:285
24165 "The virt-rescue appliance needs to be small and so does not include many "
24166 "network tools. In particular there is no L<telnet(1)> command. You can "
24167 "make TCP connections from the shell using the magical C</dev/tcp/"
24168 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
24172 #: ../rescue/virt-rescue.pod:290
24175 " exec 3<>/dev/tcp/redhat.com/80\n"
24176 " echo \"GET /\" >&3\n"
24182 #: ../rescue/virt-rescue.pod:294
24183 msgid "See L<bash(1)> for more details."
24187 #: ../rescue/virt-rescue.pod:300
24189 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
24190 "ENVIRONMENT VARIABLES> for the complete list."
24194 #: ../rescue/virt-rescue.pod:327
24196 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-"
24197 "filesystems(1)>, L<http://libguestfs.org/>."
24201 #: ../resize/virt-resize.pod:5
24202 msgid "virt-resize - Resize a virtual machine disk"
24206 #: ../resize/virt-resize.pod:9
24209 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
24210 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
24211 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
24216 #: ../resize/virt-resize.pod:15
24218 "Virt-resize is a tool which can resize a virtual machine disk, making it "
24219 "larger or smaller overall, and resizing or deleting any partitions contained "
24224 #: ../resize/virt-resize.pod:19
24226 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
24227 "not> be used on live virtual machines - for consistent results, shut the "
24228 "virtual machine down before resizing it."
24232 #: ../resize/virt-resize.pod:23
24234 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
24235 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
24239 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:603
24240 #: ../sparsify/virt-sparsify.pod:227 ../src/guestfs.pod:484
24241 #: ../src/guestfs.pod:1302 ../src/guestfs.pod:1441 ../src/guestfs.pod:2690
24246 #: ../resize/virt-resize.pod:33
24248 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
24249 "fill the extra 5GB of space."
24253 #: ../resize/virt-resize.pod:36
24256 " virt-filesystems --long -h --all -a olddisk\n"
24261 #: ../resize/virt-resize.pod:38
24264 " truncate -r olddisk newdisk\n"
24265 " truncate -s +5G newdisk\n"
24270 #: ../resize/virt-resize.pod:41
24273 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
24274 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
24279 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:610
24280 #: ../sparsify/virt-sparsify.pod:234 ../src/guestfs.pod:490
24281 #: ../src/guestfs.pod:1306 ../src/guestfs.pod:1445 ../src/guestfs.pod:2715
24286 #: ../resize/virt-resize.pod:46
24288 "As above, but make the /boot partition 200MB bigger, while giving the "
24289 "remaining space to /dev/sda2:"
24293 #: ../resize/virt-resize.pod:49
24296 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
24297 " olddisk newdisk\n"
24302 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:616
24303 #: ../sparsify/virt-sparsify.pod:240 ../src/guestfs.pod:501
24304 #: ../src/guestfs.pod:1451
24309 #: ../resize/virt-resize.pod:54
24311 "As in the first example, but expand a logical volume as the final step. "
24312 "This is what you would typically use for Linux guests that use LVM:"
24316 #: ../resize/virt-resize.pod:58
24319 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
24320 " olddisk newdisk\n"
24325 #: ../resize/virt-resize.pod:61
24330 #: ../resize/virt-resize.pod:63
24332 "As in the first example, but the output format will be qcow2 instead of a "
24337 #: ../resize/virt-resize.pod:66
24340 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
24341 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
24346 #: ../resize/virt-resize.pod:71
24347 msgid "DETAILED USAGE"
24351 #: ../resize/virt-resize.pod:73
24352 msgid "EXPANDING A VIRTUAL MACHINE DISK"
24356 #: ../resize/virt-resize.pod:77
24357 msgid "1. Shut down the virtual machine"
24361 #: ../resize/virt-resize.pod:79
24362 msgid "2. Locate input disk image"
24366 #: ../resize/virt-resize.pod:81
24368 "Locate the input disk image (ie. the file or device on the host containing "
24369 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
24370 "dumpxml> like this to find the disk image name:"
24374 #: ../resize/virt-resize.pod:85
24377 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
24378 " Found 1 nodes:\n"
24380 " <source dev=\"/dev/vg/lv_guest\" />\n"
24385 #: ../resize/virt-resize.pod:90
24386 msgid "3. Look at current sizing"
24390 #: ../resize/virt-resize.pod:92
24391 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
24395 #: ../resize/virt-resize.pod:95
24398 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
24399 " Name Type Size Parent\n"
24400 " /dev/sda1 partition 101M /dev/sda\n"
24401 " /dev/sda2 partition 7.9G /dev/sda\n"
24402 " /dev/sda device 8.0G -\n"
24407 #: ../resize/virt-resize.pod:101
24409 "(This example is a virtual machine with an 8 GB disk which we would like to "
24410 "expand up to 10 GB)."
24414 #: ../resize/virt-resize.pod:104
24415 msgid "4. Create output disk"
24419 #: ../resize/virt-resize.pod:106
24421 "Virt-resize cannot do in-place disk modifications. You have to have space "
24422 "to store the resized output disk."
24426 #: ../resize/virt-resize.pod:109
24428 "To store the resized disk image in a file, create a file of a suitable size:"
24432 #: ../resize/virt-resize.pod:112
24435 " # rm -f outdisk\n"
24436 " # truncate -s 10G outdisk\n"
24441 #: ../resize/virt-resize.pod:115
24442 msgid "Or use L<lvcreate(1)> to create a logical volume:"
24446 #: ../resize/virt-resize.pod:117
24449 " # lvcreate -L 10G -n lv_name vg_name\n"
24454 #: ../resize/virt-resize.pod:119
24455 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
24459 #: ../resize/virt-resize.pod:121
24462 " # virsh pool-list\n"
24463 " # virsh vol-create-as poolname newvol 10G\n"
24468 #: ../resize/virt-resize.pod:124
24473 #: ../resize/virt-resize.pod:126
24475 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
24476 "file) and the output disk. The output disk is the one created in the "
24481 #: ../resize/virt-resize.pod:130
24484 " # virt-resize indisk outdisk\n"
24489 #: ../resize/virt-resize.pod:132
24491 "This command just copies disk image C<indisk> to disk image C<outdisk> "
24492 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
24493 "larger, then an extra, empty partition is created at the end of the disk "
24494 "covering the extra space. If C<outdisk> is smaller, then it will give an "
24499 #: ../resize/virt-resize.pod:138
24501 "More realistically you'd want to expand existing partitions in the disk "
24502 "image by passing extra options (for the full list see the L</OPTIONS> "
24507 #: ../resize/virt-resize.pod:142
24509 "L</--expand> is the most useful option. It expands the named partition "
24510 "within the disk to fill any extra space:"
24514 #: ../resize/virt-resize.pod:145
24517 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
24522 #: ../resize/virt-resize.pod:147
24524 "(In this case, an extra partition is I<not> created at the end of the disk, "
24525 "because there will be no unused space)."
24529 #: ../resize/virt-resize.pod:150
24531 "L</--resize> is the other commonly used option. The following would "
24532 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
24533 "rest of the available space:"
24537 #: ../resize/virt-resize.pod:154
24540 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
24541 " indisk outdisk\n"
24546 #: ../resize/virt-resize.pod:157
24548 "If the expanded partition in the image contains a filesystem or LVM PV, then "
24549 "if virt-resize knows how, it will resize the contents, the equivalent of "
24550 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
24551 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
24552 "filesystems, so you would have to online resize them after booting the guest."
24556 #: ../resize/virt-resize.pod:164
24557 msgid "Other options are covered below."
24561 #: ../resize/virt-resize.pod:166
24566 #: ../resize/virt-resize.pod:168
24567 msgid "Thoroughly test the new disk image I<before> discarding the old one."
24571 #: ../resize/virt-resize.pod:170
24572 msgid "If you are using libvirt, edit the XML to point at the new disk:"
24576 #: ../resize/virt-resize.pod:172
24579 " # virsh edit guestname\n"
24584 #: ../resize/virt-resize.pod:174
24586 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
24587 "html#elementsDisks>"
24591 #: ../resize/virt-resize.pod:177
24592 msgid "Then start up the domain with the new, resized disk:"
24596 #: ../resize/virt-resize.pod:179
24599 " # virsh start guestname\n"
24604 #: ../resize/virt-resize.pod:181
24606 "and check that it still works. See also the L</NOTES> section below for "
24607 "additional information."
24611 #: ../resize/virt-resize.pod:184
24612 msgid "7. Resize LVs etc inside the guest"
24616 #: ../resize/virt-resize.pod:186
24617 msgid "(This can also be done offline using L<guestfish(1)>)"
24621 #: ../resize/virt-resize.pod:188
24623 "Once the guest has booted you should see the new space available, at least "
24624 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
24625 "may need to resize LVs inside PVs, and also resize filesystem types that "
24626 "virt-resize does not know how to expand."
24630 #: ../resize/virt-resize.pod:195
24631 msgid "SHRINKING A VIRTUAL MACHINE DISK"
24635 #: ../resize/virt-resize.pod:197
24637 "Shrinking is somewhat more complex than expanding, and only an overview is "
24642 #: ../resize/virt-resize.pod:200
24644 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
24645 "filesystems). The user has to shrink content before passing the disk image "
24646 "to virt-resize, and virt-resize will check that the content has been shrunk "
24651 #: ../resize/virt-resize.pod:205
24652 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
24656 #: ../resize/virt-resize.pod:207
24658 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
24659 "steps 3 and 4 above to allocate a new disk image."
24663 #: ../resize/virt-resize.pod:210
24665 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
24669 #: ../resize/virt-resize.pod:213
24670 msgid "IGNORING OR DELETING PARTITIONS"
24674 #: ../resize/virt-resize.pod:215
24676 "virt-resize also gives a convenient way to ignore or delete partitions when "
24677 "copying from the input disk to the output disk. Ignoring a partition speeds "
24678 "up the copy where you don't care about the existing contents of a "
24679 "partition. Deleting a partition removes it completely, but note that it "
24680 "also renumbers any partitions after the one which is deleted, which can "
24681 "leave some guests unbootable."
24685 #: ../resize/virt-resize.pod:222
24686 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
24690 #: ../resize/virt-resize.pod:224
24692 "If the input disk is in qcow2 format, then you may prefer that the output is "
24693 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
24694 "the fly. The output format is simply determined by the format of the empty "
24695 "output container that you provide. Thus to create qcow2 output, use:"
24699 #: ../resize/virt-resize.pod:230
24702 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
24707 #: ../resize/virt-resize.pod:232
24708 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
24712 #: ../resize/virt-resize.pod:234
24713 msgid "Similarly, to get non-sparse raw output use:"
24717 #: ../resize/virt-resize.pod:236
24720 " fallocate -l size outdisk\n"
24725 #: ../resize/virt-resize.pod:238
24727 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
24728 "dev/zero of=outdisk bs=1M count=..>)"
24732 #: ../resize/virt-resize.pod:241
24733 msgid "LOGICAL PARTITIONS"
24737 #: ../resize/virt-resize.pod:243
24739 "Logical partitions (a.k.a. C</dev/sda5+> on disks using DOS partition "
24740 "tables) cannot be resized."
24744 #: ../resize/virt-resize.pod:246
24746 "To understand what is going on, firstly one of the four partitions C</dev/"
24747 "sda1-4> will have MBR partition type C<05> or C<0f>. This is called the "
24748 "B<extended partition>. Use L<virt-filesystems(1)> to see the MBR partition "
24753 #: ../resize/virt-resize.pod:251
24754 msgid "Logical partitions live inside the extended partition."
24758 #: ../resize/virt-resize.pod:253
24760 "The extended partition can be expanded, but not shrunk (unless you force it, "
24761 "which is not advisable). When the extended partition is copied across, all "
24762 "the logical partitions contained inside are copied over implicitly. Virt-"
24763 "resize does not look inside the extended partition, so it copies the logical "
24764 "partitions blindly."
24768 #: ../resize/virt-resize.pod:259
24770 "You cannot specify a logical partition (C</dev/sda5+>) at all on the command "
24771 "line. Doing so will give an error."
24775 #: ../resize/virt-resize.pod:268 ../sparsify/virt-sparsify.pod:105
24776 msgid "Display help."
24780 #: ../resize/virt-resize.pod:270
24781 msgid "B<--align-first auto>"
24785 #: ../resize/virt-resize.pod:272
24786 msgid "B<--align-first never>"
24790 #: ../resize/virt-resize.pod:274
24791 msgid "B<--align-first always>"
24795 #: ../resize/virt-resize.pod:276
24797 "Align the first partition for improved performance (see also the I<--"
24798 "alignment> option)."
24802 #: ../resize/virt-resize.pod:279
24804 "The default is I<--align-first auto> which only aligns the first partition "
24805 "if it is safe to do so. That is, only when we know how to fix the "
24806 "bootloader automatically, and at the moment that can only be done for "
24811 #: ../resize/virt-resize.pod:284
24813 "I<--align-first never> means we never move the first partition. This is the "
24814 "safest option. Try this if the guest does not boot after resizing."
24818 #: ../resize/virt-resize.pod:288
24820 "I<--align-first always> means we always align the first partition (if it "
24821 "needs to be aligned). For some guests this will break the bootloader, "
24822 "making the guest unbootable."
24826 #: ../resize/virt-resize.pod:292
24827 msgid "B<--alignment N>"
24831 #: ../resize/virt-resize.pod:294
24833 "Set the alignment of partitions to C<N> sectors. The default in virt-resize "
24834 "E<lt> 1.13.19 was 64 sectors, and after that is 128 sectors."
24838 #: ../resize/virt-resize.pod:298
24840 "Assuming 512 byte sector size inside the guest, here are some suitable "
24845 #: ../resize/virt-resize.pod:303
24846 msgid "I<--alignment 1> (512 bytes)"
24850 #: ../resize/virt-resize.pod:305
24852 "The partitions would be packed together as closely as possible, but would be "
24853 "completely unaligned. In some cases this can cause very poor performance. "
24854 "See L<virt-alignment-scan(1)> for further details."
24858 #: ../resize/virt-resize.pod:309
24859 msgid "I<--alignment 8> (4K)"
24863 #: ../resize/virt-resize.pod:311
24865 "This would be the minimum acceptable alignment for reasonable performance on "
24870 #: ../resize/virt-resize.pod:314
24871 msgid "I<--alignment 128> (64K)"
24875 #: ../resize/virt-resize.pod:316
24877 "This alignment provides good performance when the host is using high end "
24882 #: ../resize/virt-resize.pod:319
24883 msgid "I<--alignment 2048> (1M)"
24887 #: ../resize/virt-resize.pod:321
24889 "This is the standard alignment used by all newly installed guests since "
24894 #: ../resize/virt-resize.pod:326
24899 #: ../resize/virt-resize.pod:328 ../tools/virt-make-fs.pl:177
24900 #: ../tools/virt-win-reg.pl:120
24905 #: ../resize/virt-resize.pod:330 ../tools/virt-win-reg.pl:122
24906 msgid "Enable debugging messages."
24910 #: ../resize/virt-resize.pod:332 ../sparsify/virt-sparsify.pod:131
24911 msgid "B<--debug-gc>"
24915 #: ../resize/virt-resize.pod:334
24917 "Debug garbage collection and memory allocation. This is only useful when "
24918 "debugging memory problems in virt-resize or the OCaml libguestfs bindings."
24922 #: ../resize/virt-resize.pod:338
24923 msgid "B<--delete part>"
24927 #: ../resize/virt-resize.pod:340
24929 "Delete the named partition. It would be more accurate to describe this as "
24930 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
24931 "the original disk image is left intact."
24935 #: ../resize/virt-resize.pod:344
24937 "Note that when you delete a partition, then anything contained in the "
24938 "partition is also deleted. Furthermore, this causes any partitions that "
24939 "come after to be I<renumbered>, which can easily make your guest unbootable."
24943 #: ../resize/virt-resize.pod:349 ../resize/virt-resize.pod:410
24944 #: ../resize/virt-resize.pod:537 ../sparsify/virt-sparsify.pod:157
24945 msgid "You can give this option multiple times."
24949 #: ../resize/virt-resize.pod:351
24950 msgid "B<--expand part>"
24954 #: ../resize/virt-resize.pod:353
24956 "Expand the named partition so it uses up all extra space (space left over "
24957 "after any other resize changes that you request have been done)."
24961 #: ../resize/virt-resize.pod:356
24963 "If virt-resize knows how, it will expand the direct content of the "
24964 "partition. For example, if the partition is an LVM PV, it will expand the "
24965 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
24966 "content it doesn't know about alone."
24970 #: ../resize/virt-resize.pod:361
24971 msgid "Currently virt-resize can resize:"
24975 #: ../resize/virt-resize.pod:367
24976 msgid "ext2, ext3 and ext4 filesystems."
24980 #: ../resize/virt-resize.pod:371
24981 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
24985 #: ../resize/virt-resize.pod:373
24987 "The filesystem must have been shut down consistently last time it was used. "
24988 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
24989 "consistency check, so at the first boot after resizing Windows will check "
24994 #: ../resize/virt-resize.pod:380
24996 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
24997 "inside the PV, but see the I<--LV-expand> option. The user could also "
24998 "resize LVs as desired after boot."
25002 #: ../resize/virt-resize.pod:386
25003 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
25007 #: ../resize/virt-resize.pod:390 ../resize/virt-resize.pod:565
25008 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
25012 #: ../resize/virt-resize.pod:392 ../sparsify/virt-sparsify.pod:137
25013 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92
25014 #: ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
25015 msgid "B<--format> raw"
25019 #: ../resize/virt-resize.pod:394 ../sparsify/virt-sparsify.pod:141
25021 "Specify the format of the input disk image. If this flag is not given then "
25022 "it is auto-detected from the image itself."
25026 #: ../resize/virt-resize.pod:400
25028 "Note that this option I<does not> affect the output format. See L</QCOW2 "
25029 "AND NON-SPARSE RAW FORMATS>."
25033 #: ../resize/virt-resize.pod:403
25034 msgid "B<--ignore part>"
25038 #: ../resize/virt-resize.pod:405
25040 "Ignore the named partition. Effectively this means the partition is "
25041 "allocated on the destination disk, but the content is not copied across from "
25042 "the source disk. The content of the partition will be blank (all zero "
25047 #: ../resize/virt-resize.pod:412
25048 msgid "B<--LV-expand logvol>"
25052 #: ../resize/virt-resize.pod:414
25054 "This takes the logical volume and, as a final step, expands it to fill all "
25055 "the space available in its volume group. A typical usage, assuming a Linux "
25056 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
25057 "lv_root> would be:"
25061 #: ../resize/virt-resize.pod:419
25064 " virt-resize indisk outdisk \\\n"
25065 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
25070 #: ../resize/virt-resize.pod:422
25072 "This would first expand the partition (and PV), and then expand the root "
25073 "device to fill the extra space in the PV."
25077 #: ../resize/virt-resize.pod:425
25079 "The contents of the LV are also resized if virt-resize knows how to do "
25080 "that. You can stop virt-resize from trying to expand the content by using "
25081 "the option I<--no-expand-content>."
25085 #: ../resize/virt-resize.pod:429
25086 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
25090 #: ../resize/virt-resize.pod:431
25092 "You can give this option multiple times, I<but> it doesn't make sense to do "
25093 "this unless the logical volumes you specify are all in different volume "
25098 #: ../resize/virt-resize.pod:435 ../sparsify/virt-sparsify.pod:159
25099 msgid "B<--machine-readable>"
25103 #: ../resize/virt-resize.pod:437 ../sparsify/virt-sparsify.pod:161
25105 "This option is used to make the output more machine friendly when being "
25106 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
25110 #: ../resize/virt-resize.pod:443
25111 msgid "B<--dryrun>"
25115 #: ../resize/virt-resize.pod:445
25116 msgid "Print a summary of what would be done, but don't do anything."
25120 #: ../resize/virt-resize.pod:447
25121 msgid "B<--no-copy-boot-loader>"
25125 #: ../resize/virt-resize.pod:449
25127 "By default, virt-resize copies over some sectors at the start of the disk "
25128 "(up to the beginning of the first partition). Commonly these sectors "
25129 "contain the Master Boot Record (MBR) and the boot loader, and are required "
25130 "in order for the guest to boot correctly."
25134 #: ../resize/virt-resize.pod:454
25136 "If you specify this flag, then this initial copy is not done. You may need "
25137 "to reinstall the boot loader in this case."
25141 #: ../resize/virt-resize.pod:457
25142 msgid "B<--no-extra-partition>"
25146 #: ../resize/virt-resize.pod:459
25148 "By default, virt-resize creates an extra partition if there is any extra, "
25149 "unused space after all resizing has happened. Use this option to prevent "
25150 "the extra partition from being created. If you do this then the extra space "
25151 "will be inaccessible until you run fdisk, parted, or some other partitioning "
25152 "tool in the guest."
25156 #: ../resize/virt-resize.pod:465
25158 "Note that if the surplus space is smaller than 10 MB, no extra partition "
25163 #: ../resize/virt-resize.pod:468
25164 msgid "B<--no-expand-content>"
25168 #: ../resize/virt-resize.pod:470
25170 "By default, virt-resize will try to expand the direct contents of "
25171 "partitions, if it knows how (see I<--expand> option above)."
25175 #: ../resize/virt-resize.pod:473
25177 "If you give the I<--no-expand-content> option then virt-resize will not "
25182 #: ../resize/virt-resize.pod:476
25183 msgid "B<--ntfsresize-force>"
25187 #: ../resize/virt-resize.pod:478
25189 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
25190 "the NTFS disk is marked as needing a consistency check. You have to use "
25191 "this option if you want to resize a Windows guest multiple times without "
25192 "booting into Windows between each resize."
25196 #: ../resize/virt-resize.pod:484
25197 msgid "B<--output-format> raw"
25201 #: ../resize/virt-resize.pod:486
25203 "Specify the format of the output disk image. If this flag is not given then "
25204 "it is auto-detected from the image itself."
25208 #: ../resize/virt-resize.pod:492
25210 "Note that this option I<does not create> the output format. This option "
25211 "just tells libguestfs what it is so it doesn't try to guess it. You still "
25212 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
25213 "SPARSE RAW FORMATS>."
25217 #: ../resize/virt-resize.pod:501
25218 msgid "Don't print the summary."
25222 #: ../resize/virt-resize.pod:503
25223 msgid "B<--resize part=size>"
25227 #: ../resize/virt-resize.pod:505
25229 "Resize the named partition (expanding or shrinking it) so that it has the "
25234 #: ../resize/virt-resize.pod:508
25236 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
25237 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
25238 "size; or as a relative number or percentage. For example:"
25242 #: ../resize/virt-resize.pod:514
25245 " --resize /dev/sda2=10G\n"
25250 #: ../resize/virt-resize.pod:516
25253 " --resize /dev/sda4=90%\n"
25258 #: ../resize/virt-resize.pod:518
25261 " --resize /dev/sda2=+1G\n"
25266 #: ../resize/virt-resize.pod:520
25269 " --resize /dev/sda2=-200M\n"
25274 #: ../resize/virt-resize.pod:522
25277 " --resize /dev/sda1=+128K\n"
25282 #: ../resize/virt-resize.pod:524
25285 " --resize /dev/sda1=+10%\n"
25290 #: ../resize/virt-resize.pod:526
25293 " --resize /dev/sda1=-10%\n"
25298 #: ../resize/virt-resize.pod:528
25300 "You can increase the size of any partition. Virt-resize will expand the "
25301 "direct content of the partition if it knows how (see I<--expand> below)."
25305 #: ../resize/virt-resize.pod:532
25307 "You can only I<decrease> the size of partitions that contain filesystems or "
25308 "PVs which have already been shrunk. Virt-resize will check this has been "
25309 "done before proceeding, or else will print an error (see also I<--resize-"
25314 #: ../resize/virt-resize.pod:539
25315 msgid "B<--resize-force part=size>"
25319 #: ../resize/virt-resize.pod:541
25321 "This is the same as I<--resize> except that it will let you decrease the "
25322 "size of any partition. Generally this means you will lose any data which "
25323 "was at the end of the partition you shrink, but you may not care about that "
25324 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
25325 "as a swap partition)."
25329 #: ../resize/virt-resize.pod:547
25330 msgid "See also the I<--ignore> option."
25334 #: ../resize/virt-resize.pod:549
25335 msgid "B<--shrink part>"
25339 #: ../resize/virt-resize.pod:551
25341 "Shrink the named partition until the overall disk image fits in the "
25342 "destination. The named partition B<must> contain a filesystem or PV which "
25343 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
25344 "online tools). Virt-resize will check this and give an error if it has not "
25349 #: ../resize/virt-resize.pod:557
25351 "The amount by which the overall disk must be shrunk (after carrying out all "
25352 "other operations requested by the user) is called the \"deficit\". For "
25353 "example, a straight copy (assume no other operations) from a 5GB disk image "
25354 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
25355 "would give an error unless the user specified a partition to shrink and that "
25356 "partition had more than a gigabyte of free space."
25360 #: ../resize/virt-resize.pod:575 ../sparsify/virt-sparsify.pod:201
25361 msgid "MACHINE READABLE OUTPUT"
25365 #: ../resize/virt-resize.pod:577
25367 "The I<--machine-readable> option can be used to make the output more machine "
25368 "friendly, which is useful when calling virt-resize from other programs, GUIs "
25373 #: ../resize/virt-resize.pod:581 ../sparsify/virt-sparsify.pod:207
25374 msgid "There are two ways to use this option."
25378 #: ../resize/virt-resize.pod:583
25380 "Firstly use the option on its own to query the capabilities of the virt-"
25381 "resize binary. Typical output looks like this:"
25385 #: ../resize/virt-resize.pod:586
25388 " $ virt-resize --machine-readable\n"
25390 " ntfsresize-force\n"
25398 #: ../resize/virt-resize.pod:593 ../sparsify/virt-sparsify.pod:217
25400 "A list of features is printed, one per line, and the program exits with "
25405 #: ../resize/virt-resize.pod:596 ../sparsify/virt-sparsify.pod:220
25407 "Secondly use the option in conjunction with other options to make the "
25408 "regular program output more machine friendly."
25412 #: ../resize/virt-resize.pod:599 ../sparsify/virt-sparsify.pod:223
25413 msgid "At the moment this means:"
25417 #: ../resize/virt-resize.pod:605 ../sparsify/virt-sparsify.pod:229
25419 "Progress bar messages can be parsed from stdout by looking for this regular "
25424 #: ../resize/virt-resize.pod:608 ../sparsify/virt-sparsify.pod:232
25427 " ^[0-9]+/[0-9]+$\n"
25432 #: ../resize/virt-resize.pod:612 ../sparsify/virt-sparsify.pod:236
25434 "The calling program should treat messages sent to stdout (except for "
25435 "progress bar messages) as status messages. They can be logged and/or "
25436 "displayed to the user."
25440 #: ../resize/virt-resize.pod:618
25442 "The calling program should treat messages sent to stderr as error messages. "
25443 "In addition, virt-resize exits with a non-zero status code if there was a "
25448 #: ../resize/virt-resize.pod:624
25450 "Versions of the program prior to 1.13.9 did not support the I<--machine-"
25451 "readable> option and will return an error."
25455 #: ../resize/virt-resize.pod:629
25456 msgid "\"Partition 1 does not end on cylinder boundary.\""
25460 #: ../resize/virt-resize.pod:631
25462 "Virt-resize aligns partitions to multiples of 128 sectors (see the I<--"
25463 "alignment> parameter). Usually this means the partitions will not be "
25464 "aligned to the ancient CHS geometry. However CHS geometry is meaningless "
25465 "for disks manufactured since the early 1990s, and doubly so for virtual hard "
25466 "drives. Alignment of partitions to cylinders is not required by any modern "
25467 "operating system."
25471 #: ../resize/virt-resize.pod:638
25472 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
25476 #: ../resize/virt-resize.pod:640
25478 "In Windows Vista and later versions, Microsoft switched to using a separate "
25479 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
25480 "and C</dev/sda2> is the main (C:) drive. Resizing the first (boot) "
25481 "partition causes the bootloader to fail with C<0xC0000225> error. Resizing "
25482 "the second partition (ie. C: drive) should work."
25486 #: ../resize/virt-resize.pod:647
25488 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
25489 "NTFS partitions have been expanded. This is just a safety check and (unless "
25490 "it find errors) is nothing to worry about."
25494 #: ../resize/virt-resize.pod:651
25495 msgid "GUEST BOOT STUCK AT \"GRUB\""
25499 #: ../resize/virt-resize.pod:653
25501 "If a Linux guest does not boot after resizing, and the boot is stuck after "
25502 "printing C<GRUB> on the console, try reinstalling grub."
25506 #: ../resize/virt-resize.pod:656
25509 " guestfish -i -a newdisk\n"
25510 " ><fs> cat /boot/grub/device.map\n"
25511 " # check the contents of this file are sensible or\n"
25512 " # edit the file if necessary\n"
25513 " ><fs> grub-install / /dev/vda\n"
25519 #: ../resize/virt-resize.pod:663
25521 "For more flexible guest reconfiguration, including if you need to specify "
25522 "other parameters to grub-install, use L<virt-rescue(1)>."
25526 #: ../resize/virt-resize.pod:666
25527 msgid "ALTERNATIVE TOOLS"
25531 #: ../resize/virt-resize.pod:668
25533 "There are several proprietary tools for resizing partitions. We won't "
25534 "mention any here."
25538 #: ../resize/virt-resize.pod:671
25540 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
25541 "operations on disk images. They can resize and move partitions, but I don't "
25542 "think they can do anything with the contents, and they certainly don't "
25547 #: ../resize/virt-resize.pod:676
25549 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
25550 "but at a much lower level. You will probably end up hand-calculating sector "
25551 "offsets, which is something that virt-resize was designed to avoid. If you "
25552 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
25557 #: ../resize/virt-resize.pod:696
25559 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
25560 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
25561 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
25562 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<virt-sparsify(1)>, "
25563 "L<virt-alignment-scan(1)>, L<http://libguestfs.org/>."
25567 #: ../ruby/examples/guestfs-ruby.pod:5
25568 msgid "guestfs-ruby - How to use libguestfs from Ruby"
25572 #: ../ruby/examples/guestfs-ruby.pod:9
25575 " require 'guestfs'\n"
25576 " g = Guestfs::Guestfs.new()\n"
25577 " g.add_drive_opts(\"disk.img\",\n"
25578 " :readonly => 1, :format => \"raw\")\n"
25584 #: ../ruby/examples/guestfs-ruby.pod:17
25586 "This manual page documents how to call libguestfs from the Ruby programming "
25587 "language. This page just documents the differences from the C API and gives "
25588 "some examples. If you are not familiar with using libguestfs, you also need "
25589 "to read L<guestfs(3)>."
25593 #: ../ruby/examples/guestfs-ruby.pod:24
25595 "Errors from libguestfs functions are mapped into the C<Error> exception. "
25596 "This has a single parameter which is the error message (a string)."
25600 #: ../ruby/examples/guestfs-ruby.pod:38
25602 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
25603 "(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
25604 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
25608 #: ../sparsify/virt-sparsify.pod:5
25609 msgid "virt-sparsify - Make a virtual machine disk sparse"
25613 #: ../sparsify/virt-sparsify.pod:9
25616 " virt-sparsify [--options] indisk outdisk\n"
25621 #: ../sparsify/virt-sparsify.pod:13
25623 "Virt-sparsify is a tool which can make a virtual machine disk (or any disk "
25624 "image) sparse a.k.a. thin-provisioned. This means that free space within "
25625 "the disk image can be converted back to free space on the host."
25629 #: ../sparsify/virt-sparsify.pod:18
25631 "Virt-sparsify can locate and sparsify free space in most filesystems (eg. "
25632 "ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes."
25636 #: ../sparsify/virt-sparsify.pod:21
25638 "Virt-sparsify can also convert between some disk formats, for example "
25639 "converting a raw disk image to a thin-provisioned qcow2 image."
25643 #: ../sparsify/virt-sparsify.pod:24
25645 "Virt-sparsify can operate on any disk image, not just ones from virtual "
25646 "machines. If a virtual machine has more than one attached disk, you must "
25647 "sparsify each one separately."
25651 #: ../sparsify/virt-sparsify.pod:28
25652 msgid "IMPORTANT LIMITATIONS"
25656 #: ../sparsify/virt-sparsify.pod:34
25658 "Virt-sparsify does not do in-place modifications. It copies from a source "
25659 "image to a destination image, leaving the source unchanged. I<Check that "
25660 "the sparsification was successful before deleting the source image>."
25664 #: ../sparsify/virt-sparsify.pod:41
25665 msgid "The virtual machine I<must be shut down> before using this tool."
25669 #: ../sparsify/virt-sparsify.pod:45
25671 "Virt-sparsify may require up to 2x the virtual size of the source disk image "
25672 "(1 temporary copy + 1 destination image). This is in the worst case and "
25673 "usually much less space is required."
25677 #: ../sparsify/virt-sparsify.pod:51
25679 "Virt-sparsify cannot resize disk images. To do that, use L<virt-resize(1)>."
25683 #: ../sparsify/virt-sparsify.pod:56
25684 msgid "Virt-sparsify cannot handle encrypted disks."
25688 #: ../sparsify/virt-sparsify.pod:60
25690 "Virt-sparsify cannot yet sparsify the space between partitions. Note that "
25691 "this space is often used for critical items like bootloaders so it's not "
25696 #: ../sparsify/virt-sparsify.pod:66
25698 "Virt-sparsify does not yet know how to sparsify swapspace. It is not safe "
25699 "to do this unless we can be sure there is no hibernation data, so at the "
25700 "moment swap partitions are ignored."
25704 #: ../sparsify/virt-sparsify.pod:72
25706 "You may also want to read the manual pages for the associated tools L<virt-"
25707 "filesystems(1)> and L<virt-df(1)> before starting."
25711 #: ../sparsify/virt-sparsify.pod:77
25712 msgid "Typical usage is:"
25716 #: ../sparsify/virt-sparsify.pod:79
25719 " virt-sparsify indisk outdisk\n"
25724 #: ../sparsify/virt-sparsify.pod:81
25726 "which copies C<indisk> to C<outdisk>, making the output sparse. C<outdisk> "
25727 "is created, or overwritten if it already exists. The format of the input "
25728 "disk is detected (eg. qcow2) and the same format is used for the output disk."
25732 #: ../sparsify/virt-sparsify.pod:86
25733 msgid "To convert between formats, use the I<--convert> option:"
25737 #: ../sparsify/virt-sparsify.pod:88
25740 " virt-sparsify disk.raw --convert qcow2 disk.qcow2\n"
25745 #: ../sparsify/virt-sparsify.pod:90
25747 "Virt-sparsify tries to zero and sparsify free space on every filesystem it "
25748 "can find within the source disk image. You can get it to ignore (don't zero "
25749 "free space on) certain filesystems by doing:"
25753 #: ../sparsify/virt-sparsify.pod:94
25756 " virt-sparsify --ignore /dev/sda1 indisk outdisk\n"
25761 #: ../sparsify/virt-sparsify.pod:96
25763 "See L<virt-filesystems(1)> to get a list of filesystems within a disk image."
25767 #: ../sparsify/virt-sparsify.pod:107
25768 msgid "B<--compress>"
25772 #: ../sparsify/virt-sparsify.pod:109
25774 "Compress the output file. This I<only> works if the output format is "
25779 #: ../sparsify/virt-sparsify.pod:112
25780 msgid "B<--convert> raw"
25784 #: ../sparsify/virt-sparsify.pod:114
25785 msgid "B<--convert> qcow2"
25789 #: ../sparsify/virt-sparsify.pod:116
25790 msgid "B<--convert> [other formats]"
25794 #: ../sparsify/virt-sparsify.pod:118
25796 "Use C<output-format> as the format for the destination image. If this is "
25797 "not specified, then the input format is used."
25801 #: ../sparsify/virt-sparsify.pod:121
25803 "Supported and known-working output formats are: C<raw>, C<qcow2>, C<vdi>."
25807 #: ../sparsify/virt-sparsify.pod:123
25809 "You can also use any format supported by the L<qemu-img(1)> program, eg. "
25810 "C<vmdk>, but support for other formats is reliant on qemu."
25814 #: ../sparsify/virt-sparsify.pod:126
25816 "Specifying the I<--convert> option is usually a good idea, because then virt-"
25817 "sparsify doesn't need to try to guess the input format."
25821 #: ../sparsify/virt-sparsify.pod:129
25822 msgid "For fine-tuning the output format, see: I<--compress>, I<-o>."
25826 #: ../sparsify/virt-sparsify.pod:133
25828 "Debug garbage collection and memory allocation. This is only useful when "
25829 "debugging memory problems in virt-sparsify or the OCaml libguestfs bindings."
25833 #: ../sparsify/virt-sparsify.pod:139
25834 msgid "B<--format> qcow2"
25838 #: ../sparsify/virt-sparsify.pod:147
25839 msgid "B<--ignore> filesystem"
25843 #: ../sparsify/virt-sparsify.pod:149
25844 msgid "B<--ignore> volgroup"
25848 #: ../sparsify/virt-sparsify.pod:151
25850 "Ignore the named filesystem. Free space on the filesystem will not be "
25851 "zeroed, but existing blocks of zeroes will still be sparsified."
25855 #: ../sparsify/virt-sparsify.pod:154
25857 "In the second form, this ignores the named volume group. Use the volume "
25858 "group name without the C</dev/> prefix, eg. I<--ignore vg_foo>"
25862 #: ../sparsify/virt-sparsify.pod:165
25863 msgid "B<-o> option[,option,...]"
25867 #: ../sparsify/virt-sparsify.pod:167
25869 "Pass I<-o> option(s) to the L<qemu-img(1)> command to fine-tune the output "
25870 "format. Options available depend on the output format (see I<--convert>) "
25871 "and the installed version of the qemu-img program."
25875 #: ../sparsify/virt-sparsify.pod:171
25877 "You should use I<-o> at most once. To pass multiple options, separate them "
25882 #: ../sparsify/virt-sparsify.pod:174
25885 " virt-sparsify --convert qcow2 \\\n"
25886 " -o cluster_size=512,preallocation=metadata ...\n"
25891 #: ../sparsify/virt-sparsify.pod:181
25892 msgid "This disables progress bars and other unnecessary output."
25896 #: ../sparsify/virt-sparsify.pod:203
25898 "The I<--machine-readable> option can be used to make the output more machine "
25899 "friendly, which is useful when calling virt-sparsify from other programs, "
25904 #: ../sparsify/virt-sparsify.pod:209
25906 "Firstly use the option on its own to query the capabilities of the virt-"
25907 "sparsify binary. Typical output looks like this:"
25911 #: ../sparsify/virt-sparsify.pod:212
25914 " $ virt-sparsify --machine-readable\n"
25922 #: ../sparsify/virt-sparsify.pod:242
25924 "The calling program should treat messages sent to stderr as error messages. "
25925 "In addition, virt-sparsify exits with a non-zero status code if there was a "
25930 #: ../sparsify/virt-sparsify.pod:248
25932 "All versions of virt-sparsify have supported the I<--machine-readable> "
25937 #: ../sparsify/virt-sparsify.pod:262
25939 "Location of the temporary directory used for the potentially large temporary "
25944 #: ../sparsify/virt-sparsify.pod:265
25946 "You should ensure there is enough free space in the worst case for a full "
25947 "copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point "
25948 "to another directory that has enough space."
25952 #: ../sparsify/virt-sparsify.pod:269
25953 msgid "This defaults to C</tmp>."
25957 #: ../sparsify/virt-sparsify.pod:273
25959 "For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>."
25963 #: ../sparsify/virt-sparsify.pod:277
25965 "L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>, "
25966 "L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>, L<qemu-img"
25967 "(1)>, L<http://libguestfs.org/>."
25971 #: ../src/guestfs-actions.pod:1
25972 msgid "guestfs_add_cdrom"
25976 #: ../src/guestfs-actions.pod:3
25980 " guestfs_add_cdrom (guestfs_h *g,\n"
25981 " const char *filename);\n"
25986 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:302
25987 #: ../src/guestfs-actions.pod:323
25989 "I<This function is deprecated.> In new code, use the L</"
25990 "guestfs_add_drive_opts> call instead."
25994 #: ../src/guestfs-actions.pod:24
25996 "This call checks for the existence of C<filename>. This stops you from "
25997 "specifying other types of drive which are supported by qemu such as C<nbd:> "
25998 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
26003 #: ../src/guestfs-actions.pod:31
26005 "If you just want to add an ISO file (often you use this as an efficient way "
26006 "to transfer large files into the guest), then you should probably use "
26007 "C<guestfs_add_drive_ro> instead."
26011 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:187
26012 #: ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:291
26013 #: ../src/guestfs-actions.pod:312 ../src/guestfs-actions.pod:333
26014 #: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
26015 #: ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:500
26016 #: ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:559
26017 #: ../src/guestfs-actions.pod:587 ../src/guestfs-actions.pod:605
26018 #: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:705
26019 #: ../src/guestfs-actions.pod:719 ../src/guestfs-actions.pod:773
26020 #: ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:890
26021 #: ../src/guestfs-actions.pod:904 ../src/guestfs-actions.pod:918
26022 #: ../src/guestfs-actions.pod:955 ../src/guestfs-actions.pod:1138
26023 #: ../src/guestfs-actions.pod:1158 ../src/guestfs-actions.pod:1176
26024 #: ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1325
26025 #: ../src/guestfs-actions.pod:1371 ../src/guestfs-actions.pod:1411
26026 #: ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1517
26027 #: ../src/guestfs-actions.pod:1575 ../src/guestfs-actions.pod:1629
26028 #: ../src/guestfs-actions.pod:1648 ../src/guestfs-actions.pod:1662
26029 #: ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1760
26030 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1816
26031 #: ../src/guestfs-actions.pod:1858 ../src/guestfs-actions.pod:1971
26032 #: ../src/guestfs-actions.pod:1998 ../src/guestfs-actions.pod:2213
26033 #: ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:2322
26034 #: ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2974
26035 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3070
26036 #: ../src/guestfs-actions.pod:4131 ../src/guestfs-actions.pod:4146
26037 #: ../src/guestfs-actions.pod:4171 ../src/guestfs-actions.pod:4373
26038 #: ../src/guestfs-actions.pod:4387 ../src/guestfs-actions.pod:4400
26039 #: ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4429
26040 #: ../src/guestfs-actions.pod:4465 ../src/guestfs-actions.pod:4537
26041 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4574
26042 #: ../src/guestfs-actions.pod:4594 ../src/guestfs-actions.pod:4614
26043 #: ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4668
26044 #: ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4722
26045 #: ../src/guestfs-actions.pod:4734 ../src/guestfs-actions.pod:4767
26046 #: ../src/guestfs-actions.pod:4783 ../src/guestfs-actions.pod:4796
26047 #: ../src/guestfs-actions.pod:4811 ../src/guestfs-actions.pod:4828
26048 #: ../src/guestfs-actions.pod:4986 ../src/guestfs-actions.pod:5060
26049 #: ../src/guestfs-actions.pod:5070 ../src/guestfs-actions.pod:5090
26050 #: ../src/guestfs-actions.pod:5103 ../src/guestfs-actions.pod:5154
26051 #: ../src/guestfs-actions.pod:5172 ../src/guestfs-actions.pod:5190
26052 #: ../src/guestfs-actions.pod:5206 ../src/guestfs-actions.pod:5220
26053 #: ../src/guestfs-actions.pod:5234 ../src/guestfs-actions.pod:5251
26054 #: ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5293
26055 #: ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5429
26056 #: ../src/guestfs-actions.pod:5460 ../src/guestfs-actions.pod:5479
26057 #: ../src/guestfs-actions.pod:5498 ../src/guestfs-actions.pod:5510
26058 #: ../src/guestfs-actions.pod:5527 ../src/guestfs-actions.pod:5540
26059 #: ../src/guestfs-actions.pod:5555 ../src/guestfs-actions.pod:5570
26060 #: ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5628
26061 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5687
26062 #: ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5718
26063 #: ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:5820
26064 #: ../src/guestfs-actions.pod:5867 ../src/guestfs-actions.pod:5910
26065 #: ../src/guestfs-actions.pod:5938 ../src/guestfs-actions.pod:5955
26066 #: ../src/guestfs-actions.pod:5973 ../src/guestfs-actions.pod:6110
26067 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6189
26068 #: ../src/guestfs-actions.pod:6207 ../src/guestfs-actions.pod:6259
26069 #: ../src/guestfs-actions.pod:6325 ../src/guestfs-actions.pod:6342
26070 #: ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6369
26071 #: ../src/guestfs-actions.pod:6658 ../src/guestfs-actions.pod:6677
26072 #: ../src/guestfs-actions.pod:6696 ../src/guestfs-actions.pod:6710
26073 #: ../src/guestfs-actions.pod:6722 ../src/guestfs-actions.pod:6736
26074 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6762
26075 #: ../src/guestfs-actions.pod:6778 ../src/guestfs-actions.pod:6796
26076 #: ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6834
26077 #: ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:6882
26078 #: ../src/guestfs-actions.pod:6905 ../src/guestfs-actions.pod:6923
26079 #: ../src/guestfs-actions.pod:6942 ../src/guestfs-actions.pod:6963
26080 #: ../src/guestfs-actions.pod:6982 ../src/guestfs-actions.pod:6999
26081 #: ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7046
26082 #: ../src/guestfs-actions.pod:7070 ../src/guestfs-actions.pod:7089
26083 #: ../src/guestfs-actions.pod:7105 ../src/guestfs-actions.pod:7129
26084 #: ../src/guestfs-actions.pod:7148 ../src/guestfs-actions.pod:7163
26085 #: ../src/guestfs-actions.pod:7182 ../src/guestfs-actions.pod:7226
26086 #: ../src/guestfs-actions.pod:7253 ../src/guestfs-actions.pod:7283
26087 #: ../src/guestfs-actions.pod:7395 ../src/guestfs-actions.pod:7516
26088 #: ../src/guestfs-actions.pod:7528 ../src/guestfs-actions.pod:7541
26089 #: ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7576
26090 #: ../src/guestfs-actions.pod:7589 ../src/guestfs-actions.pod:7602
26091 #: ../src/guestfs-actions.pod:7615 ../src/guestfs-actions.pod:7630
26092 #: ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7706
26093 #: ../src/guestfs-actions.pod:7722 ../src/guestfs-actions.pod:7738
26094 #: ../src/guestfs-actions.pod:7755 ../src/guestfs-actions.pod:7768
26095 #: ../src/guestfs-actions.pod:7788 ../src/guestfs-actions.pod:7888
26096 #: ../src/guestfs-actions.pod:7946 ../src/guestfs-actions.pod:7960
26097 #: ../src/guestfs-actions.pod:8001 ../src/guestfs-actions.pod:8014
26098 #: ../src/guestfs-actions.pod:8032 ../src/guestfs-actions.pod:8066
26099 #: ../src/guestfs-actions.pod:8102 ../src/guestfs-actions.pod:8218
26100 #: ../src/guestfs-actions.pod:8233 ../src/guestfs-actions.pod:8247
26101 #: ../src/guestfs-actions.pod:8302 ../src/guestfs-actions.pod:8315
26102 #: ../src/guestfs-actions.pod:8360 ../src/guestfs-actions.pod:8400
26103 #: ../src/guestfs-actions.pod:8456 ../src/guestfs-actions.pod:8476
26104 #: ../src/guestfs-actions.pod:8509 ../src/guestfs-actions.pod:8573
26105 #: ../src/guestfs-actions.pod:8596 ../src/guestfs-actions.pod:8622
26106 msgid "This function returns 0 on success or -1 on error."
26110 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:189
26111 #: ../src/guestfs-actions.pod:1373 ../src/guestfs-actions.pod:2436
26112 #: ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2659
26113 #: ../src/guestfs-actions.pod:4133 ../src/guestfs-actions.pod:4153
26114 #: ../src/guestfs-actions.pod:5604 ../src/guestfs-actions.pod:6884
26115 #: ../src/guestfs-actions.pod:7001 ../src/guestfs-actions.pod:7150
26116 #: ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7757
26117 #: ../src/guestfs-actions.pod:8402
26118 msgid "(Added in 0.3)"
26122 #: ../src/guestfs-actions.pod:41
26123 msgid "guestfs_add_domain"
26127 #: ../src/guestfs-actions.pod:43
26131 " guestfs_add_domain (guestfs_h *g,\n"
26132 " const char *dom,\n"
26138 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:198
26139 #: ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:1253
26140 #: ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:1383
26141 #: ../src/guestfs-actions.pod:1452 ../src/guestfs-actions.pod:1505
26142 #: ../src/guestfs-actions.pod:1558 ../src/guestfs-actions.pod:3327
26143 #: ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:5305
26144 #: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5831
26145 #: ../src/guestfs-actions.pod:7799
26147 "You may supply a list of optional arguments to this call. Use zero or more "
26148 "of the following pairs of parameters, and terminate the list with C<-1> on "
26149 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
26153 #: ../src/guestfs-actions.pod:53
26156 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
26157 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
26158 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
26159 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
26160 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
26161 " GUESTFS_ADD_DOMAIN_READONLYDISK, const char *readonlydisk,\n"
26166 #: ../src/guestfs-actions.pod:60
26168 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
26169 "It works by connecting to libvirt, requesting the domain and domain XML from "
26170 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
26175 #: ../src/guestfs-actions.pod:141
26177 "The other optional parameters are passed directly through to "
26178 "C<guestfs_add_drive_opts>."
26182 #: ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:403
26183 #: ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:790
26184 #: ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:839
26185 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1836
26186 #: ../src/guestfs-actions.pod:2192 ../src/guestfs-actions.pod:2395
26187 #: ../src/guestfs-actions.pod:2506 ../src/guestfs-actions.pod:2557
26188 #: ../src/guestfs-actions.pod:2609 ../src/guestfs-actions.pod:2623
26189 #: ../src/guestfs-actions.pod:2646 ../src/guestfs-actions.pod:2961
26190 #: ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:3463
26191 #: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:6007
26192 #: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:6439
26193 #: ../src/guestfs-actions.pod:6465 ../src/guestfs-actions.pod:7987
26194 #: ../src/guestfs-actions.pod:8413 ../src/guestfs-actions.pod:8426
26195 #: ../src/guestfs-actions.pod:8439
26196 msgid "On error this function returns -1."
26200 #: ../src/guestfs-actions.pod:146
26201 msgid "(Added in 1.7.4)"
26205 #: ../src/guestfs-actions.pod:148
26206 msgid "guestfs_add_domain_va"
26210 #: ../src/guestfs-actions.pod:150
26214 " guestfs_add_domain_va (guestfs_h *g,\n"
26215 " const char *dom,\n"
26216 " va_list args);\n"
26221 #: ../src/guestfs-actions.pod:155
26222 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
26226 #: ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:168
26227 #: ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:278
26228 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:979
26229 #: ../src/guestfs-actions.pod:1281 ../src/guestfs-actions.pod:1294
26230 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1353
26231 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1442
26232 #: ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1495
26233 #: ../src/guestfs-actions.pod:1536 ../src/guestfs-actions.pod:1548
26234 #: ../src/guestfs-actions.pod:1594 ../src/guestfs-actions.pod:1606
26235 #: ../src/guestfs-actions.pod:3411 ../src/guestfs-actions.pod:3423
26236 #: ../src/guestfs-actions.pod:4998 ../src/guestfs-actions.pod:5010
26237 #: ../src/guestfs-actions.pod:5370 ../src/guestfs-actions.pod:5382
26238 #: ../src/guestfs-actions.pod:5642 ../src/guestfs-actions.pod:5654
26239 #: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5891
26240 #: ../src/guestfs-actions.pod:7901 ../src/guestfs-actions.pod:7912
26241 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
26245 #: ../src/guestfs-actions.pod:159
26246 msgid "guestfs_add_domain_argv"
26250 #: ../src/guestfs-actions.pod:161
26254 " guestfs_add_domain_argv (guestfs_h *g,\n"
26255 " const char *dom,\n"
26256 " const struct guestfs_add_domain_argv *optargs);\n"
26261 #: ../src/guestfs-actions.pod:166
26262 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
26266 #: ../src/guestfs-actions.pod:170
26267 msgid "guestfs_add_drive"
26271 #: ../src/guestfs-actions.pod:172
26275 " guestfs_add_drive (guestfs_h *g,\n"
26276 " const char *filename);\n"
26281 #: ../src/guestfs-actions.pod:176
26283 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
26284 "optional parameters, so the disk is added writable, with the format being "
26285 "detected automatically."
26289 #: ../src/guestfs-actions.pod:180
26291 "Automatic detection of the format opens you up to a potential security hole "
26292 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
26293 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
26294 "you should think about replacing calls to this function with calls to "
26295 "C<guestfs_add_drive_opts>, and specifying the format."
26299 #: ../src/guestfs-actions.pod:191
26300 msgid "guestfs_add_drive_opts"
26304 #: ../src/guestfs-actions.pod:193
26308 " guestfs_add_drive_opts (guestfs_h *g,\n"
26309 " const char *filename,\n"
26315 #: ../src/guestfs-actions.pod:203
26318 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
26319 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
26320 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
26321 " GUESTFS_ADD_DRIVE_OPTS_NAME, const char *name,\n"
26326 #: ../src/guestfs-actions.pod:233
26328 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
26329 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
26330 "Possible formats include C<raw> and C<qcow2>."
26334 #: ../src/guestfs-actions.pod:244
26336 "This rarely-used option lets you emulate the behaviour of the deprecated "
26337 "C<guestfs_add_drive_with_if> call (q.v.)"
26341 #: ../src/guestfs-actions.pod:256
26342 msgid "(Added in 1.5.23)"
26346 #: ../src/guestfs-actions.pod:258
26347 msgid "guestfs_add_drive_opts_va"
26351 #: ../src/guestfs-actions.pod:260
26355 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
26356 " const char *filename,\n"
26357 " va_list args);\n"
26362 #: ../src/guestfs-actions.pod:265
26363 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
26367 #: ../src/guestfs-actions.pod:269
26368 msgid "guestfs_add_drive_opts_argv"
26372 #: ../src/guestfs-actions.pod:271
26376 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
26377 " const char *filename,\n"
26378 " const struct guestfs_add_drive_opts_argv *optargs);\n"
26383 #: ../src/guestfs-actions.pod:276
26384 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
26388 #: ../src/guestfs-actions.pod:280
26389 msgid "guestfs_add_drive_ro"
26393 #: ../src/guestfs-actions.pod:282
26397 " guestfs_add_drive_ro (guestfs_h *g,\n"
26398 " const char *filename);\n"
26403 #: ../src/guestfs-actions.pod:286
26405 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
26406 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
26407 "disk is added read-only, with the format being detected automatically."
26411 #: ../src/guestfs-actions.pod:293
26412 msgid "(Added in 1.0.38)"
26416 #: ../src/guestfs-actions.pod:295
26417 msgid "guestfs_add_drive_ro_with_if"
26421 #: ../src/guestfs-actions.pod:297
26425 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
26426 " const char *filename,\n"
26427 " const char *iface);\n"
26432 #: ../src/guestfs-actions.pod:309
26434 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
26435 "QEMU interface emulation to use at run time."
26439 #: ../src/guestfs-actions.pod:314 ../src/guestfs-actions.pod:335
26440 #: ../src/guestfs-actions.pod:2920
26441 msgid "(Added in 1.0.84)"
26445 #: ../src/guestfs-actions.pod:316
26446 msgid "guestfs_add_drive_with_if"
26450 #: ../src/guestfs-actions.pod:318
26454 " guestfs_add_drive_with_if (guestfs_h *g,\n"
26455 " const char *filename,\n"
26456 " const char *iface);\n"
26461 #: ../src/guestfs-actions.pod:330
26463 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
26464 "QEMU interface emulation to use at run time."
26468 #: ../src/guestfs-actions.pod:337
26469 msgid "guestfs_aug_clear"
26473 #: ../src/guestfs-actions.pod:339
26477 " guestfs_aug_clear (guestfs_h *g,\n"
26478 " const char *augpath);\n"
26483 #: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:2648
26484 msgid "(Added in 1.3.4)"
26488 #: ../src/guestfs-actions.pod:350
26489 msgid "guestfs_aug_close"
26493 #: ../src/guestfs-actions.pod:352
26497 " guestfs_aug_close (guestfs_h *g);\n"
26502 #: ../src/guestfs-actions.pod:355
26504 "Close the current Augeas handle and free up any resources used by it. After "
26505 "calling this, you have to call C<guestfs_aug_init> again before you can use "
26506 "any other Augeas functions."
26510 #: ../src/guestfs-actions.pod:362 ../src/guestfs-actions.pod:387
26511 #: ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:419
26512 #: ../src/guestfs-actions.pod:482 ../src/guestfs-actions.pod:502
26513 #: ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:547
26514 #: ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:575
26515 #: ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:607
26516 #: ../src/guestfs-actions.pod:6516
26517 msgid "(Added in 0.7)"
26521 #: ../src/guestfs-actions.pod:364
26522 msgid "guestfs_aug_defnode"
26526 #: ../src/guestfs-actions.pod:366
26529 " struct guestfs_int_bool *\n"
26530 " guestfs_aug_defnode (guestfs_h *g,\n"
26531 " const char *name,\n"
26532 " const char *expr,\n"
26533 " const char *val);\n"
26538 #: ../src/guestfs-actions.pod:375
26540 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
26541 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
26542 "containing that single node."
26546 #: ../src/guestfs-actions.pod:383
26548 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
26549 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
26553 #: ../src/guestfs-actions.pod:389
26554 msgid "guestfs_aug_defvar"
26558 #: ../src/guestfs-actions.pod:391
26562 " guestfs_aug_defvar (guestfs_h *g,\n"
26563 " const char *name,\n"
26564 " const char *expr);\n"
26569 #: ../src/guestfs-actions.pod:407
26570 msgid "guestfs_aug_get"
26574 #: ../src/guestfs-actions.pod:409
26578 " guestfs_aug_get (guestfs_h *g,\n"
26579 " const char *augpath);\n"
26584 #: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:1019
26585 #: ../src/guestfs-actions.pod:1037 ../src/guestfs-actions.pod:1097
26586 #: ../src/guestfs-actions.pod:1113 ../src/guestfs-actions.pod:1216
26587 #: ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1722
26588 #: ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1875
26589 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:2175
26590 #: ../src/guestfs-actions.pod:2338 ../src/guestfs-actions.pod:2355
26591 #: ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2465
26592 #: ../src/guestfs-actions.pod:2486 ../src/guestfs-actions.pod:2671
26593 #: ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:3089
26594 #: ../src/guestfs-actions.pod:3191 ../src/guestfs-actions.pod:3295
26595 #: ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3529
26596 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3578
26597 #: ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:3679
26598 #: ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:3719
26599 #: ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:4706
26600 #: ../src/guestfs-actions.pod:4873 ../src/guestfs-actions.pod:5132
26601 #: ../src/guestfs-actions.pod:6025 ../src/guestfs-actions.pod:6226
26602 #: ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:6592
26603 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:7301
26604 #: ../src/guestfs-actions.pod:7317 ../src/guestfs-actions.pod:7341
26605 #: ../src/guestfs-actions.pod:7365 ../src/guestfs-actions.pod:8161
26606 #: ../src/guestfs-actions.pod:8180 ../src/guestfs-actions.pod:8198
26607 #: ../src/guestfs-actions.pod:8372 ../src/guestfs-actions.pod:8686
26609 "This function returns a string, or NULL on error. I<The caller must free "
26610 "the returned string after use>."
26614 #: ../src/guestfs-actions.pod:421
26615 msgid "guestfs_aug_init"
26619 #: ../src/guestfs-actions.pod:423
26623 " guestfs_aug_init (guestfs_h *g,\n"
26624 " const char *root,\n"
26630 #: ../src/guestfs-actions.pod:432
26631 msgid "You must call this before using any other C<guestfs_aug_*> commands."
26635 #: ../src/guestfs-actions.pod:457
26637 "This option is only useful when debugging Augeas lenses. Use of this option "
26638 "may require additional memory for the libguestfs appliance. You may need to "
26639 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
26640 "C<guestfs_set_memsize>."
26644 #: ../src/guestfs-actions.pod:472
26645 msgid "Do not load the tree in C<guestfs_aug_init>."
26649 #: ../src/guestfs-actions.pod:476
26650 msgid "To close the handle, you can call C<guestfs_aug_close>."
26654 #: ../src/guestfs-actions.pod:484
26655 msgid "guestfs_aug_insert"
26659 #: ../src/guestfs-actions.pod:486
26663 " guestfs_aug_insert (guestfs_h *g,\n"
26664 " const char *augpath,\n"
26665 " const char *label,\n"
26671 #: ../src/guestfs-actions.pod:504
26672 msgid "guestfs_aug_load"
26676 #: ../src/guestfs-actions.pod:506
26680 " guestfs_aug_load (guestfs_h *g);\n"
26685 #: ../src/guestfs-actions.pod:518
26686 msgid "guestfs_aug_ls"
26690 #: ../src/guestfs-actions.pod:520
26694 " guestfs_aug_ls (guestfs_h *g,\n"
26695 " const char *augpath);\n"
26700 #: ../src/guestfs-actions.pod:524
26702 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
26703 "sorting the resulting nodes into alphabetical order."
26707 #: ../src/guestfs-actions.pod:527 ../src/guestfs-actions.pod:543
26708 #: ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:1235
26709 #: ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:1909
26710 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2031
26711 #: ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2743
26712 #: ../src/guestfs-actions.pod:2759 ../src/guestfs-actions.pod:2778
26713 #: ../src/guestfs-actions.pod:2843 ../src/guestfs-actions.pod:2867
26714 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2987
26715 #: ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3631
26716 #: ../src/guestfs-actions.pod:3915 ../src/guestfs-actions.pod:4229
26717 #: ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4266
26718 #: ../src/guestfs-actions.pod:4321 ../src/guestfs-actions.pod:4341
26719 #: ../src/guestfs-actions.pod:4446 ../src/guestfs-actions.pod:4845
26720 #: ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:6386
26721 #: ../src/guestfs-actions.pod:6512 ../src/guestfs-actions.pod:6626
26722 #: ../src/guestfs-actions.pod:7381 ../src/guestfs-actions.pod:7442
26723 #: ../src/guestfs-actions.pod:7497 ../src/guestfs-actions.pod:7643
26724 #: ../src/guestfs-actions.pod:7667 ../src/guestfs-actions.pod:8265
26725 #: ../src/guestfs-actions.pod:8285 ../src/guestfs-actions.pod:8332
26726 #: ../src/guestfs-actions.pod:8526 ../src/guestfs-actions.pod:8545
26727 #: ../src/guestfs-actions.pod:8636 ../src/guestfs-actions.pod:8655
26728 #: ../src/guestfs-actions.pod:8701 ../src/guestfs-actions.pod:8720
26730 "This function returns a NULL-terminated array of strings (like L<environ(3)"
26731 ">), or NULL if there was an error. I<The caller must free the strings and "
26732 "the array after use>."
26736 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:1160
26737 #: ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1947
26738 #: ../src/guestfs-actions.pod:3993 ../src/guestfs-actions.pod:4024
26739 #: ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4736
26740 #: ../src/guestfs-actions.pod:5072 ../src/guestfs-actions.pod:5105
26741 #: ../src/guestfs-actions.pod:5268 ../src/guestfs-actions.pod:5755
26742 #: ../src/guestfs-actions.pod:6327 ../src/guestfs-actions.pod:6724
26743 #: ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6750
26744 #: ../src/guestfs-actions.pod:7228 ../src/guestfs-actions.pod:8003
26745 #: ../src/guestfs-actions.pod:8016 ../src/guestfs-actions.pod:8249
26746 #: ../src/guestfs-actions.pod:8514
26747 msgid "(Added in 0.8)"
26751 #: ../src/guestfs-actions.pod:533
26752 msgid "guestfs_aug_match"
26756 #: ../src/guestfs-actions.pod:535
26760 " guestfs_aug_match (guestfs_h *g,\n"
26761 " const char *augpath);\n"
26766 #: ../src/guestfs-actions.pod:549
26767 msgid "guestfs_aug_mv"
26771 #: ../src/guestfs-actions.pod:551
26775 " guestfs_aug_mv (guestfs_h *g,\n"
26776 " const char *src,\n"
26777 " const char *dest);\n"
26782 #: ../src/guestfs-actions.pod:563
26783 msgid "guestfs_aug_rm"
26787 #: ../src/guestfs-actions.pod:565
26791 " guestfs_aug_rm (guestfs_h *g,\n"
26792 " const char *augpath);\n"
26797 #: ../src/guestfs-actions.pod:577
26798 msgid "guestfs_aug_save"
26802 #: ../src/guestfs-actions.pod:579
26806 " guestfs_aug_save (guestfs_h *g);\n"
26811 #: ../src/guestfs-actions.pod:584
26813 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
26818 #: ../src/guestfs-actions.pod:591
26819 msgid "guestfs_aug_set"
26823 #: ../src/guestfs-actions.pod:593
26827 " guestfs_aug_set (guestfs_h *g,\n"
26828 " const char *augpath,\n"
26829 " const char *val);\n"
26834 #: ../src/guestfs-actions.pod:600
26836 "In the Augeas API, it is possible to clear a node by setting the value to "
26837 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
26838 "this call. Instead you must use the C<guestfs_aug_clear> call."
26842 #: ../src/guestfs-actions.pod:609
26843 msgid "guestfs_available"
26847 #: ../src/guestfs-actions.pod:611
26851 " guestfs_available (guestfs_h *g,\n"
26852 " char *const *groups);\n"
26857 #: ../src/guestfs-actions.pod:619
26859 "The libguestfs groups, and the functions that those groups correspond to, "
26860 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
26861 "runtime by calling C<guestfs_available_all_groups>."
26865 #: ../src/guestfs-actions.pod:643
26866 msgid "You must call C<guestfs_launch> before calling this function."
26870 #: ../src/guestfs-actions.pod:665
26872 "This call was added in version C<1.0.80>. In previous versions of "
26873 "libguestfs all you could do would be to speculatively execute a command to "
26874 "find out if the daemon implemented it. See also C<guestfs_version>."
26878 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:1692
26879 msgid "(Added in 1.0.80)"
26883 #: ../src/guestfs-actions.pod:676
26884 msgid "guestfs_available_all_groups"
26888 #: ../src/guestfs-actions.pod:678
26892 " guestfs_available_all_groups (guestfs_h *g);\n"
26897 #: ../src/guestfs-actions.pod:681
26899 "This command returns a list of all optional groups that this daemon knows "
26900 "about. Note this returns both supported and unsupported groups. To find "
26901 "out which ones the daemon can actually support you have to call "
26902 "C<guestfs_available> on each member of the returned list."
26906 #: ../src/guestfs-actions.pod:687
26907 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
26911 #: ../src/guestfs-actions.pod:693
26912 msgid "(Added in 1.3.15)"
26916 #: ../src/guestfs-actions.pod:695
26917 msgid "guestfs_base64_in"
26921 #: ../src/guestfs-actions.pod:697
26925 " guestfs_base64_in (guestfs_h *g,\n"
26926 " const char *base64file,\n"
26927 " const char *filename);\n"
26932 #: ../src/guestfs-actions.pod:707 ../src/guestfs-actions.pod:721
26933 msgid "(Added in 1.3.5)"
26937 #: ../src/guestfs-actions.pod:709
26938 msgid "guestfs_base64_out"
26942 #: ../src/guestfs-actions.pod:711
26946 " guestfs_base64_out (guestfs_h *g,\n"
26947 " const char *filename,\n"
26948 " const char *base64file);\n"
26953 #: ../src/guestfs-actions.pod:723
26954 msgid "guestfs_blkid"
26958 #: ../src/guestfs-actions.pod:725
26962 " guestfs_blkid (guestfs_h *g,\n"
26963 " const char *device);\n"
26968 #: ../src/guestfs-actions.pod:756 ../src/guestfs-actions.pod:3231
26969 #: ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:4306
26970 #: ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5731
26971 #: ../src/guestfs-actions.pod:7928
26973 "This function returns a NULL-terminated array of strings, or NULL if there "
26974 "was an error. The array of strings will always have length C<2n+1>, where "
26975 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
26976 "caller must free the strings and the array after use>."
26980 #: ../src/guestfs-actions.pod:762
26981 msgid "guestfs_blockdev_flushbufs"
26985 #: ../src/guestfs-actions.pod:764
26989 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
26990 " const char *device);\n"
26995 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:792
26996 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:823
26997 #: ../src/guestfs-actions.pod:841 ../src/guestfs-actions.pod:860
26998 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:892
26999 #: ../src/guestfs-actions.pod:906 ../src/guestfs-actions.pod:920
27000 msgid "(Added in 0.9.3)"
27004 #: ../src/guestfs-actions.pod:777
27005 msgid "guestfs_blockdev_getbsz"
27009 #: ../src/guestfs-actions.pod:779
27013 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
27014 " const char *device);\n"
27019 #: ../src/guestfs-actions.pod:794
27020 msgid "guestfs_blockdev_getro"
27024 #: ../src/guestfs-actions.pod:796
27028 " guestfs_blockdev_getro (guestfs_h *g,\n"
27029 " const char *device);\n"
27034 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:1930
27035 #: ../src/guestfs-actions.pod:1945 ../src/guestfs-actions.pod:2434
27036 #: ../src/guestfs-actions.pod:2445 ../src/guestfs-actions.pod:2517
27037 #: ../src/guestfs-actions.pod:2543 ../src/guestfs-actions.pod:2583
27038 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2634
27039 #: ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:3736
27040 #: ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3770
27041 #: ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:3946
27042 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:3975
27043 #: ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:4006
27044 #: ../src/guestfs-actions.pod:4022 ../src/guestfs-actions.pod:4036
27045 #: ../src/guestfs-actions.pod:4049 ../src/guestfs-actions.pod:4063
27046 #: ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:4093
27047 #: ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4120
27048 #: ../src/guestfs-actions.pod:5989
27049 msgid "This function returns a C truth value on success or -1 on error."
27053 #: ../src/guestfs-actions.pod:809
27054 msgid "guestfs_blockdev_getsize64"
27058 #: ../src/guestfs-actions.pod:811
27062 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
27063 " const char *device);\n"
27068 #: ../src/guestfs-actions.pod:817
27069 msgid "See also C<guestfs_blockdev_getsz>."
27073 #: ../src/guestfs-actions.pod:825
27074 msgid "guestfs_blockdev_getss"
27078 #: ../src/guestfs-actions.pod:827
27082 " guestfs_blockdev_getss (guestfs_h *g,\n"
27083 " const char *device);\n"
27088 #: ../src/guestfs-actions.pod:834
27090 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
27095 #: ../src/guestfs-actions.pod:843
27096 msgid "guestfs_blockdev_getsz"
27100 #: ../src/guestfs-actions.pod:845
27104 " guestfs_blockdev_getsz (guestfs_h *g,\n"
27105 " const char *device);\n"
27110 #: ../src/guestfs-actions.pod:852
27112 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
27113 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
27117 #: ../src/guestfs-actions.pod:862
27118 msgid "guestfs_blockdev_rereadpt"
27122 #: ../src/guestfs-actions.pod:864
27126 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
27127 " const char *device);\n"
27132 #: ../src/guestfs-actions.pod:876
27133 msgid "guestfs_blockdev_setbsz"
27137 #: ../src/guestfs-actions.pod:878
27141 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
27142 " const char *device,\n"
27143 " int blocksize);\n"
27148 #: ../src/guestfs-actions.pod:894
27149 msgid "guestfs_blockdev_setro"
27153 #: ../src/guestfs-actions.pod:896
27157 " guestfs_blockdev_setro (guestfs_h *g,\n"
27158 " const char *device);\n"
27163 #: ../src/guestfs-actions.pod:908
27164 msgid "guestfs_blockdev_setrw"
27168 #: ../src/guestfs-actions.pod:910
27172 " guestfs_blockdev_setrw (guestfs_h *g,\n"
27173 " const char *device);\n"
27178 #: ../src/guestfs-actions.pod:922
27179 msgid "guestfs_btrfs_filesystem_resize"
27183 #: ../src/guestfs-actions.pod:924
27187 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
27188 " const char *mountpoint,\n"
27194 #: ../src/guestfs-actions.pod:934
27197 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
27202 #: ../src/guestfs-actions.pod:957
27203 msgid "(Added in 1.11.17)"
27207 #: ../src/guestfs-actions.pod:959
27208 msgid "guestfs_btrfs_filesystem_resize_va"
27212 #: ../src/guestfs-actions.pod:961
27216 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
27217 " const char *mountpoint,\n"
27218 " va_list args);\n"
27223 #: ../src/guestfs-actions.pod:966
27224 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
27228 #: ../src/guestfs-actions.pod:970
27229 msgid "guestfs_btrfs_filesystem_resize_argv"
27233 #: ../src/guestfs-actions.pod:972
27237 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
27238 " const char *mountpoint,\n"
27239 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
27244 #: ../src/guestfs-actions.pod:977
27245 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
27249 #: ../src/guestfs-actions.pod:981
27250 msgid "guestfs_case_sensitive_path"
27254 #: ../src/guestfs-actions.pod:983
27258 " guestfs_case_sensitive_path (guestfs_h *g,\n"
27259 " const char *path);\n"
27264 #: ../src/guestfs-actions.pod:1009
27266 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
27267 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
27268 "how the directories were originally created under Windows)."
27272 #: ../src/guestfs-actions.pod:1017
27273 msgid "See also C<guestfs_realpath>."
27277 #: ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:8183
27278 msgid "(Added in 1.0.75)"
27282 #: ../src/guestfs-actions.pod:1024
27283 msgid "guestfs_cat"
27287 #: ../src/guestfs-actions.pod:1026
27291 " guestfs_cat (guestfs_h *g,\n"
27292 " const char *path);\n"
27297 #: ../src/guestfs-actions.pod:1032
27299 "Note that this function cannot correctly handle binary files (specifically, "
27300 "files containing C<\\0> character which is treated as end of string). For "
27301 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
27302 "functions which have a more complex interface."
27306 #: ../src/guestfs-actions.pod:1043 ../src/guestfs-actions.pod:4250
27307 #: ../src/guestfs-actions.pod:4345 ../src/guestfs-actions.pod:4362
27308 #: ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4849
27309 #: ../src/guestfs-actions.pod:4863 ../src/guestfs-actions.pod:6390
27310 #: ../src/guestfs-actions.pod:6404 ../src/guestfs-actions.pod:8336
27311 #: ../src/guestfs-actions.pod:8350
27312 msgid "(Added in 0.4)"
27316 #: ../src/guestfs-actions.pod:1045
27317 msgid "guestfs_checksum"
27321 #: ../src/guestfs-actions.pod:1047
27325 " guestfs_checksum (guestfs_h *g,\n"
27326 " const char *csumtype,\n"
27327 " const char *path);\n"
27332 #: ../src/guestfs-actions.pod:1093
27333 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
27337 #: ../src/guestfs-actions.pod:1095
27338 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
27342 #: ../src/guestfs-actions.pod:1100 ../src/guestfs-actions.pod:1767
27343 #: ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:3948
27344 #: ../src/guestfs-actions.pod:3977 ../src/guestfs-actions.pod:4038
27345 #: ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:8039
27346 msgid "(Added in 1.0.2)"
27350 #: ../src/guestfs-actions.pod:1102
27351 msgid "guestfs_checksum_device"
27355 #: ../src/guestfs-actions.pod:1104
27359 " guestfs_checksum_device (guestfs_h *g,\n"
27360 " const char *csumtype,\n"
27361 " const char *device);\n"
27366 #: ../src/guestfs-actions.pod:1109
27368 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
27369 "device named C<device>. For the types of checksums supported see the "
27370 "C<guestfs_checksum> command."
27374 #: ../src/guestfs-actions.pod:1116 ../src/guestfs-actions.pod:5822
27375 #: ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5991
27376 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6191
27377 #: ../src/guestfs-actions.pod:7948 ../src/guestfs-actions.pod:7962
27378 #: ../src/guestfs-actions.pod:8362
27379 msgid "(Added in 1.3.2)"
27383 #: ../src/guestfs-actions.pod:1118
27384 msgid "guestfs_checksums_out"
27388 #: ../src/guestfs-actions.pod:1120
27392 " guestfs_checksums_out (guestfs_h *g,\n"
27393 " const char *csumtype,\n"
27394 " const char *directory,\n"
27395 " const char *sumsfile);\n"
27400 #: ../src/guestfs-actions.pod:1140
27401 msgid "(Added in 1.3.7)"
27405 #: ../src/guestfs-actions.pod:1142
27406 msgid "guestfs_chmod"
27410 #: ../src/guestfs-actions.pod:1144
27414 " guestfs_chmod (guestfs_h *g,\n"
27416 " const char *path);\n"
27421 #: ../src/guestfs-actions.pod:1162
27422 msgid "guestfs_chown"
27426 #: ../src/guestfs-actions.pod:1164
27430 " guestfs_chown (guestfs_h *g,\n"
27433 " const char *path);\n"
27438 #: ../src/guestfs-actions.pod:1180
27439 msgid "guestfs_command"
27443 #: ../src/guestfs-actions.pod:1182
27447 " guestfs_command (guestfs_h *g,\n"
27448 " char *const *arguments);\n"
27453 #: ../src/guestfs-actions.pod:1191
27455 "The single parameter is an argv-style list of arguments. The first element "
27456 "is the name of the program to run. Subsequent elements are parameters. The "
27457 "list must be non-empty (ie. must contain a program name). Note that the "
27458 "command runs directly, and is I<not> invoked via the shell (see "
27463 #: ../src/guestfs-actions.pod:1222 ../src/guestfs-actions.pod:1242
27464 #: ../src/guestfs-actions.pod:2066
27465 msgid "(Added in 0.9.1)"
27469 #: ../src/guestfs-actions.pod:1224
27470 msgid "guestfs_command_lines"
27474 #: ../src/guestfs-actions.pod:1226
27478 " guestfs_command_lines (guestfs_h *g,\n"
27479 " char *const *arguments);\n"
27484 #: ../src/guestfs-actions.pod:1230
27486 "This is the same as C<guestfs_command>, but splits the result into a list of "
27491 #: ../src/guestfs-actions.pod:1233
27492 msgid "See also: C<guestfs_sh_lines>"
27496 #: ../src/guestfs-actions.pod:1244
27497 msgid "guestfs_compress_device_out"
27501 #: ../src/guestfs-actions.pod:1246
27505 " guestfs_compress_device_out (guestfs_h *g,\n"
27506 " const char *ctype,\n"
27507 " const char *device,\n"
27508 " const char *zdevice,\n"
27514 #: ../src/guestfs-actions.pod:1258
27517 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
27522 #: ../src/guestfs-actions.pod:1263
27524 "The C<ctype> and optional C<level> parameters have the same meaning as in "
27525 "C<guestfs_compress_out>."
27529 #: ../src/guestfs-actions.pod:1268 ../src/guestfs-actions.pod:1327
27530 #: ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:7107
27531 msgid "(Added in 1.13.15)"
27535 #: ../src/guestfs-actions.pod:1270
27536 msgid "guestfs_compress_device_out_va"
27540 #: ../src/guestfs-actions.pod:1272
27544 " guestfs_compress_device_out_va (guestfs_h *g,\n"
27545 " const char *ctype,\n"
27546 " const char *device,\n"
27547 " const char *zdevice,\n"
27548 " va_list args);\n"
27553 #: ../src/guestfs-actions.pod:1279
27554 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
27558 #: ../src/guestfs-actions.pod:1283
27559 msgid "guestfs_compress_device_out_argv"
27563 #: ../src/guestfs-actions.pod:1285
27567 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
27568 " const char *ctype,\n"
27569 " const char *device,\n"
27570 " const char *zdevice,\n"
27571 " const struct guestfs_compress_device_out_argv *optargs);\n"
27576 #: ../src/guestfs-actions.pod:1292
27577 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
27581 #: ../src/guestfs-actions.pod:1296
27582 msgid "guestfs_compress_out"
27586 #: ../src/guestfs-actions.pod:1298
27590 " guestfs_compress_out (guestfs_h *g,\n"
27591 " const char *ctype,\n"
27592 " const char *file,\n"
27593 " const char *zfile,\n"
27599 #: ../src/guestfs-actions.pod:1310
27602 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
27607 #: ../src/guestfs-actions.pod:1329
27608 msgid "guestfs_compress_out_va"
27612 #: ../src/guestfs-actions.pod:1331
27616 " guestfs_compress_out_va (guestfs_h *g,\n"
27617 " const char *ctype,\n"
27618 " const char *file,\n"
27619 " const char *zfile,\n"
27620 " va_list args);\n"
27625 #: ../src/guestfs-actions.pod:1338
27626 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
27630 #: ../src/guestfs-actions.pod:1342
27631 msgid "guestfs_compress_out_argv"
27635 #: ../src/guestfs-actions.pod:1344
27639 " guestfs_compress_out_argv (guestfs_h *g,\n"
27640 " const char *ctype,\n"
27641 " const char *file,\n"
27642 " const char *zfile,\n"
27643 " const struct guestfs_compress_out_argv *optargs);\n"
27648 #: ../src/guestfs-actions.pod:1351
27649 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
27653 #: ../src/guestfs-actions.pod:1355
27654 msgid "guestfs_config"
27658 #: ../src/guestfs-actions.pod:1357
27662 " guestfs_config (guestfs_h *g,\n"
27663 " const char *qemuparam,\n"
27664 " const char *qemuvalue);\n"
27669 #: ../src/guestfs-actions.pod:1375
27670 msgid "guestfs_copy_device_to_device"
27674 #: ../src/guestfs-actions.pod:1377
27678 " guestfs_copy_device_to_device (guestfs_h *g,\n"
27679 " const char *src,\n"
27680 " const char *dest,\n"
27686 #: ../src/guestfs-actions.pod:1388
27689 " GUESTFS_COPY_DEVICE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
27690 " GUESTFS_COPY_DEVICE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
27691 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, int64_t size,\n"
27696 #: ../src/guestfs-actions.pod:1392
27698 "The four calls C<guestfs_copy_device_to_device>, "
27699 "C<guestfs_copy_device_to_file>, C<guestfs_copy_file_to_device>, and "
27700 "C<guestfs_copy_file_to_file> let you copy from a source (device|file) to a "
27701 "destination (device|file)."
27705 #: ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1466
27706 #: ../src/guestfs-actions.pod:1519 ../src/guestfs-actions.pod:1577
27707 #: ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1762
27708 #: ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:1838
27709 #: ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2237
27710 #: ../src/guestfs-actions.pod:4148 ../src/guestfs-actions.pod:8034
27711 #: ../src/guestfs-actions.pod:8068 ../src/guestfs-actions.pod:8575
27712 #: ../src/guestfs-actions.pod:8598
27714 "This long-running command can generate progress notification messages so "
27715 "that the caller can display a progress bar or indicator. To receive these "
27716 "messages, the caller must register a progress event callback. See L<guestfs"
27717 "(3)/GUESTFS_EVENT_PROGRESS>."
27721 #: ../src/guestfs-actions.pod:1418 ../src/guestfs-actions.pod:1471
27722 #: ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1582
27723 #: ../src/guestfs-actions.pod:6247
27724 msgid "(Added in 1.13.25)"
27728 #: ../src/guestfs-actions.pod:1420
27729 msgid "guestfs_copy_device_to_device_va"
27733 #: ../src/guestfs-actions.pod:1422
27737 " guestfs_copy_device_to_device_va (guestfs_h *g,\n"
27738 " const char *src,\n"
27739 " const char *dest,\n"
27740 " va_list args);\n"
27745 #: ../src/guestfs-actions.pod:1428
27746 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_device>."
27750 #: ../src/guestfs-actions.pod:1432
27751 msgid "guestfs_copy_device_to_device_argv"
27755 #: ../src/guestfs-actions.pod:1434
27759 " guestfs_copy_device_to_device_argv (guestfs_h *g,\n"
27760 " const char *src,\n"
27761 " const char *dest,\n"
27762 " const struct guestfs_copy_device_to_device_argv *optargs);\n"
27767 #: ../src/guestfs-actions.pod:1440
27768 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_device>."
27772 #: ../src/guestfs-actions.pod:1444
27773 msgid "guestfs_copy_device_to_file"
27777 #: ../src/guestfs-actions.pod:1446
27781 " guestfs_copy_device_to_file (guestfs_h *g,\n"
27782 " const char *src,\n"
27783 " const char *dest,\n"
27789 #: ../src/guestfs-actions.pod:1457
27792 " GUESTFS_COPY_DEVICE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
27793 " GUESTFS_COPY_DEVICE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
27794 " GUESTFS_COPY_DEVICE_TO_FILE_SIZE, int64_t size,\n"
27799 #: ../src/guestfs-actions.pod:1461 ../src/guestfs-actions.pod:1514
27800 #: ../src/guestfs-actions.pod:1567
27802 "See C<guestfs_copy_device_to_device> for a general overview of this call."
27806 #: ../src/guestfs-actions.pod:1473
27807 msgid "guestfs_copy_device_to_file_va"
27811 #: ../src/guestfs-actions.pod:1475
27815 " guestfs_copy_device_to_file_va (guestfs_h *g,\n"
27816 " const char *src,\n"
27817 " const char *dest,\n"
27818 " va_list args);\n"
27823 #: ../src/guestfs-actions.pod:1481
27824 msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_file>."
27828 #: ../src/guestfs-actions.pod:1485
27829 msgid "guestfs_copy_device_to_file_argv"
27833 #: ../src/guestfs-actions.pod:1487
27837 " guestfs_copy_device_to_file_argv (guestfs_h *g,\n"
27838 " const char *src,\n"
27839 " const char *dest,\n"
27840 " const struct guestfs_copy_device_to_file_argv *optargs);\n"
27845 #: ../src/guestfs-actions.pod:1493
27846 msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_file>."
27850 #: ../src/guestfs-actions.pod:1497
27851 msgid "guestfs_copy_file_to_device"
27855 #: ../src/guestfs-actions.pod:1499
27859 " guestfs_copy_file_to_device (guestfs_h *g,\n"
27860 " const char *src,\n"
27861 " const char *dest,\n"
27867 #: ../src/guestfs-actions.pod:1510
27870 " GUESTFS_COPY_FILE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
27871 " GUESTFS_COPY_FILE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
27872 " GUESTFS_COPY_FILE_TO_DEVICE_SIZE, int64_t size,\n"
27877 #: ../src/guestfs-actions.pod:1526
27878 msgid "guestfs_copy_file_to_device_va"
27882 #: ../src/guestfs-actions.pod:1528
27886 " guestfs_copy_file_to_device_va (guestfs_h *g,\n"
27887 " const char *src,\n"
27888 " const char *dest,\n"
27889 " va_list args);\n"
27894 #: ../src/guestfs-actions.pod:1534
27895 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_device>."
27899 #: ../src/guestfs-actions.pod:1538
27900 msgid "guestfs_copy_file_to_device_argv"
27904 #: ../src/guestfs-actions.pod:1540
27908 " guestfs_copy_file_to_device_argv (guestfs_h *g,\n"
27909 " const char *src,\n"
27910 " const char *dest,\n"
27911 " const struct guestfs_copy_file_to_device_argv *optargs);\n"
27916 #: ../src/guestfs-actions.pod:1546
27917 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_device>."
27921 #: ../src/guestfs-actions.pod:1550
27922 msgid "guestfs_copy_file_to_file"
27926 #: ../src/guestfs-actions.pod:1552
27930 " guestfs_copy_file_to_file (guestfs_h *g,\n"
27931 " const char *src,\n"
27932 " const char *dest,\n"
27938 #: ../src/guestfs-actions.pod:1563
27941 " GUESTFS_COPY_FILE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
27942 " GUESTFS_COPY_FILE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
27943 " GUESTFS_COPY_FILE_TO_FILE_SIZE, int64_t size,\n"
27948 #: ../src/guestfs-actions.pod:1570
27950 "This is B<not> the function you want for copying files. This is for copying "
27951 "blocks within existing files. See C<guestfs_cp>, C<guestfs_cp_a> and "
27952 "C<guestfs_mv> for general file copying and moving functions."
27956 #: ../src/guestfs-actions.pod:1584
27957 msgid "guestfs_copy_file_to_file_va"
27961 #: ../src/guestfs-actions.pod:1586
27965 " guestfs_copy_file_to_file_va (guestfs_h *g,\n"
27966 " const char *src,\n"
27967 " const char *dest,\n"
27968 " va_list args);\n"
27973 #: ../src/guestfs-actions.pod:1592
27974 msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_file>."
27978 #: ../src/guestfs-actions.pod:1596
27979 msgid "guestfs_copy_file_to_file_argv"
27983 #: ../src/guestfs-actions.pod:1598
27987 " guestfs_copy_file_to_file_argv (guestfs_h *g,\n"
27988 " const char *src,\n"
27989 " const char *dest,\n"
27990 " const struct guestfs_copy_file_to_file_argv *optargs);\n"
27995 #: ../src/guestfs-actions.pod:1604
27996 msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_file>."
28000 #: ../src/guestfs-actions.pod:1608
28001 msgid "guestfs_copy_size"
28005 #: ../src/guestfs-actions.pod:1610
28009 " guestfs_copy_size (guestfs_h *g,\n"
28010 " const char *src,\n"
28011 " const char *dest,\n"
28012 " int64_t size);\n"
28017 #: ../src/guestfs-actions.pod:1616 ../src/guestfs-actions.pod:1673
28019 "I<This function is deprecated.> In new code, use the L</"
28020 "guestfs_copy_device_to_device> call instead."
28024 #: ../src/guestfs-actions.pod:1636 ../src/guestfs-actions.pod:4876
28025 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:8269
28026 #: ../src/guestfs-actions.pod:8289 ../src/guestfs-actions.pod:8375
28027 msgid "(Added in 1.0.87)"
28031 #: ../src/guestfs-actions.pod:1638
28036 #: ../src/guestfs-actions.pod:1640
28040 " guestfs_cp (guestfs_h *g,\n"
28041 " const char *src,\n"
28042 " const char *dest);\n"
28047 #: ../src/guestfs-actions.pod:1650 ../src/guestfs-actions.pod:1664
28048 #: ../src/guestfs-actions.pod:1744 ../src/guestfs-actions.pod:1818
28049 #: ../src/guestfs-actions.pod:1932 ../src/guestfs-actions.pod:5769
28050 #: ../src/guestfs-actions.pod:6261
28051 msgid "(Added in 1.0.18)"
28055 #: ../src/guestfs-actions.pod:1652
28056 msgid "guestfs_cp_a"
28060 #: ../src/guestfs-actions.pod:1654
28064 " guestfs_cp_a (guestfs_h *g,\n"
28065 " const char *src,\n"
28066 " const char *dest);\n"
28071 #: ../src/guestfs-actions.pod:1666
28076 #: ../src/guestfs-actions.pod:1668
28080 " guestfs_dd (guestfs_h *g,\n"
28081 " const char *src,\n"
28082 " const char *dest);\n"
28087 #: ../src/guestfs-actions.pod:1685
28089 "If the destination is a device, it must be as large or larger than the "
28090 "source file or device, otherwise the copy will fail. This command cannot do "
28091 "partial copies (see C<guestfs_copy_device_to_device>)."
28095 #: ../src/guestfs-actions.pod:1694
28100 #: ../src/guestfs-actions.pod:1696
28104 " guestfs_df (guestfs_h *g);\n"
28109 #: ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1718
28111 "This command is mostly useful for interactive sessions. It is I<not> "
28112 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
28117 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1725
28118 #: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2850
28119 #: ../src/guestfs-actions.pod:2874 ../src/guestfs-actions.pod:2942
28120 #: ../src/guestfs-actions.pod:5135 ../src/guestfs-actions.pod:5669
28121 #: ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7674
28122 #: ../src/guestfs-actions.pod:8415 ../src/guestfs-actions.pod:8428
28123 #: ../src/guestfs-actions.pod:8441
28124 msgid "(Added in 1.0.54)"
28128 #: ../src/guestfs-actions.pod:1710
28129 msgid "guestfs_df_h"
28133 #: ../src/guestfs-actions.pod:1712
28137 " guestfs_df_h (guestfs_h *g);\n"
28142 #: ../src/guestfs-actions.pod:1727
28143 msgid "guestfs_dmesg"
28147 #: ../src/guestfs-actions.pod:1729
28151 " guestfs_dmesg (guestfs_h *g);\n"
28156 #: ../src/guestfs-actions.pod:1736
28158 "Another way to get the same information is to enable verbose messages with "
28159 "C<guestfs_set_verbose> or by setting the environment variable "
28160 "C<LIBGUESTFS_DEBUG=1> before running the program."
28164 #: ../src/guestfs-actions.pod:1746
28165 msgid "guestfs_download"
28169 #: ../src/guestfs-actions.pod:1748
28173 " guestfs_download (guestfs_h *g,\n"
28174 " const char *remotefilename,\n"
28175 " const char *filename);\n"
28180 #: ../src/guestfs-actions.pod:1758
28181 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
28185 #: ../src/guestfs-actions.pod:1769
28186 msgid "guestfs_download_offset"
28190 #: ../src/guestfs-actions.pod:1771
28194 " guestfs_download_offset (guestfs_h *g,\n"
28195 " const char *remotefilename,\n"
28196 " const char *filename,\n"
28197 " int64_t offset,\n"
28198 " int64_t size);\n"
28203 #: ../src/guestfs-actions.pod:1784
28205 "Note that there is no limit on the amount of data that can be downloaded "
28206 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
28207 "full amount unless an error occurs."
28211 #: ../src/guestfs-actions.pod:1789
28212 msgid "See also C<guestfs_download>, C<guestfs_pread>."
28216 #: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:8073
28217 msgid "(Added in 1.5.17)"
28221 #: ../src/guestfs-actions.pod:1800
28222 msgid "guestfs_drop_caches"
28226 #: ../src/guestfs-actions.pod:1802
28230 " guestfs_drop_caches (guestfs_h *g,\n"
28231 " int whattodrop);\n"
28236 #: ../src/guestfs-actions.pod:1820
28241 #: ../src/guestfs-actions.pod:1822
28245 " guestfs_du (guestfs_h *g,\n"
28246 " const char *path);\n"
28251 #: ../src/guestfs-actions.pod:1845
28252 msgid "guestfs_e2fsck_f"
28256 #: ../src/guestfs-actions.pod:1847
28260 " guestfs_e2fsck_f (guestfs_h *g,\n"
28261 " const char *device);\n"
28266 #: ../src/guestfs-actions.pod:1855
28268 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
28269 "Normally you should use C<guestfs_fsck>."
28273 #: ../src/guestfs-actions.pod:1860
28274 msgid "(Added in 1.0.29)"
28278 #: ../src/guestfs-actions.pod:1862
28279 msgid "guestfs_echo_daemon"
28283 #: ../src/guestfs-actions.pod:1864
28287 " guestfs_echo_daemon (guestfs_h *g,\n"
28288 " char *const *words);\n"
28293 #: ../src/guestfs-actions.pod:1873
28294 msgid "See also C<guestfs_ping_daemon>."
28298 #: ../src/guestfs-actions.pod:1878 ../src/guestfs-actions.pod:2636
28299 #: ../src/guestfs-actions.pod:7131
28300 msgid "(Added in 1.0.69)"
28304 #: ../src/guestfs-actions.pod:1880
28305 msgid "guestfs_egrep"
28309 #: ../src/guestfs-actions.pod:1882
28313 " guestfs_egrep (guestfs_h *g,\n"
28314 " const char *regex,\n"
28315 " const char *path);\n"
28320 #: ../src/guestfs-actions.pod:1897 ../src/guestfs-actions.pod:1916
28321 #: ../src/guestfs-actions.pod:1973 ../src/guestfs-actions.pod:2019
28322 #: ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:2766
28323 #: ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2963
28324 #: ../src/guestfs-actions.pod:2976 ../src/guestfs-actions.pod:2991
28325 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3059
28326 #: ../src/guestfs-actions.pod:3072 ../src/guestfs-actions.pod:4375
28327 #: ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:4402
28328 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:5557
28329 #: ../src/guestfs-actions.pod:6595 ../src/guestfs-actions.pod:6644
28330 #: ../src/guestfs-actions.pod:7518 ../src/guestfs-actions.pod:7530
28331 #: ../src/guestfs-actions.pod:7543 ../src/guestfs-actions.pod:7556
28332 #: ../src/guestfs-actions.pod:7578 ../src/guestfs-actions.pod:7591
28333 #: ../src/guestfs-actions.pod:7604 ../src/guestfs-actions.pod:7617
28334 #: ../src/guestfs-actions.pod:8533 ../src/guestfs-actions.pod:8552
28335 #: ../src/guestfs-actions.pod:8643 ../src/guestfs-actions.pod:8662
28336 #: ../src/guestfs-actions.pod:8708 ../src/guestfs-actions.pod:8727
28337 msgid "(Added in 1.0.66)"
28341 #: ../src/guestfs-actions.pod:1899
28342 msgid "guestfs_egrepi"
28346 #: ../src/guestfs-actions.pod:1901
28350 " guestfs_egrepi (guestfs_h *g,\n"
28351 " const char *regex,\n"
28352 " const char *path);\n"
28357 #: ../src/guestfs-actions.pod:1918
28358 msgid "guestfs_equal"
28362 #: ../src/guestfs-actions.pod:1920
28366 " guestfs_equal (guestfs_h *g,\n"
28367 " const char *file1,\n"
28368 " const char *file2);\n"
28373 #: ../src/guestfs-actions.pod:1934
28374 msgid "guestfs_exists"
28378 #: ../src/guestfs-actions.pod:1936
28382 " guestfs_exists (guestfs_h *g,\n"
28383 " const char *path);\n"
28388 #: ../src/guestfs-actions.pod:1943
28389 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
28393 #: ../src/guestfs-actions.pod:1949
28394 msgid "guestfs_fallocate"
28398 #: ../src/guestfs-actions.pod:1951
28402 " guestfs_fallocate (guestfs_h *g,\n"
28403 " const char *path,\n"
28409 #: ../src/guestfs-actions.pod:1956
28411 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
28416 #: ../src/guestfs-actions.pod:1975
28417 msgid "guestfs_fallocate64"
28421 #: ../src/guestfs-actions.pod:1977
28425 " guestfs_fallocate64 (guestfs_h *g,\n"
28426 " const char *path,\n"
28432 #: ../src/guestfs-actions.pod:1986
28434 "Note that this call allocates disk blocks for the file. To create a sparse "
28435 "file use C<guestfs_truncate_size> instead."
28439 #: ../src/guestfs-actions.pod:1989
28441 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
28442 "oversight it only allowed 30 bit lengths to be specified, effectively "
28443 "limiting the maximum size of files created through that call to 1GB."
28447 #: ../src/guestfs-actions.pod:2000
28448 msgid "(Added in 1.3.17)"
28452 #: ../src/guestfs-actions.pod:2002
28453 msgid "guestfs_fgrep"
28457 #: ../src/guestfs-actions.pod:2004
28461 " guestfs_fgrep (guestfs_h *g,\n"
28462 " const char *pattern,\n"
28463 " const char *path);\n"
28468 #: ../src/guestfs-actions.pod:2021
28469 msgid "guestfs_fgrepi"
28473 #: ../src/guestfs-actions.pod:2023
28477 " guestfs_fgrepi (guestfs_h *g,\n"
28478 " const char *pattern,\n"
28479 " const char *path);\n"
28484 #: ../src/guestfs-actions.pod:2040
28485 msgid "guestfs_file"
28489 #: ../src/guestfs-actions.pod:2042
28493 " guestfs_file (guestfs_h *g,\n"
28494 " const char *path);\n"
28499 #: ../src/guestfs-actions.pod:2060
28501 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
28502 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
28506 #: ../src/guestfs-actions.pod:2068
28507 msgid "guestfs_file_architecture"
28511 #: ../src/guestfs-actions.pod:2070
28515 " guestfs_file_architecture (guestfs_h *g,\n"
28516 " const char *filename);\n"
28521 #: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:2341
28522 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:3092
28523 #: ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3260
28524 #: ../src/guestfs-actions.pod:3447 ../src/guestfs-actions.pod:3465
28525 #: ../src/guestfs-actions.pod:3505 ../src/guestfs-actions.pod:3581
28526 #: ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:3919
28527 #: ../src/guestfs-actions.pod:4051
28528 msgid "(Added in 1.5.3)"
28532 #: ../src/guestfs-actions.pod:2180
28533 msgid "guestfs_filesize"
28537 #: ../src/guestfs-actions.pod:2182
28541 " guestfs_filesize (guestfs_h *g,\n"
28542 " const char *file);\n"
28547 #: ../src/guestfs-actions.pod:2188
28549 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
28550 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
28551 "devices, use C<guestfs_blockdev_getsize64>."
28555 #: ../src/guestfs-actions.pod:2194
28556 msgid "(Added in 1.0.82)"
28560 #: ../src/guestfs-actions.pod:2196
28561 msgid "guestfs_fill"
28565 #: ../src/guestfs-actions.pod:2198
28569 " guestfs_fill (guestfs_h *g,\n"
28572 " const char *path);\n"
28577 #: ../src/guestfs-actions.pod:2208
28579 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
28580 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
28581 "bytes use C<guestfs_fill_pattern>."
28585 #: ../src/guestfs-actions.pod:2220
28586 msgid "(Added in 1.0.79)"
28590 #: ../src/guestfs-actions.pod:2222
28591 msgid "guestfs_fill_pattern"
28595 #: ../src/guestfs-actions.pod:2224
28599 " guestfs_fill_pattern (guestfs_h *g,\n"
28600 " const char *pattern,\n"
28602 " const char *path);\n"
28607 #: ../src/guestfs-actions.pod:2230
28609 "This function is like C<guestfs_fill> except that it creates a new file of "
28610 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
28611 "pattern is truncated if necessary to ensure the length of the file is "
28612 "exactly C<len> bytes."
28616 #: ../src/guestfs-actions.pod:2242
28617 msgid "(Added in 1.3.12)"
28621 #: ../src/guestfs-actions.pod:2244
28622 msgid "guestfs_find"
28626 #: ../src/guestfs-actions.pod:2246
28630 " guestfs_find (guestfs_h *g,\n"
28631 " const char *directory);\n"
28636 #: ../src/guestfs-actions.pod:2262
28638 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
28642 #: ../src/guestfs-actions.pod:2275
28643 msgid "See also C<guestfs_find0>."
28647 #: ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:4813
28648 #: ../src/guestfs-actions.pod:6679
28649 msgid "(Added in 1.0.27)"
28653 #: ../src/guestfs-actions.pod:2286
28654 msgid "guestfs_find0"
28658 #: ../src/guestfs-actions.pod:2288
28662 " guestfs_find0 (guestfs_h *g,\n"
28663 " const char *directory,\n"
28664 " const char *files);\n"
28669 #: ../src/guestfs-actions.pod:2297
28671 "This command works the same way as C<guestfs_find> with the following "
28676 #: ../src/guestfs-actions.pod:2324
28677 msgid "(Added in 1.0.74)"
28681 #: ../src/guestfs-actions.pod:2326
28682 msgid "guestfs_findfs_label"
28686 #: ../src/guestfs-actions.pod:2328
28690 " guestfs_findfs_label (guestfs_h *g,\n"
28691 " const char *label);\n"
28696 #: ../src/guestfs-actions.pod:2336
28697 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
28701 #: ../src/guestfs-actions.pod:2343
28702 msgid "guestfs_findfs_uuid"
28706 #: ../src/guestfs-actions.pod:2345
28710 " guestfs_findfs_uuid (guestfs_h *g,\n"
28711 " const char *uuid);\n"
28716 #: ../src/guestfs-actions.pod:2353
28717 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
28721 #: ../src/guestfs-actions.pod:2360
28722 msgid "guestfs_fsck"
28726 #: ../src/guestfs-actions.pod:2362
28730 " guestfs_fsck (guestfs_h *g,\n"
28731 " const char *fstype,\n"
28732 " const char *device);\n"
28737 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:8580
28738 msgid "(Added in 1.0.16)"
28742 #: ../src/guestfs-actions.pod:2399
28743 msgid "guestfs_get_append"
28747 #: ../src/guestfs-actions.pod:2401
28751 " guestfs_get_append (guestfs_h *g);\n"
28756 #: ../src/guestfs-actions.pod:2409
28758 "This function returns a string which may be NULL. There is no way to return "
28759 "an error from this function. The string is owned by the guest handle and "
28760 "must I<not> be freed."
28764 #: ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:6357
28765 #: ../src/guestfs-actions.pod:6836 ../src/guestfs-actions.pod:7285
28766 #: ../src/guestfs-actions.pod:7304 ../src/guestfs-actions.pod:7320
28767 #: ../src/guestfs-actions.pod:7344 ../src/guestfs-actions.pod:8220
28768 #: ../src/guestfs-actions.pod:8235 ../src/guestfs-actions.pod:8624
28769 msgid "(Added in 1.0.26)"
28773 #: ../src/guestfs-actions.pod:2415
28774 msgid "guestfs_get_attach_method"
28778 #: ../src/guestfs-actions.pod:2417
28782 " guestfs_get_attach_method (guestfs_h *g);\n"
28787 #: ../src/guestfs-actions.pod:2420
28788 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
28792 #: ../src/guestfs-actions.pod:2425 ../src/guestfs-actions.pod:6866
28793 msgid "(Added in 1.9.8)"
28797 #: ../src/guestfs-actions.pod:2427
28798 msgid "guestfs_get_autosync"
28802 #: ../src/guestfs-actions.pod:2429
28806 " guestfs_get_autosync (guestfs_h *g);\n"
28811 #: ../src/guestfs-actions.pod:2438
28812 msgid "guestfs_get_direct"
28816 #: ../src/guestfs-actions.pod:2440
28820 " guestfs_get_direct (guestfs_h *g);\n"
28825 #: ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:6907
28826 msgid "(Added in 1.0.72)"
28830 #: ../src/guestfs-actions.pod:2449
28831 msgid "guestfs_get_e2label"
28835 #: ../src/guestfs-actions.pod:2451
28839 " guestfs_get_e2label (guestfs_h *g,\n"
28840 " const char *device);\n"
28845 #: ../src/guestfs-actions.pod:2455
28847 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
28852 #: ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2489
28853 #: ../src/guestfs-actions.pod:6925 ../src/guestfs-actions.pod:6944
28854 msgid "(Added in 1.0.15)"
28858 #: ../src/guestfs-actions.pod:2470
28859 msgid "guestfs_get_e2uuid"
28863 #: ../src/guestfs-actions.pod:2472
28867 " guestfs_get_e2uuid (guestfs_h *g,\n"
28868 " const char *device);\n"
28873 #: ../src/guestfs-actions.pod:2476
28875 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
28880 #: ../src/guestfs-actions.pod:2491
28881 msgid "guestfs_get_memsize"
28885 #: ../src/guestfs-actions.pod:2493
28889 " guestfs_get_memsize (guestfs_h *g);\n"
28894 #: ../src/guestfs-actions.pod:2499
28896 "If C<guestfs_set_memsize> was not called on this handle, and if "
28897 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
28898 "value for memsize."
28902 #: ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:5253
28903 #: ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5481
28904 #: ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5512
28905 #: ../src/guestfs-actions.pod:5529 ../src/guestfs-actions.pod:5542
28906 #: ../src/guestfs-actions.pod:6582 ../src/guestfs-actions.pod:6965
28907 #: ../src/guestfs-actions.pod:7255 ../src/guestfs-actions.pod:7989
28908 msgid "(Added in 1.0.55)"
28912 #: ../src/guestfs-actions.pod:2510
28913 msgid "guestfs_get_network"
28917 #: ../src/guestfs-actions.pod:2512
28921 " guestfs_get_network (guestfs_h *g);\n"
28926 #: ../src/guestfs-actions.pod:2519 ../src/guestfs-actions.pod:6984
28927 msgid "(Added in 1.5.4)"
28931 #: ../src/guestfs-actions.pod:2521
28932 msgid "guestfs_get_path"
28936 #: ../src/guestfs-actions.pod:2523
28940 " guestfs_get_path (guestfs_h *g);\n"
28945 #: ../src/guestfs-actions.pod:2531 ../src/guestfs-actions.pod:2571
28947 "This function returns a string, or NULL on error. The string is owned by "
28948 "the guest handle and must I<not> be freed."
28952 #: ../src/guestfs-actions.pod:2536
28953 msgid "guestfs_get_pgroup"
28957 #: ../src/guestfs-actions.pod:2538
28961 " guestfs_get_pgroup (guestfs_h *g);\n"
28966 #: ../src/guestfs-actions.pod:2545 ../src/guestfs-actions.pod:7020
28967 #: ../src/guestfs-actions.pod:8481
28968 msgid "(Added in 1.11.18)"
28972 #: ../src/guestfs-actions.pod:2547
28973 msgid "guestfs_get_pid"
28977 #: ../src/guestfs-actions.pod:2549
28981 " guestfs_get_pid (guestfs_h *g);\n"
28986 #: ../src/guestfs-actions.pod:2559
28987 msgid "(Added in 1.0.56)"
28991 #: ../src/guestfs-actions.pod:2561
28992 msgid "guestfs_get_qemu"
28996 #: ../src/guestfs-actions.pod:2563
29000 " guestfs_get_qemu (guestfs_h *g);\n"
29005 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:7048
29006 msgid "(Added in 1.0.6)"
29010 #: ../src/guestfs-actions.pod:2576
29011 msgid "guestfs_get_recovery_proc"
29015 #: ../src/guestfs-actions.pod:2578
29019 " guestfs_get_recovery_proc (guestfs_h *g);\n"
29024 #: ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:4173
29025 #: ../src/guestfs-actions.pod:4517 ../src/guestfs-actions.pod:4911
29026 #: ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:6287
29027 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:7072
29028 #: ../src/guestfs-actions.pod:7770 ../src/guestfs-actions.pod:7790
29029 #: ../src/guestfs-actions.pod:8104
29030 msgid "(Added in 1.0.77)"
29034 #: ../src/guestfs-actions.pod:2587
29035 msgid "guestfs_get_selinux"
29039 #: ../src/guestfs-actions.pod:2589
29043 " guestfs_get_selinux (guestfs_h *g);\n"
29048 #: ../src/guestfs-actions.pod:2592
29050 "This returns the current setting of the selinux flag which is passed to the "
29051 "appliance at boot time. See C<guestfs_set_selinux>."
29055 #: ../src/guestfs-actions.pod:2600 ../src/guestfs-actions.pod:2674
29056 #: ../src/guestfs-actions.pod:7091 ../src/guestfs-actions.pod:7165
29057 msgid "(Added in 1.0.67)"
29061 #: ../src/guestfs-actions.pod:2602
29062 msgid "guestfs_get_smp"
29066 #: ../src/guestfs-actions.pod:2604
29070 " guestfs_get_smp (guestfs_h *g);\n"
29075 #: ../src/guestfs-actions.pod:2613
29076 msgid "guestfs_get_state"
29080 #: ../src/guestfs-actions.pod:2615
29084 " guestfs_get_state (guestfs_h *g);\n"
29089 #: ../src/guestfs-actions.pod:2627
29090 msgid "guestfs_get_trace"
29094 #: ../src/guestfs-actions.pod:2629
29098 " guestfs_get_trace (guestfs_h *g);\n"
29103 #: ../src/guestfs-actions.pod:2638
29104 msgid "guestfs_get_umask"
29108 #: ../src/guestfs-actions.pod:2640
29112 " guestfs_get_umask (guestfs_h *g);\n"
29117 #: ../src/guestfs-actions.pod:2643
29119 "Return the current umask. By default the umask is C<022> unless it has been "
29120 "set by calling C<guestfs_umask>."
29124 #: ../src/guestfs-actions.pod:2650
29125 msgid "guestfs_get_verbose"
29129 #: ../src/guestfs-actions.pod:2652
29133 " guestfs_get_verbose (guestfs_h *g);\n"
29138 #: ../src/guestfs-actions.pod:2661
29139 msgid "guestfs_getcon"
29143 #: ../src/guestfs-actions.pod:2663
29147 " guestfs_getcon (guestfs_h *g);\n"
29152 #: ../src/guestfs-actions.pod:2668
29154 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
29158 #: ../src/guestfs-actions.pod:2676
29159 msgid "guestfs_getxattr"
29163 #: ../src/guestfs-actions.pod:2678
29167 " guestfs_getxattr (guestfs_h *g,\n"
29168 " const char *path,\n"
29169 " const char *name,\n"
29170 " size_t *size_r);\n"
29175 #: ../src/guestfs-actions.pod:2684
29177 "Get a single extended attribute from file C<path> named C<name>. This call "
29178 "follows symlinks. If you want to lookup an extended attribute for the "
29179 "symlink itself, use C<guestfs_lgetxattr>."
29183 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:4187
29185 "Normally it is better to get all extended attributes from a file in one go "
29186 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
29187 "implementations are buggy and do not provide a way to list out attributes. "
29188 "For these filesystems (notably ntfs-3g) you have to know the names of the "
29189 "extended attributes you want in advance and call this function."
29193 #: ../src/guestfs-actions.pod:2698
29194 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
29198 #: ../src/guestfs-actions.pod:2700 ../src/guestfs-actions.pod:2913
29199 #: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:4199
29200 #: ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6306
29201 #: ../src/guestfs-actions.pod:6487
29203 "This function returns a buffer, or NULL on error. The size of the returned "
29204 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
29209 #: ../src/guestfs-actions.pod:2704 ../src/guestfs-actions.pod:4203
29210 msgid "(Added in 1.7.24)"
29214 #: ../src/guestfs-actions.pod:2706
29215 msgid "guestfs_getxattrs"
29219 #: ../src/guestfs-actions.pod:2708
29222 " struct guestfs_xattr_list *\n"
29223 " guestfs_getxattrs (guestfs_h *g,\n"
29224 " const char *path);\n"
29229 #: ../src/guestfs-actions.pod:2718
29230 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
29234 #: ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:4215
29235 #: ../src/guestfs-actions.pod:4907
29237 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
29238 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
29242 #: ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:4219
29243 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:4467
29244 #: ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:7184
29245 #: ../src/guestfs-actions.pod:8689
29246 msgid "(Added in 1.0.59)"
29250 #: ../src/guestfs-actions.pod:2726
29251 msgid "guestfs_glob_expand"
29255 #: ../src/guestfs-actions.pod:2728
29259 " guestfs_glob_expand (guestfs_h *g,\n"
29260 " const char *pattern);\n"
29265 #: ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:7368
29266 #: ../src/guestfs-actions.pod:7385
29267 msgid "(Added in 1.0.50)"
29271 #: ../src/guestfs-actions.pod:2749
29272 msgid "guestfs_grep"
29276 #: ../src/guestfs-actions.pod:2751
29280 " guestfs_grep (guestfs_h *g,\n"
29281 " const char *regex,\n"
29282 " const char *path);\n"
29287 #: ../src/guestfs-actions.pod:2768
29288 msgid "guestfs_grepi"
29292 #: ../src/guestfs-actions.pod:2770
29296 " guestfs_grepi (guestfs_h *g,\n"
29297 " const char *regex,\n"
29298 " const char *path);\n"
29303 #: ../src/guestfs-actions.pod:2787
29304 msgid "guestfs_grub_install"
29308 #: ../src/guestfs-actions.pod:2789
29312 " guestfs_grub_install (guestfs_h *g,\n"
29313 " const char *root,\n"
29314 " const char *device);\n"
29319 #: ../src/guestfs-actions.pod:2832
29320 msgid "(Added in 1.0.17)"
29324 #: ../src/guestfs-actions.pod:2834
29325 msgid "guestfs_head"
29329 #: ../src/guestfs-actions.pod:2836
29333 " guestfs_head (guestfs_h *g,\n"
29334 " const char *path);\n"
29339 #: ../src/guestfs-actions.pod:2852
29340 msgid "guestfs_head_n"
29344 #: ../src/guestfs-actions.pod:2854
29348 " guestfs_head_n (guestfs_h *g,\n"
29350 " const char *path);\n"
29355 #: ../src/guestfs-actions.pod:2876
29356 msgid "guestfs_hexdump"
29360 #: ../src/guestfs-actions.pod:2878
29364 " guestfs_hexdump (guestfs_h *g,\n"
29365 " const char *path);\n"
29370 #: ../src/guestfs-actions.pod:2891 ../src/guestfs-actions.pod:7449
29371 #: ../src/guestfs-actions.pod:7504
29372 msgid "(Added in 1.0.22)"
29376 #: ../src/guestfs-actions.pod:2893
29377 msgid "guestfs_initrd_cat"
29381 #: ../src/guestfs-actions.pod:2895
29385 " guestfs_initrd_cat (guestfs_h *g,\n"
29386 " const char *initrdpath,\n"
29387 " const char *filename,\n"
29388 " size_t *size_r);\n"
29393 #: ../src/guestfs-actions.pod:2911
29394 msgid "See also C<guestfs_initrd_list>."
29398 #: ../src/guestfs-actions.pod:2922
29399 msgid "guestfs_initrd_list"
29403 #: ../src/guestfs-actions.pod:2924
29407 " guestfs_initrd_list (guestfs_h *g,\n"
29408 " const char *path);\n"
29413 #: ../src/guestfs-actions.pod:2944
29414 msgid "guestfs_inotify_add_watch"
29418 #: ../src/guestfs-actions.pod:2946
29422 " guestfs_inotify_add_watch (guestfs_h *g,\n"
29423 " const char *path,\n"
29429 #: ../src/guestfs-actions.pod:2965
29430 msgid "guestfs_inotify_close"
29434 #: ../src/guestfs-actions.pod:2967
29438 " guestfs_inotify_close (guestfs_h *g);\n"
29443 #: ../src/guestfs-actions.pod:2978
29444 msgid "guestfs_inotify_files"
29448 #: ../src/guestfs-actions.pod:2980
29452 " guestfs_inotify_files (guestfs_h *g);\n"
29457 #: ../src/guestfs-actions.pod:2983
29459 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
29460 "returns a list of pathnames of objects that were touched. The returned "
29461 "pathnames are sorted and deduplicated."
29465 #: ../src/guestfs-actions.pod:2993
29466 msgid "guestfs_inotify_init"
29470 #: ../src/guestfs-actions.pod:2995
29474 " guestfs_inotify_init (guestfs_h *g,\n"
29475 " int maxevents);\n"
29480 #: ../src/guestfs-actions.pod:3003
29482 "C<maxevents> is the maximum number of events which will be queued up between "
29483 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
29484 "passed as C<0>, then the kernel (or previously set) default is used. For "
29485 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
29486 "throws away events, but records the fact that it threw them away by setting "
29487 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
29488 "C<guestfs_inotify_read>)."
29492 #: ../src/guestfs-actions.pod:3013
29494 "Before any events are generated, you have to add some watches to the "
29495 "internal watch list. See: C<guestfs_inotify_add_watch>, "
29496 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
29500 #: ../src/guestfs-actions.pod:3019
29502 "Queued up events should be read periodically by calling "
29503 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
29504 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
29505 "often enough then you risk the internal queue overflowing."
29509 #: ../src/guestfs-actions.pod:3026
29511 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
29512 "This also removes any watches automatically."
29516 #: ../src/guestfs-actions.pod:3039
29517 msgid "guestfs_inotify_read"
29521 #: ../src/guestfs-actions.pod:3041
29524 " struct guestfs_inotify_event_list *\n"
29525 " guestfs_inotify_read (guestfs_h *g);\n"
29530 #: ../src/guestfs-actions.pod:3055
29532 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
29533 "there was an error. I<The caller must call "
29534 "C<guestfs_free_inotify_event_list> after use>."
29538 #: ../src/guestfs-actions.pod:3061
29539 msgid "guestfs_inotify_rm_watch"
29543 #: ../src/guestfs-actions.pod:3063
29547 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
29553 #: ../src/guestfs-actions.pod:3067
29555 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
29559 #: ../src/guestfs-actions.pod:3074
29560 msgid "guestfs_inspect_get_arch"
29564 #: ../src/guestfs-actions.pod:3076
29568 " guestfs_inspect_get_arch (guestfs_h *g,\n"
29569 " const char *root);\n"
29574 #: ../src/guestfs-actions.pod:3080
29576 "This returns the architecture of the inspected operating system. The "
29577 "possible return values are listed under C<guestfs_file_architecture>."
29581 #: ../src/guestfs-actions.pod:3094
29582 msgid "guestfs_inspect_get_distro"
29586 #: ../src/guestfs-actions.pod:3096
29590 " guestfs_inspect_get_distro (guestfs_h *g,\n"
29591 " const char *root);\n"
29596 #: ../src/guestfs-actions.pod:3196
29597 msgid "guestfs_inspect_get_drive_mappings"
29601 #: ../src/guestfs-actions.pod:3198
29605 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
29606 " const char *root);\n"
29611 #: ../src/guestfs-actions.pod:3227
29613 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29614 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
29618 #: ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:3702
29619 msgid "(Added in 1.9.17)"
29623 #: ../src/guestfs-actions.pod:3239
29624 msgid "guestfs_inspect_get_filesystems"
29628 #: ../src/guestfs-actions.pod:3241
29632 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
29633 " const char *root);\n"
29638 #: ../src/guestfs-actions.pod:3253
29640 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29641 "C<guestfs_inspect_get_mountpoints>."
29645 #: ../src/guestfs-actions.pod:3262
29646 msgid "guestfs_inspect_get_format"
29650 #: ../src/guestfs-actions.pod:3264
29654 " guestfs_inspect_get_format (guestfs_h *g,\n"
29655 " const char *root);\n"
29660 #: ../src/guestfs-actions.pod:3298 ../src/guestfs-actions.pod:3738
29661 #: ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3772
29662 #: ../src/guestfs-actions.pod:6698
29663 msgid "(Added in 1.9.4)"
29667 #: ../src/guestfs-actions.pod:3300
29668 msgid "guestfs_inspect_get_hostname"
29672 #: ../src/guestfs-actions.pod:3302
29676 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
29677 " const char *root);\n"
29682 #: ../src/guestfs-actions.pod:3317
29683 msgid "(Added in 1.7.9)"
29687 #: ../src/guestfs-actions.pod:3319
29688 msgid "guestfs_inspect_get_icon"
29692 #: ../src/guestfs-actions.pod:3321
29696 " guestfs_inspect_get_icon (guestfs_h *g,\n"
29697 " const char *root,\n"
29698 " size_t *size_r,\n"
29704 #: ../src/guestfs-actions.pod:3332
29707 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
29708 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
29713 #: ../src/guestfs-actions.pod:3399 ../src/guestfs-actions.pod:4233
29714 #: ../src/guestfs-actions.pod:5630
29715 msgid "(Added in 1.11.12)"
29719 #: ../src/guestfs-actions.pod:3401
29720 msgid "guestfs_inspect_get_icon_va"
29724 #: ../src/guestfs-actions.pod:3403
29728 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
29729 " const char *root,\n"
29730 " size_t *size_r,\n"
29731 " va_list args);\n"
29736 #: ../src/guestfs-actions.pod:3409
29737 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
29741 #: ../src/guestfs-actions.pod:3413
29742 msgid "guestfs_inspect_get_icon_argv"
29746 #: ../src/guestfs-actions.pod:3415
29750 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
29751 " const char *root,\n"
29752 " size_t *size_r,\n"
29753 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
29758 #: ../src/guestfs-actions.pod:3421
29759 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
29763 #: ../src/guestfs-actions.pod:3425
29764 msgid "guestfs_inspect_get_major_version"
29768 #: ../src/guestfs-actions.pod:3427
29772 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
29773 " const char *root);\n"
29778 #: ../src/guestfs-actions.pod:3449
29779 msgid "guestfs_inspect_get_minor_version"
29783 #: ../src/guestfs-actions.pod:3451
29787 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
29788 " const char *root);\n"
29793 #: ../src/guestfs-actions.pod:3460
29795 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29796 "C<guestfs_inspect_get_major_version>."
29800 #: ../src/guestfs-actions.pod:3467
29801 msgid "guestfs_inspect_get_mountpoints"
29805 #: ../src/guestfs-actions.pod:3469
29809 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
29810 " const char *root);\n"
29815 #: ../src/guestfs-actions.pod:3490
29817 "For operating systems like Windows which still use drive letters, this call "
29818 "will only return an entry for the first drive \"mounted on\" C</>. For "
29819 "information about the mapping of drive letters to partitions, see "
29820 "C<guestfs_inspect_get_drive_mappings>."
29824 #: ../src/guestfs-actions.pod:3496
29826 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29827 "C<guestfs_inspect_get_filesystems>."
29831 #: ../src/guestfs-actions.pod:3507
29832 msgid "guestfs_inspect_get_package_format"
29836 #: ../src/guestfs-actions.pod:3509
29840 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
29841 " const char *root);\n"
29846 #: ../src/guestfs-actions.pod:3513
29848 "This function and C<guestfs_inspect_get_package_management> return the "
29849 "package format and package management tool used by the inspected operating "
29850 "system. For example for Fedora these functions would return C<rpm> (package "
29851 "format) and C<yum> (package management)."
29855 #: ../src/guestfs-actions.pod:3532 ../src/guestfs-actions.pod:3560
29856 msgid "(Added in 1.7.5)"
29860 #: ../src/guestfs-actions.pod:3534
29861 msgid "guestfs_inspect_get_package_management"
29865 #: ../src/guestfs-actions.pod:3536
29869 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
29870 " const char *root);\n"
29875 #: ../src/guestfs-actions.pod:3540
29877 "C<guestfs_inspect_get_package_format> and this function return the package "
29878 "format and package management tool used by the inspected operating system. "
29879 "For example for Fedora these functions would return C<rpm> (package format) "
29880 "and C<yum> (package management)."
29884 #: ../src/guestfs-actions.pod:3562
29885 msgid "guestfs_inspect_get_product_name"
29889 #: ../src/guestfs-actions.pod:3564
29893 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
29894 " const char *root);\n"
29899 #: ../src/guestfs-actions.pod:3583
29900 msgid "guestfs_inspect_get_product_variant"
29904 #: ../src/guestfs-actions.pod:3585
29908 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
29909 " const char *root);\n"
29914 #: ../src/guestfs-actions.pod:3608
29916 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
29917 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
29921 #: ../src/guestfs-actions.pod:3615
29922 msgid "(Added in 1.9.13)"
29926 #: ../src/guestfs-actions.pod:3617
29927 msgid "guestfs_inspect_get_roots"
29931 #: ../src/guestfs-actions.pod:3619
29935 " guestfs_inspect_get_roots (guestfs_h *g);\n"
29940 #: ../src/guestfs-actions.pod:3622
29942 "This function is a convenient way to get the list of root devices, as "
29943 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
29944 "the whole inspection process."
29948 #: ../src/guestfs-actions.pod:3626
29950 "This returns an empty list if either no root devices were found or the "
29951 "caller has not called C<guestfs_inspect_os>."
29955 #: ../src/guestfs-actions.pod:3635
29956 msgid "(Added in 1.7.3)"
29960 #: ../src/guestfs-actions.pod:3637
29961 msgid "guestfs_inspect_get_type"
29965 #: ../src/guestfs-actions.pod:3639
29969 " guestfs_inspect_get_type (guestfs_h *g,\n"
29970 " const char *root);\n"
29975 #: ../src/guestfs-actions.pod:3684
29976 msgid "guestfs_inspect_get_windows_current_control_set"
29980 #: ../src/guestfs-actions.pod:3686
29984 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
29985 " const char *root);\n"
29990 #: ../src/guestfs-actions.pod:3704
29991 msgid "guestfs_inspect_get_windows_systemroot"
29995 #: ../src/guestfs-actions.pod:3706
29999 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
30000 " const char *root);\n"
30005 #: ../src/guestfs-actions.pod:3722
30006 msgid "(Added in 1.5.25)"
30010 #: ../src/guestfs-actions.pod:3724
30011 msgid "guestfs_inspect_is_live"
30015 #: ../src/guestfs-actions.pod:3726
30019 " guestfs_inspect_is_live (guestfs_h *g,\n"
30020 " const char *root);\n"
30025 #: ../src/guestfs-actions.pod:3730
30027 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
30028 "disk), then this returns true if a live image was detected on the disk."
30032 #: ../src/guestfs-actions.pod:3740
30033 msgid "guestfs_inspect_is_multipart"
30037 #: ../src/guestfs-actions.pod:3742
30041 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
30042 " const char *root);\n"
30047 #: ../src/guestfs-actions.pod:3746
30049 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
30050 "disk), then this returns true if the disk is part of a set."
30054 #: ../src/guestfs-actions.pod:3756
30055 msgid "guestfs_inspect_is_netinst"
30059 #: ../src/guestfs-actions.pod:3758
30063 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
30064 " const char *root);\n"
30069 #: ../src/guestfs-actions.pod:3762
30071 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
30072 "disk), then this returns true if the disk is a network installer, ie. not a "
30073 "self-contained install CD but one which is likely to require network access "
30074 "to complete the install."
30078 #: ../src/guestfs-actions.pod:3774
30079 msgid "guestfs_inspect_list_applications"
30083 #: ../src/guestfs-actions.pod:3776
30086 " struct guestfs_application_list *\n"
30087 " guestfs_inspect_list_applications (guestfs_h *g,\n"
30088 " const char *root);\n"
30093 #: ../src/guestfs-actions.pod:3782
30095 "I<Note:> This call works differently from other parts of the inspection "
30096 "API. You have to call C<guestfs_inspect_os>, then "
30097 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
30098 "this. Listing applications is a significantly more difficult operation "
30099 "which requires access to the full filesystem. Also note that unlike the "
30100 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
30101 "the libguestfs handle, this call actually reads parts of the mounted "
30102 "filesystems during the call."
30106 #: ../src/guestfs-actions.pod:3872
30108 "This function returns a C<struct guestfs_application_list *>, or NULL if "
30109 "there was an error. I<The caller must call C<guestfs_free_application_list> "
30114 #: ../src/guestfs-actions.pod:3876
30115 msgid "(Added in 1.7.8)"
30119 #: ../src/guestfs-actions.pod:3878
30120 msgid "guestfs_inspect_os"
30124 #: ../src/guestfs-actions.pod:3880
30128 " guestfs_inspect_os (guestfs_h *g);\n"
30133 #: ../src/guestfs-actions.pod:3896
30135 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
30136 "functions in order to query further information about each operating system, "
30137 "such as the name and version."
30141 #: ../src/guestfs-actions.pod:3901
30143 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
30144 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
30145 "the contents. This should be called with no disks currently mounted. The "
30146 "function may also use Augeas, so any existing Augeas handle will be closed."
30150 #: ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:4244
30151 #: ../src/guestfs-actions.pod:4339
30152 msgid "See also C<guestfs_list_filesystems>."
30156 #: ../src/guestfs-actions.pod:3921
30157 msgid "guestfs_is_blockdev"
30161 #: ../src/guestfs-actions.pod:3923
30165 " guestfs_is_blockdev (guestfs_h *g,\n"
30166 " const char *path);\n"
30171 #: ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:3959
30172 #: ../src/guestfs-actions.pod:3989 ../src/guestfs-actions.pod:4004
30173 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4076
30174 #: ../src/guestfs-actions.pod:4091
30175 msgid "See also C<guestfs_stat>."
30179 #: ../src/guestfs-actions.pod:3934 ../src/guestfs-actions.pod:3963
30180 #: ../src/guestfs-actions.pod:4008 ../src/guestfs-actions.pod:4080
30181 #: ../src/guestfs-actions.pod:4095
30182 msgid "(Added in 1.5.10)"
30186 #: ../src/guestfs-actions.pod:3936
30187 msgid "guestfs_is_busy"
30191 #: ../src/guestfs-actions.pod:3938
30195 " guestfs_is_busy (guestfs_h *g);\n"
30200 #: ../src/guestfs-actions.pod:3950
30201 msgid "guestfs_is_chardev"
30205 #: ../src/guestfs-actions.pod:3952
30209 " guestfs_is_chardev (guestfs_h *g,\n"
30210 " const char *path);\n"
30215 #: ../src/guestfs-actions.pod:3965
30216 msgid "guestfs_is_config"
30220 #: ../src/guestfs-actions.pod:3967
30224 " guestfs_is_config (guestfs_h *g);\n"
30229 #: ../src/guestfs-actions.pod:3979
30230 msgid "guestfs_is_dir"
30234 #: ../src/guestfs-actions.pod:3981
30238 " guestfs_is_dir (guestfs_h *g,\n"
30239 " const char *path);\n"
30244 #: ../src/guestfs-actions.pod:3995
30245 msgid "guestfs_is_fifo"
30249 #: ../src/guestfs-actions.pod:3997
30253 " guestfs_is_fifo (guestfs_h *g,\n"
30254 " const char *path);\n"
30259 #: ../src/guestfs-actions.pod:4010
30260 msgid "guestfs_is_file"
30264 #: ../src/guestfs-actions.pod:4012
30268 " guestfs_is_file (guestfs_h *g,\n"
30269 " const char *path);\n"
30274 #: ../src/guestfs-actions.pod:4026
30275 msgid "guestfs_is_launching"
30279 #: ../src/guestfs-actions.pod:4028
30283 " guestfs_is_launching (guestfs_h *g);\n"
30288 #: ../src/guestfs-actions.pod:4040
30289 msgid "guestfs_is_lv"
30293 #: ../src/guestfs-actions.pod:4042
30297 " guestfs_is_lv (guestfs_h *g,\n"
30298 " const char *device);\n"
30303 #: ../src/guestfs-actions.pod:4053
30304 msgid "guestfs_is_ready"
30308 #: ../src/guestfs-actions.pod:4055
30312 " guestfs_is_ready (guestfs_h *g);\n"
30317 #: ../src/guestfs-actions.pod:4067
30318 msgid "guestfs_is_socket"
30322 #: ../src/guestfs-actions.pod:4069
30326 " guestfs_is_socket (guestfs_h *g,\n"
30327 " const char *path);\n"
30332 #: ../src/guestfs-actions.pod:4082
30333 msgid "guestfs_is_symlink"
30337 #: ../src/guestfs-actions.pod:4084
30341 " guestfs_is_symlink (guestfs_h *g,\n"
30342 " const char *path);\n"
30347 #: ../src/guestfs-actions.pod:4097
30348 msgid "guestfs_is_zero"
30352 #: ../src/guestfs-actions.pod:4099
30356 " guestfs_is_zero (guestfs_h *g,\n"
30357 " const char *path);\n"
30362 #: ../src/guestfs-actions.pod:4108 ../src/guestfs-actions.pod:4122
30363 msgid "(Added in 1.11.8)"
30367 #: ../src/guestfs-actions.pod:4110
30368 msgid "guestfs_is_zero_device"
30372 #: ../src/guestfs-actions.pod:4112
30376 " guestfs_is_zero_device (guestfs_h *g,\n"
30377 " const char *device);\n"
30382 #: ../src/guestfs-actions.pod:4124
30383 msgid "guestfs_kill_subprocess"
30387 #: ../src/guestfs-actions.pod:4126
30391 " guestfs_kill_subprocess (guestfs_h *g);\n"
30396 #: ../src/guestfs-actions.pod:4135
30397 msgid "guestfs_launch"
30401 #: ../src/guestfs-actions.pod:4137
30405 " guestfs_launch (guestfs_h *g);\n"
30410 #: ../src/guestfs-actions.pod:4155
30411 msgid "guestfs_lchown"
30415 #: ../src/guestfs-actions.pod:4157
30419 " guestfs_lchown (guestfs_h *g,\n"
30422 " const char *path);\n"
30427 #: ../src/guestfs-actions.pod:4163
30429 "Change the file owner to C<owner> and group to C<group>. This is like "
30430 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
30431 "changed, not the target."
30435 #: ../src/guestfs-actions.pod:4175
30436 msgid "guestfs_lgetxattr"
30440 #: ../src/guestfs-actions.pod:4177
30444 " guestfs_lgetxattr (guestfs_h *g,\n"
30445 " const char *path,\n"
30446 " const char *name,\n"
30447 " size_t *size_r);\n"
30452 #: ../src/guestfs-actions.pod:4197
30453 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
30457 #: ../src/guestfs-actions.pod:4205
30458 msgid "guestfs_lgetxattrs"
30462 #: ../src/guestfs-actions.pod:4207
30465 " struct guestfs_xattr_list *\n"
30466 " guestfs_lgetxattrs (guestfs_h *g,\n"
30467 " const char *path);\n"
30472 #: ../src/guestfs-actions.pod:4211
30474 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
30475 "then it returns the extended attributes of the link itself."
30479 #: ../src/guestfs-actions.pod:4221
30480 msgid "guestfs_list_9p"
30484 #: ../src/guestfs-actions.pod:4223
30488 " guestfs_list_9p (guestfs_h *g);\n"
30493 #: ../src/guestfs-actions.pod:4235
30494 msgid "guestfs_list_devices"
30498 #: ../src/guestfs-actions.pod:4237
30502 " guestfs_list_devices (guestfs_h *g);\n"
30507 #: ../src/guestfs-actions.pod:4252
30508 msgid "guestfs_list_dm_devices"
30512 #: ../src/guestfs-actions.pod:4254
30516 " guestfs_list_dm_devices (guestfs_h *g);\n"
30521 #: ../src/guestfs-actions.pod:4259
30523 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
30524 "previous call to C<guestfs_luks_open>."
30528 #: ../src/guestfs-actions.pod:4262
30530 "Device mapper devices which correspond to logical volumes are I<not> "
30531 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
30536 #: ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:5869
30537 msgid "(Added in 1.11.15)"
30541 #: ../src/guestfs-actions.pod:4272
30542 msgid "guestfs_list_filesystems"
30546 #: ../src/guestfs-actions.pod:4274
30550 " guestfs_list_filesystems (guestfs_h *g);\n"
30555 #: ../src/guestfs-actions.pod:4294
30557 "This command runs other libguestfs commands, which might include "
30558 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
30559 "soon after launch and only when nothing is mounted."
30563 #: ../src/guestfs-actions.pod:4298
30565 "Not all of the filesystems returned will be mountable. In particular, swap "
30566 "partitions are returned in the list. Also this command does not check that "
30567 "each filesystem found is valid and mountable, and some filesystems might be "
30568 "mountable but require special options. Filesystems may not all belong to a "
30569 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
30573 #: ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:6229
30574 msgid "(Added in 1.5.15)"
30578 #: ../src/guestfs-actions.pod:4314
30579 msgid "guestfs_list_md_devices"
30583 #: ../src/guestfs-actions.pod:4316
30587 " guestfs_list_md_devices (guestfs_h *g);\n"
30592 #: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:7890
30593 msgid "(Added in 1.15.4)"
30597 #: ../src/guestfs-actions.pod:4327
30598 msgid "guestfs_list_partitions"
30602 #: ../src/guestfs-actions.pod:4329
30606 " guestfs_list_partitions (guestfs_h *g);\n"
30611 #: ../src/guestfs-actions.pod:4336
30613 "This does not return logical volumes. For that you will need to call "
30618 #: ../src/guestfs-actions.pod:4347
30623 #: ../src/guestfs-actions.pod:4349
30627 " guestfs_ll (guestfs_h *g,\n"
30628 " const char *directory);\n"
30633 #: ../src/guestfs-actions.pod:4364
30638 #: ../src/guestfs-actions.pod:4366
30642 " guestfs_ln (guestfs_h *g,\n"
30643 " const char *target,\n"
30644 " const char *linkname);\n"
30649 #: ../src/guestfs-actions.pod:4377
30650 msgid "guestfs_ln_f"
30654 #: ../src/guestfs-actions.pod:4379
30658 " guestfs_ln_f (guestfs_h *g,\n"
30659 " const char *target,\n"
30660 " const char *linkname);\n"
30665 #: ../src/guestfs-actions.pod:4391
30666 msgid "guestfs_ln_s"
30670 #: ../src/guestfs-actions.pod:4393
30674 " guestfs_ln_s (guestfs_h *g,\n"
30675 " const char *target,\n"
30676 " const char *linkname);\n"
30681 #: ../src/guestfs-actions.pod:4404
30682 msgid "guestfs_ln_sf"
30686 #: ../src/guestfs-actions.pod:4406
30690 " guestfs_ln_sf (guestfs_h *g,\n"
30691 " const char *target,\n"
30692 " const char *linkname);\n"
30697 #: ../src/guestfs-actions.pod:4418
30698 msgid "guestfs_lremovexattr"
30702 #: ../src/guestfs-actions.pod:4420
30706 " guestfs_lremovexattr (guestfs_h *g,\n"
30707 " const char *xattr,\n"
30708 " const char *path);\n"
30713 #: ../src/guestfs-actions.pod:4425
30715 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
30716 "link, then it removes an extended attribute of the link itself."
30720 #: ../src/guestfs-actions.pod:4433
30725 #: ../src/guestfs-actions.pod:4435
30729 " guestfs_ls (guestfs_h *g,\n"
30730 " const char *directory);\n"
30735 #: ../src/guestfs-actions.pod:4443
30737 "This command is mostly useful for interactive sessions. Programs should "
30738 "probably use C<guestfs_readdir> instead."
30742 #: ../src/guestfs-actions.pod:4452
30743 msgid "guestfs_lsetxattr"
30747 #: ../src/guestfs-actions.pod:4454
30751 " guestfs_lsetxattr (guestfs_h *g,\n"
30752 " const char *xattr,\n"
30753 " const char *val,\n"
30755 " const char *path);\n"
30760 #: ../src/guestfs-actions.pod:4461
30762 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
30763 "then it sets an extended attribute of the link itself."
30767 #: ../src/guestfs-actions.pod:4469
30768 msgid "guestfs_lstat"
30772 #: ../src/guestfs-actions.pod:4471
30775 " struct guestfs_stat *\n"
30776 " guestfs_lstat (guestfs_h *g,\n"
30777 " const char *path);\n"
30782 #: ../src/guestfs-actions.pod:4477
30784 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
30785 "link, then the link is stat-ed, not the file it refers to."
30789 #: ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:7409
30791 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
30792 "error. I<The caller must call C<guestfs_free_stat> after use>."
30796 #: ../src/guestfs-actions.pod:4487 ../src/guestfs-actions.pod:7413
30797 #: ../src/guestfs-actions.pod:7431 ../src/guestfs-actions.pod:7934
30798 msgid "(Added in 0.9.2)"
30802 #: ../src/guestfs-actions.pod:4489
30803 msgid "guestfs_lstatlist"
30807 #: ../src/guestfs-actions.pod:4491
30810 " struct guestfs_stat_list *\n"
30811 " guestfs_lstatlist (guestfs_h *g,\n"
30812 " const char *path,\n"
30813 " char *const *names);\n"
30818 #: ../src/guestfs-actions.pod:4496
30820 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
30821 "files, where all files are in the directory C<path>. C<names> is the list "
30822 "of files from this directory."
30826 #: ../src/guestfs-actions.pod:4505
30828 "This call is intended for programs that want to efficiently list a directory "
30829 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
30830 "for a similarly efficient call for getting extended attributes. Very long "
30831 "directory listings might cause the protocol message size to be exceeded, "
30832 "causing this call to fail. The caller must split up such requests into "
30833 "smaller groups of names."
30837 #: ../src/guestfs-actions.pod:4513
30839 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
30840 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
30844 #: ../src/guestfs-actions.pod:4519
30845 msgid "guestfs_luks_add_key"
30849 #: ../src/guestfs-actions.pod:4521
30853 " guestfs_luks_add_key (guestfs_h *g,\n"
30854 " const char *device,\n"
30855 " const char *key,\n"
30856 " const char *newkey,\n"
30862 #: ../src/guestfs-actions.pod:4533
30864 "Note that if C<keyslot> already contains a key, then this command will "
30865 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
30869 #: ../src/guestfs-actions.pod:4539 ../src/guestfs-actions.pod:4576
30870 #: ../src/guestfs-actions.pod:4596 ../src/guestfs-actions.pod:4616
30871 #: ../src/guestfs-actions.pod:4651 ../src/guestfs-actions.pod:4670
30873 "This function takes a key or passphrase parameter which could contain "
30874 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
30879 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4580
30880 #: ../src/guestfs-actions.pod:4600 ../src/guestfs-actions.pod:4620
30881 msgid "(Added in 1.5.2)"
30885 #: ../src/guestfs-actions.pod:4545
30886 msgid "guestfs_luks_close"
30890 #: ../src/guestfs-actions.pod:4547
30894 " guestfs_luks_close (guestfs_h *g,\n"
30895 " const char *device);\n"
30900 #: ../src/guestfs-actions.pod:4551
30902 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
30903 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
30904 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
30905 "underlying block device."
30909 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4655
30910 #: ../src/guestfs-actions.pod:4674 ../src/guestfs-actions.pod:4724
30911 #: ../src/guestfs-actions.pod:4769
30912 msgid "(Added in 1.5.1)"
30916 #: ../src/guestfs-actions.pod:4561
30917 msgid "guestfs_luks_format"
30921 #: ../src/guestfs-actions.pod:4563
30925 " guestfs_luks_format (guestfs_h *g,\n"
30926 " const char *device,\n"
30927 " const char *key,\n"
30933 #: ../src/guestfs-actions.pod:4582
30934 msgid "guestfs_luks_format_cipher"
30938 #: ../src/guestfs-actions.pod:4584
30942 " guestfs_luks_format_cipher (guestfs_h *g,\n"
30943 " const char *device,\n"
30944 " const char *key,\n"
30946 " const char *cipher);\n"
30951 #: ../src/guestfs-actions.pod:4591
30953 "This command is the same as C<guestfs_luks_format> but it also allows you to "
30954 "set the C<cipher> used."
30958 #: ../src/guestfs-actions.pod:4602
30959 msgid "guestfs_luks_kill_slot"
30963 #: ../src/guestfs-actions.pod:4604
30967 " guestfs_luks_kill_slot (guestfs_h *g,\n"
30968 " const char *device,\n"
30969 " const char *key,\n"
30975 #: ../src/guestfs-actions.pod:4622
30976 msgid "guestfs_luks_open"
30980 #: ../src/guestfs-actions.pod:4624
30984 " guestfs_luks_open (guestfs_h *g,\n"
30985 " const char *device,\n"
30986 " const char *key,\n"
30987 " const char *mapname);\n"
30992 #: ../src/guestfs-actions.pod:4642
30994 "If this block device contains LVM volume groups, then calling "
30995 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
31000 #: ../src/guestfs-actions.pod:4646
31001 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
31005 #: ../src/guestfs-actions.pod:4657
31006 msgid "guestfs_luks_open_ro"
31010 #: ../src/guestfs-actions.pod:4659
31014 " guestfs_luks_open_ro (guestfs_h *g,\n"
31015 " const char *device,\n"
31016 " const char *key,\n"
31017 " const char *mapname);\n"
31022 #: ../src/guestfs-actions.pod:4665
31024 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
31029 #: ../src/guestfs-actions.pod:4676
31030 msgid "guestfs_lvcreate"
31034 #: ../src/guestfs-actions.pod:4678
31038 " guestfs_lvcreate (guestfs_h *g,\n"
31039 " const char *logvol,\n"
31040 " const char *volgroup,\n"
31046 #: ../src/guestfs-actions.pod:4691
31047 msgid "guestfs_lvm_canonical_lv_name"
31051 #: ../src/guestfs-actions.pod:4693
31055 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
31056 " const char *lvname);\n"
31061 #: ../src/guestfs-actions.pod:4704
31062 msgid "See also C<guestfs_is_lv>."
31066 #: ../src/guestfs-actions.pod:4709
31067 msgid "(Added in 1.5.24)"
31071 #: ../src/guestfs-actions.pod:4711
31072 msgid "guestfs_lvm_clear_filter"
31076 #: ../src/guestfs-actions.pod:4713
31080 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
31085 #: ../src/guestfs-actions.pod:4716
31087 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
31088 "see every block device."
31092 #: ../src/guestfs-actions.pod:4726
31093 msgid "guestfs_lvm_remove_all"
31097 #: ../src/guestfs-actions.pod:4728
31101 " guestfs_lvm_remove_all (guestfs_h *g);\n"
31106 #: ../src/guestfs-actions.pod:4738
31107 msgid "guestfs_lvm_set_filter"
31111 #: ../src/guestfs-actions.pod:4740
31115 " guestfs_lvm_set_filter (guestfs_h *g,\n"
31116 " char *const *devices);\n"
31121 #: ../src/guestfs-actions.pod:4771
31122 msgid "guestfs_lvremove"
31126 #: ../src/guestfs-actions.pod:4773
31130 " guestfs_lvremove (guestfs_h *g,\n"
31131 " const char *device);\n"
31136 #: ../src/guestfs-actions.pod:4785 ../src/guestfs-actions.pod:6344
31137 #: ../src/guestfs-actions.pod:8304
31138 msgid "(Added in 1.0.13)"
31142 #: ../src/guestfs-actions.pod:4787
31143 msgid "guestfs_lvrename"
31147 #: ../src/guestfs-actions.pod:4789
31151 " guestfs_lvrename (guestfs_h *g,\n"
31152 " const char *logvol,\n"
31153 " const char *newlogvol);\n"
31158 #: ../src/guestfs-actions.pod:4798 ../src/guestfs-actions.pod:8317
31159 msgid "(Added in 1.0.83)"
31163 #: ../src/guestfs-actions.pod:4800
31164 msgid "guestfs_lvresize"
31168 #: ../src/guestfs-actions.pod:4802
31172 " guestfs_lvresize (guestfs_h *g,\n"
31173 " const char *device,\n"
31179 #: ../src/guestfs-actions.pod:4815
31180 msgid "guestfs_lvresize_free"
31184 #: ../src/guestfs-actions.pod:4817
31188 " guestfs_lvresize_free (guestfs_h *g,\n"
31189 " const char *lv,\n"
31195 #: ../src/guestfs-actions.pod:4830
31196 msgid "(Added in 1.3.3)"
31200 #: ../src/guestfs-actions.pod:4832
31201 msgid "guestfs_lvs"
31205 #: ../src/guestfs-actions.pod:4834
31209 " guestfs_lvs (guestfs_h *g);\n"
31214 #: ../src/guestfs-actions.pod:4843
31215 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
31219 #: ../src/guestfs-actions.pod:4851
31220 msgid "guestfs_lvs_full"
31224 #: ../src/guestfs-actions.pod:4853
31227 " struct guestfs_lvm_lv_list *\n"
31228 " guestfs_lvs_full (guestfs_h *g);\n"
31233 #: ../src/guestfs-actions.pod:4859
31235 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
31236 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
31240 #: ../src/guestfs-actions.pod:4865
31241 msgid "guestfs_lvuuid"
31245 #: ../src/guestfs-actions.pod:4867
31249 " guestfs_lvuuid (guestfs_h *g,\n"
31250 " const char *device);\n"
31255 #: ../src/guestfs-actions.pod:4878
31256 msgid "guestfs_lxattrlist"
31260 #: ../src/guestfs-actions.pod:4880
31263 " struct guestfs_xattr_list *\n"
31264 " guestfs_lxattrlist (guestfs_h *g,\n"
31265 " const char *path,\n"
31266 " char *const *names);\n"
31271 #: ../src/guestfs-actions.pod:4899
31273 "This call is intended for programs that want to efficiently list a directory "
31274 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
31275 "a similarly efficient call for getting standard stats. Very long directory "
31276 "listings might cause the protocol message size to be exceeded, causing this "
31277 "call to fail. The caller must split up such requests into smaller groups of "
31282 #: ../src/guestfs-actions.pod:4913
31283 msgid "guestfs_md_create"
31287 #: ../src/guestfs-actions.pod:4915
31291 " guestfs_md_create (guestfs_h *g,\n"
31292 " const char *name,\n"
31293 " char *const *devices,\n"
31299 #: ../src/guestfs-actions.pod:4926
31302 " GUESTFS_MD_CREATE_MISSINGBITMAP, int64_t missingbitmap,\n"
31303 " GUESTFS_MD_CREATE_NRDEVICES, int nrdevices,\n"
31304 " GUESTFS_MD_CREATE_SPARE, int spare,\n"
31305 " GUESTFS_MD_CREATE_CHUNK, int64_t chunk,\n"
31306 " GUESTFS_MD_CREATE_LEVEL, const char *level,\n"
31311 #: ../src/guestfs-actions.pod:4988
31312 msgid "guestfs_md_create_va"
31316 #: ../src/guestfs-actions.pod:4990
31320 " guestfs_md_create_va (guestfs_h *g,\n"
31321 " const char *name,\n"
31322 " char *const *devices,\n"
31323 " va_list args);\n"
31328 #: ../src/guestfs-actions.pod:4996
31329 msgid "This is the \"va_list variant\" of L</guestfs_md_create>."
31333 #: ../src/guestfs-actions.pod:5000
31334 msgid "guestfs_md_create_argv"
31338 #: ../src/guestfs-actions.pod:5002
31342 " guestfs_md_create_argv (guestfs_h *g,\n"
31343 " const char *name,\n"
31344 " char *const *devices,\n"
31345 " const struct guestfs_md_create_argv *optargs);\n"
31350 #: ../src/guestfs-actions.pod:5008
31351 msgid "This is the \"argv variant\" of L</guestfs_md_create>."
31355 #: ../src/guestfs-actions.pod:5012
31356 msgid "guestfs_md_detail"
31360 #: ../src/guestfs-actions.pod:5014
31364 " guestfs_md_detail (guestfs_h *g,\n"
31365 " const char *md);\n"
31370 #: ../src/guestfs-actions.pod:5051
31371 msgid "guestfs_md_stop"
31375 #: ../src/guestfs-actions.pod:5053
31379 " guestfs_md_stop (guestfs_h *g,\n"
31380 " const char *md);\n"
31385 #: ../src/guestfs-actions.pod:5062
31386 msgid "guestfs_mkdir"
31390 #: ../src/guestfs-actions.pod:5064
31394 " guestfs_mkdir (guestfs_h *g,\n"
31395 " const char *path);\n"
31400 #: ../src/guestfs-actions.pod:5074
31401 msgid "guestfs_mkdir_mode"
31405 #: ../src/guestfs-actions.pod:5076
31409 " guestfs_mkdir_mode (guestfs_h *g,\n"
31410 " const char *path,\n"
31416 #: ../src/guestfs-actions.pod:5088
31417 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
31421 #: ../src/guestfs-actions.pod:5094
31422 msgid "guestfs_mkdir_p"
31426 #: ../src/guestfs-actions.pod:5096
31430 " guestfs_mkdir_p (guestfs_h *g,\n"
31431 " const char *path);\n"
31436 #: ../src/guestfs-actions.pod:5107
31437 msgid "guestfs_mkdtemp"
31441 #: ../src/guestfs-actions.pod:5109
31445 " guestfs_mkdtemp (guestfs_h *g,\n"
31446 " const char *template);\n"
31451 #: ../src/guestfs-actions.pod:5137
31452 msgid "guestfs_mke2fs_J"
31456 #: ../src/guestfs-actions.pod:5139
31460 " guestfs_mke2fs_J (guestfs_h *g,\n"
31461 " const char *fstype,\n"
31462 " int blocksize,\n"
31463 " const char *device,\n"
31464 " const char *journal);\n"
31469 #: ../src/guestfs-actions.pod:5152
31470 msgid "See also C<guestfs_mke2journal>."
31474 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5174
31475 #: ../src/guestfs-actions.pod:5192 ../src/guestfs-actions.pod:5208
31476 #: ../src/guestfs-actions.pod:5222 ../src/guestfs-actions.pod:5236
31477 #: ../src/guestfs-actions.pod:5295 ../src/guestfs-actions.pod:5572
31478 msgid "(Added in 1.0.68)"
31482 #: ../src/guestfs-actions.pod:5158
31483 msgid "guestfs_mke2fs_JL"
31487 #: ../src/guestfs-actions.pod:5160
31491 " guestfs_mke2fs_JL (guestfs_h *g,\n"
31492 " const char *fstype,\n"
31493 " int blocksize,\n"
31494 " const char *device,\n"
31495 " const char *label);\n"
31500 #: ../src/guestfs-actions.pod:5170
31501 msgid "See also C<guestfs_mke2journal_L>."
31505 #: ../src/guestfs-actions.pod:5176
31506 msgid "guestfs_mke2fs_JU"
31510 #: ../src/guestfs-actions.pod:5178
31514 " guestfs_mke2fs_JU (guestfs_h *g,\n"
31515 " const char *fstype,\n"
31516 " int blocksize,\n"
31517 " const char *device,\n"
31518 " const char *uuid);\n"
31523 #: ../src/guestfs-actions.pod:5188
31524 msgid "See also C<guestfs_mke2journal_U>."
31528 #: ../src/guestfs-actions.pod:5194
31529 msgid "guestfs_mke2journal"
31533 #: ../src/guestfs-actions.pod:5196
31537 " guestfs_mke2journal (guestfs_h *g,\n"
31538 " int blocksize,\n"
31539 " const char *device);\n"
31544 #: ../src/guestfs-actions.pod:5210
31545 msgid "guestfs_mke2journal_L"
31549 #: ../src/guestfs-actions.pod:5212
31553 " guestfs_mke2journal_L (guestfs_h *g,\n"
31554 " int blocksize,\n"
31555 " const char *label,\n"
31556 " const char *device);\n"
31561 #: ../src/guestfs-actions.pod:5224
31562 msgid "guestfs_mke2journal_U"
31566 #: ../src/guestfs-actions.pod:5226
31570 " guestfs_mke2journal_U (guestfs_h *g,\n"
31571 " int blocksize,\n"
31572 " const char *uuid,\n"
31573 " const char *device);\n"
31578 #: ../src/guestfs-actions.pod:5238
31579 msgid "guestfs_mkfifo"
31583 #: ../src/guestfs-actions.pod:5240
31587 " guestfs_mkfifo (guestfs_h *g,\n"
31589 " const char *path);\n"
31594 #: ../src/guestfs-actions.pod:5245
31596 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
31597 "is just a convenient wrapper around C<guestfs_mknod>."
31601 #: ../src/guestfs-actions.pod:5255
31602 msgid "guestfs_mkfs"
31606 #: ../src/guestfs-actions.pod:5257
31610 " guestfs_mkfs (guestfs_h *g,\n"
31611 " const char *fstype,\n"
31612 " const char *device);\n"
31617 #: ../src/guestfs-actions.pod:5270
31618 msgid "guestfs_mkfs_b"
31622 #: ../src/guestfs-actions.pod:5272
31626 " guestfs_mkfs_b (guestfs_h *g,\n"
31627 " const char *fstype,\n"
31628 " int blocksize,\n"
31629 " const char *device);\n"
31634 #: ../src/guestfs-actions.pod:5278
31636 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
31641 #: ../src/guestfs-actions.pod:5285
31643 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
31644 "block size of the resulting filesystem. Supported block sizes depend on the "
31645 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
31649 #: ../src/guestfs-actions.pod:5297
31650 msgid "guestfs_mkfs_opts"
31654 #: ../src/guestfs-actions.pod:5299
31658 " guestfs_mkfs_opts (guestfs_h *g,\n"
31659 " const char *fstype,\n"
31660 " const char *device,\n"
31666 #: ../src/guestfs-actions.pod:5310
31669 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
31670 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
31671 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
31672 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
31677 #: ../src/guestfs-actions.pod:5358
31678 msgid "(Added in 1.7.19)"
31682 #: ../src/guestfs-actions.pod:5360
31683 msgid "guestfs_mkfs_opts_va"
31687 #: ../src/guestfs-actions.pod:5362
31691 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
31692 " const char *fstype,\n"
31693 " const char *device,\n"
31694 " va_list args);\n"
31699 #: ../src/guestfs-actions.pod:5368
31700 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
31704 #: ../src/guestfs-actions.pod:5372
31705 msgid "guestfs_mkfs_opts_argv"
31709 #: ../src/guestfs-actions.pod:5374
31713 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
31714 " const char *fstype,\n"
31715 " const char *device,\n"
31716 " const struct guestfs_mkfs_opts_argv *optargs);\n"
31721 #: ../src/guestfs-actions.pod:5380
31722 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
31726 #: ../src/guestfs-actions.pod:5384
31727 msgid "guestfs_mkmountpoint"
31731 #: ../src/guestfs-actions.pod:5386
31735 " guestfs_mkmountpoint (guestfs_h *g,\n"
31736 " const char *exemptpath);\n"
31741 #: ../src/guestfs-actions.pod:5390
31743 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
31744 "that can be used to create extra mountpoints before mounting the first "
31749 #: ../src/guestfs-actions.pod:5414
31751 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
31752 "may get unexpected errors if you try to mix these calls. It is safest to "
31753 "manually unmount filesystems and remove mountpoints after use."
31757 #: ../src/guestfs-actions.pod:5418
31759 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
31760 "first, so for this to work for manual mountpoints, you must ensure that the "
31761 "innermost mountpoints have the longest pathnames, as in the example code "
31766 #: ../src/guestfs-actions.pod:5425
31768 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
31769 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
31770 "can also trigger these issues."
31774 #: ../src/guestfs-actions.pod:5431 ../src/guestfs-actions.pod:5737
31775 #: ../src/guestfs-actions.pod:6764
31776 msgid "(Added in 1.0.62)"
31780 #: ../src/guestfs-actions.pod:5433
31781 msgid "guestfs_mknod"
31785 #: ../src/guestfs-actions.pod:5435
31789 " guestfs_mknod (guestfs_h *g,\n"
31793 " const char *path);\n"
31798 #: ../src/guestfs-actions.pod:5450
31800 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
31801 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
31802 "regular file). These constants are available in the standard Linux header "
31803 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
31804 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
31805 "the appropriate constant for you."
31809 #: ../src/guestfs-actions.pod:5464
31810 msgid "guestfs_mknod_b"
31814 #: ../src/guestfs-actions.pod:5466
31818 " guestfs_mknod_b (guestfs_h *g,\n"
31822 " const char *path);\n"
31827 #: ../src/guestfs-actions.pod:5473
31829 "This call creates a block device node called C<path> with mode C<mode> and "
31830 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
31831 "wrapper around C<guestfs_mknod>."
31835 #: ../src/guestfs-actions.pod:5483
31836 msgid "guestfs_mknod_c"
31840 #: ../src/guestfs-actions.pod:5485
31844 " guestfs_mknod_c (guestfs_h *g,\n"
31848 " const char *path);\n"
31853 #: ../src/guestfs-actions.pod:5492
31855 "This call creates a char device node called C<path> with mode C<mode> and "
31856 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
31857 "wrapper around C<guestfs_mknod>."
31861 #: ../src/guestfs-actions.pod:5502
31862 msgid "guestfs_mkswap"
31866 #: ../src/guestfs-actions.pod:5504
31870 " guestfs_mkswap (guestfs_h *g,\n"
31871 " const char *device);\n"
31876 #: ../src/guestfs-actions.pod:5514
31877 msgid "guestfs_mkswap_L"
31881 #: ../src/guestfs-actions.pod:5516
31885 " guestfs_mkswap_L (guestfs_h *g,\n"
31886 " const char *label,\n"
31887 " const char *device);\n"
31892 #: ../src/guestfs-actions.pod:5531
31893 msgid "guestfs_mkswap_U"
31897 #: ../src/guestfs-actions.pod:5533
31901 " guestfs_mkswap_U (guestfs_h *g,\n"
31902 " const char *uuid,\n"
31903 " const char *device);\n"
31908 #: ../src/guestfs-actions.pod:5544
31909 msgid "guestfs_mkswap_file"
31913 #: ../src/guestfs-actions.pod:5546
31917 " guestfs_mkswap_file (guestfs_h *g,\n"
31918 " const char *path);\n"
31923 #: ../src/guestfs-actions.pod:5552
31925 "This command just writes a swap file signature to an existing file. To "
31926 "create the file itself, use something like C<guestfs_fallocate>."
31930 #: ../src/guestfs-actions.pod:5559
31931 msgid "guestfs_modprobe"
31935 #: ../src/guestfs-actions.pod:5561
31939 " guestfs_modprobe (guestfs_h *g,\n"
31940 " const char *modulename);\n"
31945 #: ../src/guestfs-actions.pod:5574
31946 msgid "guestfs_mount"
31950 #: ../src/guestfs-actions.pod:5576
31954 " guestfs_mount (guestfs_h *g,\n"
31955 " const char *device,\n"
31956 " const char *mountpoint);\n"
31961 #: ../src/guestfs-actions.pod:5595
31963 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
31964 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
31965 "problems for users. If your program might need to work with older versions "
31966 "of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
31967 "for the first parameter if you don't want any options)."
31971 #: ../src/guestfs-actions.pod:5606
31972 msgid "guestfs_mount_9p"
31976 #: ../src/guestfs-actions.pod:5608
31980 " guestfs_mount_9p (guestfs_h *g,\n"
31981 " const char *mounttag,\n"
31982 " const char *mountpoint,\n"
31988 #: ../src/guestfs-actions.pod:5619
31991 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
31996 #: ../src/guestfs-actions.pod:5632
31997 msgid "guestfs_mount_9p_va"
32001 #: ../src/guestfs-actions.pod:5634
32005 " guestfs_mount_9p_va (guestfs_h *g,\n"
32006 " const char *mounttag,\n"
32007 " const char *mountpoint,\n"
32008 " va_list args);\n"
32013 #: ../src/guestfs-actions.pod:5640
32014 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
32018 #: ../src/guestfs-actions.pod:5644
32019 msgid "guestfs_mount_9p_argv"
32023 #: ../src/guestfs-actions.pod:5646
32027 " guestfs_mount_9p_argv (guestfs_h *g,\n"
32028 " const char *mounttag,\n"
32029 " const char *mountpoint,\n"
32030 " const struct guestfs_mount_9p_argv *optargs);\n"
32035 #: ../src/guestfs-actions.pod:5652
32036 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
32040 #: ../src/guestfs-actions.pod:5656
32041 msgid "guestfs_mount_loop"
32045 #: ../src/guestfs-actions.pod:5658
32049 " guestfs_mount_loop (guestfs_h *g,\n"
32050 " const char *file,\n"
32051 " const char *mountpoint);\n"
32056 #: ../src/guestfs-actions.pod:5671
32057 msgid "guestfs_mount_options"
32061 #: ../src/guestfs-actions.pod:5673
32065 " guestfs_mount_options (guestfs_h *g,\n"
32066 " const char *options,\n"
32067 " const char *device,\n"
32068 " const char *mountpoint);\n"
32073 #: ../src/guestfs-actions.pod:5679
32075 "This is the same as the C<guestfs_mount> command, but it allows you to set "
32076 "the mount options as for the L<mount(8)> I<-o> flag."
32080 #: ../src/guestfs-actions.pod:5689 ../src/guestfs-actions.pod:5703
32081 #: ../src/guestfs-actions.pod:5720
32082 msgid "(Added in 1.0.10)"
32086 #: ../src/guestfs-actions.pod:5691
32087 msgid "guestfs_mount_ro"
32091 #: ../src/guestfs-actions.pod:5693
32095 " guestfs_mount_ro (guestfs_h *g,\n"
32096 " const char *device,\n"
32097 " const char *mountpoint);\n"
32102 #: ../src/guestfs-actions.pod:5698
32104 "This is the same as the C<guestfs_mount> command, but it mounts the "
32105 "filesystem with the read-only (I<-o ro>) flag."
32109 #: ../src/guestfs-actions.pod:5705
32110 msgid "guestfs_mount_vfs"
32114 #: ../src/guestfs-actions.pod:5707
32118 " guestfs_mount_vfs (guestfs_h *g,\n"
32119 " const char *options,\n"
32120 " const char *vfstype,\n"
32121 " const char *device,\n"
32122 " const char *mountpoint);\n"
32127 #: ../src/guestfs-actions.pod:5714
32129 "This is the same as the C<guestfs_mount> command, but it allows you to set "
32130 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
32135 #: ../src/guestfs-actions.pod:5722
32136 msgid "guestfs_mountpoints"
32140 #: ../src/guestfs-actions.pod:5724
32144 " guestfs_mountpoints (guestfs_h *g);\n"
32149 #: ../src/guestfs-actions.pod:5727
32151 "This call is similar to C<guestfs_mounts>. That call returns a list of "
32152 "devices. This one returns a hash table (map) of device name to directory "
32153 "where the device is mounted."
32157 #: ../src/guestfs-actions.pod:5739
32158 msgid "guestfs_mounts"
32162 #: ../src/guestfs-actions.pod:5741
32166 " guestfs_mounts (guestfs_h *g);\n"
32171 #: ../src/guestfs-actions.pod:5749
32172 msgid "See also: C<guestfs_mountpoints>"
32176 #: ../src/guestfs-actions.pod:5757
32181 #: ../src/guestfs-actions.pod:5759
32185 " guestfs_mv (guestfs_h *g,\n"
32186 " const char *src,\n"
32187 " const char *dest);\n"
32192 #: ../src/guestfs-actions.pod:5771
32193 msgid "guestfs_ntfs_3g_probe"
32197 #: ../src/guestfs-actions.pod:5773
32201 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
32203 " const char *device);\n"
32208 #: ../src/guestfs-actions.pod:5792
32209 msgid "(Added in 1.0.43)"
32213 #: ../src/guestfs-actions.pod:5794
32214 msgid "guestfs_ntfsresize"
32218 #: ../src/guestfs-actions.pod:5796
32222 " guestfs_ntfsresize (guestfs_h *g,\n"
32223 " const char *device);\n"
32228 #: ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:5900
32230 "I<This function is deprecated.> In new code, use the L</"
32231 "guestfs_ntfsresize_opts> call instead."
32235 #: ../src/guestfs-actions.pod:5824
32236 msgid "guestfs_ntfsresize_opts"
32240 #: ../src/guestfs-actions.pod:5826
32244 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
32245 " const char *device,\n"
32251 #: ../src/guestfs-actions.pod:5836
32254 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
32255 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
32260 #: ../src/guestfs-actions.pod:5856
32262 "After the resize operation, the filesystem is always marked as requiring a "
32263 "consistency check (for safety). You have to boot into Windows to perform "
32264 "this check and clear this condition. If you I<don't> set the C<force> "
32265 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
32266 "times on a single filesystem without booting into Windows between each "
32271 #: ../src/guestfs-actions.pod:5871
32272 msgid "guestfs_ntfsresize_opts_va"
32276 #: ../src/guestfs-actions.pod:5873
32280 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
32281 " const char *device,\n"
32282 " va_list args);\n"
32287 #: ../src/guestfs-actions.pod:5878
32288 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
32292 #: ../src/guestfs-actions.pod:5882
32293 msgid "guestfs_ntfsresize_opts_argv"
32297 #: ../src/guestfs-actions.pod:5884
32301 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
32302 " const char *device,\n"
32303 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
32308 #: ../src/guestfs-actions.pod:5889
32309 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
32313 #: ../src/guestfs-actions.pod:5893
32314 msgid "guestfs_ntfsresize_size"
32318 #: ../src/guestfs-actions.pod:5895
32322 " guestfs_ntfsresize_size (guestfs_h *g,\n"
32323 " const char *device,\n"
32324 " int64_t size);\n"
32329 #: ../src/guestfs-actions.pod:5907
32331 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
32332 "to specify the new size (in bytes) explicitly."
32336 #: ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:6371
32337 #: ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6712
32338 #: ../src/guestfs-actions.pod:8461
32339 msgid "(Added in 1.3.14)"
32343 #: ../src/guestfs-actions.pod:5914
32344 msgid "guestfs_part_add"
32348 #: ../src/guestfs-actions.pod:5916
32352 " guestfs_part_add (guestfs_h *g,\n"
32353 " const char *device,\n"
32354 " const char *prlogex,\n"
32355 " int64_t startsect,\n"
32356 " int64_t endsect);\n"
32361 #: ../src/guestfs-actions.pod:5923
32363 "This command adds a partition to C<device>. If there is no partition table "
32364 "on the device, call C<guestfs_part_init> first."
32368 #: ../src/guestfs-actions.pod:5935
32370 "Creating a partition which covers the whole disk is not so easy. Use "
32371 "C<guestfs_part_disk> to do that."
32375 #: ../src/guestfs-actions.pod:5940 ../src/guestfs-actions.pod:5975
32376 #: ../src/guestfs-actions.pod:6028 ../src/guestfs-actions.pod:6112
32377 #: ../src/guestfs-actions.pod:6150 ../src/guestfs-actions.pod:6169
32378 #: ../src/guestfs-actions.pod:6209
32379 msgid "(Added in 1.0.78)"
32383 #: ../src/guestfs-actions.pod:5942
32384 msgid "guestfs_part_del"
32388 #: ../src/guestfs-actions.pod:5944
32392 " guestfs_part_del (guestfs_h *g,\n"
32393 " const char *device,\n"
32399 #: ../src/guestfs-actions.pod:5959
32400 msgid "guestfs_part_disk"
32404 #: ../src/guestfs-actions.pod:5961
32408 " guestfs_part_disk (guestfs_h *g,\n"
32409 " const char *device,\n"
32410 " const char *parttype);\n"
32415 #: ../src/guestfs-actions.pod:5966
32417 "This command is simply a combination of C<guestfs_part_init> followed by "
32418 "C<guestfs_part_add> to create a single primary partition covering the whole "
32423 #: ../src/guestfs-actions.pod:5970
32425 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
32426 "possible values are described in C<guestfs_part_init>."
32430 #: ../src/guestfs-actions.pod:5977
32431 msgid "guestfs_part_get_bootable"
32435 #: ../src/guestfs-actions.pod:5979
32439 " guestfs_part_get_bootable (guestfs_h *g,\n"
32440 " const char *device,\n"
32446 #: ../src/guestfs-actions.pod:5987
32447 msgid "See also C<guestfs_part_set_bootable>."
32451 #: ../src/guestfs-actions.pod:5993
32452 msgid "guestfs_part_get_mbr_id"
32456 #: ../src/guestfs-actions.pod:5995
32460 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
32461 " const char *device,\n"
32467 #: ../src/guestfs-actions.pod:6003 ../src/guestfs-actions.pod:6185
32469 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
32470 "undefined results for other partition table types (see "
32471 "C<guestfs_part_get_parttype>)."
32475 #: ../src/guestfs-actions.pod:6011
32476 msgid "guestfs_part_get_parttype"
32480 #: ../src/guestfs-actions.pod:6013
32484 " guestfs_part_get_parttype (guestfs_h *g,\n"
32485 " const char *device);\n"
32490 #: ../src/guestfs-actions.pod:6020
32492 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
32493 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
32494 "possible, although unusual. See C<guestfs_part_init> for a full list."
32498 #: ../src/guestfs-actions.pod:6030
32499 msgid "guestfs_part_init"
32503 #: ../src/guestfs-actions.pod:6032
32507 " guestfs_part_init (guestfs_h *g,\n"
32508 " const char *device,\n"
32509 " const char *parttype);\n"
32514 #: ../src/guestfs-actions.pod:6041
32516 "Initially there are no partitions. Following this, you should call "
32517 "C<guestfs_part_add> for each partition required."
32521 #: ../src/guestfs-actions.pod:6114
32522 msgid "guestfs_part_list"
32526 #: ../src/guestfs-actions.pod:6116
32529 " struct guestfs_partition_list *\n"
32530 " guestfs_part_list (guestfs_h *g,\n"
32531 " const char *device);\n"
32536 #: ../src/guestfs-actions.pod:6133
32538 "Start of the partition I<in bytes>. To get sectors you have to divide by "
32539 "the device's sector size, see C<guestfs_blockdev_getss>."
32543 #: ../src/guestfs-actions.pod:6146
32545 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
32546 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
32551 #: ../src/guestfs-actions.pod:6152
32552 msgid "guestfs_part_set_bootable"
32556 #: ../src/guestfs-actions.pod:6154
32560 " guestfs_part_set_bootable (guestfs_h *g,\n"
32561 " const char *device,\n"
32563 " int bootable);\n"
32568 #: ../src/guestfs-actions.pod:6171
32569 msgid "guestfs_part_set_mbr_id"
32573 #: ../src/guestfs-actions.pod:6173
32577 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
32578 " const char *device,\n"
32585 #: ../src/guestfs-actions.pod:6193
32586 msgid "guestfs_part_set_name"
32590 #: ../src/guestfs-actions.pod:6195
32594 " guestfs_part_set_name (guestfs_h *g,\n"
32595 " const char *device,\n"
32597 " const char *name);\n"
32602 #: ../src/guestfs-actions.pod:6211
32603 msgid "guestfs_part_to_dev"
32607 #: ../src/guestfs-actions.pod:6213
32611 " guestfs_part_to_dev (guestfs_h *g,\n"
32612 " const char *partition);\n"
32617 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6240
32619 "The named partition must exist, for example as a string returned from "
32620 "C<guestfs_list_partitions>."
32624 #: ../src/guestfs-actions.pod:6224
32625 msgid "See also C<guestfs_part_to_partnum>."
32629 #: ../src/guestfs-actions.pod:6231
32630 msgid "guestfs_part_to_partnum"
32634 #: ../src/guestfs-actions.pod:6233
32638 " guestfs_part_to_partnum (guestfs_h *g,\n"
32639 " const char *partition);\n"
32644 #: ../src/guestfs-actions.pod:6243
32645 msgid "See also C<guestfs_part_to_dev>."
32649 #: ../src/guestfs-actions.pod:6249
32650 msgid "guestfs_ping_daemon"
32654 #: ../src/guestfs-actions.pod:6251
32658 " guestfs_ping_daemon (guestfs_h *g);\n"
32663 #: ../src/guestfs-actions.pod:6263
32664 msgid "guestfs_pread"
32668 #: ../src/guestfs-actions.pod:6265
32672 " guestfs_pread (guestfs_h *g,\n"
32673 " const char *path,\n"
32675 " int64_t offset,\n"
32676 " size_t *size_r);\n"
32681 #: ../src/guestfs-actions.pod:6278
32682 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
32686 #: ../src/guestfs-actions.pod:6289
32687 msgid "guestfs_pread_device"
32691 #: ../src/guestfs-actions.pod:6291
32695 " guestfs_pread_device (guestfs_h *g,\n"
32696 " const char *device,\n"
32698 " int64_t offset,\n"
32699 " size_t *size_r);\n"
32704 #: ../src/guestfs-actions.pod:6304
32705 msgid "See also C<guestfs_pread>."
32709 #: ../src/guestfs-actions.pod:6313
32710 msgid "(Added in 1.5.21)"
32714 #: ../src/guestfs-actions.pod:6315
32715 msgid "guestfs_pvcreate"
32719 #: ../src/guestfs-actions.pod:6317
32723 " guestfs_pvcreate (guestfs_h *g,\n"
32724 " const char *device);\n"
32729 #: ../src/guestfs-actions.pod:6329
32730 msgid "guestfs_pvremove"
32734 #: ../src/guestfs-actions.pod:6331
32738 " guestfs_pvremove (guestfs_h *g,\n"
32739 " const char *device);\n"
32744 #: ../src/guestfs-actions.pod:6346
32745 msgid "guestfs_pvresize"
32749 #: ../src/guestfs-actions.pod:6348
32753 " guestfs_pvresize (guestfs_h *g,\n"
32754 " const char *device);\n"
32759 #: ../src/guestfs-actions.pod:6359
32760 msgid "guestfs_pvresize_size"
32764 #: ../src/guestfs-actions.pod:6361
32768 " guestfs_pvresize_size (guestfs_h *g,\n"
32769 " const char *device,\n"
32770 " int64_t size);\n"
32775 #: ../src/guestfs-actions.pod:6366
32777 "This command is the same as C<guestfs_pvresize> except that it allows you to "
32778 "specify the new size (in bytes) explicitly."
32782 #: ../src/guestfs-actions.pod:6373
32783 msgid "guestfs_pvs"
32787 #: ../src/guestfs-actions.pod:6375
32791 " guestfs_pvs (guestfs_h *g);\n"
32796 #: ../src/guestfs-actions.pod:6384
32797 msgid "See also C<guestfs_pvs_full>."
32801 #: ../src/guestfs-actions.pod:6392
32802 msgid "guestfs_pvs_full"
32806 #: ../src/guestfs-actions.pod:6394
32809 " struct guestfs_lvm_pv_list *\n"
32810 " guestfs_pvs_full (guestfs_h *g);\n"
32815 #: ../src/guestfs-actions.pod:6400
32817 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
32818 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
32822 #: ../src/guestfs-actions.pod:6406
32823 msgid "guestfs_pvuuid"
32827 #: ../src/guestfs-actions.pod:6408
32831 " guestfs_pvuuid (guestfs_h *g,\n"
32832 " const char *device);\n"
32837 #: ../src/guestfs-actions.pod:6419
32838 msgid "guestfs_pwrite"
32842 #: ../src/guestfs-actions.pod:6421
32846 " guestfs_pwrite (guestfs_h *g,\n"
32847 " const char *path,\n"
32848 " const char *content,\n"
32849 " size_t content_size,\n"
32850 " int64_t offset);\n"
32855 #: ../src/guestfs-actions.pod:6437
32856 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
32860 #: ../src/guestfs-actions.pod:6446
32861 msgid "guestfs_pwrite_device"
32865 #: ../src/guestfs-actions.pod:6448
32869 " guestfs_pwrite_device (guestfs_h *g,\n"
32870 " const char *device,\n"
32871 " const char *content,\n"
32872 " size_t content_size,\n"
32873 " int64_t offset);\n"
32878 #: ../src/guestfs-actions.pod:6463
32879 msgid "See also C<guestfs_pwrite>."
32883 #: ../src/guestfs-actions.pod:6470
32884 msgid "(Added in 1.5.20)"
32888 #: ../src/guestfs-actions.pod:6472
32889 msgid "guestfs_read_file"
32893 #: ../src/guestfs-actions.pod:6474
32897 " guestfs_read_file (guestfs_h *g,\n"
32898 " const char *path,\n"
32899 " size_t *size_r);\n"
32904 #: ../src/guestfs-actions.pod:6482
32906 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
32907 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
32908 "function is limited in the total size of file that can be handled."
32912 #: ../src/guestfs-actions.pod:6494
32913 msgid "(Added in 1.0.63)"
32917 #: ../src/guestfs-actions.pod:6496
32918 msgid "guestfs_read_lines"
32922 #: ../src/guestfs-actions.pod:6498
32926 " guestfs_read_lines (guestfs_h *g,\n"
32927 " const char *path);\n"
32932 #: ../src/guestfs-actions.pod:6507
32934 "Note that this function cannot correctly handle binary files (specifically, "
32935 "files containing C<\\0> character which is treated as end of line). For "
32936 "those you need to use the C<guestfs_read_file> function which has a more "
32937 "complex interface."
32941 #: ../src/guestfs-actions.pod:6518
32942 msgid "guestfs_readdir"
32946 #: ../src/guestfs-actions.pod:6520
32949 " struct guestfs_dirent_list *\n"
32950 " guestfs_readdir (guestfs_h *g,\n"
32951 " const char *dir);\n"
32956 #: ../src/guestfs-actions.pod:6574
32958 "This function is primarily intended for use by programs. To get a simple "
32959 "list of names, use C<guestfs_ls>. To get a printable directory for human "
32960 "consumption, use C<guestfs_ll>."
32964 #: ../src/guestfs-actions.pod:6578
32966 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
32967 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
32971 #: ../src/guestfs-actions.pod:6584
32972 msgid "guestfs_readlink"
32976 #: ../src/guestfs-actions.pod:6586
32980 " guestfs_readlink (guestfs_h *g,\n"
32981 " const char *path);\n"
32986 #: ../src/guestfs-actions.pod:6597
32987 msgid "guestfs_readlinklist"
32991 #: ../src/guestfs-actions.pod:6599
32995 " guestfs_readlinklist (guestfs_h *g,\n"
32996 " const char *path,\n"
32997 " char *const *names);\n"
33002 #: ../src/guestfs-actions.pod:6632
33003 msgid "guestfs_realpath"
33007 #: ../src/guestfs-actions.pod:6634
33011 " guestfs_realpath (guestfs_h *g,\n"
33012 " const char *path);\n"
33017 #: ../src/guestfs-actions.pod:6646
33018 msgid "guestfs_removexattr"
33022 #: ../src/guestfs-actions.pod:6648
33026 " guestfs_removexattr (guestfs_h *g,\n"
33027 " const char *xattr,\n"
33028 " const char *path);\n"
33033 #: ../src/guestfs-actions.pod:6656
33034 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
33038 #: ../src/guestfs-actions.pod:6662
33039 msgid "guestfs_resize2fs"
33043 #: ../src/guestfs-actions.pod:6664
33047 " guestfs_resize2fs (guestfs_h *g,\n"
33048 " const char *device);\n"
33053 #: ../src/guestfs-actions.pod:6671
33055 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
33056 "C<device> before calling this command. For unknown reasons C<resize2fs> "
33057 "sometimes gives an error about this and sometimes not. In any case, it is "
33058 "always safe to call C<guestfs_e2fsck_f> before calling this function."
33062 #: ../src/guestfs-actions.pod:6681
33063 msgid "guestfs_resize2fs_M"
33067 #: ../src/guestfs-actions.pod:6683
33071 " guestfs_resize2fs_M (guestfs_h *g,\n"
33072 " const char *device);\n"
33077 #: ../src/guestfs-actions.pod:6687
33079 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
33080 "resized to its minimum size. This works like the I<-M> option to the "
33081 "C<resize2fs> command."
33085 #: ../src/guestfs-actions.pod:6691
33087 "To get the resulting size of the filesystem you should call "
33088 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
33089 "These two numbers, multiplied together, give the resulting size of the "
33090 "minimal filesystem in bytes."
33094 #: ../src/guestfs-actions.pod:6700
33095 msgid "guestfs_resize2fs_size"
33099 #: ../src/guestfs-actions.pod:6702
33103 " guestfs_resize2fs_size (guestfs_h *g,\n"
33104 " const char *device,\n"
33105 " int64_t size);\n"
33110 #: ../src/guestfs-actions.pod:6707
33112 "This command is the same as C<guestfs_resize2fs> except that it allows you "
33113 "to specify the new size (in bytes) explicitly."
33117 #: ../src/guestfs-actions.pod:6714
33122 #: ../src/guestfs-actions.pod:6716
33126 " guestfs_rm (guestfs_h *g,\n"
33127 " const char *path);\n"
33132 #: ../src/guestfs-actions.pod:6726
33133 msgid "guestfs_rm_rf"
33137 #: ../src/guestfs-actions.pod:6728
33141 " guestfs_rm_rf (guestfs_h *g,\n"
33142 " const char *path);\n"
33147 #: ../src/guestfs-actions.pod:6740
33148 msgid "guestfs_rmdir"
33152 #: ../src/guestfs-actions.pod:6742
33156 " guestfs_rmdir (guestfs_h *g,\n"
33157 " const char *path);\n"
33162 #: ../src/guestfs-actions.pod:6752
33163 msgid "guestfs_rmmountpoint"
33167 #: ../src/guestfs-actions.pod:6754
33171 " guestfs_rmmountpoint (guestfs_h *g,\n"
33172 " const char *exemptpath);\n"
33177 #: ../src/guestfs-actions.pod:6758
33179 "This calls removes a mountpoint that was previously created with "
33180 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
33184 #: ../src/guestfs-actions.pod:6766
33185 msgid "guestfs_scrub_device"
33189 #: ../src/guestfs-actions.pod:6768
33193 " guestfs_scrub_device (guestfs_h *g,\n"
33194 " const char *device);\n"
33199 #: ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6798
33200 #: ../src/guestfs-actions.pod:6817
33201 msgid "(Added in 1.0.52)"
33205 #: ../src/guestfs-actions.pod:6782
33206 msgid "guestfs_scrub_file"
33210 #: ../src/guestfs-actions.pod:6784
33214 " guestfs_scrub_file (guestfs_h *g,\n"
33215 " const char *file);\n"
33220 #: ../src/guestfs-actions.pod:6800
33221 msgid "guestfs_scrub_freespace"
33225 #: ../src/guestfs-actions.pod:6802
33229 " guestfs_scrub_freespace (guestfs_h *g,\n"
33230 " const char *dir);\n"
33235 #: ../src/guestfs-actions.pod:6806
33237 "This command creates the directory C<dir> and then fills it with files until "
33238 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
33239 "and deletes them. The intention is to scrub any free space on the partition "
33240 "containing C<dir>."
33244 #: ../src/guestfs-actions.pod:6819
33245 msgid "guestfs_set_append"
33249 #: ../src/guestfs-actions.pod:6821
33253 " guestfs_set_append (guestfs_h *g,\n"
33254 " const char *append);\n"
33259 #: ../src/guestfs-actions.pod:6838
33260 msgid "guestfs_set_attach_method"
33264 #: ../src/guestfs-actions.pod:6840
33268 " guestfs_set_attach_method (guestfs_h *g,\n"
33269 " const char *attachmethod);\n"
33274 #: ../src/guestfs-actions.pod:6868
33275 msgid "guestfs_set_autosync"
33279 #: ../src/guestfs-actions.pod:6870
33283 " guestfs_set_autosync (guestfs_h *g,\n"
33284 " int autosync);\n"
33289 #: ../src/guestfs-actions.pod:6886
33290 msgid "guestfs_set_direct"
33294 #: ../src/guestfs-actions.pod:6888
33298 " guestfs_set_direct (guestfs_h *g,\n"
33304 #: ../src/guestfs-actions.pod:6896
33306 "One consequence of this is that log messages aren't caught by the library "
33307 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
33312 #: ../src/guestfs-actions.pod:6909
33313 msgid "guestfs_set_e2label"
33317 #: ../src/guestfs-actions.pod:6911
33321 " guestfs_set_e2label (guestfs_h *g,\n"
33322 " const char *device,\n"
33323 " const char *label);\n"
33328 #: ../src/guestfs-actions.pod:6920
33330 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
33331 "the existing label on a filesystem."
33335 #: ../src/guestfs-actions.pod:6927
33336 msgid "guestfs_set_e2uuid"
33340 #: ../src/guestfs-actions.pod:6929
33344 " guestfs_set_e2uuid (guestfs_h *g,\n"
33345 " const char *device,\n"
33346 " const char *uuid);\n"
33351 #: ../src/guestfs-actions.pod:6939
33353 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
33354 "the existing UUID of a filesystem."
33358 #: ../src/guestfs-actions.pod:6946
33359 msgid "guestfs_set_memsize"
33363 #: ../src/guestfs-actions.pod:6948
33367 " guestfs_set_memsize (guestfs_h *g,\n"
33373 #: ../src/guestfs-actions.pod:6952
33375 "This sets the memory size in megabytes allocated to the qemu subprocess. "
33376 "This only has any effect if called before C<guestfs_launch>."
33380 #: ../src/guestfs-actions.pod:6967
33381 msgid "guestfs_set_network"
33385 #: ../src/guestfs-actions.pod:6969
33389 " guestfs_set_network (guestfs_h *g,\n"
33395 #: ../src/guestfs-actions.pod:6979
33397 "You must call this before calling C<guestfs_launch>, otherwise it has no "
33402 #: ../src/guestfs-actions.pod:6986
33403 msgid "guestfs_set_path"
33407 #: ../src/guestfs-actions.pod:6988
33411 " guestfs_set_path (guestfs_h *g,\n"
33412 " const char *searchpath);\n"
33417 #: ../src/guestfs-actions.pod:7003
33418 msgid "guestfs_set_pgroup"
33422 #: ../src/guestfs-actions.pod:7005
33426 " guestfs_set_pgroup (guestfs_h *g,\n"
33432 #: ../src/guestfs-actions.pod:7022
33433 msgid "guestfs_set_qemu"
33437 #: ../src/guestfs-actions.pod:7024
33441 " guestfs_set_qemu (guestfs_h *g,\n"
33442 " const char *qemu);\n"
33447 #: ../src/guestfs-actions.pod:7050
33448 msgid "guestfs_set_recovery_proc"
33452 #: ../src/guestfs-actions.pod:7052
33456 " guestfs_set_recovery_proc (guestfs_h *g,\n"
33457 " int recoveryproc);\n"
33462 #: ../src/guestfs-actions.pod:7056
33464 "If this is called with the parameter C<false> then C<guestfs_launch> does "
33465 "not create a recovery process. The purpose of the recovery process is to "
33466 "stop runaway qemu processes in the case where the main program aborts "
33471 #: ../src/guestfs-actions.pod:7061
33473 "This only has any effect if called before C<guestfs_launch>, and the default "
33478 #: ../src/guestfs-actions.pod:7074
33479 msgid "guestfs_set_selinux"
33483 #: ../src/guestfs-actions.pod:7076
33487 " guestfs_set_selinux (guestfs_h *g,\n"
33493 #: ../src/guestfs-actions.pod:7093
33494 msgid "guestfs_set_smp"
33498 #: ../src/guestfs-actions.pod:7095
33502 " guestfs_set_smp (guestfs_h *g,\n"
33508 #: ../src/guestfs-actions.pod:7103
33509 msgid "This function must be called before C<guestfs_launch>."
33513 #: ../src/guestfs-actions.pod:7109
33514 msgid "guestfs_set_trace"
33518 #: ../src/guestfs-actions.pod:7111
33522 " guestfs_set_trace (guestfs_h *g,\n"
33528 #: ../src/guestfs-actions.pod:7125
33530 "Trace messages are normally sent to C<stderr>, unless you register a "
33531 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
33535 #: ../src/guestfs-actions.pod:7133
33536 msgid "guestfs_set_verbose"
33540 #: ../src/guestfs-actions.pod:7135
33544 " guestfs_set_verbose (guestfs_h *g,\n"
33550 #: ../src/guestfs-actions.pod:7144
33552 "Verbose messages are normally sent to C<stderr>, unless you register a "
33553 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
33557 #: ../src/guestfs-actions.pod:7152
33558 msgid "guestfs_setcon"
33562 #: ../src/guestfs-actions.pod:7154
33566 " guestfs_setcon (guestfs_h *g,\n"
33567 " const char *context);\n"
33572 #: ../src/guestfs-actions.pod:7167
33573 msgid "guestfs_setxattr"
33577 #: ../src/guestfs-actions.pod:7169
33581 " guestfs_setxattr (guestfs_h *g,\n"
33582 " const char *xattr,\n"
33583 " const char *val,\n"
33585 " const char *path);\n"
33590 #: ../src/guestfs-actions.pod:7180
33591 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
33595 #: ../src/guestfs-actions.pod:7186
33596 msgid "guestfs_sfdisk"
33600 #: ../src/guestfs-actions.pod:7188
33604 " guestfs_sfdisk (guestfs_h *g,\n"
33605 " const char *device,\n"
33609 " char *const *lines);\n"
33614 #: ../src/guestfs-actions.pod:7196 ../src/guestfs-actions.pod:7237
33615 #: ../src/guestfs-actions.pod:7268
33617 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
33622 #: ../src/guestfs-actions.pod:7223
33624 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
33628 #: ../src/guestfs-actions.pod:7230
33629 msgid "guestfs_sfdiskM"
33633 #: ../src/guestfs-actions.pod:7232
33637 " guestfs_sfdiskM (guestfs_h *g,\n"
33638 " const char *device,\n"
33639 " char *const *lines);\n"
33644 #: ../src/guestfs-actions.pod:7244
33646 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
33647 "partition sizes are specified in megabytes only (rounded to the nearest "
33648 "cylinder) and you don't need to specify the cyls, heads and sectors "
33649 "parameters which were rarely if ever used anyway."
33653 #: ../src/guestfs-actions.pod:7250
33655 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
33656 "C<guestfs_part_disk>"
33660 #: ../src/guestfs-actions.pod:7257
33661 msgid "guestfs_sfdisk_N"
33665 #: ../src/guestfs-actions.pod:7259
33669 " guestfs_sfdisk_N (guestfs_h *g,\n"
33670 " const char *device,\n"
33675 " const char *line);\n"
33680 #: ../src/guestfs-actions.pod:7278
33682 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
33683 "for the cyls/heads/sectors parameters."
33687 #: ../src/guestfs-actions.pod:7281
33688 msgid "See also: C<guestfs_part_add>"
33692 #: ../src/guestfs-actions.pod:7287
33693 msgid "guestfs_sfdisk_disk_geometry"
33697 #: ../src/guestfs-actions.pod:7289
33701 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
33702 " const char *device);\n"
33707 #: ../src/guestfs-actions.pod:7293
33709 "This displays the disk geometry of C<device> read from the partition table. "
33710 "Especially in the case where the underlying block device has been resized, "
33711 "this can be different from the kernel's idea of the geometry (see "
33712 "C<guestfs_sfdisk_kernel_geometry>)."
33716 #: ../src/guestfs-actions.pod:7306
33717 msgid "guestfs_sfdisk_kernel_geometry"
33721 #: ../src/guestfs-actions.pod:7308
33725 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
33726 " const char *device);\n"
33731 #: ../src/guestfs-actions.pod:7322
33732 msgid "guestfs_sfdisk_l"
33736 #: ../src/guestfs-actions.pod:7324
33740 " guestfs_sfdisk_l (guestfs_h *g,\n"
33741 " const char *device);\n"
33746 #: ../src/guestfs-actions.pod:7328
33748 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
33753 #: ../src/guestfs-actions.pod:7339
33754 msgid "See also: C<guestfs_part_list>"
33758 #: ../src/guestfs-actions.pod:7346
33763 #: ../src/guestfs-actions.pod:7348
33767 " guestfs_sh (guestfs_h *g,\n"
33768 " const char *command);\n"
33773 #: ../src/guestfs-actions.pod:7355
33774 msgid "This is like C<guestfs_command>, but passes the command to:"
33778 #: ../src/guestfs-actions.pod:7363
33779 msgid "All the provisos about C<guestfs_command> apply to this call."
33783 #: ../src/guestfs-actions.pod:7370
33784 msgid "guestfs_sh_lines"
33788 #: ../src/guestfs-actions.pod:7372
33792 " guestfs_sh_lines (guestfs_h *g,\n"
33793 " const char *command);\n"
33798 #: ../src/guestfs-actions.pod:7376
33800 "This is the same as C<guestfs_sh>, but splits the result into a list of "
33805 #: ../src/guestfs-actions.pod:7379
33806 msgid "See also: C<guestfs_command_lines>"
33810 #: ../src/guestfs-actions.pod:7387
33811 msgid "guestfs_sleep"
33815 #: ../src/guestfs-actions.pod:7389
33819 " guestfs_sleep (guestfs_h *g,\n"
33825 #: ../src/guestfs-actions.pod:7397
33826 msgid "(Added in 1.0.41)"
33830 #: ../src/guestfs-actions.pod:7399 ../src/guestfs-structs.pod:109
33831 msgid "guestfs_stat"
33835 #: ../src/guestfs-actions.pod:7401
33838 " struct guestfs_stat *\n"
33839 " guestfs_stat (guestfs_h *g,\n"
33840 " const char *path);\n"
33845 #: ../src/guestfs-actions.pod:7415 ../src/guestfs-structs.pod:135
33846 msgid "guestfs_statvfs"
33850 #: ../src/guestfs-actions.pod:7417
33853 " struct guestfs_statvfs *\n"
33854 " guestfs_statvfs (guestfs_h *g,\n"
33855 " const char *path);\n"
33860 #: ../src/guestfs-actions.pod:7427
33862 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
33863 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
33867 #: ../src/guestfs-actions.pod:7433
33868 msgid "guestfs_strings"
33872 #: ../src/guestfs-actions.pod:7435
33876 " guestfs_strings (guestfs_h *g,\n"
33877 " const char *path);\n"
33882 #: ../src/guestfs-actions.pod:7451
33883 msgid "guestfs_strings_e"
33887 #: ../src/guestfs-actions.pod:7453
33891 " guestfs_strings_e (guestfs_h *g,\n"
33892 " const char *encoding,\n"
33893 " const char *path);\n"
33898 #: ../src/guestfs-actions.pod:7458
33900 "This is like the C<guestfs_strings> command, but allows you to specify the "
33901 "encoding of strings that are looked for in the source file C<path>."
33905 #: ../src/guestfs-actions.pod:7468
33907 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
33908 "ISO-8859-X (this is what C<guestfs_strings> uses)."
33912 #: ../src/guestfs-actions.pod:7506
33913 msgid "guestfs_swapoff_device"
33917 #: ../src/guestfs-actions.pod:7508
33921 " guestfs_swapoff_device (guestfs_h *g,\n"
33922 " const char *device);\n"
33927 #: ../src/guestfs-actions.pod:7512
33929 "This command disables the libguestfs appliance swap device or partition "
33930 "named C<device>. See C<guestfs_swapon_device>."
33934 #: ../src/guestfs-actions.pod:7520
33935 msgid "guestfs_swapoff_file"
33939 #: ../src/guestfs-actions.pod:7522
33943 " guestfs_swapoff_file (guestfs_h *g,\n"
33944 " const char *file);\n"
33949 #: ../src/guestfs-actions.pod:7532
33950 msgid "guestfs_swapoff_label"
33954 #: ../src/guestfs-actions.pod:7534
33958 " guestfs_swapoff_label (guestfs_h *g,\n"
33959 " const char *label);\n"
33964 #: ../src/guestfs-actions.pod:7545
33965 msgid "guestfs_swapoff_uuid"
33969 #: ../src/guestfs-actions.pod:7547
33973 " guestfs_swapoff_uuid (guestfs_h *g,\n"
33974 " const char *uuid);\n"
33979 #: ../src/guestfs-actions.pod:7558
33980 msgid "guestfs_swapon_device"
33984 #: ../src/guestfs-actions.pod:7560
33988 " guestfs_swapon_device (guestfs_h *g,\n"
33989 " const char *device);\n"
33994 #: ../src/guestfs-actions.pod:7564
33996 "This command enables the libguestfs appliance to use the swap device or "
33997 "partition named C<device>. The increased memory is made available for all "
33998 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
34002 #: ../src/guestfs-actions.pod:7580
34003 msgid "guestfs_swapon_file"
34007 #: ../src/guestfs-actions.pod:7582
34011 " guestfs_swapon_file (guestfs_h *g,\n"
34012 " const char *file);\n"
34017 #: ../src/guestfs-actions.pod:7586
34019 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
34024 #: ../src/guestfs-actions.pod:7593
34025 msgid "guestfs_swapon_label"
34029 #: ../src/guestfs-actions.pod:7595
34033 " guestfs_swapon_label (guestfs_h *g,\n"
34034 " const char *label);\n"
34039 #: ../src/guestfs-actions.pod:7599
34041 "This command enables swap to a labeled swap partition. See "
34042 "C<guestfs_swapon_device> for other notes."
34046 #: ../src/guestfs-actions.pod:7606
34047 msgid "guestfs_swapon_uuid"
34051 #: ../src/guestfs-actions.pod:7608
34055 " guestfs_swapon_uuid (guestfs_h *g,\n"
34056 " const char *uuid);\n"
34061 #: ../src/guestfs-actions.pod:7612
34063 "This command enables swap to a swap partition with the given UUID. See "
34064 "C<guestfs_swapon_device> for other notes."
34068 #: ../src/guestfs-actions.pod:7619
34069 msgid "guestfs_sync"
34073 #: ../src/guestfs-actions.pod:7621
34077 " guestfs_sync (guestfs_h *g);\n"
34082 #: ../src/guestfs-actions.pod:7634
34083 msgid "guestfs_tail"
34087 #: ../src/guestfs-actions.pod:7636
34091 " guestfs_tail (guestfs_h *g,\n"
34092 " const char *path);\n"
34097 #: ../src/guestfs-actions.pod:7652
34098 msgid "guestfs_tail_n"
34102 #: ../src/guestfs-actions.pod:7654
34106 " guestfs_tail_n (guestfs_h *g,\n"
34108 " const char *path);\n"
34113 #: ../src/guestfs-actions.pod:7676
34114 msgid "guestfs_tar_in"
34118 #: ../src/guestfs-actions.pod:7678
34122 " guestfs_tar_in (guestfs_h *g,\n"
34123 " const char *tarfile,\n"
34124 " const char *directory);\n"
34129 #: ../src/guestfs-actions.pod:7686
34131 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
34135 #: ../src/guestfs-actions.pod:7691 ../src/guestfs-actions.pod:7708
34136 #: ../src/guestfs-actions.pod:7724 ../src/guestfs-actions.pod:7740
34137 msgid "(Added in 1.0.3)"
34141 #: ../src/guestfs-actions.pod:7693
34142 msgid "guestfs_tar_out"
34146 #: ../src/guestfs-actions.pod:7695
34150 " guestfs_tar_out (guestfs_h *g,\n"
34151 " const char *directory,\n"
34152 " const char *tarfile);\n"
34157 #: ../src/guestfs-actions.pod:7703
34159 "To download a compressed tarball, use C<guestfs_tgz_out> or "
34160 "C<guestfs_txz_out>."
34164 #: ../src/guestfs-actions.pod:7710
34165 msgid "guestfs_tgz_in"
34169 #: ../src/guestfs-actions.pod:7712
34173 " guestfs_tgz_in (guestfs_h *g,\n"
34174 " const char *tarball,\n"
34175 " const char *directory);\n"
34180 #: ../src/guestfs-actions.pod:7720
34181 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
34185 #: ../src/guestfs-actions.pod:7726
34186 msgid "guestfs_tgz_out"
34190 #: ../src/guestfs-actions.pod:7728
34194 " guestfs_tgz_out (guestfs_h *g,\n"
34195 " const char *directory,\n"
34196 " const char *tarball);\n"
34201 #: ../src/guestfs-actions.pod:7736
34202 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
34206 #: ../src/guestfs-actions.pod:7742
34207 msgid "guestfs_touch"
34211 #: ../src/guestfs-actions.pod:7744
34215 " guestfs_touch (guestfs_h *g,\n"
34216 " const char *path);\n"
34221 #: ../src/guestfs-actions.pod:7759
34222 msgid "guestfs_truncate"
34226 #: ../src/guestfs-actions.pod:7761
34230 " guestfs_truncate (guestfs_h *g,\n"
34231 " const char *path);\n"
34236 #: ../src/guestfs-actions.pod:7772
34237 msgid "guestfs_truncate_size"
34241 #: ../src/guestfs-actions.pod:7774
34245 " guestfs_truncate_size (guestfs_h *g,\n"
34246 " const char *path,\n"
34247 " int64_t size);\n"
34252 #: ../src/guestfs-actions.pod:7782
34254 "If the current file size is less than C<size> then the file is extended to "
34255 "the required size with zero bytes. This creates a sparse file (ie. disk "
34256 "blocks are not allocated for the file until you write to it). To create a "
34257 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
34261 #: ../src/guestfs-actions.pod:7792
34262 msgid "guestfs_tune2fs"
34266 #: ../src/guestfs-actions.pod:7794
34270 " guestfs_tune2fs (guestfs_h *g,\n"
34271 " const char *device,\n"
34277 #: ../src/guestfs-actions.pod:7804
34280 " GUESTFS_TUNE2FS_FORCE, int force,\n"
34281 " GUESTFS_TUNE2FS_MAXMOUNTCOUNT, int maxmountcount,\n"
34282 " GUESTFS_TUNE2FS_MOUNTCOUNT, int mountcount,\n"
34283 " GUESTFS_TUNE2FS_ERRORBEHAVIOR, const char *errorbehavior,\n"
34284 " GUESTFS_TUNE2FS_GROUP, int64_t group,\n"
34285 " GUESTFS_TUNE2FS_INTERVALBETWEENCHECKS, int intervalbetweenchecks,\n"
34286 " GUESTFS_TUNE2FS_RESERVEDBLOCKSPERCENTAGE, int reservedblockspercentage,\n"
34287 " GUESTFS_TUNE2FS_LASTMOUNTEDDIRECTORY, const char *lastmounteddirectory,\n"
34288 " GUESTFS_TUNE2FS_RESERVEDBLOCKSCOUNT, int64_t reservedblockscount,\n"
34289 " GUESTFS_TUNE2FS_USER, int64_t user,\n"
34294 #: ../src/guestfs-actions.pod:7884
34296 "To get the current values of filesystem parameters, see "
34297 "C<guestfs_tune2fs_l>. For precise details of how tune2fs works, see the "
34298 "L<tune2fs(8)> man page."
34302 #: ../src/guestfs-actions.pod:7892
34303 msgid "guestfs_tune2fs_va"
34307 #: ../src/guestfs-actions.pod:7894
34311 " guestfs_tune2fs_va (guestfs_h *g,\n"
34312 " const char *device,\n"
34313 " va_list args);\n"
34318 #: ../src/guestfs-actions.pod:7899
34319 msgid "This is the \"va_list variant\" of L</guestfs_tune2fs>."
34323 #: ../src/guestfs-actions.pod:7903
34324 msgid "guestfs_tune2fs_argv"
34328 #: ../src/guestfs-actions.pod:7905
34332 " guestfs_tune2fs_argv (guestfs_h *g,\n"
34333 " const char *device,\n"
34334 " const struct guestfs_tune2fs_argv *optargs);\n"
34339 #: ../src/guestfs-actions.pod:7910
34340 msgid "This is the \"argv variant\" of L</guestfs_tune2fs>."
34344 #: ../src/guestfs-actions.pod:7914
34345 msgid "guestfs_tune2fs_l"
34349 #: ../src/guestfs-actions.pod:7916
34353 " guestfs_tune2fs_l (guestfs_h *g,\n"
34354 " const char *device);\n"
34359 #: ../src/guestfs-actions.pod:7936
34360 msgid "guestfs_txz_in"
34364 #: ../src/guestfs-actions.pod:7938
34368 " guestfs_txz_in (guestfs_h *g,\n"
34369 " const char *tarball,\n"
34370 " const char *directory);\n"
34375 #: ../src/guestfs-actions.pod:7950
34376 msgid "guestfs_txz_out"
34380 #: ../src/guestfs-actions.pod:7952
34384 " guestfs_txz_out (guestfs_h *g,\n"
34385 " const char *directory,\n"
34386 " const char *tarball);\n"
34391 #: ../src/guestfs-actions.pod:7964
34392 msgid "guestfs_umask"
34396 #: ../src/guestfs-actions.pod:7966
34400 " guestfs_umask (guestfs_h *g,\n"
34406 #: ../src/guestfs-actions.pod:7982
34408 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
34409 "C<guestfs_mkdir>."
34413 #: ../src/guestfs-actions.pod:7991
34414 msgid "guestfs_umount"
34418 #: ../src/guestfs-actions.pod:7993
34422 " guestfs_umount (guestfs_h *g,\n"
34423 " const char *pathordevice);\n"
34428 #: ../src/guestfs-actions.pod:8005
34429 msgid "guestfs_umount_all"
34433 #: ../src/guestfs-actions.pod:8007
34437 " guestfs_umount_all (guestfs_h *g);\n"
34442 #: ../src/guestfs-actions.pod:8018
34443 msgid "guestfs_upload"
34447 #: ../src/guestfs-actions.pod:8020
34451 " guestfs_upload (guestfs_h *g,\n"
34452 " const char *filename,\n"
34453 " const char *remotefilename);\n"
34458 #: ../src/guestfs-actions.pod:8030
34459 msgid "See also C<guestfs_download>."
34463 #: ../src/guestfs-actions.pod:8041
34464 msgid "guestfs_upload_offset"
34468 #: ../src/guestfs-actions.pod:8043
34472 " guestfs_upload_offset (guestfs_h *g,\n"
34473 " const char *filename,\n"
34474 " const char *remotefilename,\n"
34475 " int64_t offset);\n"
34480 #: ../src/guestfs-actions.pod:8059
34482 "Note that there is no limit on the amount of data that can be uploaded with "
34483 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
34484 "full amount unless an error occurs."
34488 #: ../src/guestfs-actions.pod:8064
34489 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
34493 #: ../src/guestfs-actions.pod:8075
34494 msgid "guestfs_utimens"
34498 #: ../src/guestfs-actions.pod:8077
34502 " guestfs_utimens (guestfs_h *g,\n"
34503 " const char *path,\n"
34504 " int64_t atsecs,\n"
34505 " int64_t atnsecs,\n"
34506 " int64_t mtsecs,\n"
34507 " int64_t mtnsecs);\n"
34512 #: ../src/guestfs-actions.pod:8106 ../src/guestfs-structs.pod:175
34513 msgid "guestfs_version"
34517 #: ../src/guestfs-actions.pod:8108
34520 " struct guestfs_version *\n"
34521 " guestfs_version (guestfs_h *g);\n"
34526 #: ../src/guestfs-actions.pod:8136
34528 "I<Note:> Don't use this call to test for availability of features. In "
34529 "enterprise distributions we backport features from later versions into "
34530 "earlier versions, making this an unreliable way to test for features. Use "
34531 "C<guestfs_available> instead."
34535 #: ../src/guestfs-actions.pod:8142
34537 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
34538 "error. I<The caller must call C<guestfs_free_version> after use>."
34542 #: ../src/guestfs-actions.pod:8146
34543 msgid "(Added in 1.0.58)"
34547 #: ../src/guestfs-actions.pod:8148
34548 msgid "guestfs_vfs_label"
34552 #: ../src/guestfs-actions.pod:8150
34556 " guestfs_vfs_label (guestfs_h *g,\n"
34557 " const char *device);\n"
34562 #: ../src/guestfs-actions.pod:8159
34563 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
34567 #: ../src/guestfs-actions.pod:8164 ../src/guestfs-actions.pod:8201
34568 msgid "(Added in 1.3.18)"
34572 #: ../src/guestfs-actions.pod:8166
34573 msgid "guestfs_vfs_type"
34577 #: ../src/guestfs-actions.pod:8168
34581 " guestfs_vfs_type (guestfs_h *g,\n"
34582 " const char *device);\n"
34587 #: ../src/guestfs-actions.pod:8185
34588 msgid "guestfs_vfs_uuid"
34592 #: ../src/guestfs-actions.pod:8187
34596 " guestfs_vfs_uuid (guestfs_h *g,\n"
34597 " const char *device);\n"
34602 #: ../src/guestfs-actions.pod:8196
34603 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
34607 #: ../src/guestfs-actions.pod:8203
34608 msgid "guestfs_vg_activate"
34612 #: ../src/guestfs-actions.pod:8205
34616 " guestfs_vg_activate (guestfs_h *g,\n"
34618 " char *const *volgroups);\n"
34623 #: ../src/guestfs-actions.pod:8222
34624 msgid "guestfs_vg_activate_all"
34628 #: ../src/guestfs-actions.pod:8224
34632 " guestfs_vg_activate_all (guestfs_h *g,\n"
34633 " int activate);\n"
34638 #: ../src/guestfs-actions.pod:8237
34639 msgid "guestfs_vgcreate"
34643 #: ../src/guestfs-actions.pod:8239
34647 " guestfs_vgcreate (guestfs_h *g,\n"
34648 " const char *volgroup,\n"
34649 " char *const *physvols);\n"
34654 #: ../src/guestfs-actions.pod:8251
34655 msgid "guestfs_vglvuuids"
34659 #: ../src/guestfs-actions.pod:8253
34663 " guestfs_vglvuuids (guestfs_h *g,\n"
34664 " const char *vgname);\n"
34669 #: ../src/guestfs-actions.pod:8260
34671 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
34672 "associate logical volumes and volume groups."
34676 #: ../src/guestfs-actions.pod:8263
34677 msgid "See also C<guestfs_vgpvuuids>."
34681 #: ../src/guestfs-actions.pod:8271
34682 msgid "guestfs_vgpvuuids"
34686 #: ../src/guestfs-actions.pod:8273
34690 " guestfs_vgpvuuids (guestfs_h *g,\n"
34691 " const char *vgname);\n"
34696 #: ../src/guestfs-actions.pod:8280
34698 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
34699 "associate physical volumes and volume groups."
34703 #: ../src/guestfs-actions.pod:8283
34704 msgid "See also C<guestfs_vglvuuids>."
34708 #: ../src/guestfs-actions.pod:8291
34709 msgid "guestfs_vgremove"
34713 #: ../src/guestfs-actions.pod:8293
34717 " guestfs_vgremove (guestfs_h *g,\n"
34718 " const char *vgname);\n"
34723 #: ../src/guestfs-actions.pod:8306
34724 msgid "guestfs_vgrename"
34728 #: ../src/guestfs-actions.pod:8308
34732 " guestfs_vgrename (guestfs_h *g,\n"
34733 " const char *volgroup,\n"
34734 " const char *newvolgroup);\n"
34739 #: ../src/guestfs-actions.pod:8319
34740 msgid "guestfs_vgs"
34744 #: ../src/guestfs-actions.pod:8321
34748 " guestfs_vgs (guestfs_h *g);\n"
34753 #: ../src/guestfs-actions.pod:8330
34754 msgid "See also C<guestfs_vgs_full>."
34758 #: ../src/guestfs-actions.pod:8338
34759 msgid "guestfs_vgs_full"
34763 #: ../src/guestfs-actions.pod:8340
34766 " struct guestfs_lvm_vg_list *\n"
34767 " guestfs_vgs_full (guestfs_h *g);\n"
34772 #: ../src/guestfs-actions.pod:8346
34774 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
34775 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
34779 #: ../src/guestfs-actions.pod:8352
34780 msgid "guestfs_vgscan"
34784 #: ../src/guestfs-actions.pod:8354
34788 " guestfs_vgscan (guestfs_h *g);\n"
34793 #: ../src/guestfs-actions.pod:8364
34794 msgid "guestfs_vguuid"
34798 #: ../src/guestfs-actions.pod:8366
34802 " guestfs_vguuid (guestfs_h *g,\n"
34803 " const char *vgname);\n"
34808 #: ../src/guestfs-actions.pod:8377
34809 msgid "guestfs_wait_ready"
34813 #: ../src/guestfs-actions.pod:8379
34817 " guestfs_wait_ready (guestfs_h *g);\n"
34822 #: ../src/guestfs-actions.pod:8382
34824 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
34829 #: ../src/guestfs-actions.pod:8389
34830 msgid "This function is a no op."
34834 #: ../src/guestfs-actions.pod:8391
34836 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
34837 "calling C<guestfs_launch> to wait for the launch to complete. However this "
34838 "is no longer necessary because C<guestfs_launch> now does the waiting."
34842 #: ../src/guestfs-actions.pod:8396
34844 "If you see any calls to this function in code then you can just remove them, "
34845 "unless you want to retain compatibility with older versions of the API."
34849 #: ../src/guestfs-actions.pod:8404
34850 msgid "guestfs_wc_c"
34854 #: ../src/guestfs-actions.pod:8406
34858 " guestfs_wc_c (guestfs_h *g,\n"
34859 " const char *path);\n"
34864 #: ../src/guestfs-actions.pod:8417
34865 msgid "guestfs_wc_l"
34869 #: ../src/guestfs-actions.pod:8419
34873 " guestfs_wc_l (guestfs_h *g,\n"
34874 " const char *path);\n"
34879 #: ../src/guestfs-actions.pod:8430
34880 msgid "guestfs_wc_w"
34884 #: ../src/guestfs-actions.pod:8432
34888 " guestfs_wc_w (guestfs_h *g,\n"
34889 " const char *path);\n"
34894 #: ../src/guestfs-actions.pod:8443
34895 msgid "guestfs_write"
34899 #: ../src/guestfs-actions.pod:8445
34903 " guestfs_write (guestfs_h *g,\n"
34904 " const char *path,\n"
34905 " const char *content,\n"
34906 " size_t content_size);\n"
34911 #: ../src/guestfs-actions.pod:8454
34912 msgid "See also C<guestfs_write_append>."
34916 #: ../src/guestfs-actions.pod:8463
34917 msgid "guestfs_write_append"
34921 #: ../src/guestfs-actions.pod:8465
34925 " guestfs_write_append (guestfs_h *g,\n"
34926 " const char *path,\n"
34927 " const char *content,\n"
34928 " size_t content_size);\n"
34933 #: ../src/guestfs-actions.pod:8474
34934 msgid "See also C<guestfs_write>."
34938 #: ../src/guestfs-actions.pod:8483
34939 msgid "guestfs_write_file"
34943 #: ../src/guestfs-actions.pod:8485
34947 " guestfs_write_file (guestfs_h *g,\n"
34948 " const char *path,\n"
34949 " const char *content,\n"
34955 #: ../src/guestfs-actions.pod:8491
34957 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
34962 #: ../src/guestfs-actions.pod:8516
34963 msgid "guestfs_zegrep"
34967 #: ../src/guestfs-actions.pod:8518
34971 " guestfs_zegrep (guestfs_h *g,\n"
34972 " const char *regex,\n"
34973 " const char *path);\n"
34978 #: ../src/guestfs-actions.pod:8535
34979 msgid "guestfs_zegrepi"
34983 #: ../src/guestfs-actions.pod:8537
34987 " guestfs_zegrepi (guestfs_h *g,\n"
34988 " const char *regex,\n"
34989 " const char *path);\n"
34994 #: ../src/guestfs-actions.pod:8554
34995 msgid "guestfs_zero"
34999 #: ../src/guestfs-actions.pod:8556
35003 " guestfs_zero (guestfs_h *g,\n"
35004 " const char *device);\n"
35009 #: ../src/guestfs-actions.pod:8570
35011 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
35012 "C<guestfs_is_zero_device>"
35016 #: ../src/guestfs-actions.pod:8582
35017 msgid "guestfs_zero_device"
35021 #: ../src/guestfs-actions.pod:8584
35025 " guestfs_zero_device (guestfs_h *g,\n"
35026 " const char *device);\n"
35031 #: ../src/guestfs-actions.pod:8588
35033 "This command writes zeroes over the entire C<device>. Compare with "
35034 "C<guestfs_zero> which just zeroes the first few blocks of a device."
35038 #: ../src/guestfs-actions.pod:8603
35039 msgid "(Added in 1.3.1)"
35043 #: ../src/guestfs-actions.pod:8605
35044 msgid "guestfs_zerofree"
35048 #: ../src/guestfs-actions.pod:8607
35052 " guestfs_zerofree (guestfs_h *g,\n"
35053 " const char *device);\n"
35058 #: ../src/guestfs-actions.pod:8626
35059 msgid "guestfs_zfgrep"
35063 #: ../src/guestfs-actions.pod:8628
35067 " guestfs_zfgrep (guestfs_h *g,\n"
35068 " const char *pattern,\n"
35069 " const char *path);\n"
35074 #: ../src/guestfs-actions.pod:8645
35075 msgid "guestfs_zfgrepi"
35079 #: ../src/guestfs-actions.pod:8647
35083 " guestfs_zfgrepi (guestfs_h *g,\n"
35084 " const char *pattern,\n"
35085 " const char *path);\n"
35090 #: ../src/guestfs-actions.pod:8664
35091 msgid "guestfs_zfile"
35095 #: ../src/guestfs-actions.pod:8666
35099 " guestfs_zfile (guestfs_h *g,\n"
35100 " const char *meth,\n"
35101 " const char *path);\n"
35106 #: ../src/guestfs-actions.pod:8671
35108 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
35113 #: ../src/guestfs-actions.pod:8683
35115 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
35120 #: ../src/guestfs-actions.pod:8691
35121 msgid "guestfs_zgrep"
35125 #: ../src/guestfs-actions.pod:8693
35129 " guestfs_zgrep (guestfs_h *g,\n"
35130 " const char *regex,\n"
35131 " const char *path);\n"
35136 #: ../src/guestfs-actions.pod:8710
35137 msgid "guestfs_zgrepi"
35141 #: ../src/guestfs-actions.pod:8712
35145 " guestfs_zgrepi (guestfs_h *g,\n"
35146 " const char *regex,\n"
35147 " const char *path);\n"
35152 #: ../src/guestfs-availability.pod:3
35157 #: ../src/guestfs-availability.pod:5
35159 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
35160 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
35161 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
35162 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
35163 "L</guestfs_aug_save> L</guestfs_aug_set>"
35167 #: ../src/guestfs-availability.pod:21
35172 #: ../src/guestfs-availability.pod:23
35173 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
35177 #: ../src/guestfs-availability.pod:26
35182 #: ../src/guestfs-availability.pod:28
35183 msgid "The following functions: L</guestfs_grub_install>"
35187 #: ../src/guestfs-availability.pod:31
35192 #: ../src/guestfs-availability.pod:33
35194 "The following functions: L</guestfs_inotify_add_watch> L</"
35195 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
35196 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
35200 #: ../src/guestfs-availability.pod:41
35201 msgid "B<linuxfsuuid>"
35205 #: ../src/guestfs-availability.pod:43
35207 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
35208 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
35212 #: ../src/guestfs-availability.pod:50
35213 msgid "B<linuxmodules>"
35217 #: ../src/guestfs-availability.pod:52
35218 msgid "The following functions: L</guestfs_modprobe>"
35222 #: ../src/guestfs-availability.pod:55
35223 msgid "B<linuxxattrs>"
35227 #: ../src/guestfs-availability.pod:57
35229 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
35230 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
35231 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
35232 "guestfs_setxattr>"
35236 #: ../src/guestfs-availability.pod:68
35241 #: ../src/guestfs-availability.pod:70
35243 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
35244 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
35245 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
35249 #: ../src/guestfs-availability.pod:79
35254 #: ../src/guestfs-availability.pod:81
35256 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
35257 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
35258 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
35259 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
35260 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
35261 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
35262 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
35266 #: ../src/guestfs-availability.pod:104
35271 #: ../src/guestfs-availability.pod:106
35273 "The following functions: L</guestfs_md_create> L</guestfs_md_detail> L</"
35278 #: ../src/guestfs-availability.pod:111
35283 #: ../src/guestfs-availability.pod:113
35285 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
35286 "guestfs_mknod_b> L</guestfs_mknod_c>"
35290 #: ../src/guestfs-availability.pod:119
35295 #: ../src/guestfs-availability.pod:121
35296 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
35300 #: ../src/guestfs-availability.pod:124
35301 msgid "B<ntfsprogs>"
35305 #: ../src/guestfs-availability.pod:126
35307 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
35308 "L</guestfs_ntfsresize_size>"
35312 #: ../src/guestfs-availability.pod:131
35313 msgid "B<realpath>"
35317 #: ../src/guestfs-availability.pod:133
35318 msgid "The following functions: L</guestfs_realpath>"
35322 #: ../src/guestfs-availability.pod:136
35327 #: ../src/guestfs-availability.pod:138
35329 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
35330 "guestfs_scrub_freespace>"
35334 #: ../src/guestfs-availability.pod:143
35339 #: ../src/guestfs-availability.pod:145
35340 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
35344 #: ../src/guestfs-availability.pod:149
35349 #: ../src/guestfs-availability.pod:151
35350 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
35354 #: ../src/guestfs-availability.pod:155
35355 msgid "B<zerofree>"
35359 #: ../src/guestfs-availability.pod:157
35360 msgid "The following functions: L</guestfs_zerofree>"
35364 #: ../src/guestfs-structs.pod:1
35365 msgid "guestfs_int_bool"
35369 #: ../src/guestfs-structs.pod:3
35372 " struct guestfs_int_bool {\n"
35380 #: ../src/guestfs-structs.pod:8
35383 " struct guestfs_int_bool_list {\n"
35384 " uint32_t len; /* Number of elements in list. */\n"
35385 " struct guestfs_int_bool *val; /* Elements. */\n"
35391 #: ../src/guestfs-structs.pod:13
35394 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
35395 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
35400 #: ../src/guestfs-structs.pod:16
35401 msgid "guestfs_lvm_pv"
35405 #: ../src/guestfs-structs.pod:18
35408 " struct guestfs_lvm_pv {\n"
35409 " char *pv_name;\n"
35410 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
35411 " char pv_uuid[32];\n"
35413 " uint64_t pv_size;\n"
35414 " uint64_t dev_size;\n"
35415 " uint64_t pv_free;\n"
35416 " uint64_t pv_used;\n"
35417 " char *pv_attr;\n"
35418 " int64_t pv_pe_count;\n"
35419 " int64_t pv_pe_alloc_count;\n"
35420 " char *pv_tags;\n"
35421 " uint64_t pe_start;\n"
35422 " int64_t pv_mda_count;\n"
35423 " uint64_t pv_mda_free;\n"
35429 #: ../src/guestfs-structs.pod:36
35432 " struct guestfs_lvm_pv_list {\n"
35433 " uint32_t len; /* Number of elements in list. */\n"
35434 " struct guestfs_lvm_pv *val; /* Elements. */\n"
35440 #: ../src/guestfs-structs.pod:41
35443 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
35444 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
35449 #: ../src/guestfs-structs.pod:44
35450 msgid "guestfs_lvm_vg"
35454 #: ../src/guestfs-structs.pod:46
35457 " struct guestfs_lvm_vg {\n"
35458 " char *vg_name;\n"
35459 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
35460 " char vg_uuid[32];\n"
35462 " char *vg_attr;\n"
35463 " uint64_t vg_size;\n"
35464 " uint64_t vg_free;\n"
35465 " char *vg_sysid;\n"
35466 " uint64_t vg_extent_size;\n"
35467 " int64_t vg_extent_count;\n"
35468 " int64_t vg_free_count;\n"
35469 " int64_t max_lv;\n"
35470 " int64_t max_pv;\n"
35471 " int64_t pv_count;\n"
35472 " int64_t lv_count;\n"
35473 " int64_t snap_count;\n"
35474 " int64_t vg_seqno;\n"
35475 " char *vg_tags;\n"
35476 " int64_t vg_mda_count;\n"
35477 " uint64_t vg_mda_free;\n"
35483 #: ../src/guestfs-structs.pod:69
35486 " struct guestfs_lvm_vg_list {\n"
35487 " uint32_t len; /* Number of elements in list. */\n"
35488 " struct guestfs_lvm_vg *val; /* Elements. */\n"
35494 #: ../src/guestfs-structs.pod:74
35497 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
35498 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
35503 #: ../src/guestfs-structs.pod:77
35504 msgid "guestfs_lvm_lv"
35508 #: ../src/guestfs-structs.pod:79
35511 " struct guestfs_lvm_lv {\n"
35512 " char *lv_name;\n"
35513 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
35514 " char lv_uuid[32];\n"
35515 " char *lv_attr;\n"
35516 " int64_t lv_major;\n"
35517 " int64_t lv_minor;\n"
35518 " int64_t lv_kernel_major;\n"
35519 " int64_t lv_kernel_minor;\n"
35520 " uint64_t lv_size;\n"
35521 " int64_t seg_count;\n"
35523 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
35524 " float snap_percent;\n"
35525 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
35526 " float copy_percent;\n"
35527 " char *move_pv;\n"
35528 " char *lv_tags;\n"
35529 " char *mirror_log;\n"
35530 " char *modules;\n"
35536 #: ../src/guestfs-structs.pod:101
35539 " struct guestfs_lvm_lv_list {\n"
35540 " uint32_t len; /* Number of elements in list. */\n"
35541 " struct guestfs_lvm_lv *val; /* Elements. */\n"
35547 #: ../src/guestfs-structs.pod:106
35550 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
35551 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
35556 #: ../src/guestfs-structs.pod:111
35559 " struct guestfs_stat {\n"
35563 " int64_t nlink;\n"
35568 " int64_t blksize;\n"
35569 " int64_t blocks;\n"
35570 " int64_t atime;\n"
35571 " int64_t mtime;\n"
35572 " int64_t ctime;\n"
35578 #: ../src/guestfs-structs.pod:127
35581 " struct guestfs_stat_list {\n"
35582 " uint32_t len; /* Number of elements in list. */\n"
35583 " struct guestfs_stat *val; /* Elements. */\n"
35589 #: ../src/guestfs-structs.pod:132
35592 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
35593 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
35598 #: ../src/guestfs-structs.pod:137
35601 " struct guestfs_statvfs {\n"
35602 " int64_t bsize;\n"
35603 " int64_t frsize;\n"
35604 " int64_t blocks;\n"
35605 " int64_t bfree;\n"
35606 " int64_t bavail;\n"
35607 " int64_t files;\n"
35608 " int64_t ffree;\n"
35609 " int64_t favail;\n"
35612 " int64_t namemax;\n"
35618 #: ../src/guestfs-structs.pod:151
35621 " struct guestfs_statvfs_list {\n"
35622 " uint32_t len; /* Number of elements in list. */\n"
35623 " struct guestfs_statvfs *val; /* Elements. */\n"
35629 #: ../src/guestfs-structs.pod:156
35632 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
35633 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
35638 #: ../src/guestfs-structs.pod:159
35639 msgid "guestfs_dirent"
35643 #: ../src/guestfs-structs.pod:161
35646 " struct guestfs_dirent {\n"
35655 #: ../src/guestfs-structs.pod:167
35658 " struct guestfs_dirent_list {\n"
35659 " uint32_t len; /* Number of elements in list. */\n"
35660 " struct guestfs_dirent *val; /* Elements. */\n"
35666 #: ../src/guestfs-structs.pod:172
35669 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
35670 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
35675 #: ../src/guestfs-structs.pod:177
35678 " struct guestfs_version {\n"
35679 " int64_t major;\n"
35680 " int64_t minor;\n"
35681 " int64_t release;\n"
35688 #: ../src/guestfs-structs.pod:184
35691 " struct guestfs_version_list {\n"
35692 " uint32_t len; /* Number of elements in list. */\n"
35693 " struct guestfs_version *val; /* Elements. */\n"
35699 #: ../src/guestfs-structs.pod:189
35702 " void guestfs_free_version (struct guestfs_free_version *);\n"
35703 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
35708 #: ../src/guestfs-structs.pod:192
35709 msgid "guestfs_xattr"
35713 #: ../src/guestfs-structs.pod:194
35716 " struct guestfs_xattr {\n"
35717 " char *attrname;\n"
35718 " /* The next two fields describe a byte array. */\n"
35719 " uint32_t attrval_len;\n"
35720 " char *attrval;\n"
35726 #: ../src/guestfs-structs.pod:201
35729 " struct guestfs_xattr_list {\n"
35730 " uint32_t len; /* Number of elements in list. */\n"
35731 " struct guestfs_xattr *val; /* Elements. */\n"
35737 #: ../src/guestfs-structs.pod:206
35740 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
35741 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
35746 #: ../src/guestfs-structs.pod:209
35747 msgid "guestfs_inotify_event"
35751 #: ../src/guestfs-structs.pod:211
35754 " struct guestfs_inotify_event {\n"
35755 " int64_t in_wd;\n"
35756 " uint32_t in_mask;\n"
35757 " uint32_t in_cookie;\n"
35758 " char *in_name;\n"
35764 #: ../src/guestfs-structs.pod:218
35767 " struct guestfs_inotify_event_list {\n"
35768 " uint32_t len; /* Number of elements in list. */\n"
35769 " struct guestfs_inotify_event *val; /* Elements. */\n"
35775 #: ../src/guestfs-structs.pod:223
35778 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
35779 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
35784 #: ../src/guestfs-structs.pod:226
35785 msgid "guestfs_partition"
35789 #: ../src/guestfs-structs.pod:228
35792 " struct guestfs_partition {\n"
35793 " int32_t part_num;\n"
35794 " uint64_t part_start;\n"
35795 " uint64_t part_end;\n"
35796 " uint64_t part_size;\n"
35802 #: ../src/guestfs-structs.pod:235
35805 " struct guestfs_partition_list {\n"
35806 " uint32_t len; /* Number of elements in list. */\n"
35807 " struct guestfs_partition *val; /* Elements. */\n"
35813 #: ../src/guestfs-structs.pod:240
35816 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
35817 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
35822 #: ../src/guestfs-structs.pod:243
35823 msgid "guestfs_application"
35827 #: ../src/guestfs-structs.pod:245
35830 " struct guestfs_application {\n"
35831 " char *app_name;\n"
35832 " char *app_display_name;\n"
35833 " int32_t app_epoch;\n"
35834 " char *app_version;\n"
35835 " char *app_release;\n"
35836 " char *app_install_path;\n"
35837 " char *app_trans_path;\n"
35838 " char *app_publisher;\n"
35839 " char *app_url;\n"
35840 " char *app_source_package;\n"
35841 " char *app_summary;\n"
35842 " char *app_description;\n"
35848 #: ../src/guestfs-structs.pod:260
35851 " struct guestfs_application_list {\n"
35852 " uint32_t len; /* Number of elements in list. */\n"
35853 " struct guestfs_application *val; /* Elements. */\n"
35859 #: ../src/guestfs-structs.pod:265
35862 " void guestfs_free_application (struct guestfs_free_application *);\n"
35863 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
35868 #: ../src/guestfs.pod:5
35869 msgid "guestfs - Library for accessing and modifying virtual machine images"
35873 #: ../src/guestfs.pod:11
35876 " guestfs_h *g = guestfs_create ();\n"
35877 " guestfs_add_drive (g, \"guest.img\");\n"
35878 " guestfs_launch (g);\n"
35879 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
35880 " guestfs_touch (g, \"/hello\");\n"
35881 " guestfs_umount (g, \"/\");\n"
35882 " guestfs_close (g);\n"
35885 " guestfs_h *g = guestfs_create ();\n"
35886 " guestfs_add_drive (g, \"guest.img\");\n"
35887 " guestfs_launch (g);\n"
35888 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
35889 " guestfs_touch (g, \"/hello\");\n"
35890 " guestfs_umount (g, \"/\");\n"
35891 " guestfs_close (g);\n"
35895 #: ../src/guestfs.pod:25
35897 "Libguestfs is a library for accessing and modifying guest disk images. "
35898 "Amongst the things this is good for: making batch configuration changes to "
35899 "guests, getting disk used/free statistics (see also: virt-df), migrating "
35900 "between virtualization systems (see also: virt-p2v), performing partial "
35901 "backups, performing partial guest clones, cloning guests and changing "
35902 "registry/UUID/hostname info, and much else besides."
35906 #: ../src/guestfs.pod:33
35908 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
35909 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
35910 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
35915 #: ../src/guestfs.pod:38
35917 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
35918 "what filesystem is in each LV, etc.). It can also run commands in the "
35919 "context of the guest. Also you can access filesystems over FUSE."
35923 #: ../src/guestfs.pod:43
35925 "Libguestfs is a library that can be linked with C and C++ management "
35926 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
35927 "PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
35932 #: ../src/guestfs.pod:48
35934 "You don't need to be root to use libguestfs, although obviously you do need "
35935 "enough permissions to access the disk images."
35939 #: ../src/guestfs.pod:51
35941 "Libguestfs is a large API because it can do many things. For a gentle "
35942 "introduction, please read the L</API OVERVIEW> section next."
35946 #: ../src/guestfs.pod:54
35948 "There are also some example programs in the L<guestfs-examples(3)> manual "
35953 #: ../src/guestfs.pod:57
35954 msgid "API OVERVIEW"
35958 #: ../src/guestfs.pod:59
35960 "This section provides a gentler overview of the libguestfs API. We also try "
35961 "to group API calls together, where that may not be obvious from reading "
35962 "about the individual calls in the main section of this manual."
35966 #: ../src/guestfs.pod:64
35971 #: ../src/guestfs.pod:66
35973 "Before you can use libguestfs calls, you have to create a handle. Then you "
35974 "must add at least one disk image to the handle, followed by launching the "
35975 "handle, then performing whatever operations you want, and finally closing "
35976 "the handle. By convention we use the single letter C<g> for the name of the "
35977 "handle variable, although of course you can use any name you want."
35981 #: ../src/guestfs.pod:73
35982 msgid "The general structure of all libguestfs-using programs looks like this:"
35986 #: ../src/guestfs.pod:76
35989 " guestfs_h *g = guestfs_create ();\n"
35994 #: ../src/guestfs.pod:78
35997 " /* Call guestfs_add_drive additional times if there are\n"
35998 " * multiple disk images.\n"
36000 " guestfs_add_drive (g, \"guest.img\");\n"
36005 #: ../src/guestfs.pod:83
36008 " /* Most manipulation calls won't work until you've launched\n"
36009 " * the handle 'g'. You have to do this _after_ adding drives\n"
36010 " * and _before_ other commands.\n"
36012 " guestfs_launch (g);\n"
36017 #: ../src/guestfs.pod:89
36020 " /* Now you can examine what partitions, LVs etc are available.\n"
36022 " char **partitions = guestfs_list_partitions (g);\n"
36023 " char **logvols = guestfs_lvs (g);\n"
36028 #: ../src/guestfs.pod:94
36031 " /* To access a filesystem in the image, you must mount it.\n"
36033 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
36038 #: ../src/guestfs.pod:98
36041 " /* Now you can perform filesystem actions on the guest\n"
36044 " guestfs_touch (g, \"/hello\");\n"
36049 #: ../src/guestfs.pod:103
36052 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
36053 " * it is done automatically when you close the handle. See\n"
36054 " * discussion of autosync in this page.\n"
36056 " guestfs_sync (g);\n"
36061 #: ../src/guestfs.pod:109
36064 " /* Close the handle 'g'. */\n"
36065 " guestfs_close (g);\n"
36070 #: ../src/guestfs.pod:112
36072 "The code above doesn't include any error checking. In real code you should "
36073 "check return values carefully for errors. In general all functions that "
36074 "return integers return C<-1> on error, and all functions that return "
36075 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
36076 "how to handle errors, and consult the documentation for each function call "
36077 "below to see precisely how they return error indications. See L<guestfs-"
36078 "examples(3)> for fully worked examples."
36082 #: ../src/guestfs.pod:121
36083 msgid "DISK IMAGES"
36087 #: ../src/guestfs.pod:123
36089 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
36090 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
36091 "actual block device, or simply an empty file of zeroes that you have created "
36092 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
36097 #: ../src/guestfs.pod:129
36099 "The call you should use in modern code for adding drives is L</"
36100 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
36101 "specifying that the format is raw, do:"
36105 #: ../src/guestfs.pod:133
36108 " guestfs_add_drive_opts (g, filename,\n"
36109 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
36115 #: ../src/guestfs.pod:137
36116 msgid "You can add a disk read-only using:"
36120 #: ../src/guestfs.pod:139
36123 " guestfs_add_drive_opts (g, filename,\n"
36124 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
36125 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
36131 #: ../src/guestfs.pod:144
36133 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
36134 "libguestfs won't modify the file."
36138 #: ../src/guestfs.pod:147
36140 "Be extremely cautious if the disk image is in use, eg. if it is being used "
36141 "by a virtual machine. Adding it read-write will almost certainly cause disk "
36142 "corruption, but adding it read-only is safe."
36146 #: ../src/guestfs.pod:151
36148 "You must add at least one disk image, and you may add multiple disk images. "
36149 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
36150 "first one you added), C</dev/sdb> (for the second one you added), etc."
36154 #: ../src/guestfs.pod:156
36156 "Once L</guestfs_launch> has been called you cannot add any more images. You "
36157 "can call L</guestfs_list_devices> to get a list of the device names, in the "
36158 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
36162 #: ../src/guestfs.pod:161
36167 #: ../src/guestfs.pod:163
36169 "Before you can read or write files, create directories and so on in a disk "
36170 "image that contains filesystems, you have to mount those filesystems using "
36171 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
36172 "a disk image contains (for example) one partition with a filesystem on that "
36173 "partition, then you can mount it directly:"
36177 #: ../src/guestfs.pod:170
36180 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
36185 #: ../src/guestfs.pod:172
36187 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
36188 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
36189 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
36190 "that these are libguestfs virtual devices, and are nothing to do with host "
36195 #: ../src/guestfs.pod:178
36197 "If you are given a disk image and you don't know what it contains then you "
36198 "have to find out. Libguestfs can do that too: use L</"
36199 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
36200 "LVs, and either try mounting each to see what is mountable, or else examine "
36201 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
36202 "filesystems, use L</guestfs_list_filesystems>."
36206 #: ../src/guestfs.pod:186
36208 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
36209 "L</INSPECTION> below). But you might find it easier to look at higher level "
36210 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
36214 #: ../src/guestfs.pod:191
36216 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
36217 "several other variations of the C<guestfs_mount_*> call."
36221 #: ../src/guestfs.pod:194
36222 msgid "FILESYSTEM ACCESS AND MODIFICATION"
36226 #: ../src/guestfs.pod:196
36228 "The majority of the libguestfs API consists of fairly low-level calls for "
36229 "accessing and modifying the files, directories, symlinks etc on mounted "
36230 "filesystems. There are over a hundred such calls which you can find listed "
36231 "in detail below in this man page, and we don't even pretend to cover them "
36232 "all in this overview."
36236 #: ../src/guestfs.pod:202
36238 "Specify filenames as full paths, starting with C<\"/\"> and including the "
36243 #: ../src/guestfs.pod:205
36245 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
36246 "the file called C<\"etc/passwd\"> then you could do:"
36250 #: ../src/guestfs.pod:208
36253 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
36258 #: ../src/guestfs.pod:210
36260 "This would return C<data> as a newly allocated buffer containing the full "
36261 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
36262 "or C<NULL> if there was an error."
36266 #: ../src/guestfs.pod:214
36268 "As another example, to create a top-level directory on that filesystem "
36269 "called C<\"var\"> you would do:"
36273 #: ../src/guestfs.pod:217
36276 " guestfs_mkdir (g, \"/var\");\n"
36281 #: ../src/guestfs.pod:219
36282 msgid "To create a symlink you could do:"
36286 #: ../src/guestfs.pod:221
36289 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
36290 " \"/etc/rc3.d/S30portmap\");\n"
36295 #: ../src/guestfs.pod:224
36297 "Libguestfs will reject attempts to use relative paths and there is no "
36298 "concept of a current working directory."
36302 #: ../src/guestfs.pod:227
36304 "Libguestfs can return errors in many situations: for example if the "
36305 "filesystem isn't writable, or if a file or directory that you requested "
36306 "doesn't exist. If you are using the C API (documented here) you have to "
36307 "check for those error conditions after each call. (Other language bindings "
36308 "turn these errors into exceptions)."
36312 #: ../src/guestfs.pod:233
36314 "File writes are affected by the per-handle umask, set by calling L</"
36315 "guestfs_umask> and defaulting to 022. See L</UMASK>."
36319 #: ../src/guestfs.pod:236
36320 msgid "PARTITIONING"
36324 #: ../src/guestfs.pod:238
36326 "Libguestfs contains API calls to read, create and modify partition tables on "
36331 #: ../src/guestfs.pod:241
36333 "In the common case where you want to create a single partition covering the "
36334 "whole disk, you should use the L</guestfs_part_disk> call:"
36338 #: ../src/guestfs.pod:245
36341 " const char *parttype = \"mbr\";\n"
36342 " if (disk_is_larger_than_2TB)\n"
36343 " parttype = \"gpt\";\n"
36344 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
36349 #: ../src/guestfs.pod:250
36351 "Obviously this effectively wipes anything that was on that disk image before."
36355 #: ../src/guestfs.pod:253
36360 #: ../src/guestfs.pod:255
36362 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
36363 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
36364 "you familiarize yourself with the concepts of physical volumes, volume "
36365 "groups and logical volumes."
36369 #: ../src/guestfs.pod:260
36371 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
36372 "tldp.org/HOWTO/LVM-HOWTO/>."
36376 #: ../src/guestfs.pod:263
36377 msgid "DOWNLOADING"
36381 #: ../src/guestfs.pod:265
36383 "Use L</guestfs_cat> to download small, text only files. This call is "
36384 "limited to files which are less than 2 MB and which cannot contain any ASCII "
36385 "NUL (C<\\0>) characters. However the API is very simple to use."
36389 #: ../src/guestfs.pod:269
36391 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
36392 "bit data, since it returns a (pointer, size) pair. However it is still "
36393 "limited to \"small\" files, less than 2 MB."
36397 #: ../src/guestfs.pod:273
36399 "L</guestfs_download> can be used to download any file, with no limits on "
36400 "content or size (even files larger than 4 GB)."
36404 #: ../src/guestfs.pod:276
36406 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
36410 #: ../src/guestfs.pod:279
36415 #: ../src/guestfs.pod:281
36417 "It's often the case that you want to write a file or files to the disk image."
36421 #: ../src/guestfs.pod:284
36423 "To write a small file with fixed content, use L</guestfs_write>. To create "
36424 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
36425 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
36426 "of other functions for creating test files, for example L</guestfs_fill> and "
36427 "L</guestfs_fill_pattern>."
36431 #: ../src/guestfs.pod:290
36433 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
36434 "file content or size (even files larger than 4 GB)."
36438 #: ../src/guestfs.pod:293
36440 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
36444 #: ../src/guestfs.pod:295
36446 "However the fastest way to upload I<large numbers of arbitrary files> is to "
36447 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
36448 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
36449 "in a predictable way (eg. adding it last after all other drives) then you "
36450 "can get the device name from L</guestfs_list_devices> and mount it directly "
36451 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
36452 "portable between kernel versions, and they don't support labels or UUIDs. "
36453 "If you want to pre-build an image or you need to mount it using a label or "
36454 "UUID, use an ISO image instead."
36458 #: ../src/guestfs.pod:306
36463 #: ../src/guestfs.pod:308
36465 "There are various different commands for copying between files and devices "
36466 "and in and out of the guest filesystem. These are summarised in the table "
36471 #: ../src/guestfs.pod:314
36472 msgid "B<file> to B<file>"
36476 #: ../src/guestfs.pod:316
36478 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
36479 "directories recursively."
36483 #: ../src/guestfs.pod:319
36485 "To copy part of a file (offset and size) use L</guestfs_copy_file_to_file>."
36489 #: ../src/guestfs.pod:322
36490 msgid "B<file> to B<device>"
36494 #: ../src/guestfs.pod:324
36495 msgid "B<device> to B<file>"
36499 #: ../src/guestfs.pod:326
36500 msgid "B<device> to B<device>"
36504 #: ../src/guestfs.pod:328
36506 "Use L</guestfs_copy_file_to_device>, L</guestfs_copy_device_to_file>, or L</"
36507 "guestfs_copy_device_to_device>."
36511 #: ../src/guestfs.pod:331
36512 msgid "Example: duplicate the contents of an LV:"
36516 #: ../src/guestfs.pod:333
36519 " guestfs_copy_device_to_device (g,\n"
36520 " \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
36521 " /* -1 marks the end of the list of optional parameters */\n"
36527 #: ../src/guestfs.pod:338
36529 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
36530 "(C</dev/VG/Original>). To copy less than the whole source device, use the "
36531 "optional C<size> parameter:"
36535 #: ../src/guestfs.pod:342
36538 " guestfs_copy_device_to_device (g,\n"
36539 " \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
36540 " GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, 10000,\n"
36546 #: ../src/guestfs.pod:347
36547 msgid "B<file on the host> to B<file or device>"
36551 #: ../src/guestfs.pod:349
36552 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
36556 #: ../src/guestfs.pod:351
36557 msgid "B<file or device> to B<file on the host>"
36561 #: ../src/guestfs.pod:353
36562 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
36566 #: ../src/guestfs.pod:357
36567 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
36571 #: ../src/guestfs.pod:359
36573 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
36574 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
36575 "appears you can only upload and download to files. However many Un*x-like "
36576 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
36577 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
36578 "and arbitrary file descriptor N."
36582 #: ../src/guestfs.pod:367
36583 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
36587 #: ../src/guestfs.pod:370
36590 " guestfs_download (g, filename, \"/dev/stdout\");\n"
36595 #: ../src/guestfs.pod:372
36596 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
36600 #: ../src/guestfs.pod:374
36603 " char devfd[64];\n"
36604 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
36605 " guestfs_tar_out (g, \"/\", devfd);\n"
36610 #: ../src/guestfs.pod:378
36611 msgid "LISTING FILES"
36615 #: ../src/guestfs.pod:380
36617 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
36618 "L<guestfish(1)>-equivalent command C<ll>)."
36622 #: ../src/guestfs.pod:383
36624 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
36625 "programs, as a flat list of strings."
36629 #: ../src/guestfs.pod:386
36631 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
36632 "directory, plus additional information about each one. It is more "
36633 "equivalent to using the L<readdir(3)> call on a local filesystem."
36637 #: ../src/guestfs.pod:390
36639 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
36643 #: ../src/guestfs.pod:393
36644 msgid "RUNNING COMMANDS"
36648 #: ../src/guestfs.pod:395
36650 "Although libguestfs is primarily an API for manipulating files inside guest "
36651 "images, we also provide some limited facilities for running commands inside "
36656 #: ../src/guestfs.pod:399
36657 msgid "There are many limitations to this:"
36661 #: ../src/guestfs.pod:405
36663 "The kernel version that the command runs under will be different from what "
36668 #: ../src/guestfs.pod:410
36670 "If the command needs to communicate with daemons, then most likely they "
36671 "won't be running."
36675 #: ../src/guestfs.pod:415
36676 msgid "The command will be running in limited memory."
36680 #: ../src/guestfs.pod:419
36682 "The network may not be available unless you enable it (see L</"
36683 "guestfs_set_network>)."
36687 #: ../src/guestfs.pod:424
36688 msgid "Only supports Linux guests (not Windows, BSD, etc)."
36692 #: ../src/guestfs.pod:428
36694 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
36698 #: ../src/guestfs.pod:433
36700 "For SELinux guests, you may need to enable SELinux and load policy first. "
36701 "See L</SELINUX> in this manpage."
36705 #: ../src/guestfs.pod:438
36707 "I<Security:> It is not safe to run commands from untrusted, possibly "
36708 "malicious guests. These commands may attempt to exploit your program by "
36709 "sending unexpected output. They could also try to exploit the Linux kernel "
36710 "or qemu provided by the libguestfs appliance. They could use the network "
36711 "provided by the libguestfs appliance to bypass ordinary network partitions "
36712 "and firewalls. They could use the elevated privileges or different SELinux "
36713 "context of your program to their advantage."
36717 #: ../src/guestfs.pod:447
36719 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
36720 "(a script which runs when the guest next boots normally), and to have this "
36721 "script run the commands you want in the normal context of the running guest, "
36722 "network security and so on. For information about other security issues, "
36723 "see L</SECURITY>."
36727 #: ../src/guestfs.pod:455
36729 "The two main API calls to run commands are L</guestfs_command> and L</"
36730 "guestfs_sh> (there are also variations)."
36734 #: ../src/guestfs.pod:458
36736 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
36737 "shell globs, redirections, etc will work."
36741 #: ../src/guestfs.pod:461
36742 msgid "CONFIGURATION FILES"
36746 #: ../src/guestfs.pod:463
36748 "To read and write configuration files in Linux guest filesystems, we "
36749 "strongly recommend using Augeas. For example, Augeas understands how to "
36750 "read and write, say, a Linux shadow password file or X.org configuration "
36751 "file, and so avoids you having to write that code."
36755 #: ../src/guestfs.pod:468
36757 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
36758 "document Augeas itself here because there is excellent documentation on the "
36759 "L<http://augeas.net/> website."
36763 #: ../src/guestfs.pod:472
36765 "If you don't want to use Augeas (you fool!) then try calling L</"
36766 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
36771 #: ../src/guestfs.pod:476
36776 #: ../src/guestfs.pod:478
36778 "We support SELinux guests. To ensure that labeling happens correctly in "
36779 "SELinux guests, you need to enable SELinux and load the guest's policy:"
36783 #: ../src/guestfs.pod:486
36784 msgid "Before launching, do:"
36788 #: ../src/guestfs.pod:488
36791 " guestfs_set_selinux (g, 1);\n"
36796 #: ../src/guestfs.pod:492
36798 "After mounting the guest's filesystem(s), load the policy. This is best "
36799 "done by running the L<load_policy(8)> command in the guest itself:"
36803 #: ../src/guestfs.pod:496
36806 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
36811 #: ../src/guestfs.pod:498
36813 "(Older versions of C<load_policy> require you to specify the name of the "
36818 #: ../src/guestfs.pod:503
36820 "Optionally, set the security context for the API. The correct security "
36821 "context to use can only be known by inspecting the guest. As an example:"
36825 #: ../src/guestfs.pod:507
36828 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
36833 #: ../src/guestfs.pod:511
36834 msgid "This will work for running commands and editing existing files."
36838 #: ../src/guestfs.pod:513
36840 "When new files are created, you may need to label them explicitly, for "
36841 "example by running the external command C<restorecon pathname>."
36845 #: ../src/guestfs.pod:517
36850 #: ../src/guestfs.pod:519
36852 "Certain calls are affected by the current file mode creation mask (the "
36853 "\"umask\"). In particular ones which create files or directories, such as "
36854 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
36855 "either the default mode that the file is created with or modifies the mode "
36860 #: ../src/guestfs.pod:525
36862 "The default umask is C<022>, so files are created with modes such as C<0644> "
36863 "and directories with C<0755>."
36867 #: ../src/guestfs.pod:528
36869 "There are two ways to avoid being affected by umask. Either set umask to 0 "
36870 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
36871 "guestfs_chmod> after creating each file or directory."
36875 #: ../src/guestfs.pod:532
36876 msgid "For more information about umask, see L<umask(2)>."
36880 #: ../src/guestfs.pod:536
36882 "Libguestfs allows you to access Linux guests which have been encrypted using "
36883 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
36884 "standard. This includes nearly all whole disk encryption systems used by "
36885 "modern Linux guests."
36889 #: ../src/guestfs.pod:542
36891 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
36892 "returns the string C<crypto_LUKS>)."
36896 #: ../src/guestfs.pod:545
36898 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
36899 "will require the passphrase!"
36903 #: ../src/guestfs.pod:548
36905 "Opening a LUKS device creates a new device mapper device called C</dev/"
36906 "mapper/mapname> (where C<mapname> is the string you supply to L</"
36907 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
36908 "from and encrypted to the underlying block device respectively."
36912 #: ../src/guestfs.pod:554
36914 "LVM volume groups on the device can be made visible by calling L</"
36915 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
36916 "(s) can now be mounted in the usual way."
36920 #: ../src/guestfs.pod:558
36922 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
36923 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
36924 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
36925 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
36926 "underlying encrypted block device)."
36930 #: ../src/guestfs.pod:565
36935 #: ../src/guestfs.pod:567
36937 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
36938 "contains operating systems, an install CD or a live CD. (These APIs used to "
36939 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
36940 "version 1.5.3 the most frequently used part of this library has been "
36941 "rewritten in C and moved into the core code)."
36945 #: ../src/guestfs.pod:574
36947 "Add all disks belonging to the unknown virtual machine and call L</"
36948 "guestfs_launch> in the usual way."
36952 #: ../src/guestfs.pod:577
36954 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
36955 "and certain heuristics, and returns a list of operating systems that were "
36956 "found. An empty list means none were found. A single element is the root "
36957 "filesystem of the operating system. For dual- or multi-boot guests, "
36958 "multiple roots can be returned, each one corresponding to a separate "
36959 "operating system. (Multi-boot virtual machines are extremely rare in the "
36960 "world of virtualization, but since this scenario can happen, we have built "
36961 "libguestfs to deal with it.)"
36965 #: ../src/guestfs.pod:586
36967 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
36968 "to get additional details about that operating system. For example, call L</"
36969 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
36970 "Windows and Linux-based operating systems respectively."
36974 #: ../src/guestfs.pod:592
36976 "Un*x-like and Linux-based operating systems usually consist of several "
36977 "filesystems which are mounted at boot time (for example, a separate boot "
36978 "partition mounted on C</boot>). The inspection rules are able to detect how "
36979 "filesystems correspond to mount points. Call "
36980 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
36981 "hash table like this example:"
36985 #: ../src/guestfs.pod:599
36988 " /boot => /dev/sda1\n"
36989 " / => /dev/vg_guest/lv_root\n"
36990 " /usr => /dev/vg_guest/lv_usr\n"
36995 #: ../src/guestfs.pod:603
36997 "The caller can then make calls to L</guestfs_mount_options> to mount the "
36998 "filesystems as suggested."
37002 #: ../src/guestfs.pod:606
37004 "Be careful to mount filesystems in the right order (eg. C</> before C</"
37005 "usr>). Sorting the keys of the hash by length, shortest first, should work."
37009 #: ../src/guestfs.pod:610
37011 "Inspection currently only works for some common operating systems. "
37012 "Contributors are welcome to send patches for other operating systems that we "
37013 "currently cannot detect."
37017 #: ../src/guestfs.pod:614
37019 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
37020 "for more details. The L</guestfs_inspect_os> function just ignores any "
37021 "encrypted devices."
37025 #: ../src/guestfs.pod:618
37027 "A note on the implementation: The call L</guestfs_inspect_os> performs "
37028 "inspection and caches the results in the guest handle. Subsequent calls to "
37029 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
37030 "read the disks. If you change the content of the guest disks, you can redo "
37031 "inspection by calling L</guestfs_inspect_os> again. (L</"
37032 "guestfs_inspect_list_applications> works a little differently from the other "
37033 "calls and does read the disks. See documentation for that function for "
37038 #: ../src/guestfs.pod:627
37039 msgid "INSPECTING INSTALL DISKS"
37043 #: ../src/guestfs.pod:629
37045 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
37050 #: ../src/guestfs.pod:632
37052 "Call L</guestfs_inspect_get_format> to return the format of the operating "
37053 "system, which currently can be C<installed> (a regular operating system) or "
37054 "C<installer> (some sort of install disk)."
37058 #: ../src/guestfs.pod:636
37060 "Further information is available about the operating system that can be "
37061 "installed using the regular inspection APIs like L</"
37062 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
37066 #: ../src/guestfs.pod:641
37068 "Some additional information specific to installer disks is also available "
37069 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
37070 "guestfs_inspect_is_multipart> calls."
37074 #: ../src/guestfs.pod:646
37075 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
37079 #: ../src/guestfs.pod:648
37081 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
37082 "ntfs-3g.org/> driver."
37086 #: ../src/guestfs.pod:651
37087 msgid "DRIVE LETTERS AND PATHS"
37091 #: ../src/guestfs.pod:653
37093 "DOS and Windows still use drive letters, and the filesystems are always "
37094 "treated as case insensitive by Windows itself, and therefore you might find "
37095 "a Windows configuration file referring to a path like C<c:\\windows"
37096 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
37097 "might be referred to as C</WINDOWS/System32>."
37101 #: ../src/guestfs.pod:659
37103 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
37104 "L</guestfs_inspect_get_drive_mappings>)"
37108 #: ../src/guestfs.pod:662
37110 "Dealing with separator characters (backslash vs forward slash) is outside "
37111 "the scope of libguestfs, but usually a simple character replacement will "
37116 #: ../src/guestfs.pod:666
37118 "To resolve the case insensitivity of paths, call L</"
37119 "guestfs_case_sensitive_path>."
37123 #: ../src/guestfs.pod:669
37124 msgid "ACCESSING THE WINDOWS REGISTRY"
37128 #: ../src/guestfs.pod:671
37130 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
37131 "files, through the library C<hivex> which is part of the libguestfs project "
37132 "although ships as a separate tarball. You have to locate and download the "
37133 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
37134 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
37135 "reg(1)> for more help on this issue."
37139 #: ../src/guestfs.pod:679
37140 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
37144 #: ../src/guestfs.pod:681
37146 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
37147 "provide something which looks like a Linux symlink. The way it tries to do "
37148 "the rewriting is described here:"
37152 #: ../src/guestfs.pod:685
37154 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
37159 #: ../src/guestfs.pod:687
37161 "The essential problem is that ntfs-3g simply does not have enough "
37162 "information to do a correct job. NTFS links can contain drive letters and "
37163 "references to external device GUIDs that ntfs-3g has no way of resolving. "
37164 "It is almost certainly the case that libguestfs callers should ignore what "
37165 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
37169 #: ../src/guestfs.pod:694
37171 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
37172 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
37173 "attribute, and read the raw reparse data from that (you can find the format "
37174 "documented in various places around the web)."
37178 #: ../src/guestfs.pod:699
37179 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
37183 #: ../src/guestfs.pod:701
37185 "There are other useful extended attributes that can be read from ntfs-3g "
37186 "filesystems (using L</guestfs_getxattr>). See:"
37190 #: ../src/guestfs.pod:704
37192 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
37196 #: ../src/guestfs.pod:706
37197 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
37201 #: ../src/guestfs.pod:708
37203 "Although we don't want to discourage you from using the C API, we will "
37204 "mention here that the same API is also available in other languages."
37208 #: ../src/guestfs.pod:711
37210 "The API is broadly identical in all supported languages. This means that "
37211 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
37212 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
37213 "OCaml. In other words, a straightforward, predictable isomorphism between "
37218 #: ../src/guestfs.pod:717
37220 "Error messages are automatically transformed into exceptions if the language "
37225 #: ../src/guestfs.pod:720
37227 "We don't try to \"object orientify\" parts of the API in OO languages, "
37228 "although contributors are welcome to write higher level APIs above what we "
37229 "provide in their favourite languages if they wish."
37233 #: ../src/guestfs.pod:726
37238 #: ../src/guestfs.pod:728
37240 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
37241 "identical to the C API. C++ classes and exceptions are not used."
37245 #: ../src/guestfs.pod:732
37250 #: ../src/guestfs.pod:734
37252 "The C# bindings are highly experimental. Please read the warnings at the "
37253 "top of C<csharp/Libguestfs.cs>."
37257 #: ../src/guestfs.pod:737
37262 #: ../src/guestfs.pod:739
37263 msgid "See L<guestfs-erlang(3)>."
37267 #: ../src/guestfs.pod:741
37272 #: ../src/guestfs.pod:743
37274 "This is the only language binding that is working but incomplete. Only "
37275 "calls which return simple integers have been bound in Haskell, and we are "
37276 "looking for help to complete this binding."
37280 #: ../src/guestfs.pod:747
37285 #: ../src/guestfs.pod:749
37287 "Full documentation is contained in the Javadoc which is distributed with "
37288 "libguestfs. For examples, see L<guestfs-java(3)>."
37292 #: ../src/guestfs.pod:752
37297 #: ../src/guestfs.pod:754
37298 msgid "See L<guestfs-ocaml(3)>."
37302 #: ../src/guestfs.pod:756
37307 #: ../src/guestfs.pod:758
37308 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
37312 #: ../src/guestfs.pod:760
37317 #: ../src/guestfs.pod:762
37319 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
37320 "the php-libguestfs package for your distribution."
37324 #: ../src/guestfs.pod:765
37325 msgid "The PHP binding only works correctly on 64 bit machines."
37329 #: ../src/guestfs.pod:767
37334 #: ../src/guestfs.pod:769
37335 msgid "See L<guestfs-python(3)>."
37339 #: ../src/guestfs.pod:771
37344 #: ../src/guestfs.pod:773
37345 msgid "See L<guestfs-ruby(3)>."
37349 #: ../src/guestfs.pod:775
37350 msgid "B<shell scripts>"
37354 #: ../src/guestfs.pod:777
37355 msgid "See L<guestfish(1)>."
37359 #: ../src/guestfs.pod:781
37360 msgid "LIBGUESTFS GOTCHAS"
37364 #: ../src/guestfs.pod:783
37366 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
37367 "system [...] that works in the way it is documented but is counterintuitive "
37368 "and almost invites mistakes.\""
37372 #: ../src/guestfs.pod:787
37374 "Since we developed libguestfs and the associated tools, there are several "
37375 "things we would have designed differently, but are now stuck with for "
37376 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
37377 "release, you can expect these to change. Beware of them."
37381 #: ../src/guestfs.pod:795
37382 msgid "Autosync / forgetting to sync."
37386 #: ../src/guestfs.pod:797
37388 "I<Update:> Autosync is enabled by default for all API users starting from "
37389 "libguestfs 1.5.24. This section only applies to older versions."
37393 #: ../src/guestfs.pod:800
37395 "When modifying a filesystem from C or another language, you B<must> unmount "
37396 "all filesystems and call L</guestfs_sync> explicitly before you close the "
37397 "libguestfs handle. You can also call:"
37401 #: ../src/guestfs.pod:804
37404 " guestfs_set_autosync (g, 1);\n"
37409 #: ../src/guestfs.pod:806
37411 "to have the unmount/sync done automatically for you when the handle 'g' is "
37412 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
37416 #: ../src/guestfs.pod:810
37418 "If you forget to do this, then it is entirely possible that your changes "
37419 "won't be written out, or will be partially written, or (very rarely) that "
37420 "you'll get disk corruption."
37424 #: ../src/guestfs.pod:814
37426 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
37427 "guestfish scripts that forget to sync will work just fine, which can make "
37428 "this very puzzling if you are trying to debug a problem."
37432 #: ../src/guestfs.pod:818
37433 msgid "Mount option C<-o sync> should not be the default."
37437 #: ../src/guestfs.pod:820
37439 "I<Update:> L</guestfs_mount> no longer adds any options starting from "
37440 "libguestfs 1.13.16. This section only applies to older versions."
37444 #: ../src/guestfs.pod:823
37446 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
37447 "However C<-o sync> does not add any reliability benefit, but does have a "
37448 "very large performance impact."
37452 #: ../src/guestfs.pod:827
37454 "The work around is to use L</guestfs_mount_options> and set the mount "
37455 "options that you actually want to use."
37459 #: ../src/guestfs.pod:830
37460 msgid "Read-only should be the default."
37464 #: ../src/guestfs.pod:832
37466 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
37467 "specify I<--rw> if you want to make changes to the image."
37471 #: ../src/guestfs.pod:835
37472 msgid "This would reduce the potential to corrupt live VM images."
37476 #: ../src/guestfs.pod:837
37478 "Note that many filesystems change the disk when you just mount and unmount, "
37479 "even if you didn't perform any writes. You need to use L</"
37480 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
37484 #: ../src/guestfs.pod:841
37485 msgid "guestfish command line is hard to use."
37489 #: ../src/guestfs.pod:843
37491 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
37492 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
37493 "exist, so it fails. In earlier versions of guestfish the error message was "
37494 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
37495 "we should have used C<guestfish -c command> to run commands."
37499 #: ../src/guestfs.pod:850
37500 msgid "guestfish megabyte modifiers don't work right on all commands"
37504 #: ../src/guestfs.pod:852
37506 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
37507 "other modifiers). What guestfish actually does is to multiply the number "
37508 "part by the modifier part and pass the result to the C API. However this "
37509 "doesn't work for a few APIs which aren't expecting bytes, but are already "
37510 "expecting some other unit (eg. megabytes)."
37514 #: ../src/guestfs.pod:859
37515 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
37519 #: ../src/guestfs.pod:861
37522 " lvcreate LV VG 100M\n"
37527 #: ../src/guestfs.pod:863
37529 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
37530 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
37531 "megabytes * megabytes) logical volume. The error message you get from this "
37532 "is also a little obscure."
37536 #: ../src/guestfs.pod:868
37538 "This could be fixed in the generator by specially marking parameters and "
37539 "return values which take bytes or other units."
37543 #: ../src/guestfs.pod:871
37544 msgid "Ambiguity between devices and paths"
37548 #: ../src/guestfs.pod:873
37550 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
37551 "sdb2>) and a similar pathname. A file might just happen to be called "
37552 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
37556 #: ../src/guestfs.pod:878
37558 "In the current API we usually resolve this ambiguity by having two separate "
37559 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
37560 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
37561 "detecting if the path supplied begins with C</dev/>."
37565 #: ../src/guestfs.pod:884
37567 "To avoid both the ambiguity and the need to duplicate some calls, we could "
37568 "make paths/devices into structured names. One way to do this would be to "
37569 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
37570 "aspect of grub. Another way would be to use a structured type, equivalent "
37571 "to this OCaml type:"
37575 #: ../src/guestfs.pod:890
37578 " type path = Path of string | Device of int | Partition of int * int\n"
37583 #: ../src/guestfs.pod:892
37584 msgid "which would allow you to pass arguments like:"
37588 #: ../src/guestfs.pod:894
37591 " Path \"/foo/bar\"\n"
37592 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
37593 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
37594 " Path \"/dev/sdb2\" (* not a device *)\n"
37599 #: ../src/guestfs.pod:899
37601 "As you can see there are still problems to resolve even with this "
37602 "representation. Also consider how it might work in guestfish."
37606 #: ../src/guestfs.pod:904
37607 msgid "KEYS AND PASSPHRASES"
37611 #: ../src/guestfs.pod:906
37613 "Certain libguestfs calls take a parameter that contains sensitive key "
37614 "material, passed in as a C string."
37618 #: ../src/guestfs.pod:909
37620 "In the future we would hope to change the libguestfs implementation so that "
37621 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
37622 "swap. However this is I<not> done at the moment, because of the complexity "
37623 "of such an implementation."
37627 #: ../src/guestfs.pod:914
37629 "Therefore you should be aware that any key parameter you pass to libguestfs "
37630 "might end up being written out to the swap partition. If this is a concern, "
37631 "scrub the swap partition or don't use libguestfs on encrypted devices."
37635 #: ../src/guestfs.pod:919
37636 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
37640 #: ../src/guestfs.pod:921
37642 "All high-level libguestfs actions are synchronous. If you want to use "
37643 "libguestfs asynchronously then you must create a thread."
37647 #: ../src/guestfs.pod:924
37649 "Only use the handle from a single thread. Either use the handle exclusively "
37650 "from one thread, or provide your own mutex so that two threads cannot issue "
37651 "calls on the same handle at the same time."
37655 #: ../src/guestfs.pod:928
37657 "See the graphical program guestfs-browser for one possible architecture for "
37658 "multithreaded programs using libvirt and libguestfs."
37662 #: ../src/guestfs.pod:931
37667 #: ../src/guestfs.pod:933
37669 "Libguestfs needs a supermin appliance, which it finds by looking along an "
37674 #: ../src/guestfs.pod:936
37676 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
37677 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
37681 #: ../src/guestfs.pod:939
37683 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
37684 "to change the directories that libguestfs will search in. The value is a "
37685 "colon-separated list of paths. The current directory is I<not> searched "
37686 "unless the path contains an empty element or C<.>. For example "
37687 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
37688 "then C</usr/lib/guestfs>."
37692 #: ../src/guestfs.pod:946
37693 msgid "QEMU WRAPPERS"
37697 #: ../src/guestfs.pod:948
37699 "If you want to compile your own qemu, run qemu from a non-standard location, "
37700 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
37705 #: ../src/guestfs.pod:952
37707 "There is one important rule to remember: you I<must C<exec qemu>> as the "
37708 "last command in the shell script (so that qemu replaces the shell and "
37709 "becomes the direct child of the libguestfs-using program). If you don't do "
37710 "this, then the qemu process won't be cleaned up correctly."
37714 #: ../src/guestfs.pod:957
37716 "Here is an example of a wrapper, where I have built my own copy of qemu from "
37721 #: ../src/guestfs.pod:960
37725 " qemudir=/home/rjones/d/qemu\n"
37726 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
37731 #: ../src/guestfs.pod:964
37733 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
37734 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
37739 #: ../src/guestfs.pod:968
37742 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
37747 #: ../src/guestfs.pod:970
37749 "Note that libguestfs also calls qemu with the -help and -version options in "
37750 "order to determine features."
37754 #: ../src/guestfs.pod:973
37756 "Wrappers can also be used to edit the options passed to qemu. In the "
37757 "following example, the C<-machine ...> option (C<-machine> and the following "
37758 "argument) are removed from the command line and replaced with C<-machine pc,"
37759 "accel=tcg>. The while loop iterates over the options until it finds the "
37760 "right one to remove, putting the remaining options into the C<args> array."
37764 #: ../src/guestfs.pod:982
37768 " while [ $# -gt 0 ]; do\n"
37769 " case \"$1\" in\n"
37773 " args[i]=\"$1\"\n"
37782 #: ../src/guestfs.pod:994
37785 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
37790 #: ../src/guestfs.pod:996
37791 msgid "ATTACHING TO RUNNING DAEMONS"
37795 #: ../src/guestfs.pod:998
37797 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
37798 "babies. Use with caution."
37802 #: ../src/guestfs.pod:1001
37804 "I<Note (2):> This section explains how to attach to a running daemon from a "
37805 "low level perspective. For most users, simply using virt tools such as "
37806 "L<guestfish(1)> with the I<--live> option will \"just work\"."
37810 #: ../src/guestfs.pod:1005
37811 msgid "Using guestfs_set_attach_method"
37815 #: ../src/guestfs.pod:1007
37817 "By calling L</guestfs_set_attach_method> you can change how the library "
37818 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
37819 "ARCHITECTURE> for some background)."
37823 #: ../src/guestfs.pod:1011
37825 "The normal attach method is C<appliance>, where a small appliance is created "
37826 "containing the daemon, and then the library connects to this."
37830 #: ../src/guestfs.pod:1014
37832 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
37833 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
37834 "daemon over the Unix domain socket."
37838 #: ../src/guestfs.pod:1018
37840 "The normal use for this is to connect to a running virtual machine that "
37841 "contains a C<guestfsd> daemon, and send commands so you can read and write "
37842 "files inside the live virtual machine."
37846 #: ../src/guestfs.pod:1022
37847 msgid "Using guestfs_add_domain with live flag"
37851 #: ../src/guestfs.pod:1024
37853 "L</guestfs_add_domain> provides some help for getting the correct attach "
37854 "method. If you pass the C<live> option to this function, then (if the "
37855 "virtual machine is running) it will examine the libvirt XML looking for a "
37856 "virtio-serial channel to connect to:"
37860 #: ../src/guestfs.pod:1030
37867 " <channel type='unix'>\n"
37868 " <source mode='bind' path='/path/to/socket'/>\n"
37869 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
37878 #: ../src/guestfs.pod:1042
37880 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
37881 "method to C<unix:/path/to/socket>."
37885 #: ../src/guestfs.pod:1045
37887 "Some of the libguestfs tools (including guestfish) support a I<--live> "
37888 "option which is passed through to L</guestfs_add_domain> thus allowing you "
37889 "to attach to and modify live virtual machines."
37893 #: ../src/guestfs.pod:1049
37895 "The virtual machine needs to have been set up beforehand so that it has the "
37896 "virtio-serial channel and so that guestfsd is running inside it."
37900 #: ../src/guestfs.pod:1053
37901 msgid "ABI GUARANTEE"
37905 #: ../src/guestfs.pod:1055
37907 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
37908 "actions as outlined in this section. Although we will deprecate some "
37909 "actions, for example if they get replaced by newer calls, we will keep the "
37910 "old actions forever. This allows you the developer to program in confidence "
37911 "against the libguestfs API."
37915 #: ../src/guestfs.pod:1061
37916 msgid "BLOCK DEVICE NAMING"
37920 #: ../src/guestfs.pod:1063
37922 "In the kernel there is now quite a profusion of schemata for naming block "
37923 "devices (in this context, by I<block device> I mean a physical or virtual "
37924 "hard drive). The original Linux IDE driver used names starting with C</dev/"
37925 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
37926 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
37927 "for the old IDE driver (particularly for SATA devices) those devices also "
37928 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
37929 "paravirtualized drivers. This has created several different naming systems, "
37930 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
37934 #: ../src/guestfs.pod:1075
37936 "As discussed above, libguestfs uses a qemu appliance running an embedded "
37937 "Linux kernel to access block devices. We can run a variety of appliances "
37938 "based on a variety of Linux kernels."
37942 #: ../src/guestfs.pod:1079
37944 "This causes a problem for libguestfs because many API calls use device or "
37945 "partition names. Working scripts and the recipe (example) scripts that we "
37946 "make available over the internet could fail if the naming scheme changes."
37950 #: ../src/guestfs.pod:1084
37952 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
37953 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
37954 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
37955 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
37959 #: ../src/guestfs.pod:1090
37961 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
37962 "L</guestfs_list_partitions> and similar calls return the true names of the "
37963 "devices and partitions as known to the appliance."
37967 #: ../src/guestfs.pod:1095
37968 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
37972 #: ../src/guestfs.pod:1097
37974 "Usually this translation is transparent. However in some (very rare) cases "
37975 "you may need to know the exact algorithm. Such cases include where you use "
37976 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
37977 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
37981 #: ../src/guestfs.pod:1103
37983 "The algorithm is applied only to I<parameters> which are known to be either "
37984 "device or partition names. Return values from functions such as L</"
37985 "guestfs_list_devices> are never changed."
37989 #: ../src/guestfs.pod:1111
37990 msgid "Is the string a parameter which is a device or partition name?"
37994 #: ../src/guestfs.pod:1115
37995 msgid "Does the string begin with C</dev/sd>?"
37999 #: ../src/guestfs.pod:1119
38001 "Does the named device exist? If so, we use that device. However if I<not> "
38002 "then we continue with this algorithm."
38006 #: ../src/guestfs.pod:1124
38007 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
38011 #: ../src/guestfs.pod:1126
38012 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
38016 #: ../src/guestfs.pod:1128
38017 msgid "If that named device exists, use it. If not, continue."
38021 #: ../src/guestfs.pod:1132
38022 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
38026 #: ../src/guestfs.pod:1134
38027 msgid "If that named device exists, use it. If not, return an error."
38031 #: ../src/guestfs.pod:1138
38032 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
38036 #: ../src/guestfs.pod:1140
38038 "Although the standard naming scheme and automatic translation is useful for "
38039 "simple programs and guestfish scripts, for larger programs it is best not to "
38040 "rely on this mechanism."
38044 #: ../src/guestfs.pod:1144
38046 "Where possible for maximum future portability programs using libguestfs "
38047 "should use these future-proof techniques:"
38051 #: ../src/guestfs.pod:1151
38053 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
38054 "device names, and then use those names directly."
38058 #: ../src/guestfs.pod:1154
38060 "Since those device names exist by definition, they will never be translated."
38064 #: ../src/guestfs.pod:1159
38066 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
38067 "filesystem labels."
38071 #: ../src/guestfs.pod:1166
38073 "This section discusses security implications of using libguestfs, "
38074 "particularly with untrusted or malicious guests or disk images."
38078 #: ../src/guestfs.pod:1169
38079 msgid "GENERAL SECURITY CONSIDERATIONS"
38083 #: ../src/guestfs.pod:1171
38085 "Be careful with any files or data that you download from a guest (by "
38086 "\"download\" we mean not just the L</guestfs_download> command but any "
38087 "command that reads files, filenames, directories or anything else from a "
38088 "disk image). An attacker could manipulate the data to fool your program "
38089 "into doing the wrong thing. Consider cases such as:"
38093 #: ../src/guestfs.pod:1181
38094 msgid "the data (file etc) not being present"
38098 #: ../src/guestfs.pod:1185
38099 msgid "being present but empty"
38103 #: ../src/guestfs.pod:1189
38104 msgid "being much larger than normal"
38108 #: ../src/guestfs.pod:1193
38109 msgid "containing arbitrary 8 bit data"
38113 #: ../src/guestfs.pod:1197
38114 msgid "being in an unexpected character encoding"
38118 #: ../src/guestfs.pod:1201
38119 msgid "containing homoglyphs."
38123 #: ../src/guestfs.pod:1205
38124 msgid "SECURITY OF MOUNTING FILESYSTEMS"
38128 #: ../src/guestfs.pod:1207
38130 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
38131 "(VFS) module can sometimes be escalated into exploits by deliberately "
38132 "creating a malicious, malformed filesystem. These exploits are very severe "
38133 "for two reasons. Firstly there are very many filesystem drivers in the "
38134 "kernel, and many of them are infrequently used and not much developer "
38135 "attention has been paid to the code. Linux userspace helps potential "
38136 "crackers by detecting the filesystem type and automatically choosing the "
38137 "right VFS driver, even if that filesystem type is obscure or unexpected for "
38138 "the administrator. Secondly, a kernel-level exploit is like a local root "
38139 "exploit (worse in some ways), giving immediate and total access to the "
38140 "system right down to the hardware level."
38144 #: ../src/guestfs.pod:1220
38146 "That explains why you should never mount a filesystem from an untrusted "
38147 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
38148 "inside a qemu virtual machine, usually running as a non-root user. The "
38149 "attacker would need to write a filesystem which first exploited the kernel, "
38150 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
38151 "the libguestfs protocol, and finally to be as serious as the host kernel "
38152 "exploit it would need to escalate its privileges to root. This multi-step "
38153 "escalation, performed by a static piece of data, is thought to be extremely "
38154 "hard to do, although we never say 'never' about security issues."
38158 #: ../src/guestfs.pod:1231
38160 "In any case callers can reduce the attack surface by forcing the filesystem "
38161 "type when mounting (use L</guestfs_mount_vfs>)."
38165 #: ../src/guestfs.pod:1234
38166 msgid "PROTOCOL SECURITY"
38170 #: ../src/guestfs.pod:1236
38172 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
38173 "defined upper message size. However a program that uses libguestfs must "
38174 "also take care - for example you can write a program that downloads a binary "
38175 "from a disk image and executes it locally, and no amount of protocol "
38176 "security will save you from the consequences."
38180 #: ../src/guestfs.pod:1242
38181 msgid "INSPECTION SECURITY"
38185 #: ../src/guestfs.pod:1244
38187 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
38188 "directly from the guest, and these could contain any 8 bit data. Callers "
38189 "should be careful to escape these before printing them to a structured file "
38190 "(for example, use HTML escaping if creating a web page)."
38194 #: ../src/guestfs.pod:1250
38196 "Guest configuration may be altered in unusual ways by the administrator of "
38197 "the virtual machine, and may not reflect reality (particularly for untrusted "
38198 "or actively malicious guests). For example we parse the hostname from "
38199 "configuration files like C</etc/sysconfig/network> that we find in the "
38200 "guest, but the guest administrator can easily manipulate these files to "
38201 "provide the wrong hostname."
38205 #: ../src/guestfs.pod:1258
38207 "The inspection API parses guest configuration using two external libraries: "
38208 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
38209 "designed to be robust in the face of malicious data, although denial of "
38210 "service attacks are still possible, for example with oversized configuration "
38215 #: ../src/guestfs.pod:1264
38216 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
38220 #: ../src/guestfs.pod:1266
38222 "Be very cautious about running commands from the guest. By running a "
38223 "command in the guest, you are giving CPU time to a binary that you do not "
38224 "control, under the same user account as the library, albeit wrapped in qemu "
38225 "virtualization. More information and alternatives can be found in the "
38226 "section L</RUNNING COMMANDS>."
38230 #: ../src/guestfs.pod:1272
38231 msgid "CVE-2010-3851"
38235 #: ../src/guestfs.pod:1274
38236 msgid "https://bugzilla.redhat.com/642934"
38240 #: ../src/guestfs.pod:1276
38242 "This security bug concerns the automatic disk format detection that qemu "
38243 "does on disk images."
38247 #: ../src/guestfs.pod:1279
38249 "A raw disk image is just the raw bytes, there is no header. Other disk "
38250 "images like qcow2 contain a special header. Qemu deals with this by looking "
38251 "for one of the known headers, and if none is found then assuming the disk "
38252 "image must be raw."
38256 #: ../src/guestfs.pod:1284
38258 "This allows a guest which has been given a raw disk image to write some "
38259 "other header. At next boot (or when the disk image is accessed by "
38260 "libguestfs) qemu would do autodetection and think the disk image format was, "
38261 "say, qcow2 based on the header written by the guest."
38265 #: ../src/guestfs.pod:1289
38267 "This in itself would not be a problem, but qcow2 offers many features, one "
38268 "of which is to allow a disk image to refer to another image (called the "
38269 "\"backing disk\"). It does this by placing the path to the backing disk "
38270 "into the qcow2 header. This path is not validated and could point to any "
38271 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
38272 "\"holes\" in the qcow2 disk image, which of course is completely under the "
38273 "control of the attacker."
38277 #: ../src/guestfs.pod:1297
38279 "In libguestfs this is rather hard to exploit except under two circumstances:"
38283 #: ../src/guestfs.pod:1304
38284 msgid "You have enabled the network or have opened the disk in write mode."
38288 #: ../src/guestfs.pod:1308
38290 "You are also running untrusted code from the guest (see L</RUNNING "
38295 #: ../src/guestfs.pod:1313
38297 "The way to avoid this is to specify the expected disk format when adding "
38298 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
38299 "should always do this if the disk is raw format, and it's a good idea for "
38304 #: ../src/guestfs.pod:1318
38306 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
38307 "format is fetched from libvirt and passed through."
38311 #: ../src/guestfs.pod:1321
38313 "For libguestfs tools, use the I<--format> command line parameter as "
38318 #: ../src/guestfs.pod:1324
38319 msgid "CONNECTION MANAGEMENT"
38323 #: ../src/guestfs.pod:1326
38324 msgid "guestfs_h *"
38328 #: ../src/guestfs.pod:1328
38330 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
38331 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
38332 "handle and release all resources used."
38336 #: ../src/guestfs.pod:1332
38338 "For information on using multiple handles and threads, see the section L</"
38339 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
38343 #: ../src/guestfs.pod:1335
38344 msgid "guestfs_create"
38348 #: ../src/guestfs.pod:1337
38351 " guestfs_h *guestfs_create (void);\n"
38356 #: ../src/guestfs.pod:1339
38357 msgid "Create a connection handle."
38361 #: ../src/guestfs.pod:1341
38363 "On success this returns a non-NULL pointer to a handle. On error it returns "
38368 #: ../src/guestfs.pod:1344
38370 "You have to \"configure\" the handle after creating it. This includes "
38371 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
38372 "handle at least once."
38376 #: ../src/guestfs.pod:1348
38377 msgid "After configuring the handle, you have to call L</guestfs_launch>."
38381 #: ../src/guestfs.pod:1350
38383 "You may also want to configure error handling for the handle. See the L</"
38384 "ERROR HANDLING> section below."
38388 #: ../src/guestfs.pod:1353
38389 msgid "guestfs_close"
38393 #: ../src/guestfs.pod:1355
38396 " void guestfs_close (guestfs_h *g);\n"
38401 #: ../src/guestfs.pod:1357
38402 msgid "This closes the connection handle and frees up all resources used."
38406 #: ../src/guestfs.pod:1359
38408 "If autosync was set on the handle and the handle was launched, then this "
38409 "implicitly calls various functions to unmount filesystems and sync the "
38410 "disk. See L</guestfs_set_autosync> for more details."
38414 #: ../src/guestfs.pod:1363
38415 msgid "If a close callback was set on the handle, then it is called."
38419 #: ../src/guestfs.pod:1365
38420 msgid "ERROR HANDLING"
38424 #: ../src/guestfs.pod:1367
38426 "API functions can return errors. For example, almost all functions that "
38427 "return C<int> will return C<-1> to indicate an error."
38431 #: ../src/guestfs.pod:1370
38433 "Additional information is available for errors: an error message string and "
38434 "optionally an error number (errno) if the thing that failed was a system "
38439 #: ../src/guestfs.pod:1374
38441 "You can get at the additional information about the last error on the handle "
38442 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
38443 "up an error handler with L</guestfs_set_error_handler>."
38447 #: ../src/guestfs.pod:1379
38449 "When the handle is created, a default error handler is installed which "
38450 "prints the error message string to C<stderr>. For small short-running "
38451 "command line programs it is sufficient to do:"
38455 #: ../src/guestfs.pod:1383
38458 " if (guestfs_launch (g) == -1)\n"
38459 " exit (EXIT_FAILURE);\n"
38464 #: ../src/guestfs.pod:1386
38466 "since the default error handler will ensure that an error message has been "
38467 "printed to C<stderr> before the program exits."
38471 #: ../src/guestfs.pod:1389
38473 "For other programs the caller will almost certainly want to install an "
38474 "alternate error handler or do error handling in-line like this:"
38478 #: ../src/guestfs.pod:1392
38481 " /* This disables the default behaviour of printing errors\n"
38483 " guestfs_set_error_handler (g, NULL, NULL);\n"
38488 #: ../src/guestfs.pod:1396
38491 " if (guestfs_launch (g) == -1) {\n"
38492 " /* Examine the error message and print it etc. */\n"
38493 " char *msg = guestfs_last_error (g);\n"
38494 " int errnum = guestfs_last_errno (g);\n"
38495 " fprintf (stderr, \"%s\", msg);\n"
38496 " if (errnum != 0)\n"
38497 " fprintf (stderr, \": %s\", strerror (errnum));\n"
38498 " fprintf (stderr, \"\\n\");\n"
38505 #: ../src/guestfs.pod:1407
38507 "Out of memory errors are handled differently. The default action is to call "
38508 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
38509 "guestfs_set_out_of_memory_handler>."
38513 #: ../src/guestfs.pod:1411
38515 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
38516 "because there is no handle if this happens there is no way to get additional "
38517 "error information. However L</guestfs_create> is supposed to be a "
38518 "lightweight operation which can only fail because of insufficient memory (it "
38519 "returns NULL in this case)."
38523 #: ../src/guestfs.pod:1417
38524 msgid "guestfs_last_error"
38528 #: ../src/guestfs.pod:1419
38531 " const char *guestfs_last_error (guestfs_h *g);\n"
38536 #: ../src/guestfs.pod:1421
38538 "This returns the last error message that happened on C<g>. If there has not "
38539 "been an error since the handle was created, then this returns C<NULL>."
38543 #: ../src/guestfs.pod:1425
38545 "The lifetime of the returned string is until the next error occurs, or L</"
38546 "guestfs_close> is called."
38550 #: ../src/guestfs.pod:1428
38551 msgid "guestfs_last_errno"
38555 #: ../src/guestfs.pod:1430
38558 " int guestfs_last_errno (guestfs_h *g);\n"
38563 #: ../src/guestfs.pod:1432
38564 msgid "This returns the last error number (errno) that happened on C<g>."
38568 #: ../src/guestfs.pod:1434
38569 msgid "If successful, an errno integer not equal to zero is returned."
38573 #: ../src/guestfs.pod:1436
38575 "If no error, this returns 0. This call can return 0 in three situations:"
38579 #: ../src/guestfs.pod:1443
38580 msgid "There has not been any error on the handle."
38584 #: ../src/guestfs.pod:1447
38586 "There has been an error but the errno was meaningless. This corresponds to "
38587 "the case where the error did not come from a failed system call, but for "
38588 "some other reason."
38592 #: ../src/guestfs.pod:1453
38594 "There was an error from a failed system call, but for some reason the errno "
38595 "was not captured and returned. This usually indicates a bug in libguestfs."
38599 #: ../src/guestfs.pod:1459
38601 "Libguestfs tries to convert the errno from inside the applicance into a "
38602 "corresponding errno for the caller (not entirely trivial: the appliance "
38603 "might be running a completely different operating system from the library "
38604 "and error numbers are not standardized across Un*xen). If this could not be "
38605 "done, then the error is translated to C<EINVAL>. In practice this should "
38606 "only happen in very rare circumstances."
38610 #: ../src/guestfs.pod:1467
38611 msgid "guestfs_set_error_handler"
38615 #: ../src/guestfs.pod:1469
38618 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
38620 " const char *msg);\n"
38621 " void guestfs_set_error_handler (guestfs_h *g,\n"
38622 " guestfs_error_handler_cb cb,\n"
38623 " void *opaque);\n"
38628 #: ../src/guestfs.pod:1476
38630 "The callback C<cb> will be called if there is an error. The parameters "
38631 "passed to the callback are an opaque data pointer and the error message "
38636 #: ../src/guestfs.pod:1480
38638 "C<errno> is not passed to the callback. To get that the callback must call "
38639 "L</guestfs_last_errno>."
38643 #: ../src/guestfs.pod:1483
38645 "Note that the message string C<msg> is freed as soon as the callback "
38646 "function returns, so if you want to stash it somewhere you must make your "
38651 #: ../src/guestfs.pod:1487
38652 msgid "The default handler prints messages on C<stderr>."
38656 #: ../src/guestfs.pod:1489
38657 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
38661 #: ../src/guestfs.pod:1491
38662 msgid "guestfs_get_error_handler"
38666 #: ../src/guestfs.pod:1493
38669 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
38670 " void **opaque_rtn);\n"
38675 #: ../src/guestfs.pod:1496
38676 msgid "Returns the current error handler callback."
38680 #: ../src/guestfs.pod:1498
38681 msgid "guestfs_set_out_of_memory_handler"
38685 #: ../src/guestfs.pod:1500
38688 " typedef void (*guestfs_abort_cb) (void);\n"
38689 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
38690 " guestfs_abort_cb);\n"
38695 #: ../src/guestfs.pod:1504
38697 "The callback C<cb> will be called if there is an out of memory situation. "
38698 "I<Note this callback must not return>."
38702 #: ../src/guestfs.pod:1507
38703 msgid "The default is to call L<abort(3)>."
38707 #: ../src/guestfs.pod:1509
38709 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
38713 #: ../src/guestfs.pod:1512
38714 msgid "guestfs_get_out_of_memory_handler"
38718 #: ../src/guestfs.pod:1514
38721 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
38726 #: ../src/guestfs.pod:1516
38727 msgid "This returns the current out of memory handler."
38731 #: ../src/guestfs.pod:1518
38736 #: ../src/guestfs.pod:1522
38741 #: ../src/guestfs.pod:1524
38746 #: ../src/guestfs.pod:1526
38747 msgid "AVAILABILITY"
38751 #: ../src/guestfs.pod:1528
38752 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
38756 #: ../src/guestfs.pod:1530
38758 "Using L</guestfs_available> you can test availability of the following "
38759 "groups of functions. This test queries the appliance to see if the "
38760 "appliance you are currently using supports the functionality."
38764 #: ../src/guestfs.pod:1535
38765 msgid "@AVAILABILITY@"
38769 #: ../src/guestfs.pod:1537
38770 msgid "GUESTFISH supported COMMAND"
38774 #: ../src/guestfs.pod:1539
38776 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
38777 "prints out the available groups and whether they are supported by this build "
38778 "of libguestfs. Note however that you have to do C<run> first."
38782 #: ../src/guestfs.pod:1544
38783 msgid "SINGLE CALLS AT COMPILE TIME"
38787 #: ../src/guestfs.pod:1546
38789 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
38790 "function, such as:"
38794 #: ../src/guestfs.pod:1549
38797 " #define LIBGUESTFS_HAVE_DD 1\n"
38802 #: ../src/guestfs.pod:1551
38803 msgid "if L</guestfs_dd> is available."
38807 #: ../src/guestfs.pod:1553
38809 "Before version 1.5.8, if you needed to test whether a single libguestfs "
38810 "function is available at compile time, we recommended using build tools such "
38811 "as autoconf or cmake. For example in autotools you could use:"
38815 #: ../src/guestfs.pod:1558
38818 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
38819 " AC_CHECK_FUNCS([guestfs_dd])\n"
38824 #: ../src/guestfs.pod:1561
38826 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
38831 #: ../src/guestfs.pod:1564
38832 msgid "SINGLE CALLS AT RUN TIME"
38836 #: ../src/guestfs.pod:1566
38838 "Testing at compile time doesn't guarantee that a function really exists in "
38839 "the library. The reason is that you might be dynamically linked against a "
38840 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
38841 "This situation unfortunately results in a segmentation fault, which is a "
38842 "shortcoming of the C dynamic linking system itself."
38846 #: ../src/guestfs.pod:1573
38848 "You can use L<dlopen(3)> to test if a function is available at run time, as "
38849 "in this example program (note that you still need the compile time check as "
38854 #: ../src/guestfs.pod:1577
38857 " #include <stdio.h>\n"
38858 " #include <stdlib.h>\n"
38859 " #include <unistd.h>\n"
38860 " #include <dlfcn.h>\n"
38861 " #include <guestfs.h>\n"
38866 #: ../src/guestfs.pod:1583
38871 " #ifdef LIBGUESTFS_HAVE_DD\n"
38873 " int has_function;\n"
38878 #: ../src/guestfs.pod:1589
38881 " /* Test if the function guestfs_dd is really available. */\n"
38882 " dl = dlopen (NULL, RTLD_LAZY);\n"
38884 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
38885 " exit (EXIT_FAILURE);\n"
38887 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
38893 #: ../src/guestfs.pod:1598
38896 " if (!has_function)\n"
38897 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
38899 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
38900 " /* Now it's safe to call\n"
38901 " guestfs_dd (g, \"foo\", \"bar\");\n"
38905 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
38912 #: ../src/guestfs.pod:1611
38914 "You may think the above is an awful lot of hassle, and it is. There are "
38915 "other ways outside of the C linking system to ensure that this kind of "
38916 "incompatibility never arises, such as using package versioning:"
38920 #: ../src/guestfs.pod:1616
38923 " Requires: libguestfs >= 1.0.80\n"
38928 #: ../src/guestfs.pod:1618
38929 msgid "CALLS WITH OPTIONAL ARGUMENTS"
38933 #: ../src/guestfs.pod:1620
38935 "A recent feature of the API is the introduction of calls which take optional "
38936 "arguments. In C these are declared 3 ways. The main way is as a call which "
38937 "takes variable arguments (ie. C<...>), as in this example:"
38941 #: ../src/guestfs.pod:1625
38944 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
38949 #: ../src/guestfs.pod:1627
38951 "Call this with a list of optional arguments, terminated by C<-1>. So to "
38952 "call with no optional arguments specified:"
38956 #: ../src/guestfs.pod:1630
38959 " guestfs_add_drive_opts (g, filename, -1);\n"
38964 #: ../src/guestfs.pod:1632
38965 msgid "With a single optional argument:"
38969 #: ../src/guestfs.pod:1634
38972 " guestfs_add_drive_opts (g, filename,\n"
38973 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
38979 #: ../src/guestfs.pod:1638
38984 #: ../src/guestfs.pod:1640
38987 " guestfs_add_drive_opts (g, filename,\n"
38988 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
38989 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
38995 #: ../src/guestfs.pod:1645
38997 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
39002 #: ../src/guestfs.pod:1648
39003 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
39007 #: ../src/guestfs.pod:1650
39009 "The second variant has the same name with the suffix C<_va>, which works the "
39010 "same way but takes a C<va_list>. See the C manual for details. For the "
39011 "example function, this is declared:"
39015 #: ../src/guestfs.pod:1654
39018 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
39019 " va_list args);\n"
39024 #: ../src/guestfs.pod:1657
39025 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
39029 #: ../src/guestfs.pod:1659
39031 "The third variant is useful where you need to construct these calls. You "
39032 "pass in a structure where you fill in the optional fields. The structure "
39033 "has a bitmask as the first element which you must set to indicate which "
39034 "fields you have filled in. For our example function the structure and call "
39039 #: ../src/guestfs.pod:1665
39042 " struct guestfs_add_drive_opts_argv {\n"
39043 " uint64_t bitmask;\n"
39045 " const char *format;\n"
39048 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
39049 " const struct guestfs_add_drive_opts_argv *optargs);\n"
39054 #: ../src/guestfs.pod:1674
39055 msgid "You could call it like this:"
39059 #: ../src/guestfs.pod:1676
39062 " struct guestfs_add_drive_opts_argv optargs = {\n"
39063 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
39064 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
39065 " .readonly = 1,\n"
39066 " .format = \"qcow2\"\n"
39072 #: ../src/guestfs.pod:1683
39075 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
39080 #: ../src/guestfs.pod:1691
39081 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
39085 #: ../src/guestfs.pod:1696
39086 msgid "You do not need to fill in all fields of the structure."
39090 #: ../src/guestfs.pod:1700
39092 "There must be a one-to-one correspondence between fields of the structure "
39093 "that are filled in, and bits set in the bitmask."
39097 #: ../src/guestfs.pod:1705
39098 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
39102 #: ../src/guestfs.pod:1707
39104 "In other languages, optional arguments are expressed in the way that is "
39105 "natural for that language. We refer you to the language-specific "
39106 "documentation for more details on that."
39110 #: ../src/guestfs.pod:1711
39111 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
39115 #: ../src/guestfs.pod:1713
39116 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
39120 #: ../src/guestfs.pod:1715
39122 "B<Note:> This section documents the generic event mechanism introduced in "
39123 "libguestfs 1.10, which you should use in new code if possible. The old "
39124 "functions C<guestfs_set_log_message_callback>, "
39125 "C<guestfs_set_subprocess_quit_callback>, "
39126 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
39127 "C<guestfs_set_progress_callback> are no longer documented in this manual "
39128 "page. Because of the ABI guarantee, the old functions continue to work."
39132 #: ../src/guestfs.pod:1724
39134 "Handles generate events when certain things happen, such as log messages "
39135 "being generated, progress messages during long-running operations, or the "
39136 "handle being closed. The API calls described below let you register a "
39137 "callback to be called when events happen. You can register multiple "
39138 "callbacks (for the same, different or overlapping sets of events), and "
39139 "individually remove callbacks. If callbacks are not removed, then they "
39140 "remain in force until the handle is closed."
39144 #: ../src/guestfs.pod:1732
39146 "In the current implementation, events are only generated synchronously: that "
39147 "means that events (and hence callbacks) can only happen while you are in the "
39148 "middle of making another libguestfs call. The callback is called in the "
39153 #: ../src/guestfs.pod:1737
39155 "Events may contain a payload, usually nothing (void), an array of 64 bit "
39156 "unsigned integers, or a message buffer. Payloads are discussed later on."
39160 #: ../src/guestfs.pod:1741
39161 msgid "CLASSES OF EVENTS"
39165 #: ../src/guestfs.pod:1745
39166 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
39170 #: ../src/guestfs.pod:1748
39172 "The callback function will be called while the handle is being closed "
39173 "(synchronously from L</guestfs_close>)."
39177 #: ../src/guestfs.pod:1751
39179 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
39180 "handles that are open when the program exits. This means that this callback "
39181 "might be called indirectly from L<exit(3)>, which can cause unexpected "
39182 "problems in higher-level languages (eg. if your HLL interpreter has already "
39183 "been cleaned up by the time this is called, and if your callback then jumps "
39184 "into some HLL function)."
39188 #: ../src/guestfs.pod:1758
39190 "If no callback is registered: the handle is closed without any callback "
39195 #: ../src/guestfs.pod:1761
39196 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
39200 #: ../src/guestfs.pod:1764
39202 "The callback function will be called when the child process quits, either "
39203 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
39204 "corresponds to a transition from any state to the CONFIG state)."
39208 #: ../src/guestfs.pod:1768 ../src/guestfs.pod:1777 ../src/guestfs.pod:1894
39209 msgid "If no callback is registered: the event is ignored."
39213 #: ../src/guestfs.pod:1770
39214 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
39218 #: ../src/guestfs.pod:1773
39220 "The callback function will be called when the child process becomes ready "
39221 "first time after it has been launched. (This corresponds to a transition "
39222 "from LAUNCHING to the READY state)."
39226 #: ../src/guestfs.pod:1779
39227 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
39231 #: ../src/guestfs.pod:1782
39233 "Some long-running operations can generate progress messages. If this "
39234 "callback is registered, then it will be called each time a progress message "
39235 "is generated (usually two seconds after the operation started, and three "
39236 "times per second thereafter until it completes, although the frequency may "
39237 "change in future versions)."
39241 #: ../src/guestfs.pod:1788
39243 "The callback receives in the payload four unsigned 64 bit numbers which are "
39244 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
39248 #: ../src/guestfs.pod:1791
39250 "The units of C<total> are not defined, although for some operations C<total> "
39251 "may relate in some way to the amount of data to be transferred (eg. in bytes "
39252 "or megabytes), and C<position> may be the portion which has been transferred."
39256 #: ../src/guestfs.pod:1796
39257 msgid "The only defined and stable parts of the API are:"
39261 #: ../src/guestfs.pod:1802
39263 "The callback can display to the user some type of progress bar or indicator "
39264 "which shows the ratio of C<position>:C<total>."
39268 #: ../src/guestfs.pod:1807
39269 msgid "0 E<lt>= C<position> E<lt>= C<total>"
39273 #: ../src/guestfs.pod:1811
39275 "If any progress notification is sent during a call, then a final progress "
39276 "notification is always sent when C<position> = C<total> (I<unless> the call "
39277 "fails with an error)."
39281 #: ../src/guestfs.pod:1815
39283 "This is to simplify caller code, so callers can easily set the progress "
39284 "indicator to \"100%\" at the end of the operation, without requiring special "
39285 "code to detect this case."
39289 #: ../src/guestfs.pod:1821
39291 "For some calls we are unable to estimate the progress of the call, but we "
39292 "can still generate progress messages to indicate activity. This is known as "
39293 "\"pulse mode\", and is directly supported by certain progress bar "
39294 "implementations (eg. GtkProgressBar)."
39298 #: ../src/guestfs.pod:1826
39300 "For these calls, zero or more progress messages are generated with "
39301 "C<position = 0> and C<total = 1>, followed by a final message with "
39302 "C<position = total = 1>."
39306 #: ../src/guestfs.pod:1830
39308 "As noted above, if the call fails with an error then the final message may "
39309 "not be generated."
39313 #: ../src/guestfs.pod:1835
39315 "The callback also receives the procedure number (C<proc_nr>) and serial "
39316 "number (C<serial>) of the call. These are only useful for debugging "
39317 "protocol issues, and the callback can normally ignore them. The callback "
39318 "may want to print these numbers in error messages or debugging messages."
39322 #: ../src/guestfs.pod:1841
39323 msgid "If no callback is registered: progress messages are discarded."
39327 #: ../src/guestfs.pod:1843
39328 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
39332 #: ../src/guestfs.pod:1846
39334 "The callback function is called whenever a log message is generated by qemu, "
39335 "the appliance kernel, guestfsd (daemon), or utility programs."
39339 #: ../src/guestfs.pod:1849
39341 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
39342 "guestfs_launch>) then additional debug messages are generated."
39346 #: ../src/guestfs.pod:1852 ../src/guestfs.pod:1866
39348 "If no callback is registered: the messages are discarded unless the verbose "
39349 "flag is set in which case they are sent to stderr. You can override the "
39350 "printing of verbose messages to stderr by setting up a callback."
39354 #: ../src/guestfs.pod:1857
39355 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
39359 #: ../src/guestfs.pod:1860
39361 "The callback function is called whenever a log message is generated by the "
39362 "library part of libguestfs."
39366 #: ../src/guestfs.pod:1863
39368 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
39369 "messages are generated."
39373 #: ../src/guestfs.pod:1871
39374 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
39378 #: ../src/guestfs.pod:1874
39380 "The callback function is called whenever a trace message is generated. This "
39381 "only applies if the trace flag (L</guestfs_set_trace>) is set."
39385 #: ../src/guestfs.pod:1877
39387 "If no callback is registered: the messages are sent to stderr. You can "
39388 "override the printing of trace messages to stderr by setting up a callback."
39392 #: ../src/guestfs.pod:1881
39393 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
39397 #: ../src/guestfs.pod:1884
39399 "The callback function is called whenever a libguestfs function is entered."
39403 #: ../src/guestfs.pod:1887
39405 "The payload is a string which contains the name of the function that we are "
39406 "entering (not including C<guestfs_> prefix)."
39410 #: ../src/guestfs.pod:1890
39412 "Note that libguestfs functions can call themselves, so you may see many "
39413 "events from a single call. A few libguestfs functions do not generate this "
39418 #: ../src/guestfs.pod:1898
39419 msgid "guestfs_set_event_callback"
39423 #: ../src/guestfs.pod:1900
39426 " int guestfs_set_event_callback (guestfs_h *g,\n"
39427 " guestfs_event_callback cb,\n"
39428 " uint64_t event_bitmask,\n"
39430 " void *opaque);\n"
39435 #: ../src/guestfs.pod:1906
39437 "This function registers a callback (C<cb>) for all event classes in the "
39438 "C<event_bitmask>."
39442 #: ../src/guestfs.pod:1909
39444 "For example, to register for all log message events, you could call this "
39445 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
39446 "To register a single callback for all possible classes of events, use "
39447 "C<GUESTFS_EVENT_ALL>."
39451 #: ../src/guestfs.pod:1915
39452 msgid "C<flags> should always be passed as 0."
39456 #: ../src/guestfs.pod:1917
39458 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
39459 "it for any purpose."
39463 #: ../src/guestfs.pod:1920
39465 "The return value is the event handle (an integer) which you can use to "
39466 "delete the callback (see below)."
39470 #: ../src/guestfs.pod:1923
39472 "If there is an error, this function returns C<-1>, and sets the error in the "
39473 "handle in the usual way (see L</guestfs_last_error> etc.)"
39477 #: ../src/guestfs.pod:1926
39479 "Callbacks remain in effect until they are deleted, or until the handle is "
39484 #: ../src/guestfs.pod:1929
39486 "In the case where multiple callbacks are registered for a particular event "
39487 "class, all of the callbacks are called. The order in which multiple "
39488 "callbacks are called is not defined."
39492 #: ../src/guestfs.pod:1933
39493 msgid "guestfs_delete_event_callback"
39497 #: ../src/guestfs.pod:1935
39500 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
39505 #: ../src/guestfs.pod:1937
39507 "Delete a callback that was previously registered. C<event_handle> should be "
39508 "the integer that was returned by a previous call to "
39509 "C<guestfs_set_event_callback> on the same handle."
39513 #: ../src/guestfs.pod:1941
39514 msgid "guestfs_event_callback"
39518 #: ../src/guestfs.pod:1943
39521 " typedef void (*guestfs_event_callback) (\n"
39524 " uint64_t event,\n"
39525 " int event_handle,\n"
39527 " const char *buf, size_t buf_len,\n"
39528 " const uint64_t *array, size_t array_len);\n"
39533 #: ../src/guestfs.pod:1952
39535 "This is the type of the event callback function that you have to provide."
39539 #: ../src/guestfs.pod:1955
39541 "The basic parameters are: the handle (C<g>), the opaque user pointer "
39542 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
39543 "handle, and C<flags> which in the current API you should ignore."
39547 #: ../src/guestfs.pod:1959
39549 "The remaining parameters contain the event payload (if any). Each event may "
39550 "contain a payload, which usually relates to the event class, but for future "
39551 "proofing your code should be written to handle any payload for any event "
39556 #: ../src/guestfs.pod:1964
39558 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
39559 "there is no message buffer). Note that this message buffer can contain "
39560 "arbitrary 8 bit data, including NUL bytes."
39564 #: ../src/guestfs.pod:1968
39566 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
39567 "moment this is only used for progress messages."
39571 #: ../src/guestfs.pod:1971
39572 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
39576 #: ../src/guestfs.pod:1973
39578 "One motivation for the generic event API was to allow GUI programs to "
39579 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
39580 "unconditionally to C<stderr>."
39584 #: ../src/guestfs.pod:1977
39586 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
39587 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
39588 "messages are not events; you must capture error messages separately)."
39592 #: ../src/guestfs.pod:1982
39594 "Programs have to set up a callback to capture the classes of events of "
39599 #: ../src/guestfs.pod:1985
39603 " guestfs_set_event_callback\n"
39604 " (g, message_callback,\n"
39605 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
39606 " GUESTFS_EVENT_TRACE,\n"
39607 " 0, NULL) == -1)\n"
39608 " if (eh == -1) {\n"
39609 " // handle error in the usual way\n"
39615 #: ../src/guestfs.pod:1995
39617 "The callback can then direct messages to the appropriate place. In this "
39618 "example, messages are directed to syslog:"
39622 #: ../src/guestfs.pod:1998
39626 " message_callback (\n"
39629 " uint64_t event,\n"
39630 " int event_handle,\n"
39632 " const char *buf, size_t buf_len,\n"
39633 " const uint64_t *array, size_t array_len)\n"
39635 " const int priority = LOG_USER|LOG_INFO;\n"
39636 " if (buf_len > 0)\n"
39637 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
39643 #: ../src/guestfs.pod:2013
39644 msgid "CANCELLING LONG TRANSFERS"
39648 #: ../src/guestfs.pod:2015
39650 "Some operations can be cancelled by the caller while they are in progress. "
39651 "Currently only operations that involve uploading or downloading data can be "
39652 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
39653 "parameters in the generator)."
39657 #: ../src/guestfs.pod:2020
39658 msgid "guestfs_user_cancel"
39662 #: ../src/guestfs.pod:2022
39665 " void guestfs_user_cancel (guestfs_h *g);\n"
39670 #: ../src/guestfs.pod:2024
39672 "C<guestfs_user_cancel> cancels the current upload or download operation."
39676 #: ../src/guestfs.pod:2027
39678 "Unlike most other libguestfs calls, this function is signal safe and thread "
39679 "safe. You can call it from a signal handler or from another thread, without "
39680 "needing to do any locking."
39684 #: ../src/guestfs.pod:2031
39686 "The transfer that was in progress (if there is one) will stop shortly "
39687 "afterwards, and will return an error. The errno (see L</"
39688 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
39689 "out if the operation was cancelled or failed because of another error."
39693 #: ../src/guestfs.pod:2037
39695 "No cleanup is performed: for example, if a file was being uploaded then "
39696 "after cancellation there may be a partially uploaded file. It is the "
39697 "caller's responsibility to clean up if necessary."
39701 #: ../src/guestfs.pod:2041
39702 msgid "There are two common places that you might call C<guestfs_user_cancel>."
39706 #: ../src/guestfs.pod:2043
39708 "In an interactive text-based program, you might call it from a C<SIGINT> "
39709 "signal handler so that pressing C<^C> cancels the current operation. (You "
39710 "also need to call L</guestfs_set_pgroup> so that child processes don't "
39711 "receive the C<^C> signal)."
39715 #: ../src/guestfs.pod:2048
39717 "In a graphical program, when the main thread is displaying a progress bar "
39718 "with a cancel button, wire up the cancel button to call this function."
39722 #: ../src/guestfs.pod:2052
39723 msgid "PRIVATE DATA AREA"
39727 #: ../src/guestfs.pod:2054
39729 "You can attach named pieces of private data to the libguestfs handle, fetch "
39730 "them by name, and walk over them, for the lifetime of the handle. This is "
39731 "called the private data area and is only available from the C API."
39735 #: ../src/guestfs.pod:2059
39736 msgid "To attach a named piece of data, use the following call:"
39740 #: ../src/guestfs.pod:2061
39743 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
39748 #: ../src/guestfs.pod:2063
39750 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
39751 "pointer (which can be C<NULL>). Any previous item with the same key is "
39756 #: ../src/guestfs.pod:2067
39758 "You can use any C<key> you want, but your key should I<not> start with an "
39759 "underscore character. Keys beginning with an underscore character are "
39760 "reserved for internal libguestfs purposes (eg. for implementing language "
39761 "bindings). It is recommended that you prefix the key with some unique "
39762 "string to avoid collisions with other users."
39766 #: ../src/guestfs.pod:2073
39767 msgid "To retrieve the pointer, use:"
39771 #: ../src/guestfs.pod:2075
39774 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
39779 #: ../src/guestfs.pod:2077
39781 "This function returns C<NULL> if either no data is found associated with "
39782 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
39787 #: ../src/guestfs.pod:2081
39789 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
39790 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
39791 "all. In particular, libguestfs does I<not> try to free the data when the "
39792 "handle is closed. If the data must be freed, then the caller must either "
39793 "free it before calling L</guestfs_close> or must set up a close callback to "
39794 "do it (see L</GUESTFS_EVENT_CLOSE>)."
39798 #: ../src/guestfs.pod:2088
39799 msgid "To walk over all entries, use these two functions:"
39803 #: ../src/guestfs.pod:2090
39806 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
39811 #: ../src/guestfs.pod:2092
39814 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
39819 #: ../src/guestfs.pod:2094
39821 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
39822 "not have any particular meaning -- keys are not returned in any defined "
39823 "order). A pointer to the key is returned in C<*key_rtn> and the "
39824 "corresponding data pointer is returned from the function. C<NULL> is "
39825 "returned if there are no keys stored in the handle."
39829 #: ../src/guestfs.pod:2100
39831 "C<guestfs_next_private> returns the next key, pointer pair. The return "
39832 "value of this function is also C<NULL> is there are no further entries to "
39837 #: ../src/guestfs.pod:2104
39838 msgid "Notes about walking over entries:"
39842 #: ../src/guestfs.pod:2110
39844 "You must not call C<guestfs_set_private> while walking over the entries."
39848 #: ../src/guestfs.pod:2115
39850 "The handle maintains an internal iterator which is reset when you call "
39851 "C<guestfs_first_private>. This internal iterator is invalidated when you "
39852 "call C<guestfs_set_private>."
39856 #: ../src/guestfs.pod:2121
39857 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
39861 #: ../src/guestfs.pod:2123
39864 " guestfs_set_private (g, key, NULL);\n"
39869 #: ../src/guestfs.pod:2125
39870 msgid "then that C<key> is not returned when walking."
39874 #: ../src/guestfs.pod:2129
39876 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
39877 "C<guestfs_next_private> or C<guestfs_set_private>."
39881 #: ../src/guestfs.pod:2135
39883 "The following example code shows how to print all keys and data pointers "
39884 "that are associated with the handle C<g>:"
39888 #: ../src/guestfs.pod:2138
39891 " const char *key;\n"
39892 " void *data = guestfs_first_private (g, &key);\n"
39893 " while (data != NULL)\n"
39895 " printf (\"key = %s, data = %p\\n\", key, data);\n"
39896 " data = guestfs_next_private (g, &key);\n"
39902 #: ../src/guestfs.pod:2146
39904 "More commonly you are only interested in keys that begin with an application-"
39905 "specific prefix C<foo_>. Modify the loop like so:"
39909 #: ../src/guestfs.pod:2149
39912 " const char *key;\n"
39913 " void *data = guestfs_first_private (g, &key);\n"
39914 " while (data != NULL)\n"
39916 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
39917 " printf (\"key = %s, data = %p\\n\", key, data);\n"
39918 " data = guestfs_next_private (g, &key);\n"
39924 #: ../src/guestfs.pod:2158
39926 "If you need to modify keys while walking, then you have to jump back to the "
39927 "beginning of the loop. For example, to delete all keys prefixed with "
39932 #: ../src/guestfs.pod:2162
39935 " const char *key;\n"
39938 " data = guestfs_first_private (g, &key);\n"
39939 " while (data != NULL)\n"
39941 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
39943 " guestfs_set_private (g, key, NULL);\n"
39944 " /* note that 'key' pointer is now invalid, and so is\n"
39945 " the internal iterator */\n"
39948 " data = guestfs_next_private (g, &key);\n"
39954 #: ../src/guestfs.pod:2178
39956 "Note that the above loop is guaranteed to terminate because the keys are "
39957 "being deleted, but other manipulations of keys within the loop might not "
39958 "terminate unless you also maintain an indication of which keys have been "
39963 #: ../src/guestfs.pod:2183
39968 #: ../src/guestfs.pod:2185
39970 "The libguestfs C library can be probed using systemtap or DTrace. This is "
39971 "true of any library, not just libguestfs. However libguestfs also contains "
39972 "static markers to help in probing internal operations."
39976 #: ../src/guestfs.pod:2189
39977 msgid "You can list all the static markers by doing:"
39981 #: ../src/guestfs.pod:2191
39984 " stap -l 'process(\"/usr/lib*/libguestfs.so.0\")\n"
39985 " .provider(\"guestfs\").mark(\"*\")'\n"
39990 #: ../src/guestfs.pod:2194
39992 "B<Note:> These static markers are I<not> part of the stable API and may "
39993 "change in future versions."
39997 #: ../src/guestfs.pod:2197
39998 msgid "SYSTEMTAP SCRIPT EXAMPLE"
40002 #: ../src/guestfs.pod:2199
40004 "This script contains examples of displaying both the static markers and some "
40005 "ordinary C entry points:"
40009 #: ../src/guestfs.pod:2202
40017 #: ../src/guestfs.pod:2204
40020 " function display_time () {\n"
40021 " now = gettimeofday_us ();\n"
40024 " delta = now - last;\n"
40030 #: ../src/guestfs.pod:2211
40033 " printf (\"%d (+%d):\", now, delta);\n"
40039 #: ../src/guestfs.pod:2214
40044 " printf (\"ready\\n\");\n"
40050 #: ../src/guestfs.pod:2219
40053 " /* Display all calls to static markers. */\n"
40054 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
40055 " .provider(\"guestfs\").mark(\"*\") ? {\n"
40056 " display_time();\n"
40057 " printf (\"\\t%s %s\\n\", $$name, $$parms);\n"
40063 #: ../src/guestfs.pod:2226
40066 " /* Display all calls to guestfs_mkfs* functions. */\n"
40067 " probe process(\"/usr/lib*/libguestfs.so.0\")\n"
40068 " .function(\"guestfs_mkfs*\") ? {\n"
40069 " display_time();\n"
40070 " printf (\"\\t%s %s\\n\", probefunc(), $$parms);\n"
40076 #: ../src/guestfs.pod:2233
40078 "The script above can be saved to C<test.stap> and run using the L<stap(1)> "
40079 "program. Note that you either have to be root, or you have to add yourself "
40080 "to several special stap groups. Consult the systemtap documentation for "
40081 "more information."
40085 #: ../src/guestfs.pod:2238
40088 " # stap /tmp/test.stap\n"
40094 #: ../src/guestfs.pod:2241
40095 msgid "In another terminal, run a guestfish command such as this:"
40099 #: ../src/guestfs.pod:2245
40100 msgid "In the first terminal, stap trace output similar to this is shown:"
40104 #: ../src/guestfs.pod:2247
40107 " 1318248056692655 (+0):\tlaunch_start\n"
40108 " 1318248056692850 (+195): launch_build_appliance_start\n"
40109 " 1318248056818285 (+125435): launch_build_appliance_end\n"
40110 " 1318248056838059 (+19774): launch_run_qemu\n"
40111 " 1318248061071167 (+4233108): launch_end\n"
40112 " 1318248061280324 (+209157): guestfs_mkfs g=0x1024ab0 fstype=0x46116f device=0x1024e60\n"
40117 #: ../src/guestfs.pod:2254 ../src/guestfs.pod:2259
40122 #: ../src/guestfs.pod:2256
40124 "<!-- old anchor for the next section --> <a name="
40125 "\"state_machine_and_low_level_event_api\"/>"
40129 #: ../src/guestfs.pod:2261
40130 msgid "ARCHITECTURE"
40134 #: ../src/guestfs.pod:2263
40136 "Internally, libguestfs is implemented by running an appliance (a special "
40137 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
40138 "process of the main program."
40142 #: ../src/guestfs.pod:2267
40145 " ___________________\n"
40147 " | main program |\n"
40149 " | | child process / appliance\n"
40150 " | | __________________________\n"
40152 " +-------------------+ RPC | +-----------------+ |\n"
40153 " | libguestfs <--------------------> guestfsd | |\n"
40154 " | | | +-----------------+ |\n"
40155 " \\___________________/ | | Linux kernel | |\n"
40156 " | +--^--------------+ |\n"
40157 " \\_________|________________/\n"
40159 " _______v______\n"
40162 " | disk image |\n"
40163 " \\______________/\n"
40168 #: ../src/guestfs.pod:2287
40170 "The library, linked to the main program, creates the child process and hence "
40171 "the appliance in the L</guestfs_launch> function."
40175 #: ../src/guestfs.pod:2290
40177 "Inside the appliance is a Linux kernel and a complete stack of userspace "
40178 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
40179 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
40180 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
40181 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
40182 "attached to the qemu process which translates device access by the "
40183 "appliance's Linux kernel into accesses to the image."
40187 #: ../src/guestfs.pod:2299
40189 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
40190 "Although the disk image you are attached to might also be used by some "
40191 "virtual machine, libguestfs doesn't know or care about this. (But you will "
40192 "care if both libguestfs's qemu process and your virtual machine are trying "
40193 "to update the disk image at the same time, since these usually results in "
40194 "massive disk corruption)."
40198 #: ../src/guestfs.pod:2306
40199 msgid "STATE MACHINE"
40203 #: ../src/guestfs.pod:2308
40204 msgid "libguestfs uses a state machine to model the child process:"
40208 #: ../src/guestfs.pod:2310
40212 " guestfs_create\n"
40220 " / | \\ \\ guestfs_launch\n"
40221 " / | _\\__V______\n"
40223 " / | | LAUNCHING |\n"
40224 " / | \\___________/\n"
40226 " / | guestfs_launch\n"
40228 " ______ / __|____V\n"
40229 " / \\ ------> / \\\n"
40230 " | BUSY | | READY |\n"
40231 " \\______/ <------ \\________/\n"
40236 #: ../src/guestfs.pod:2332
40238 "The normal transitions are (1) CONFIG (when the handle is created, but there "
40239 "is no child process), (2) LAUNCHING (when the child process is booting up), "
40240 "(3) alternating between READY and BUSY as commands are issued to, and "
40241 "carried out by, the child process."
40245 #: ../src/guestfs.pod:2337
40247 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
40248 "asynchronously at any time (eg. due to some internal error), and that causes "
40249 "the state to transition back to CONFIG."
40253 #: ../src/guestfs.pod:2341
40255 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
40256 "issued when in the CONFIG state."
40260 #: ../src/guestfs.pod:2344
40262 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
40263 "L</guestfs_launch> blocks until the child process is READY to accept "
40264 "commands (or until some failure or timeout). L</guestfs_launch> internally "
40265 "moves the state from CONFIG to LAUNCHING while it is running."
40269 #: ../src/guestfs.pod:2350
40271 "API actions such as L</guestfs_mount> can only be issued when in the READY "
40272 "state. These API calls block waiting for the command to be carried out (ie. "
40273 "the state to transition to BUSY and then back to READY). There are no non-"
40274 "blocking versions, and no way to issue more than one command per handle at "
40279 #: ../src/guestfs.pod:2356
40281 "Finally, the child process sends asynchronous messages back to the main "
40282 "program, such as kernel log messages. You can register a callback to "
40283 "receive these messages."
40287 #: ../src/guestfs.pod:2360
40292 #: ../src/guestfs.pod:2362
40293 msgid "APPLIANCE BOOT PROCESS"
40297 #: ../src/guestfs.pod:2364
40299 "This process has evolved and continues to evolve. The description here "
40300 "corresponds only to the current version of libguestfs and is provided for "
40301 "information only."
40305 #: ../src/guestfs.pod:2368
40307 "In order to follow the stages involved below, enable libguestfs debugging "
40308 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
40312 #: ../src/guestfs.pod:2373
40313 msgid "Create the appliance"
40317 #: ../src/guestfs.pod:2375
40319 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
40320 "initrd and the appliance."
40324 #: ../src/guestfs.pod:2378
40326 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
40327 "directory if C<TMPDIR> is set)."
40331 #: ../src/guestfs.pod:2381
40333 "For a complete description of how the appliance is created and cached, read "
40334 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
40338 #: ../src/guestfs.pod:2385
40339 msgid "Start qemu and boot the kernel"
40343 #: ../src/guestfs.pod:2387
40344 msgid "qemu is invoked to boot the kernel."
40348 #: ../src/guestfs.pod:2389
40349 msgid "Run the initrd"
40353 #: ../src/guestfs.pod:2391
40355 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
40356 "appliance. The purpose of the initrd is to load enough kernel modules in "
40357 "order that the appliance itself can be mounted and started."
40361 #: ../src/guestfs.pod:2395
40363 "The initrd is a cpio archive called C</var/tmp/.guestfs-E<lt>UIDE<gt>/"
40368 #: ../src/guestfs.pod:2398
40370 "When the initrd has started you will see messages showing that kernel "
40371 "modules are being loaded, similar to this:"
40375 #: ../src/guestfs.pod:2401
40378 " febootstrap: ext2 mini initrd starting up\n"
40379 " febootstrap: mounting /sys\n"
40380 " febootstrap: internal insmod libcrc32c.ko\n"
40381 " febootstrap: internal insmod crc32c-intel.ko\n"
40386 #: ../src/guestfs.pod:2406
40387 msgid "Find and mount the appliance device"
40391 #: ../src/guestfs.pod:2408
40393 "The appliance is a sparse file containing an ext2 filesystem which contains "
40394 "a familiar (although reduced in size) Linux operating system. It would "
40395 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
40399 #: ../src/guestfs.pod:2412
40401 "The regular disks being inspected by libguestfs are the first devices "
40402 "exposed by qemu (eg. as C</dev/vda>)."
40406 #: ../src/guestfs.pod:2415
40408 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
40409 "there was only one regular disk)."
40413 #: ../src/guestfs.pod:2418
40415 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
40416 "and switch root into the appliance, and run C</init> from the appliance."
40420 #: ../src/guestfs.pod:2422
40421 msgid "If this works successfully you will see messages such as:"
40425 #: ../src/guestfs.pod:2424
40428 " febootstrap: picked /sys/block/vdb/dev as root device\n"
40429 " febootstrap: creating /dev/root as block special 252:16\n"
40430 " febootstrap: mounting new root on /root\n"
40431 " febootstrap: chroot\n"
40432 " Starting /init script ...\n"
40437 #: ../src/guestfs.pod:2430
40439 "Note that C<Starting /init script ...> indicates that the appliance's init "
40440 "script is now running."
40444 #: ../src/guestfs.pod:2433
40445 msgid "Initialize the appliance"
40449 #: ../src/guestfs.pod:2435
40451 "The appliance itself now initializes itself. This involves starting certain "
40452 "processes like C<udev>, possibly printing some debug information, and "
40453 "finally running the daemon (C<guestfsd>)."
40457 #: ../src/guestfs.pod:2439
40462 #: ../src/guestfs.pod:2441
40464 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
40469 #: ../src/guestfs.pod:2444
40472 " verbose daemon enabled\n"
40477 #: ../src/guestfs.pod:2446
40479 "The daemon expects to see a named virtio-serial port exposed by qemu and "
40480 "connected on the other end to the library."
40484 #: ../src/guestfs.pod:2449
40486 "The daemon connects to this port (and hence to the library) and sends a four "
40487 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
40488 "protocol (see below)."
40492 #: ../src/guestfs.pod:2455
40493 msgid "COMMUNICATION PROTOCOL"
40497 #: ../src/guestfs.pod:2457
40499 "Don't rely on using this protocol directly. This section documents how it "
40500 "currently works, but it may change at any time."
40504 #: ../src/guestfs.pod:2460
40506 "The protocol used to talk between the library and the daemon running inside "
40507 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
40508 "1014, RFC 1832, RFC 4506)."
40512 #: ../src/guestfs.pod:2464
40514 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
40515 "this file is automatically generated)."
40519 #: ../src/guestfs.pod:2467
40521 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
40522 "and C<FileOut> parameters, which are handled with very simple request/reply "
40523 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
40524 "parameters, which use the same request and reply messages, but they may also "
40525 "be followed by files sent using a chunked encoding."
40529 #: ../src/guestfs.pod:2474
40530 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
40534 #: ../src/guestfs.pod:2476
40535 msgid "For ordinary functions, the request message is:"
40539 #: ../src/guestfs.pod:2478
40542 " total length (header + arguments,\n"
40543 " but not including the length word itself)\n"
40544 " struct guestfs_message_header (encoded as XDR)\n"
40545 " struct guestfs_<foo>_args (encoded as XDR)\n"
40550 #: ../src/guestfs.pod:2483
40552 "The total length field allows the daemon to allocate a fixed size buffer "
40553 "into which it slurps the rest of the message. As a result, the total length "
40554 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
40555 "effective size of any request is limited to somewhere under this size."
40559 #: ../src/guestfs.pod:2489
40561 "Note also that many functions don't take any arguments, in which case the "
40562 "C<guestfs_I<foo>_args> is completely omitted."
40566 #: ../src/guestfs.pod:2492
40568 "The header contains the procedure number (C<guestfs_proc>) which is how the "
40569 "receiver knows what type of args structure to expect, or none at all."
40573 #: ../src/guestfs.pod:2496
40575 "For functions that take optional arguments, the optional arguments are "
40576 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
40577 "arguments. A bitmask in the header indicates which optional arguments are "
40578 "meaningful. The bitmask is also checked to see if it contains bits set "
40579 "which the daemon does not know about (eg. if more optional arguments were "
40580 "added in a later version of the library), and this causes the call to be "
40585 #: ../src/guestfs.pod:2504
40586 msgid "The reply message for ordinary functions is:"
40590 #: ../src/guestfs.pod:2506
40593 " total length (header + ret,\n"
40594 " but not including the length word itself)\n"
40595 " struct guestfs_message_header (encoded as XDR)\n"
40596 " struct guestfs_<foo>_ret (encoded as XDR)\n"
40601 #: ../src/guestfs.pod:2511
40603 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
40604 "functions that return no formal return values."
40608 #: ../src/guestfs.pod:2514
40610 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
40614 #: ../src/guestfs.pod:2517
40616 "In the case of an error, a flag is set in the header, and the reply message "
40617 "is slightly changed:"
40621 #: ../src/guestfs.pod:2520
40624 " total length (header + error,\n"
40625 " but not including the length word itself)\n"
40626 " struct guestfs_message_header (encoded as XDR)\n"
40627 " struct guestfs_message_error (encoded as XDR)\n"
40632 #: ../src/guestfs.pod:2525
40634 "The C<guestfs_message_error> structure contains the error message as a "
40639 #: ../src/guestfs.pod:2528
40640 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
40644 #: ../src/guestfs.pod:2530
40646 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
40647 "The normal request message is sent (see above). However this is followed by "
40648 "a sequence of file chunks."
40652 #: ../src/guestfs.pod:2534
40655 " total length (header + arguments,\n"
40656 " but not including the length word itself,\n"
40657 " and not including the chunks)\n"
40658 " struct guestfs_message_header (encoded as XDR)\n"
40659 " struct guestfs_<foo>_args (encoded as XDR)\n"
40660 " sequence of chunks for FileIn param #0\n"
40661 " sequence of chunks for FileIn param #1 etc.\n"
40666 #: ../src/guestfs.pod:2542
40667 msgid "The \"sequence of chunks\" is:"
40671 #: ../src/guestfs.pod:2544
40674 " length of chunk (not including length word itself)\n"
40675 " struct guestfs_chunk (encoded as XDR)\n"
40676 " length of chunk\n"
40677 " struct guestfs_chunk (encoded as XDR)\n"
40679 " length of chunk\n"
40680 " struct guestfs_chunk (with data.data_len == 0)\n"
40685 #: ../src/guestfs.pod:2552
40687 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
40688 "is set in the final chunk to indicate either successful completion or early "
40693 #: ../src/guestfs.pod:2556
40695 "At time of writing there are no functions that have more than one FileIn "
40696 "parameter. However this is (theoretically) supported, by sending the "
40697 "sequence of chunks for each FileIn parameter one after another (from left to "
40702 #: ../src/guestfs.pod:2561
40704 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
40705 "transfer. The library does this by sending a chunk with a special flag set "
40706 "to indicate cancellation. When the daemon sees this, it cancels the whole "
40707 "RPC, does I<not> send any reply, and goes back to reading the next request."
40711 #: ../src/guestfs.pod:2567
40713 "The daemon may also cancel. It does this by writing a special word "
40714 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
40715 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
40716 "cancel chunk). The special word is chosen so that even if cancellation "
40717 "happens right at the end of the transfer (after the library has finished "
40718 "writing and has started listening for the reply), the \"spurious\" cancel "
40719 "flag will not be confused with the reply message."
40723 #: ../src/guestfs.pod:2576
40725 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
40726 "limit), and also files where the size is not known in advance (eg. from "
40727 "pipes or sockets). However the chunks are rather small "
40728 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
40729 "to keep much in memory."
40733 #: ../src/guestfs.pod:2582
40734 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
40738 #: ../src/guestfs.pod:2584
40740 "The protocol for FileOut parameters is exactly the same as for FileIn "
40741 "parameters, but with the roles of daemon and library reversed."
40745 #: ../src/guestfs.pod:2587
40748 " total length (header + ret,\n"
40749 " but not including the length word itself,\n"
40750 " and not including the chunks)\n"
40751 " struct guestfs_message_header (encoded as XDR)\n"
40752 " struct guestfs_<foo>_ret (encoded as XDR)\n"
40753 " sequence of chunks for FileOut param #0\n"
40754 " sequence of chunks for FileOut param #1 etc.\n"
40759 #: ../src/guestfs.pod:2595
40760 msgid "INITIAL MESSAGE"
40764 #: ../src/guestfs.pod:2597
40766 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
40767 "which indicates that the guest and daemon is alive. This is what L</"
40768 "guestfs_launch> waits for."
40772 #: ../src/guestfs.pod:2601
40773 msgid "PROGRESS NOTIFICATION MESSAGES"
40777 #: ../src/guestfs.pod:2603
40779 "The daemon may send progress notification messages at any time. These are "
40780 "distinguished by the normal length word being replaced by "
40781 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
40785 #: ../src/guestfs.pod:2607
40787 "The library turns them into progress callbacks (see L</"
40788 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
40793 #: ../src/guestfs.pod:2611
40795 "The daemon self-limits the frequency of progress messages it sends (see "
40796 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
40801 #: ../src/guestfs.pod:2615
40802 msgid "LIBGUESTFS VERSION NUMBERS"
40806 #: ../src/guestfs.pod:2617
40808 "Since April 2010, libguestfs has started to make separate development and "
40809 "stable releases, along with corresponding branches in our git repository. "
40810 "These separate releases can be identified by version number:"
40814 #: ../src/guestfs.pod:2622
40817 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
40818 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
40824 " | `-------- sub-version\n"
40826 " `------ always '1' because we don't change the ABI\n"
40831 #: ../src/guestfs.pod:2633
40832 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
40836 #: ../src/guestfs.pod:2635
40838 "As time passes we cherry pick fixes from the development branch and backport "
40839 "those into the stable branch, the effect being that the stable branch should "
40840 "get more stable and less buggy over time. So the stable releases are ideal "
40841 "for people who don't need new features but would just like the software to "
40846 #: ../src/guestfs.pod:2641
40847 msgid "Our criteria for backporting changes are:"
40851 #: ../src/guestfs.pod:2647
40853 "Documentation changes which don't affect any code are backported unless the "
40854 "documentation refers to a future feature which is not in stable."
40858 #: ../src/guestfs.pod:2653
40860 "Bug fixes which are not controversial, fix obvious problems, and have been "
40861 "well tested are backported."
40865 #: ../src/guestfs.pod:2658
40867 "Simple rearrangements of code which shouldn't affect how it works get "
40868 "backported. This is so that the code in the two branches doesn't get too "
40869 "far out of step, allowing us to backport future fixes more easily."
40873 #: ../src/guestfs.pod:2664
40875 "We I<don't> backport new features, new APIs, new tools etc, except in one "
40876 "exceptional case: the new feature is required in order to implement an "
40877 "important bug fix."
40881 #: ../src/guestfs.pod:2670
40883 "A new stable branch starts when we think the new features in development are "
40884 "substantial and compelling enough over the current stable branch to warrant "
40885 "it. When that happens we create new stable and development versions 1.N.0 "
40886 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
40887 "stable at this point, but by backporting fixes from development, that branch "
40888 "will stabilize over time."
40892 #: ../src/guestfs.pod:2678
40893 msgid "EXTENDING LIBGUESTFS"
40897 #: ../src/guestfs.pod:2680
40898 msgid "ADDING A NEW API ACTION"
40902 #: ../src/guestfs.pod:2682
40904 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
40905 "documentation) are generated, and this makes it easy to extend the "
40910 #: ../src/guestfs.pod:2686
40911 msgid "To add a new API action there are two changes:"
40915 #: ../src/guestfs.pod:2692
40917 "You need to add a description of the call (name, parameters, return type, "
40918 "tests, documentation) to C<generator/generator_actions.ml>."
40922 #: ../src/guestfs.pod:2695
40924 "There are two sorts of API action, depending on whether the call goes "
40925 "through to the daemon in the appliance, or is serviced entirely by the "
40926 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
40927 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
40928 "an example of the latter, since a trace flag is maintained in the handle and "
40929 "all tracing is done on the library side."
40933 #: ../src/guestfs.pod:2703
40935 "Most new actions are of the first type, and get added to the "
40936 "C<daemon_functions> list. Each function has a unique procedure number used "
40937 "in the RPC protocol which is assigned to that action when we publish "
40938 "libguestfs and cannot be reused. Take the latest procedure number and "
40943 #: ../src/guestfs.pod:2709
40945 "For library-only actions of the second type, add to the "
40946 "C<non_daemon_functions> list. Since these functions are serviced by the "
40947 "library and do not travel over the RPC mechanism to the daemon, these "
40948 "functions do not need a procedure number, and so the procedure number is set "
40953 #: ../src/guestfs.pod:2717
40954 msgid "Implement the action (in C):"
40958 #: ../src/guestfs.pod:2719
40960 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
40961 "C<daemon/> directory."
40965 #: ../src/guestfs.pod:2722
40967 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
40968 "(note: double underscore) in the C<src/> directory."
40972 #: ../src/guestfs.pod:2725
40973 msgid "In either case, use another function as an example of what to do."
40977 #: ../src/guestfs.pod:2729
40978 msgid "After making these changes, use C<make> to compile."
40982 #: ../src/guestfs.pod:2731
40984 "Note that you don't need to implement the RPC, language bindings, manual "
40985 "pages or anything else. It's all automatically generated from the OCaml "
40990 #: ../src/guestfs.pod:2735
40991 msgid "ADDING TESTS FOR AN API ACTION"
40995 #: ../src/guestfs.pod:2737
40997 "You can supply zero or as many tests as you want per API call. The tests "
40998 "can either be added as part of the API description (C<generator/"
40999 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
41000 "into C<regressions/>. Note that adding a script to C<regressions/> is "
41001 "slower, so if possible use the first method."
41005 #: ../src/guestfs.pod:2743
41007 "The following describes the test environment used when you add an API test "
41008 "in C<generator_actions.ml>."
41012 #: ../src/guestfs.pod:2746
41013 msgid "The test environment has 4 block devices:"
41017 #: ../src/guestfs.pod:2750
41018 msgid "C</dev/sda> 500MB"
41022 #: ../src/guestfs.pod:2752
41023 msgid "General block device for testing."
41027 #: ../src/guestfs.pod:2754
41028 msgid "C</dev/sdb> 50MB"
41032 #: ../src/guestfs.pod:2756
41034 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
41039 #: ../src/guestfs.pod:2759
41040 msgid "C</dev/sdc> 10MB"
41044 #: ../src/guestfs.pod:2761
41045 msgid "Used in a few tests where two block devices are needed."
41049 #: ../src/guestfs.pod:2763
41050 msgid "C</dev/sdd>"
41054 #: ../src/guestfs.pod:2765
41055 msgid "ISO with fixed content (see C<images/test.iso>)."
41059 #: ../src/guestfs.pod:2769
41061 "To be able to run the tests in a reasonable amount of time, the libguestfs "
41062 "appliance and block devices are reused between tests. So don't try testing "
41063 "L</guestfs_kill_subprocess> :-x"
41067 #: ../src/guestfs.pod:2773
41069 "Each test starts with an initial scenario, selected using one of the "
41070 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
41071 "initialize the disks mentioned above in a particular way as documented in "
41072 "C<generator_types.ml>. You should not assume anything about the previous "
41073 "contents of other disks that are not initialized."
41077 #: ../src/guestfs.pod:2779
41079 "You can add a prerequisite clause to any individual test. This is a run-"
41080 "time check, which, if it fails, causes the test to be skipped. Useful if "
41081 "testing a command which might not work on all variations of libguestfs "
41082 "builds. A test that has prerequisite of C<Always> means to run "
41087 #: ../src/guestfs.pod:2785
41089 "In addition, packagers can skip individual tests by setting environment "
41090 "variables before running C<make check>."
41094 #: ../src/guestfs.pod:2788
41097 " SKIP_TEST_<CMD>_<NUM>=1\n"
41102 #: ../src/guestfs.pod:2790
41103 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
41107 #: ../src/guestfs.pod:2794
41110 " SKIP_TEST_<CMD>=1\n"
41115 #: ../src/guestfs.pod:2796
41116 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
41120 #: ../src/guestfs.pod:2798
41121 msgid "Packagers can run only certain tests by setting for example:"
41125 #: ../src/guestfs.pod:2800
41128 " TEST_ONLY=\"vfs_type zerofree\"\n"
41133 #: ../src/guestfs.pod:2802
41135 "See C<capitests/tests.c> for more details of how these environment variables "
41140 #: ../src/guestfs.pod:2805
41141 msgid "DEBUGGING NEW API ACTIONS"
41145 #: ../src/guestfs.pod:2807
41146 msgid "Test new actions work before submitting them."
41150 #: ../src/guestfs.pod:2809
41151 msgid "You can use guestfish to try out new commands."
41155 #: ../src/guestfs.pod:2811
41157 "Debugging the daemon is a problem because it runs inside a minimal "
41158 "environment. However you can fprintf messages in the daemon to stderr, and "
41159 "they will show up if you use C<guestfish -v>."
41163 #: ../src/guestfs.pod:2815
41164 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
41168 #: ../src/guestfs.pod:2817
41170 "Our C source code generally adheres to some basic code-formatting "
41171 "conventions. The existing code base is not totally consistent on this "
41172 "front, but we do prefer that contributed code be formatted similarly. In "
41173 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
41174 "indentation level, and other than that, follow the K&R style."
41178 #: ../src/guestfs.pod:2823
41180 "If you use Emacs, add the following to one of one of your start-up files (e."
41181 "g., ~/.emacs), to help ensure that you get indentation right:"
41185 #: ../src/guestfs.pod:2826
41188 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
41189 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
41190 " (add-hook 'find-file-hook\n"
41191 " '(lambda () (if (and buffer-file-name\n"
41192 " (string-match \"/libguestfs\\\\>\"\n"
41193 " (buffer-file-name))\n"
41194 " (not (string-equal mode-name \"Change Log\"))\n"
41195 " (not (string-equal mode-name \"Makefile\")))\n"
41196 " (setq indent-tabs-mode nil))))\n"
41201 #: ../src/guestfs.pod:2836
41204 " ;;; When editing C sources in libguestfs, use this style.\n"
41205 " (defun libguestfs-c-mode ()\n"
41206 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
41208 " (c-set-style \"K&R\")\n"
41209 " (setq c-indent-level 2)\n"
41210 " (setq c-basic-offset 2))\n"
41211 " (add-hook 'c-mode-hook\n"
41212 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
41213 " (buffer-file-name))\n"
41214 " (libguestfs-c-mode))))\n"
41219 #: ../src/guestfs.pod:2848
41220 msgid "Enable warnings when compiling (and fix any problems this finds):"
41224 #: ../src/guestfs.pod:2851
41227 " ./configure --enable-gcc-warnings\n"
41232 #: ../src/guestfs.pod:2853
41233 msgid "Useful targets are:"
41237 #: ../src/guestfs.pod:2855
41240 " make syntax-check # checks the syntax of the C code\n"
41241 " make check # runs the test suite\n"
41246 #: ../src/guestfs.pod:2858
41247 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
41251 #: ../src/guestfs.pod:2860
41253 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
41254 "which are used to do shell quoting."
41258 #: ../src/guestfs.pod:2865
41263 #: ../src/guestfs.pod:2867
41265 "Simple shell quoted string. Any spaces or other shell characters are "
41270 #: ../src/guestfs.pod:2870
41275 #: ../src/guestfs.pod:2872
41277 "Same as C<%Q> except the string is treated as a path which is prefixed by "
41282 #: ../src/guestfs.pod:2879
41285 " asprintf (&cmd, \"cat %R\", path);\n"
41290 #: ../src/guestfs.pod:2881
41291 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
41295 #: ../src/guestfs.pod:2883
41297 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
41298 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
41299 "they are not passed via the shell (instead, straight to exec). You probably "
41300 "want to use the C<sysroot_path()> function however."
41304 #: ../src/guestfs.pod:2889
41305 msgid "SUBMITTING YOUR NEW API ACTIONS"
41309 #: ../src/guestfs.pod:2891
41311 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
41312 "libguestfs> and CC to L<rjones@redhat.com>."
41316 #: ../src/guestfs.pod:2895
41317 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
41321 #: ../src/guestfs.pod:2897
41322 msgid "We support i18n (gettext anyhow) in the library."
41326 #: ../src/guestfs.pod:2899
41328 "However many messages come from the daemon, and we don't translate those at "
41329 "the moment. One reason is that the appliance generally has all locale files "
41330 "removed from it, because they take up a lot of space. So we'd have to readd "
41331 "some of those, as well as copying our PO files into the appliance."
41335 #: ../src/guestfs.pod:2905
41337 "Debugging messages are never translated, since they are intended for the "
41342 #: ../src/guestfs.pod:2908
41343 msgid "SOURCE CODE SUBDIRECTORIES"
41347 #: ../src/guestfs.pod:2912
41352 #: ../src/guestfs.pod:2914
41353 msgid "L<virt-alignment-scan(1)> command and documentation."
41357 #: ../src/guestfs.pod:2918
41358 msgid "The libguestfs appliance, build scripts and so on."
41362 #: ../src/guestfs.pod:2920
41363 msgid "C<capitests>"
41367 #: ../src/guestfs.pod:2922
41368 msgid "Automated tests of the C API."
41372 #: ../src/guestfs.pod:2924
41377 #: ../src/guestfs.pod:2926
41379 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
41384 #: ../src/guestfs.pod:2929
41389 #: ../src/guestfs.pod:2931
41391 "Safety and liveness tests of components that libguestfs depends upon (not of "
41392 "libguestfs itself). Mainly this is for qemu and the kernel."
41396 #: ../src/guestfs.pod:2934
41401 #: ../src/guestfs.pod:2936
41403 "Tools for cloning virtual machines. Currently contains L<virt-sysprep(1)> "
41404 "command and documentation."
41408 #: ../src/guestfs.pod:2939
41413 #: ../src/guestfs.pod:2941
41414 msgid "Outside contributions, experimental parts."
41418 #: ../src/guestfs.pod:2943
41423 #: ../src/guestfs.pod:2945
41425 "The daemon that runs inside the libguestfs appliance and carries out actions."
41429 #: ../src/guestfs.pod:2948
41434 #: ../src/guestfs.pod:2950
41435 msgid "L<virt-df(1)> command and documentation."
41439 #: ../src/guestfs.pod:2952
41444 #: ../src/guestfs.pod:2954
41445 msgid "L<virt-edit(1)> command and documentation."
41449 #: ../src/guestfs.pod:2956
41450 msgid "C<examples>"
41454 #: ../src/guestfs.pod:2958
41455 msgid "C API example code."
41459 #: ../src/guestfs.pod:2960
41460 msgid "C<extratests>"
41464 #: ../src/guestfs.pod:2962
41466 "Extra tests. These are not run by default because they require special "
41467 "tools or configuration."
41471 #: ../src/guestfs.pod:2965
41476 #: ../src/guestfs.pod:2967
41478 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
41479 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
41480 "L<virt-tar-out(1)>."
41484 #: ../src/guestfs.pod:2971
41489 #: ../src/guestfs.pod:2973
41491 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
41495 #: ../src/guestfs.pod:2975
41496 msgid "C<generator>"
41500 #: ../src/guestfs.pod:2977
41502 "The crucially important generator, used to automatically generate large "
41503 "amounts of boilerplate C code for things like RPC and bindings."
41507 #: ../src/guestfs.pod:2980
41512 #: ../src/guestfs.pod:2982
41513 msgid "Files used by the test suite."
41517 #: ../src/guestfs.pod:2984
41518 msgid "Some \"phony\" guest images which we test against."
41522 #: ../src/guestfs.pod:2986
41523 msgid "C<inspector>"
41527 #: ../src/guestfs.pod:2988
41528 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
41532 #: ../src/guestfs.pod:2990
41537 #: ../src/guestfs.pod:2992
41538 msgid "Logo used on the website. The fish is called Arthur by the way."
41542 #: ../src/guestfs.pod:2994
41547 #: ../src/guestfs.pod:2996
41548 msgid "M4 macros used by autoconf."
41552 #: ../src/guestfs.pod:2998
41557 #: ../src/guestfs.pod:3000
41558 msgid "Translations of simple gettext strings."
41562 #: ../src/guestfs.pod:3002
41567 #: ../src/guestfs.pod:3004
41569 "The build infrastructure and PO files for translations of manpages and POD "
41570 "files. Eventually this will be combined with the C<po> directory, but that "
41571 "is rather complicated."
41575 #: ../src/guestfs.pod:3008
41576 msgid "C<regressions>"
41580 #: ../src/guestfs.pod:3010
41581 msgid "Regression tests."
41585 #: ../src/guestfs.pod:3012
41590 #: ../src/guestfs.pod:3014
41591 msgid "L<virt-rescue(1)> command and documentation."
41595 #: ../src/guestfs.pod:3016
41600 #: ../src/guestfs.pod:3018
41601 msgid "L<virt-resize(1)> command and documentation."
41605 #: ../src/guestfs.pod:3020
41606 msgid "C<sparsify>"
41610 #: ../src/guestfs.pod:3022
41611 msgid "L<virt-sparsify(1)> command and documentation."
41615 #: ../src/guestfs.pod:3024
41620 #: ../src/guestfs.pod:3026
41621 msgid "Source code to the C library."
41625 #: ../src/guestfs.pod:3028
41630 #: ../src/guestfs.pod:3030
41632 "Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
41636 #: ../src/guestfs.pod:3032
41637 msgid "C<test-tool>"
41641 #: ../src/guestfs.pod:3034
41643 "Test tool for end users to test if their qemu/kernel combination will work "
41648 #: ../src/guestfs.pod:3037
41653 #: ../src/guestfs.pod:3039
41658 #: ../src/guestfs.pod:3041
41663 #: ../src/guestfs.pod:3043
41668 #: ../src/guestfs.pod:3045
41673 #: ../src/guestfs.pod:3047
41678 #: ../src/guestfs.pod:3049
41683 #: ../src/guestfs.pod:3051
41688 #: ../src/guestfs.pod:3053
41693 #: ../src/guestfs.pod:3055
41694 msgid "Language bindings."
41698 #: ../src/guestfs.pod:3059
41699 msgid "MAKING A STABLE RELEASE"
41703 #: ../src/guestfs.pod:3061
41705 "When we make a stable release, there are several steps documented here. See "
41706 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
41711 #: ../src/guestfs.pod:3069
41713 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
41717 #: ../src/guestfs.pod:3074
41718 msgid "Finalize RELEASE-NOTES."
41722 #: ../src/guestfs.pod:3078
41723 msgid "Update ROADMAP."
41727 #: ../src/guestfs.pod:3082
41728 msgid "Run C<src/api-support/update-from-tarballs.sh>."
41732 #: ../src/guestfs.pod:3086
41733 msgid "Push and pull from Transifex."
41737 #: ../src/guestfs.pod:3090
41745 #: ../src/guestfs.pod:3092
41746 msgid "to push the latest POT files to Transifex. Then run:"
41750 #: ../src/guestfs.pod:3094
41758 #: ../src/guestfs.pod:3096
41759 msgid "which is a wrapper to pull the latest translated C<*.po> files."
41763 #: ../src/guestfs.pod:3100
41765 "Create new stable and development directories under L<http://libguestfs.org/"
41770 #: ../src/guestfs.pod:3105
41771 msgid "Create the branch in git:"
41775 #: ../src/guestfs.pod:3107
41778 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
41779 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
41780 " git branch stable-1.XX\n"
41781 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
41786 #: ../src/guestfs.pod:3114
41791 #: ../src/guestfs.pod:3116
41792 msgid "PROTOCOL LIMITS"
41796 #: ../src/guestfs.pod:3118
41798 "Internally libguestfs uses a message-based protocol to pass API calls and "
41799 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
41800 "plenty more detail about this). The maximum message size used by the "
41801 "protocol is slightly less than 4 MB. For some API calls you may need to be "
41802 "aware of this limit. The API calls which may be affected are individually "
41803 "documented, with a link back to this section of the documentation."
41807 #: ../src/guestfs.pod:3126
41809 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
41810 "a simple string. Because this string is at some point internally encoded as "
41811 "a message, the maximum size that it can return is slightly under 4 MB. If "
41812 "the requested file is larger than this then you will get an error."
41816 #: ../src/guestfs.pod:3132
41818 "In order to transfer large files into and out of the guest filesystem, you "
41819 "need to use particular calls that support this. The sections L</UPLOADING> "
41820 "and L</DOWNLOADING> document how to do this."
41824 #: ../src/guestfs.pod:3136
41826 "You might also consider mounting the disk image using our FUSE filesystem "
41827 "support (L<guestmount(1)>)."
41831 #: ../src/guestfs.pod:3139
41832 msgid "MAXIMUM NUMBER OF DISKS"
41836 #: ../src/guestfs.pod:3141
41837 msgid "When using virtio disks (the default) the current limit is B<25> disks."
41841 #: ../src/guestfs.pod:3144
41843 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
41844 "slots. However febootstrap only understands disks with names C</dev/vda> "
41845 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
41850 #: ../src/guestfs.pod:3149
41852 "We are working to substantially raise this limit in future versions but it "
41853 "requires complex changes to qemu."
41857 #: ../src/guestfs.pod:3152
41859 "In future versions of libguestfs it should also be possible to \"hot plug\" "
41860 "disks (add and remove disks after calling L</guestfs_launch>). This also "
41861 "requires changes to qemu."
41865 #: ../src/guestfs.pod:3156
41866 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
41870 #: ../src/guestfs.pod:3158
41871 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
41875 #: ../src/guestfs.pod:3160
41877 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
41878 "vda>, and C</dev/vda1> through C</dev/vda15>)."
41882 #: ../src/guestfs.pod:3163
41884 "If you attach a disk with more than 15 partitions, the extra partitions are "
41885 "ignored by libguestfs."
41889 #: ../src/guestfs.pod:3166
41890 msgid "MAXIMUM SIZE OF A DISK"
41894 #: ../src/guestfs.pod:3168
41895 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
41899 #: ../src/guestfs.pod:3170
41901 "We have tested block devices up to 1 exabyte (2**60 or "
41902 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
41907 #: ../src/guestfs.pod:3174
41909 "Although libguestfs probably does not impose any limit, the underlying host "
41910 "storage will. If you store disk images on a host ext4 filesystem, then the "
41911 "maximum size will be limited by the maximum ext4 file size (currently 16 "
41912 "TB). If you store disk images as host logical volumes then you are limited "
41913 "by the maximum size of an LV."
41917 #: ../src/guestfs.pod:3180
41919 "For the hugest disk image files, we recommend using XFS on the host for "
41924 #: ../src/guestfs.pod:3183
41925 msgid "MAXIMUM SIZE OF A PARTITION"
41929 #: ../src/guestfs.pod:3185
41931 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
41932 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
41933 "address a partition located beyond 2 TB on the disk."
41937 #: ../src/guestfs.pod:3189
41939 "It is recommended that you use GPT partitions on disks which are larger than "
41940 "this size. GPT uses 64 bit sector numbers and so can address partitions "
41941 "which are theoretically larger than the largest disk we could support."
41945 #: ../src/guestfs.pod:3194
41946 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
41950 #: ../src/guestfs.pod:3196
41952 "This depends on the filesystem type. libguestfs itself does not impose any "
41953 "known limit. Consult Wikipedia or the filesystem documentation to find out "
41954 "what these limits are."
41958 #: ../src/guestfs.pod:3200
41959 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
41963 #: ../src/guestfs.pod:3202
41965 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
41966 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
41967 "uploads and downloads."
41971 #: ../src/guestfs.pod:3206
41972 msgid "INSPECTION LIMITS"
41976 #: ../src/guestfs.pod:3208
41978 "The inspection code has several arbitrary limits on things like the size of "
41979 "Windows Registry hive it will read, and the length of product name. These "
41980 "are intended to stop a malicious guest from consuming arbitrary amounts of "
41981 "memory and disk space on the host, and should not be reached in practice. "
41982 "See the source code for more information."
41986 #: ../src/guestfs.pod:3234
41988 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
41989 "effect as calling C<guestfs_set_verbose (g, 1)>."
41993 #: ../src/guestfs.pod:3246
41995 "Set the path that libguestfs uses to search for a supermin appliance. See "
41996 "the discussion of paths in section L</PATH> above."
42000 #: ../src/guestfs.pod:3255
42001 msgid "See also L</QEMU WRAPPERS> above."
42005 #: ../src/guestfs.pod:3259
42007 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
42008 "effect as calling C<guestfs_set_trace (g, 1)>."
42012 #: ../src/guestfs.pod:3277
42014 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-"
42015 "ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
42016 "L<guestfish(1)>, L<guestmount(1)>, L<virt-alignment-scan(1)>, L<virt-cat(1)"
42017 ">, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
42018 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
42019 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue"
42020 "(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, L<virt-sysprep(1)>, L<virt-tar"
42021 "(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<guestfs-"
42022 "testing(1)>, L<qemu(1)>, L<febootstrap(1)>, L<febootstrap-supermin-helper(8)"
42023 ">, L<hivex(3)>, L<stap(1)>, L<http://libguestfs.org/>."
42027 #: ../src/guestfs.pod:3314
42029 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
42030 "(8)>, L<disktype(1)>."
42034 #: ../src/guestfs.pod:3321 ../tools/virt-make-fs.pl:571
42035 #: ../tools/virt-win-reg.pl:772
42040 #: ../src/guestfs.pod:3323
42041 msgid "To get a list of bugs against libguestfs use this link:"
42045 #: ../src/guestfs.pod:3325
42047 "L<https://bugzilla.redhat.com/buglist.cgi?"
42048 "component=libguestfs&product=Virtualization+Tools>"
42052 #: ../src/guestfs.pod:3327
42053 msgid "To report a new bug against libguestfs use this link:"
42057 #: ../src/guestfs.pod:3329
42059 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
42060 "component=libguestfs&product=Virtualization+Tools>"
42064 #: ../src/guestfs.pod:3331
42065 msgid "When reporting a bug, please check:"
42069 #: ../src/guestfs.pod:3337
42070 msgid "That the bug hasn't been reported already."
42074 #: ../src/guestfs.pod:3341
42075 msgid "That you are testing a recent version."
42079 #: ../src/guestfs.pod:3345
42080 msgid "Describe the bug accurately, and give a way to reproduce it."
42084 #: ../src/guestfs.pod:3349
42086 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
42091 #: ../test-tool/libguestfs-test-tool.pod:5
42092 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
42096 #: ../test-tool/libguestfs-test-tool.pod:9
42099 " libguestfs-test-tool [--options]\n"
42104 #: ../test-tool/libguestfs-test-tool.pod:13
42106 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
42107 "to check basic libguestfs functionality is working. This is needed because "
42108 "libguestfs occasionally breaks for reasons beyond our control: usually "
42109 "because of changes in the underlying qemu or kernel packages, or the host "
42114 #: ../test-tool/libguestfs-test-tool.pod:19
42115 msgid "If you suspect a problem in libguestfs, then just run:"
42119 #: ../test-tool/libguestfs-test-tool.pod:21
42122 " libguestfs-test-tool\n"
42127 #: ../test-tool/libguestfs-test-tool.pod:23
42128 msgid "It will print lots of diagnostic messages."
42132 #: ../test-tool/libguestfs-test-tool.pod:25
42133 msgid "If it runs to completion successfully, you will see this near the end:"
42137 #: ../test-tool/libguestfs-test-tool.pod:27
42140 " ===== TEST FINISHED OK =====\n"
42145 #: ../test-tool/libguestfs-test-tool.pod:29
42146 msgid "and the test tool will exit with code 0."
42150 #: ../test-tool/libguestfs-test-tool.pod:31
42152 "If it fails (and/or exits with non-zero error code), please paste the "
42153 "I<complete, unedited> output of the test tool into a bug report. More "
42154 "information about reporting bugs can be found on the L<http://libguestfs.org/"
42159 #: ../test-tool/libguestfs-test-tool.pod:42
42160 msgid "Display short usage information and exit."
42164 #: ../test-tool/libguestfs-test-tool.pod:44
42165 msgid "B<--qemu qemu_binary>"
42169 #: ../test-tool/libguestfs-test-tool.pod:46
42171 "If you have downloaded another qemu binary, point this option at the full "
42172 "path of the binary to try it."
42176 #: ../test-tool/libguestfs-test-tool.pod:49
42177 msgid "B<--qemudir qemu_source_dir>"
42181 #: ../test-tool/libguestfs-test-tool.pod:51
42183 "If you have compiled qemu from source, point this option at the source "
42184 "directory to try it."
42188 #: ../test-tool/libguestfs-test-tool.pod:54
42193 #: ../test-tool/libguestfs-test-tool.pod:56
42194 msgid "B<--timeout N>"
42198 #: ../test-tool/libguestfs-test-tool.pod:58
42200 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
42201 "minutes) which does not usually need to be adjusted."
42205 #: ../test-tool/libguestfs-test-tool.pod:63
42206 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
42210 #: ../test-tool/libguestfs-test-tool.pod:65
42212 "If you have compiled another version of qemu from source and would like to "
42213 "try that, then you can use the I<--qemudir> option to point to the qemu "
42214 "source directory."
42218 #: ../test-tool/libguestfs-test-tool.pod:69
42220 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
42221 "option to point to the binary."
42225 #: ../test-tool/libguestfs-test-tool.pod:72
42227 "Note when using these options, you can ignore the business of qemu wrapper "
42228 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
42229 "wrapper script for you if one is needed."
42233 #: ../test-tool/libguestfs-test-tool.pod:76
42234 msgid "TRYING OUT A DIFFERENT KERNEL"
42238 #: ../test-tool/libguestfs-test-tool.pod:78
42240 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
42241 "libguestfs tries. You do this by setting the environment variables "
42242 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
42246 #: ../test-tool/libguestfs-test-tool.pod:82
42248 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
42253 #: ../test-tool/libguestfs-test-tool.pod:85
42254 msgid "SELF-DIAGNOSIS"
42258 #: ../test-tool/libguestfs-test-tool.pod:87
42260 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
42261 "produced by libguestfs-test-tool and/or possible errors."
42265 #: ../test-tool/libguestfs-test-tool.pod:92
42267 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
42268 "I<1> if there was an error."
42272 #: ../test-tool/libguestfs-test-tool.pod:97
42274 "For the full list of environment variables which may affect libguestfs, "
42275 "please see the L<guestfs(3)> manual page."
42279 #: ../test-tool/libguestfs-test-tool.pod:102
42280 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
42284 #: ../tools/virt-list-filesystems.pl:32
42286 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
42290 #: ../tools/virt-list-filesystems.pl:36
42293 " virt-list-filesystems [--options] domname\n"
42298 #: ../tools/virt-list-filesystems.pl:38
42301 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
42306 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
42308 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
42313 #: ../tools/virt-list-filesystems.pl:45
42315 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
42316 "are contained in a virtual machine or disk image."
42320 #: ../tools/virt-list-filesystems.pl:49
42322 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
42323 "functionality. For more complex cases you should look at the L<guestfish(1)"
42328 #: ../tools/virt-list-filesystems.pl:112
42330 "With this option, C<virt-list-filesystems> displays the type of each "
42331 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
42335 #: ../tools/virt-list-filesystems.pl:119
42340 #: ../tools/virt-list-filesystems.pl:123
42342 "Normally we only show mountable filesystems. If this option is given then "
42343 "swap devices are shown too."
42347 #: ../tools/virt-list-filesystems.pl:197
42349 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
42350 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
42351 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
42355 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
42356 msgid "Copyright (C) 2009 Red Hat Inc."
42360 #: ../tools/virt-list-partitions.pl:32
42362 "virt-list-partitions - List partitions in a virtual machine or disk image"
42366 #: ../tools/virt-list-partitions.pl:36
42369 " virt-list-partitions [--options] domname\n"
42374 #: ../tools/virt-list-partitions.pl:38
42377 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
42382 #: ../tools/virt-list-partitions.pl:45
42384 "C<virt-list-partitions> is a command line tool to list the partitions that "
42385 "are contained in a virtual machine or disk image. It is mainly useful as a "
42386 "first step to using L<virt-resize(1)>."
42390 #: ../tools/virt-list-partitions.pl:50
42392 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
42393 "functionality. For more complex cases you should look at the L<guestfish(1)"
42398 #: ../tools/virt-list-partitions.pl:113
42399 msgid "Show sizes in human-readable form (eg. \"1G\")."
42403 #: ../tools/virt-list-partitions.pl:123
42405 "With this option, C<virt-list-partitions> displays the type and size of each "
42406 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
42410 #: ../tools/virt-list-partitions.pl:130
42415 #: ../tools/virt-list-partitions.pl:132
42420 #: ../tools/virt-list-partitions.pl:134
42422 "Display the total size of each block device (as a separate row or rows)."
42426 #: ../tools/virt-list-partitions.pl:267
42428 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
42429 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
42430 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
42434 #: ../tools/virt-list-partitions.pl:283
42435 msgid "Copyright (C) 2009-2010 Red Hat Inc."
42439 #: ../tools/virt-make-fs.pl:37
42440 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
42444 #: ../tools/virt-make-fs.pl:41
42447 " virt-make-fs [--options] input.tar output.img\n"
42452 #: ../tools/virt-make-fs.pl:43
42455 " virt-make-fs [--options] input.tar.gz output.img\n"
42460 #: ../tools/virt-make-fs.pl:45
42463 " virt-make-fs [--options] directory output.img\n"
42468 #: ../tools/virt-make-fs.pl:49
42470 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
42471 "archive or some files in a directory. It is similar to tools like L<mkisofs"
42472 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
42473 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
42474 "you want to attach these filesystems to existing virtual machines (eg. to "
42475 "import large amounts of read-only data to a VM)."
42479 #: ../tools/virt-make-fs.pl:57
42480 msgid "Basic usage is:"
42484 #: ../tools/virt-make-fs.pl:59
42487 " virt-make-fs input output.img\n"
42492 #: ../tools/virt-make-fs.pl:61
42494 "where C<input> is either a directory containing files that you want to add, "
42495 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
42496 "C<output.img> is a disk image. The input type is detected automatically. "
42497 "The output disk image defaults to a raw ext2 sparse image unless you specify "
42498 "extra flags (see L</OPTIONS> below)."
42502 #: ../tools/virt-make-fs.pl:67
42503 msgid "FILESYSTEM TYPE"
42507 #: ../tools/virt-make-fs.pl:69
42509 "The default filesystem type is C<ext2>. Just about any filesystem type that "
42510 "libguestfs supports can be used (but I<not> read-only formats like "
42511 "ISO9660). Here are some of the more common choices:"
42515 #: ../tools/virt-make-fs.pl:75
42520 #: ../tools/virt-make-fs.pl:77
42522 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
42523 "you are not going to use the filesystem in a way that requires the journal, "
42524 "then this is just wasted overhead."
42528 #: ../tools/virt-make-fs.pl:81
42529 msgid "I<ntfs> or I<vfat>"
42533 #: ../tools/virt-make-fs.pl:83
42534 msgid "Useful if exporting data to a Windows guest."
42538 #: ../tools/virt-make-fs.pl:85
42540 "I<Note for vfat>: The tar archive or local directory must only contain files "
42541 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
42542 "program running within libguestfs is unable to change the ownership of non-"
42543 "root files, since vfat itself does not support this."
42547 #: ../tools/virt-make-fs.pl:90
42552 #: ../tools/virt-make-fs.pl:92
42554 "Lower overhead than C<ext2>, but certain limitations on filename length and "
42555 "total filesystem size."
42559 #: ../tools/virt-make-fs.pl:97 ../tools/virt-make-fs.pl:116
42560 #: ../tools/virt-make-fs.pl:149
42565 #: ../tools/virt-make-fs.pl:99
42568 " virt-make-fs --type=minix input minixfs.img\n"
42573 #: ../tools/virt-make-fs.pl:101
42574 msgid "TO PARTITION OR NOT TO PARTITION"
42578 #: ../tools/virt-make-fs.pl:103
42579 msgid "Optionally virt-make-fs can add a partition table to the output disk."
42583 #: ../tools/virt-make-fs.pl:105
42585 "Adding a partition can make the disk image more compatible with certain "
42586 "virtualized operating systems which don't expect to see a filesystem "
42587 "directly located on a block device (Linux doesn't care and will happily "
42588 "handle both types)."
42592 #: ../tools/virt-make-fs.pl:110
42594 "On the other hand, if you have a partition table then the output image is no "
42595 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
42596 "directly on a partitioned disk image. (However libguestfs tools such as "
42597 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
42601 #: ../tools/virt-make-fs.pl:118
42602 msgid "Add an MBR partition:"
42606 #: ../tools/virt-make-fs.pl:120
42609 " virt-make-fs --partition -- input disk.img\n"
42614 #: ../tools/virt-make-fs.pl:122
42616 "If the output disk image could be terabyte-sized or larger, it's better to "
42617 "use an EFI/GPT-compatible partition table:"
42621 #: ../tools/virt-make-fs.pl:125
42624 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
42629 #: ../tools/virt-make-fs.pl:127
42630 msgid "EXTRA SPACE"
42634 #: ../tools/virt-make-fs.pl:129
42636 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
42637 "the files that it contains, but might have extra space. Depending on how "
42638 "you are going to use the output, you might think this extra space is wasted "
42639 "and want to minimize it, or you might want to leave space so that more files "
42640 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
42641 "but you can use the I<--size> flag to leave space in the filesystem if you "
42646 #: ../tools/virt-make-fs.pl:137
42648 "An alternative way to leave extra space but not make the output image any "
42649 "bigger is to use an alternative disk image format (instead of the default "
42650 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
42651 "image format (check your hypervisor supports this before using it). This "
42652 "allows you to choose a large I<--size> but the extra space won't actually be "
42653 "allocated in the image until you try to store something in it."
42657 #: ../tools/virt-make-fs.pl:145
42659 "Don't forget that you can also use local commands including L<resize2fs(8)> "
42660 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
42661 "to build another image from scratch."
42665 #: ../tools/virt-make-fs.pl:151
42668 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
42673 #: ../tools/virt-make-fs.pl:179
42674 msgid "Enable debugging information."
42678 #: ../tools/virt-make-fs.pl:185
42679 msgid "B<--size=E<lt>NE<gt>>"
42683 #: ../tools/virt-make-fs.pl:187
42684 msgid "B<--size=+E<lt>NE<gt>>"
42688 #: ../tools/virt-make-fs.pl:189
42689 msgid "B<-s E<lt>NE<gt>>"
42693 #: ../tools/virt-make-fs.pl:191
42694 msgid "B<-s +E<lt>NE<gt>>"
42698 #: ../tools/virt-make-fs.pl:193
42700 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
42704 #: ../tools/virt-make-fs.pl:196
42706 "If this option is I<not> given, then the output image will be just large "
42707 "enough to contain all the files, with not much wasted space."
42711 #: ../tools/virt-make-fs.pl:199
42713 "To choose a fixed size output disk, specify an absolute number followed by b/"
42714 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
42715 "Petabytes or Exabytes. This must be large enough to contain all the input "
42716 "files, else you will get an error."
42720 #: ../tools/virt-make-fs.pl:204
42722 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
42723 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
42724 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
42725 "the input files, and (approximately) an extra 200 MB free space."
42729 #: ../tools/virt-make-fs.pl:210
42731 "Note that virt-make-fs estimates free space, and therefore will not produce "
42732 "filesystems containing precisely the free space requested. (It is much more "
42733 "expensive and time-consuming to produce a filesystem which has precisely the "
42734 "desired free space)."
42738 #: ../tools/virt-make-fs.pl:219
42739 msgid "B<--format=E<lt>fmtE<gt>>"
42743 #: ../tools/virt-make-fs.pl:221
42744 msgid "B<-F E<lt>fmtE<gt>>"
42748 #: ../tools/virt-make-fs.pl:223
42749 msgid "Choose the output disk image format."
42753 #: ../tools/virt-make-fs.pl:225
42754 msgid "The default is C<raw> (raw sparse disk image)."
42758 #: ../tools/virt-make-fs.pl:227
42760 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
42761 "that would really make sense here is C<qcow2>."
42765 #: ../tools/virt-make-fs.pl:234
42766 msgid "B<--type=E<lt>fsE<gt>>"
42770 #: ../tools/virt-make-fs.pl:236
42771 msgid "B<-t E<lt>fsE<gt>>"
42775 #: ../tools/virt-make-fs.pl:238
42776 msgid "Choose the output filesystem type."
42780 #: ../tools/virt-make-fs.pl:240
42781 msgid "The default is C<ext2>."
42785 #: ../tools/virt-make-fs.pl:242
42787 "Any filesystem which is supported read-write by libguestfs can be used here."
42791 #: ../tools/virt-make-fs.pl:249
42792 msgid "B<--partition>"
42796 #: ../tools/virt-make-fs.pl:251
42797 msgid "B<--partition=E<lt>parttypeE<gt>>"
42801 #: ../tools/virt-make-fs.pl:253
42803 "If specified, this flag adds an MBR partition table to the output disk image."
42807 #: ../tools/virt-make-fs.pl:256
42809 "You can change the partition table type, eg. I<--partition=gpt> for large "
42814 #: ../tools/virt-make-fs.pl:259
42816 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
42817 "might consider the next parameter to be the partition type. For example:"
42821 #: ../tools/virt-make-fs.pl:263
42824 " virt-make-fs --partition input.tar output.img\n"
42829 #: ../tools/virt-make-fs.pl:265
42831 "would cause virt-make-fs to think you wanted to use a partition type of "
42832 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
42833 "dash) between options and the input and output arguments:"
42837 #: ../tools/virt-make-fs.pl:269
42840 " virt-make-fs --partition -- input.tar output.img\n"
42845 #: ../tools/virt-make-fs.pl:271
42846 msgid "For MBR, virt-make-fs sets the partition type byte automatically."
42850 #: ../tools/virt-make-fs.pl:559
42852 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
42853 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
42854 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
42858 #: ../tools/virt-make-fs.pl:573 ../tools/virt-win-reg.pl:774
42860 "When reporting bugs, please enable debugging and capture the I<complete> "
42865 #: ../tools/virt-make-fs.pl:576
42868 " export LIBGUESTFS_DEBUG=1\n"
42869 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
42874 #: ../tools/virt-make-fs.pl:579
42876 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
42881 #: ../tools/virt-tar.pl:33
42882 msgid "virt-tar - Extract or upload files to a virtual machine"
42886 #: ../tools/virt-tar.pl:37
42889 " virt-tar [--options] -x domname directory tarball\n"
42894 #: ../tools/virt-tar.pl:39
42897 " virt-tar [--options] -u domname tarball directory\n"
42902 #: ../tools/virt-tar.pl:41
42905 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
42910 #: ../tools/virt-tar.pl:43
42913 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
42918 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
42923 #: ../tools/virt-tar.pl:47
42925 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
42926 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
42930 #: ../tools/virt-tar.pl:52
42931 msgid "Download C</home> from the VM into a local tarball:"
42935 #: ../tools/virt-tar.pl:54
42938 " virt-tar -x domname /home home.tar\n"
42943 #: ../tools/virt-tar.pl:56
42946 " virt-tar -zx domname /home home.tar.gz\n"
42951 #: ../tools/virt-tar.pl:58
42952 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
42956 #: ../tools/virt-tar.pl:60
42959 " virt-tar -u domname uploadstuff.tar /tmp\n"
42964 #: ../tools/virt-tar.pl:62
42967 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
42972 #: ../tools/virt-tar.pl:66
42974 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
42975 "virtual machines. If you do this, you risk disk corruption in the VM. "
42976 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
42980 #: ../tools/virt-tar.pl:71
42982 "You can use I<-x> (extract) on live virtual machines, but you might get "
42983 "inconsistent results or errors if there is filesystem activity inside the "
42984 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
42985 "work, but the only way to guarantee consistent results is if the virtual "
42986 "machine is shut down."
42990 #: ../tools/virt-tar.pl:79
42992 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
42993 "parts of a guest filesystem. There are many possibilities: making backups, "
42994 "uploading data files, snooping on guest activity, fixing or customizing "
42999 #: ../tools/virt-tar.pl:84
43001 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
43002 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
43003 "should look at the L<guestfish(1)> tool."
43007 #: ../tools/virt-tar.pl:88
43009 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
43010 "its contents (recursively) from the virtual machine into a local tarball. "
43011 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
43012 "virtual machine. You cannot use these two options together."
43016 #: ../tools/virt-tar.pl:94
43018 "In addition, you may need to use the I<-z> (gZip) option to enable "
43019 "compression. When uploading, you have to specify I<-z> if the upload file "
43020 "is compressed because virt-tar won't detect this on its own."
43024 #: ../tools/virt-tar.pl:98
43026 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
43027 "example it cannot do PKZip files or bzip2 compression. If you want that "
43028 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
43029 "the L<libguestfs(3)> API)."
43033 #: ../tools/virt-tar.pl:160
43034 msgid "B<--extract>"
43038 #: ../tools/virt-tar.pl:162
43039 msgid "B<--download>"
43043 #: ../tools/virt-tar.pl:164
43048 #: ../tools/virt-tar.pl:166
43049 msgid "B<--upload>"
43053 #: ../tools/virt-tar.pl:168
43055 "Use I<-x> to extract (download) a directory from a virtual machine to a "
43060 #: ../tools/virt-tar.pl:171
43062 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
43063 "Please read the L</WARNING> section above before using this option."
43067 #: ../tools/virt-tar.pl:175
43068 msgid "You must specify exactly one of these options."
43072 #: ../tools/virt-tar.pl:181
43077 #: ../tools/virt-tar.pl:183
43082 #: ../tools/virt-tar.pl:185
43083 msgid "Specify that the input or output tarball is gzip-compressed."
43087 #: ../tools/virt-tar.pl:298
43089 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
43090 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
43091 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
43096 #: ../tools/virt-win-reg.pl:37
43098 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
43102 #: ../tools/virt-win-reg.pl:41
43105 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
43110 #: ../tools/virt-win-reg.pl:43
43113 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
43118 #: ../tools/virt-win-reg.pl:45
43121 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
43126 #: ../tools/virt-win-reg.pl:47
43129 " virt-win-reg --merge domname [input.reg ...]\n"
43134 #: ../tools/virt-win-reg.pl:49
43137 " virt-win-reg [--options] disk.img ... # instead of domname\n"
43142 #: ../tools/virt-win-reg.pl:53
43144 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
43145 "virtual machines. If you do this, you I<will> get irreversible disk "
43146 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
43147 "but doesn't catch all cases."
43151 #: ../tools/virt-win-reg.pl:58
43153 "Modifying the Windows Registry is an inherently risky operation. The format "
43154 "is deliberately obscure and undocumented, and Registry changes can leave the "
43155 "system unbootable. Therefore when using the I<--merge> option, make sure "
43156 "you have a reliable backup first."
43160 #: ../tools/virt-win-reg.pl:65
43162 "This program can export and merge Windows Registry entries from a Windows "
43167 #: ../tools/virt-win-reg.pl:68
43169 "The first parameter is the libvirt guest name or the raw disk image of a "
43174 #: ../tools/virt-win-reg.pl:71
43176 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
43177 "exported (recursively). For example:"
43181 #: ../tools/virt-win-reg.pl:74
43184 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
43189 #: ../tools/virt-win-reg.pl:76
43191 "You can also display single values from within registry keys, for example:"
43195 #: ../tools/virt-win-reg.pl:79
43198 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
43199 " $ virt-win-reg Windows7 $cvkey ProductName\n"
43200 " Windows 7 Enterprise\n"
43205 #: ../tools/virt-win-reg.pl:83
43207 "With I<--merge>, you can merge a textual regedit file into the Windows "
43212 #: ../tools/virt-win-reg.pl:86
43215 " $ virt-win-reg --merge Windows7 changes.reg\n"
43220 #: ../tools/virt-win-reg.pl:90
43222 "This program is only meant for simple access to the registry. If you want "
43223 "to do complicated things with the registry, we suggest you download the "
43224 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
43225 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
43226 "L<hivexregedit(1)>."
43230 #: ../tools/virt-win-reg.pl:159
43235 #: ../tools/virt-win-reg.pl:161
43237 "In merge mode, this merges a textual regedit file into the Windows Registry "
43238 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
43239 "displays or exports Registry entries instead."
43243 #: ../tools/virt-win-reg.pl:165
43245 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
43246 "result in disk corruption. However exporting (without this flag) is always "
43251 #: ../tools/virt-win-reg.pl:173
43252 msgid "B<--encoding> UTF-16LE|ASCII"
43256 #: ../tools/virt-win-reg.pl:175
43258 "When merging (only), you may need to specify the encoding for strings to be "
43259 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
43260 "(3)/ENCODING STRINGS>."
43264 #: ../tools/virt-win-reg.pl:179
43266 "The default is to use UTF-16LE, which should work with recent versions of "
43271 #: ../tools/virt-win-reg.pl:186
43272 msgid "B<--unsafe-printable-strings>"
43276 #: ../tools/virt-win-reg.pl:188
43278 "When exporting (only), assume strings are UTF-16LE and print them as strings "
43279 "instead of hex sequences. Remove the final zero codepoint from strings if "
43284 #: ../tools/virt-win-reg.pl:192
43286 "This is unsafe and does not preserve the fidelity of strings in the original "
43287 "Registry for various reasons:"
43291 #: ../tools/virt-win-reg.pl:199
43293 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
43294 "other encodings will be corrupted by this transformation."
43298 #: ../tools/virt-win-reg.pl:204
43300 "Assumes that everything which has type 1 or 2 is really a string and that "
43301 "everything else is not a string, but the type field in real Registries is "
43306 #: ../tools/virt-win-reg.pl:210
43308 "Loses information about whether a zero codepoint followed the string in the "
43313 #: ../tools/virt-win-reg.pl:215
43315 "This all happens because the Registry itself contains no information about "
43316 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
43320 #: ../tools/virt-win-reg.pl:219
43322 "You should only use this option for quick hacking and debugging of the "
43323 "Registry contents, and I<never> use it if the output is going to be passed "
43324 "into another program or stored in another Registry."
43328 #: ../tools/virt-win-reg.pl:556
43329 msgid "SUPPORTED SYSTEMS"
43333 #: ../tools/virt-win-reg.pl:558
43335 "The program currently supports Windows NT-derived guests starting with "
43336 "Windows XP through to at least Windows 7."
43340 #: ../tools/virt-win-reg.pl:561
43341 msgid "The following Registry keys are supported:"
43345 #: ../tools/virt-win-reg.pl:565
43346 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
43350 #: ../tools/virt-win-reg.pl:567
43351 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
43355 #: ../tools/virt-win-reg.pl:569
43356 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
43360 #: ../tools/virt-win-reg.pl:571
43361 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
43365 #: ../tools/virt-win-reg.pl:573
43366 msgid "C<HKEY_USERS\\.DEFAULT>"
43370 #: ../tools/virt-win-reg.pl:575
43371 msgid "C<HKEY_USERS\\I<SID>>"
43375 #: ../tools/virt-win-reg.pl:577
43376 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
43380 #: ../tools/virt-win-reg.pl:579
43381 msgid "C<HKEY_USERS\\I<username>>"
43385 #: ../tools/virt-win-reg.pl:581
43387 "where I<username> is a local user name (this is a libguestfs extension)."
43391 #: ../tools/virt-win-reg.pl:585
43393 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
43398 #: ../tools/virt-win-reg.pl:588
43400 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
43401 "supported (there is no \"current user\")."
43405 #: ../tools/virt-win-reg.pl:591
43410 #: ../tools/virt-win-reg.pl:593
43412 "C<virt-win-reg> expects that regedit files have already been reencoded in "
43413 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
43414 "style line endings. Since Windows regedit files are often in UTF-16LE with "
43415 "Windows-style line endings, you may need to reencode the whole file before "
43416 "or after processing."
43420 #: ../tools/virt-win-reg.pl:599
43422 "To reencode a file from Windows format to Linux (before processing it with "
43423 "the I<--merge> option), you would do something like this:"
43427 #: ../tools/virt-win-reg.pl:602
43430 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
43435 #: ../tools/virt-win-reg.pl:604
43437 "To go in the opposite direction, after exporting and before sending the file "
43438 "to a Windows user, do something like this:"
43442 #: ../tools/virt-win-reg.pl:607
43445 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
43450 #: ../tools/virt-win-reg.pl:609
43451 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
43455 #: ../tools/virt-win-reg.pl:611
43457 "If you are unsure about the current encoding, use the L<file(1)> command. "
43458 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
43459 "style (CRLF) line endings, like this:"
43463 #: ../tools/virt-win-reg.pl:615
43466 " $ file software.reg\n"
43467 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
43468 " with CRLF line terminators\n"
43473 #: ../tools/virt-win-reg.pl:619
43474 msgid "This file would need conversion before you could I<--merge> it."
43478 #: ../tools/virt-win-reg.pl:621
43479 msgid "CurrentControlSet etc."
43483 #: ../tools/virt-win-reg.pl:623
43485 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
43486 "Registry at the level of the hive file, and therefore you cannot modify "
43491 #: ../tools/virt-win-reg.pl:627
43493 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
43494 "circumstances it might refer to another control set. The way to find out is "
43495 "to look at the C<HKLM\\SYSTEM\\Select> key:"
43499 #: ../tools/virt-win-reg.pl:631
43502 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
43503 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
43504 " \"Current\"=dword:00000001\n"
43505 " \"Default\"=dword:00000001\n"
43506 " \"Failed\"=dword:00000000\n"
43507 " \"LastKnownGood\"=dword:00000002\n"
43512 #: ../tools/virt-win-reg.pl:638
43513 msgid "\"Current\" is the one which Windows will choose when it boots."
43517 #: ../tools/virt-win-reg.pl:640
43519 "Similarly, other C<Current...> keys in the path may need to be replaced."
43523 #: ../tools/virt-win-reg.pl:643
43524 msgid "DELETING REGISTRY KEYS AND VALUES"
43528 #: ../tools/virt-win-reg.pl:645
43529 msgid "To delete a whole registry key, use the syntax:"
43533 #: ../tools/virt-win-reg.pl:647
43536 " [-HKEY_LOCAL_MACHINE\\Foo]\n"
43541 #: ../tools/virt-win-reg.pl:649
43542 msgid "To delete a single value within a key, use the syntax:"
43546 #: ../tools/virt-win-reg.pl:651
43549 " [HKEY_LOCAL_MACHINE\\Foo]\n"
43555 #: ../tools/virt-win-reg.pl:654
43556 msgid "WINDOWS TIPS"
43560 #: ../tools/virt-win-reg.pl:656
43562 "Note that some of these tips modify the guest disk image. The guest I<must> "
43563 "be shut off, else you will get disk corruption."
43567 #: ../tools/virt-win-reg.pl:659
43568 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
43572 #: ../tools/virt-win-reg.pl:661
43574 "Prepare a DOS batch script, VBScript or executable. Upload this using "
43575 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
43576 "is uploaded into C<C:\\>:"
43580 #: ../tools/virt-win-reg.pl:665
43583 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
43588 #: ../tools/virt-win-reg.pl:667
43589 msgid "Prepare a regedit file containing the registry change:"
43593 #: ../tools/virt-win-reg.pl:669
43596 " cat > test.reg <<'EOF'\n"
43597 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
43598 " \"Test\"=\"c:\\\\test.bat\"\n"
43604 #: ../tools/virt-win-reg.pl:674
43606 "In this example we use the key C<RunOnce> which means that the script will "
43607 "run precisely once when the first user logs in. If you want it to run every "
43608 "time a user logs in, replace C<RunOnce> with C<Run>."
43612 #: ../tools/virt-win-reg.pl:678
43613 msgid "Now update the registry:"
43617 #: ../tools/virt-win-reg.pl:680
43620 " virt-win-reg --merge WindowsGuest test.reg\n"
43625 #: ../tools/virt-win-reg.pl:682
43626 msgid "INSTALLING A SERVICE"
43630 #: ../tools/virt-win-reg.pl:684
43632 "This section assumes you are familiar with Windows services, and you either "
43633 "have a program which handles the Windows Service Control Protocol directly "
43634 "or you want to run any program using a service wrapper like SrvAny or the "
43639 #: ../tools/virt-win-reg.pl:689
43641 "First upload the program and optionally the service wrapper. In this case "
43642 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
43646 #: ../tools/virt-win-reg.pl:693
43649 " guestfish -i -d WindowsGuest <<EOF\n"
43650 " upload rhsrvany.exe /rhsrvany.exe\n"
43651 " upload test.exe /test.exe\n"
43657 #: ../tools/virt-win-reg.pl:698
43659 "Prepare a regedit file containing the registry changes. In this example, "
43660 "the first registry change is needed for the service itself or the service "
43661 "wrapper (if used). The second registry change is only needed because I am "
43662 "using the RHSrvAny service wrapper."
43666 #: ../tools/virt-win-reg.pl:703
43669 " cat > service.reg <<'EOF'\n"
43670 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
43671 " \"Type\"=dword:00000010\n"
43672 " \"Start\"=dword:00000002\n"
43673 " \"ErrorControl\"=dword:00000001\n"
43674 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
43675 " \"DisplayName\"=\"RHSrvAny\"\n"
43676 " \"ObjectName\"=\"NetworkService\"\n"
43681 #: ../tools/virt-win-reg.pl:712
43684 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
43685 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
43686 " \"PWD\"=\"c:\\\\Temp\"\n"
43692 #: ../tools/virt-win-reg.pl:723
43694 "For use of C<ControlSet001> see the section above in this manual page. You "
43695 "may need to adjust this according to the control set that is in use by the "
43700 #: ../tools/virt-win-reg.pl:729
43702 "C<\"ObjectName\"> controls the privileges that the service will have. An "
43703 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
43704 "privileged account."
43708 #: ../tools/virt-win-reg.pl:735
43710 "For the meaning of the magic numbers, see this Microsoft KB article: "
43711 "L<http://support.microsoft.com/kb/103000>."
43715 #: ../tools/virt-win-reg.pl:740
43716 msgid "Update the registry:"
43720 #: ../tools/virt-win-reg.pl:742
43723 " virt-win-reg --merge WindowsGuest service.reg\n"
43728 #: ../tools/virt-win-reg.pl:746
43730 "Be careful when passing parameters containing C<\\> (backslash) in the "
43731 "shell. Usually you will have to use 'single quotes' or double backslashes "
43732 "(but not both) to protect them from the shell."
43736 #: ../tools/virt-win-reg.pl:750
43737 msgid "Paths and value names are case-insensitive."
43741 #: ../tools/virt-win-reg.pl:759
43743 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
43744 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
43745 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
43749 #: ../tools/virt-win-reg.pl:777
43752 " export LIBGUESTFS_DEBUG=1\n"
43753 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
43758 #: ../tools/virt-win-reg.pl:780
43760 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."