1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
5 # rjones <rjones@redhat.com>, 2011.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-09-21 15:11+0200\n"
11 "PO-Revision-Date: 2011-07-17 20:50+0000\n"
12 "Last-Translator: rjones <rjones@redhat.com>\n"
13 "Language-Team: Japanese (http://www.transifex.net/projects/p/fedora/team/"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19 "Plural-Forms: nplurals=1; plural=0\n"
22 #: ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3
23 #: ../df/virt-df.pod:3 ../edit/virt-edit.pod:3
24 #: ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3
25 #: ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3
26 #: ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3
27 #: ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3
28 #: ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3
29 #: ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3
30 #: ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3
31 #: ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3
32 #: ../ruby/examples/guestfs-ruby.pod:3 ../src/guestfs.pod:3
33 #: ../test-tool/libguestfs-test-tool.pod:3
34 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
35 #: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
36 #: ../tools/virt-win-reg.pl:35
41 #: ../cat/virt-cat.pod:5
42 msgid "virt-cat - Display files in a virtual machine"
46 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
47 #: ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
48 #: ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7
49 #: ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7
50 #: ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7
51 #: ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7
52 #: ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7
53 #: ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7
54 #: ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7
55 #: ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7
56 #: ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7
57 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
58 #: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
59 #: ../tools/virt-win-reg.pl:39
64 #: ../cat/virt-cat.pod:9
67 " virt-cat [--options] -d domname file [file ...]\n"
72 #: ../cat/virt-cat.pod:11
75 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
80 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
81 #: ../inspector/virt-inspector.pod:13
86 #: ../cat/virt-cat.pod:15
89 " virt-cat domname file\n"
94 #: ../cat/virt-cat.pod:17
97 " virt-cat disk.img file\n"
102 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
103 #: ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
104 #: ../erlang/examples/guestfs-erlang.pod:16
105 #: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
106 #: ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19
107 #: ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21
108 #: ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20
109 #: ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15
110 #: ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18
111 #: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
112 #: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
113 #: ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11
114 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
115 #: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
116 #: ../tools/virt-win-reg.pl:63
121 #: ../cat/virt-cat.pod:21
123 "C<virt-cat> is a command line tool to display the contents of C<file> where "
124 "C<file> exists in the named virtual machine (or disk image)."
128 #: ../cat/virt-cat.pod:24
130 "Multiple filenames can be given, in which case they are concatenated "
131 "together. Each filename must be a full path, starting at the root directory "
132 "(starting with '/')."
136 #: ../cat/virt-cat.pod:28
138 "C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
139 "edit>. For more complex cases you should look at the L<guestfish(1)> tool "
140 "(see L</USING GUESTFISH> below)."
144 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
145 #: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
146 #: ../fish/guestfish.pod:1018 ../fish/virt-copy-in.pod:29
147 #: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
148 #: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
149 #: ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
154 #: ../cat/virt-cat.pod:34
156 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
160 #: ../cat/virt-cat.pod:37
163 " virt-cat -d mydomain /etc/fstab\n"
168 #: ../cat/virt-cat.pod:39
169 msgid "List syslog messages from a VM disk image file:"
173 #: ../cat/virt-cat.pod:41
176 " virt-cat -a disk.img /var/log/messages | tail\n"
181 #: ../cat/virt-cat.pod:43
182 msgid "Find out what DHCP IP address a VM acquired:"
186 #: ../cat/virt-cat.pod:45
189 " virt-cat -d mydomain /var/log/messages | \\\n"
190 " grep 'dhclient: bound to' | tail\n"
195 #: ../cat/virt-cat.pod:48
196 msgid "Find out what packages were recently installed:"
200 #: ../cat/virt-cat.pod:50
203 " virt-cat -d mydomain /var/log/yum.log | tail\n"
208 #: ../cat/virt-cat.pod:52
209 msgid "Find out who is logged on inside a virtual machine:"
213 #: ../cat/virt-cat.pod:54
216 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
222 #: ../cat/virt-cat.pod:57
223 msgid "or who was logged on:"
227 #: ../cat/virt-cat.pod:59
230 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
231 " last -f /tmp/wtmp\n"
236 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91
237 #: ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
238 #: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
239 #: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
240 #: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83
241 #: ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84
242 #: ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:36
243 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
244 #: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
245 #: ../tools/virt-win-reg.pl:96
250 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95
251 #: ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
252 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151
253 #: ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88
254 #: ../resize/virt-resize.pod:245 ../test-tool/libguestfs-test-tool.pod:40
255 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62
256 #: ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111
257 #: ../tools/virt-win-reg.pl:104
262 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97
263 #: ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
264 #: ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90
265 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64
266 #: ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113
267 #: ../tools/virt-win-reg.pl:106
268 msgid "Display brief help."
272 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99
273 #: ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
274 #: ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
279 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101
280 #: ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
281 #: ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
282 msgid "B<--add> file"
286 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
287 #: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
288 #: ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
290 "Add I<file> which should be a disk image from a virtual machine. If the "
291 "virtual machine has multiple block devices, you must supply all of them with "
292 "separate I<-a> options."
296 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107
297 #: ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
298 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93
299 #: ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
301 "The format of the disk image is auto-detected. To override this and force a "
302 "particular format use the I<--format=..> option."
306 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125
307 #: ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
312 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127
313 #: ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
314 msgid "B<--connect> URI"
318 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129
319 #: ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
320 #: ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111
321 #: ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82
322 #: ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
324 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
325 "to the default libvirt hypervisor."
329 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132
330 #: ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
332 "If you specify guest block devices directly (I<-a>), then libvirt is not "
337 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141
338 #: ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105
339 #: ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
344 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143
345 #: ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107
346 #: ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
347 msgid "B<--domain> guest"
351 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145
352 #: ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109
353 #: ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
355 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
360 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
361 #: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
362 #: ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
363 msgid "B<--echo-keys>"
367 #: ../cat/virt-cat.pod:100
369 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
370 "so you cannot see what you are typing. If you are not worried about Tempest "
371 "attacks and there is no one else in the room you can specify this flag to "
372 "see what you are typing."
376 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170
377 #: ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233
378 #: ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99
379 #: ../rescue/virt-rescue.pod:124
380 msgid "B<--format=raw|qcow2|..>"
384 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172
385 #: ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134
386 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135
387 #: ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
392 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174
393 #: ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136
394 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137
395 #: ../rescue/virt-rescue.pod:128
397 "The default for the I<-a> option is to auto-detect the format of the disk "
398 "image. Using this forces the disk format for I<-a> options which follow on "
399 "the command line. Using I<--format> with no argument switches back to auto-"
400 "detection for subsequent I<-a> options."
404 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179
405 #: ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141
406 #: ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
407 #: ../inspector/virt-inspector.pod:336 ../rescue/virt-rescue.pod:133
408 #: ../src/guestfs.pod:2765
413 #: ../cat/virt-cat.pod:116
416 " virt-cat --format=raw -a disk.img file\n"
421 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183
422 #: ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145
423 #: ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
424 msgid "forces raw format (no auto-detection) for C<disk.img>."
428 #: ../cat/virt-cat.pod:120
431 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
436 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187
437 #: ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149
438 #: ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
440 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
441 "detection for C<another.img>."
445 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190
446 #: ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152
447 #: ../rescue/virt-rescue.pod:144
449 "If you have untrusted raw-format guest disk images, you should use this "
450 "option to specify the disk format. This avoids a possible security problem "
451 "with malicious guests (CVE-2010-3851)."
455 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
456 #: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
457 #: ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
458 msgid "B<--keys-from-stdin>"
462 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
463 #: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
464 #: ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
466 "Read key or passphrase parameters from stdin. The default is to try to read "
467 "passphrases from the user by opening C</dev/tty>."
471 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261
472 #: ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161
473 #: ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257
474 #: ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:178
479 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263
480 #: ../cat/virt-ls.pod:427 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163
481 #: ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259
482 #: ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:180
487 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265
488 #: ../cat/virt-ls.pod:429 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165
489 #: ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:182
490 msgid "Enable verbose messages for debugging."
494 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267
495 #: ../cat/virt-ls.pod:431 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167
496 #: ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263
497 #: ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184
498 #: ../resize/virt-resize.pod:484
503 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269
504 #: ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169
505 #: ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265
506 #: ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186
507 #: ../resize/virt-resize.pod:486 ../tools/virt-list-filesystems.pl:69
508 #: ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169
509 #: ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
514 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271
515 #: ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171
516 #: ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:188
517 #: ../resize/virt-resize.pod:488 ../tools/virt-list-filesystems.pl:71
518 #: ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171
519 #: ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
520 msgid "Display version number and exit."
524 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281
525 #: ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173
526 #: ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278
527 #: ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:199
528 #: ../tools/virt-tar.pl:158
533 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283
534 #: ../cat/virt-ls.pod:439 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175
535 #: ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:201
536 msgid "Enable tracing of libguestfs API calls."
540 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
541 #: ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:205
542 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
546 #: ../cat/virt-cat.pod:154
547 msgid "Previous versions of virt-cat allowed you to write either:"
551 #: ../cat/virt-cat.pod:156
554 " virt-cat disk.img [disk.img ...] file\n"
559 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
560 #: ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:211
565 #: ../cat/virt-cat.pod:160
568 " virt-cat guestname file\n"
573 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
574 #: ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:215
576 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
577 "the confusing case where a disk image might have the same name as a guest."
581 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
582 #: ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:219
583 msgid "For compatibility the old style is still supported."
587 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
588 msgid "USING GUESTFISH"
592 #: ../cat/virt-cat.pod:170
594 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
595 "C<virt-cat> doesn't work."
599 #: ../cat/virt-cat.pod:173
600 msgid "Using C<virt-cat> is approximately equivalent to doing:"
604 #: ../cat/virt-cat.pod:175
607 " guestfish --ro -i -d domname download file -\n"
612 #: ../cat/virt-cat.pod:177
614 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
615 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
619 #: ../cat/virt-cat.pod:181
621 "The command above uses libguestfs's guest inspection feature and so does not "
622 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
623 "disk images that don't contain guests. To display a file from a disk image "
628 #: ../cat/virt-cat.pod:186
631 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
636 #: ../cat/virt-cat.pod:188
638 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
639 "the disk image, and C<file> is the full path to the file."
643 #: ../cat/virt-cat.pod:191 ../cat/virt-filesystems.pod:365
644 #: ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342
645 #: ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:262
646 #: ../resize/virt-resize.pod:601 ../tools/virt-list-filesystems.pl:188
647 #: ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532
648 #: ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
649 msgid "SHELL QUOTING"
653 #: ../cat/virt-cat.pod:193 ../cat/virt-filesystems.pod:367
654 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344
655 #: ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:264
656 #: ../resize/virt-resize.pod:603 ../tools/virt-list-filesystems.pl:190
657 #: ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534
658 #: ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
660 "Libvirt guest names can contain arbitrary characters, some of which have "
661 "meaning to the shell such as C<#> and space. You may need to quote or "
662 "escape these characters on the command line. See the shell manual page L<sh"
667 #: ../cat/virt-cat.pod:198 ../cat/virt-filesystems.pod:372
668 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349
669 #: ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303
670 #: ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:608
671 #: ../test-tool/libguestfs-test-tool.pod:90
676 #: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374
677 #: ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351
678 #: ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377
679 #: ../resize/virt-resize.pod:610
681 "This program returns 0 if successful, or non-zero if there was an error."
685 #: ../cat/virt-cat.pod:203 ../cat/virt-filesystems.pod:377
686 #: ../cat/virt-ls.pod:495 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354
687 #: ../erlang/examples/guestfs-erlang.pod:97
688 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
689 #: ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50
690 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
691 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:308
692 #: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45
693 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
694 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
695 #: ../resize/virt-resize.pod:613 ../ruby/examples/guestfs-ruby.pod:36
696 #: ../src/guestfs.pod:3141 ../test-tool/libguestfs-test-tool.pod:100
697 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
698 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
699 #: ../tools/virt-win-reg.pl:746
704 #: ../cat/virt-cat.pod:205
706 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
707 "tar-out(1)>, L<http://libguestfs.org/>."
711 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:388
712 #: ../cat/virt-ls.pod:507 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368
713 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:634
714 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
715 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
716 #: ../tools/virt-win-reg.pl:772
721 #: ../cat/virt-cat.pod:214 ../cat/virt-filesystems.pod:390
722 #: ../cat/virt-ls.pod:509 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370
723 #: ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:294
724 #: ../resize/virt-resize.pod:636 ../tools/virt-list-filesystems.pl:210
725 #: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566
726 #: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
727 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
731 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:392
732 #: ../cat/virt-ls.pod:511 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372
733 #: ../erlang/examples/guestfs-erlang.pod:114
734 #: ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401
735 #: ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64
736 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
737 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:323
738 #: ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:62
739 #: ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56
740 #: ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:296
741 #: ../resize/virt-resize.pod:638 ../ruby/examples/guestfs-ruby.pod:52
742 #: ../src/guestfs.pod:3218 ../test-tool/libguestfs-test-tool.pod:110
743 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
744 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
745 #: ../tools/virt-win-reg.pl:776
750 #: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405
751 #: ../resize/virt-resize.pod:640
752 msgid "Copyright (C) 2010-2011 Red Hat Inc."
756 #: ../cat/virt-cat.pod:220 ../cat/virt-filesystems.pod:396
757 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376
758 #: ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69
759 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
760 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:328
761 #: ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:300
762 #: ../resize/virt-resize.pod:642 ../test-tool/libguestfs-test-tool.pod:115
763 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
764 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
765 #: ../tools/virt-win-reg.pl:780
767 "This program is free software; you can redistribute it and/or modify it "
768 "under the terms of the GNU General Public License as published by the Free "
769 "Software Foundation; either version 2 of the License, or (at your option) "
774 #: ../cat/virt-cat.pod:225 ../cat/virt-filesystems.pod:401
775 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381
776 #: ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74
777 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
778 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:333
779 #: ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:305
780 #: ../resize/virt-resize.pod:647 ../test-tool/libguestfs-test-tool.pod:120
781 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
782 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
783 #: ../tools/virt-win-reg.pl:785
785 "This program is distributed in the hope that it will be useful, but WITHOUT "
786 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
787 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
792 #: ../cat/virt-cat.pod:230 ../cat/virt-filesystems.pod:406
793 #: ../cat/virt-ls.pod:525 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386
794 #: ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79
795 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
796 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:338
797 #: ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:310
798 #: ../resize/virt-resize.pod:652 ../test-tool/libguestfs-test-tool.pod:125
799 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
800 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
801 #: ../tools/virt-win-reg.pl:790
803 "You should have received a copy of the GNU General Public License along with "
804 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
805 "Ave, Cambridge, MA 02139, USA."
809 #: ../cat/virt-filesystems.pod:5
811 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
812 "virtual machine or disk image"
816 #: ../cat/virt-filesystems.pod:9
819 " virt-filesystems [--options] -d domname\n"
824 #: ../cat/virt-filesystems.pod:11
827 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
832 #: ../cat/virt-filesystems.pod:15
834 "This tool allows you to discover filesystems, partitions, logical volumes, "
835 "and their sizes in a disk image or virtual machine. It is a replacement for "
836 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
840 #: ../cat/virt-filesystems.pod:20
842 "One use for this tool is from shell scripts to iterate over all filesystems "
847 #: ../cat/virt-filesystems.pod:23
850 " for fs in $(virt-filesystems -a disk.img); do\n"
857 #: ../cat/virt-filesystems.pod:27
859 "Another use is to list partitions before using another tool to modify those "
860 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
861 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
865 #: ../cat/virt-filesystems.pod:32
867 "Various command line options control what this program displays. You need "
868 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
869 "guest respectively. If you just specify that then the program shows "
870 "filesystems found, one per line, like this:"
874 #: ../cat/virt-filesystems.pod:37
877 " $ virt-filesystems -a disk.img\n"
879 " /dev/vg_guest/lv_root\n"
884 #: ../cat/virt-filesystems.pod:41
886 "If you add I<-l> or I<--long> then the output includes extra information:"
890 #: ../cat/virt-filesystems.pod:44
893 " $ virt-filesystems -a disk.img -l\n"
894 " Name Type VFS Label Size\n"
895 " /dev/sda1 filesystem ext4 boot 524288000\n"
896 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
901 #: ../cat/virt-filesystems.pod:49
903 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
908 #: ../cat/virt-filesystems.pod:52
911 " $ virt-filesystems -a disk.img --extra\n"
913 " /dev/vg_guest/lv_root\n"
914 " /dev/vg_guest/lv_swap\n"
915 " /dev/vg_guest/lv_data\n"
920 #: ../cat/virt-filesystems.pod:58
922 "If you add I<--partitions> then partitions are shown instead of filesystems:"
926 #: ../cat/virt-filesystems.pod:60
929 " $ virt-filesystems -a disk.img --partitions\n"
936 #: ../cat/virt-filesystems.pod:64
938 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
939 "volumes>, I<--block-devices> to list those items."
943 #: ../cat/virt-filesystems.pod:67
945 "You can use these options in combination as well (if you want a combination "
946 "including filesystems, you have to add I<--filesystems>). Notice that some "
947 "items fall into several categories (eg. C</dev/sda1> might be both a "
948 "partition and a filesystem). These items are listed several times. To get "
949 "a list which includes absolutely everything that virt-filesystems knows "
950 "about, use the I<--all> option."
954 #: ../cat/virt-filesystems.pod:74
956 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
957 "uuid> option to display device and filesystem UUIDs in the long output."
961 #: ../cat/virt-filesystems.pod:78
963 "I<--all --long --uuid> is a useful combination to display all possible "
964 "information about everything."
968 #: ../cat/virt-filesystems.pod:81
971 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
972 " Name Type VFS Label Size Parent UUID\n"
973 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
974 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
975 " /dev/sda1 partition - - 100M /dev/sda -\n"
976 " /dev/sda2 partition - - 20G /dev/sda -\n"
977 " /dev/sda device - - 20G - -\n"
982 #: ../cat/virt-filesystems.pod:89
984 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
988 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
993 #: ../cat/virt-filesystems.pod:112
995 "Display everything. This is currently the same as specifying these options: "
996 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
997 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
998 "added to this list in future)."
1002 #: ../cat/virt-filesystems.pod:117
1003 msgid "See also I<--long>."
1007 #: ../cat/virt-filesystems.pod:119
1008 msgid "B<--blkdevs>"
1012 #: ../cat/virt-filesystems.pod:121
1013 msgid "B<--block-devices>"
1017 #: ../cat/virt-filesystems.pod:123
1018 msgid "Display block devices."
1022 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
1027 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
1029 "Write out the results in CSV format (comma-separated values). This format "
1030 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1031 "ABOUT CSV FORMAT> below."
1035 #: ../cat/virt-filesystems.pod:150
1037 "When prompting for keys and passphrases, virt-filesystems normally turns "
1038 "echoing off so you cannot see what you are typing. If you are not worried "
1039 "about Tempest attacks and there is no one else in the room you can specify "
1040 "this flag to see what you are typing."
1044 #: ../cat/virt-filesystems.pod:155
1049 #: ../cat/virt-filesystems.pod:157
1051 "This causes filesystems that are not ordinary, mountable filesystems to be "
1052 "displayed. This category includes swapspace, and filesystems that are empty "
1053 "or contain unknown data."
1057 #: ../cat/virt-filesystems.pod:161
1058 msgid "This option implies I<--filesystems>."
1062 #: ../cat/virt-filesystems.pod:163
1063 msgid "B<--filesystems>"
1067 #: ../cat/virt-filesystems.pod:165
1069 "Display mountable filesystems. If no display option was selected then this "
1070 "option is implied."
1074 #: ../cat/virt-filesystems.pod:168
1075 msgid "With I<--extra>, non-mountable filesystems are shown too."
1079 #: ../cat/virt-filesystems.pod:181
1082 " virt-filesystems --format=raw -a disk.img\n"
1087 #: ../cat/virt-filesystems.pod:185
1090 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1095 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1096 #: ../df/virt-df.pod:125 ../fish/guestfish.pod:156
1097 #: ../tools/virt-list-partitions.pl:109
1102 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1103 #: ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
1104 msgid "B<--human-readable>"
1108 #: ../cat/virt-filesystems.pod:198
1109 msgid "In I<--long> mode, display sizes in human-readable format."
1113 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1114 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1119 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1120 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1125 #: ../cat/virt-filesystems.pod:209
1126 msgid "Display extra columns of data (\"long format\")."
1130 #: ../cat/virt-filesystems.pod:211
1131 msgid "A title row is added unless you also specify I<--no-title>."
1135 #: ../cat/virt-filesystems.pod:213
1137 "The extra columns displayed depend on what output you select, and the "
1138 "ordering of columns may change in future versions. Use the title row, I<--"
1139 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1144 #: ../cat/virt-filesystems.pod:218
1146 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1147 "default is to show raw numbers of I<bytes>."
1151 #: ../cat/virt-filesystems.pod:221
1152 msgid "Use I<--uuid> to display UUIDs too."
1156 #: ../cat/virt-filesystems.pod:223
1161 #: ../cat/virt-filesystems.pod:225
1162 msgid "B<--logvols>"
1166 #: ../cat/virt-filesystems.pod:227
1167 msgid "B<--logical-volumes>"
1171 #: ../cat/virt-filesystems.pod:229
1173 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1174 "of whether the LVs contain filesystems."
1178 #: ../cat/virt-filesystems.pod:232
1179 msgid "B<--no-title>"
1183 #: ../cat/virt-filesystems.pod:234
1184 msgid "In I<--long> mode, don't add a title row."
1188 #: ../cat/virt-filesystems.pod:236
1190 "Note that the order of the columns is not fixed, and may change in future "
1191 "versions of virt-filesystems, so using this option may give you unexpected "
1196 #: ../cat/virt-filesystems.pod:240
1201 #: ../cat/virt-filesystems.pod:242
1202 msgid "B<--partitions>"
1206 #: ../cat/virt-filesystems.pod:244
1208 "Display partitions. In this mode, these are displayed irrespective of "
1209 "whether the partitions contain filesystems."
1213 #: ../cat/virt-filesystems.pod:247
1218 #: ../cat/virt-filesystems.pod:249
1219 msgid "B<--physvols>"
1223 #: ../cat/virt-filesystems.pod:251
1224 msgid "B<--physical-volumes>"
1228 #: ../cat/virt-filesystems.pod:253
1229 msgid "Display LVM physical volumes."
1233 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
1238 #: ../cat/virt-filesystems.pod:257
1243 #: ../cat/virt-filesystems.pod:259
1244 msgid "In I<--long> mode, display UUIDs as well."
1248 #: ../cat/virt-filesystems.pod:273
1253 #: ../cat/virt-filesystems.pod:275
1254 msgid "B<--volgroups>"
1258 #: ../cat/virt-filesystems.pod:277
1259 msgid "B<--volume-groups>"
1263 #: ../cat/virt-filesystems.pod:279
1264 msgid "Display LVM volume groups."
1268 #: ../cat/virt-filesystems.pod:287
1273 #: ../cat/virt-filesystems.pod:289
1275 "Note that columns in the output are subject to reordering and change in "
1276 "future versions of this tool."
1280 #: ../cat/virt-filesystems.pod:294
1285 #: ../cat/virt-filesystems.pod:296
1286 msgid "The filesystem, partition, block device or LVM name."
1290 #: ../cat/virt-filesystems.pod:298
1292 "For device and partition names these are displayed as canonical libguestfs "
1293 "names, so that for example C</dev/sda2> is the second partition on the first "
1298 #: ../cat/virt-filesystems.pod:302
1300 "If the I<--long> option is B<not> specified, then only the name column is "
1301 "shown in the output."
1305 #: ../cat/virt-filesystems.pod:305
1310 #: ../cat/virt-filesystems.pod:307
1311 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1315 #: ../cat/virt-filesystems.pod:309
1320 #: ../cat/virt-filesystems.pod:311
1322 "If there is a filesystem, then this column displays the filesystem type if "
1323 "one could be detected, eg. C<ext4>."
1327 #: ../cat/virt-filesystems.pod:314
1332 #: ../cat/virt-filesystems.pod:316
1334 "If the object has a label (used for identifying and mounting filesystems) "
1335 "then this column contains the label."
1339 #: ../cat/virt-filesystems.pod:319
1344 #: ../cat/virt-filesystems.pod:321
1346 "The size of the object in bytes. If the I<--human> option is used then the "
1347 "size is displayed in a human-readable form."
1351 #: ../cat/virt-filesystems.pod:324
1356 #: ../cat/virt-filesystems.pod:326
1358 "The parent column records the parent relationship between objects. For "
1359 "example, if the object is a partition, then this column contains the name of "
1360 "the containing device. If the object is a logical volume, then this column "
1361 "is the name of the volume group."
1365 #: ../cat/virt-filesystems.pod:331
1370 #: ../cat/virt-filesystems.pod:333
1372 "If the object has a UUID (used for identifying and mounting filesystems and "
1373 "block devices) then this column contains the UUID as a string."
1377 #: ../cat/virt-filesystems.pod:337
1378 msgid "The UUID is only displayed if the I<--uuid> option is given."
1382 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1383 #: ../df/virt-df.pod:191
1384 msgid "NOTE ABOUT CSV FORMAT"
1388 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1389 #: ../df/virt-df.pod:193
1391 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1392 "should be easy to parse, but it is definitely not easy to parse."
1396 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1397 #: ../df/virt-df.pod:196
1399 "Myth: Just split fields at commas. Reality: This does I<not> work "
1400 "reliably. This example has two columns:"
1404 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1405 #: ../df/virt-df.pod:199
1408 " \"foo,bar\",baz\n"
1413 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
1414 #: ../df/virt-df.pod:201
1416 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1417 "reliably. This example has one row:"
1421 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
1422 #: ../df/virt-df.pod:204
1431 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
1432 #: ../df/virt-df.pod:207
1434 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1435 "packaged in major Linux distributions)."
1439 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
1440 #: ../df/virt-df.pod:210
1442 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1443 "or Python's built-in csv library)."
1447 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
1448 #: ../df/virt-df.pod:213
1449 msgid "Most spreadsheets and databases can import CSV directly."
1453 #: ../cat/virt-filesystems.pod:379
1455 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
1456 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
1461 #: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570
1462 #: ../tools/virt-win-reg.pl:778
1463 msgid "Copyright (C) 2010 Red Hat Inc."
1467 #: ../cat/virt-ls.pod:5
1468 msgid "virt-ls - List files in a virtual machine"
1472 #: ../cat/virt-ls.pod:9
1475 " virt-ls [--options] -d domname directory [directory ...]\n"
1480 #: ../cat/virt-ls.pod:11
1483 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
1488 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1493 #: ../cat/virt-ls.pod:15
1496 " virt-ls [--options] domname directory\n"
1501 #: ../cat/virt-ls.pod:17
1504 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1509 #: ../cat/virt-ls.pod:21
1511 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1512 "more from a virtual machine or disk image."
1516 #: ../cat/virt-ls.pod:24
1518 "Multiple directory names can be given, in which case the output from each is "
1523 #: ../cat/virt-ls.pod:27
1525 "To list directories from a libvirt guest use the I<-d> option to specify the "
1526 "name of the guest. For a disk image, use the I<-a> option."
1530 #: ../cat/virt-ls.pod:31
1532 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1533 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
1538 #: ../cat/virt-ls.pod:37
1539 msgid "Get a list of all files and directories in a virtual machine:"
1543 #: ../cat/virt-ls.pod:39
1546 " virt-ls -R -d guest /\n"
1551 #: ../cat/virt-ls.pod:41
1552 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1556 #: ../cat/virt-ls.pod:43
1559 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1564 #: ../cat/virt-ls.pod:45
1565 msgid "List all public-writable directories in a Linux virtual machine:"
1569 #: ../cat/virt-ls.pod:47
1572 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1577 #: ../cat/virt-ls.pod:49
1578 msgid "List all Unix domain sockets in a Linux virtual machine:"
1582 #: ../cat/virt-ls.pod:51
1585 " virt-ls -lR -d guest / | grep '^s'\n"
1590 #: ../cat/virt-ls.pod:53
1591 msgid "List all regular files with filenames ending in '.png':"
1595 #: ../cat/virt-ls.pod:55
1598 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1603 #: ../cat/virt-ls.pod:57
1604 msgid "To display files larger than 10MB in home directories:"
1608 #: ../cat/virt-ls.pod:59
1611 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1616 #: ../cat/virt-ls.pod:61
1617 msgid "Find everything modified in the last 7 days:"
1621 #: ../cat/virt-ls.pod:63
1624 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1629 #: ../cat/virt-ls.pod:65
1630 msgid "Find regular files modified in the last 24 hours:"
1634 #: ../cat/virt-ls.pod:67
1637 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1642 #: ../cat/virt-ls.pod:69
1643 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1647 #: ../cat/virt-ls.pod:71
1649 "Find the differences between files in a guest and an earlier snapshot of the "
1654 #: ../cat/virt-ls.pod:74
1657 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1658 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1659 " diff -u old new | less\n"
1664 #: ../cat/virt-ls.pod:78
1666 "The commands above won't find files where the content has changed but the "
1667 "metadata (eg. file size and modification date) is the same. To do that, you "
1668 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
1669 "checksum> can be quite slow since it has to read and compute a checksum of "
1670 "every regular file in the virtual machine."
1674 #: ../cat/virt-ls.pod:84
1675 msgid "OUTPUT MODES"
1679 #: ../cat/virt-ls.pod:86
1681 "C<virt-ls> has four output modes, controlled by different combinations of "
1682 "the I<-l> and I<-R> options."
1686 #: ../cat/virt-ls.pod:89
1687 msgid "SIMPLE LISTING"
1691 #: ../cat/virt-ls.pod:91
1692 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1696 #: ../cat/virt-ls.pod:93
1699 " $ virt-ls -d guest /\n"
1707 #: ../cat/virt-ls.pod:98
1708 msgid "LONG LISTING"
1712 #: ../cat/virt-ls.pod:100
1714 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1715 "(more specifically, like the C<guestfs_ll> function)."
1719 #: ../cat/virt-ls.pod:103
1722 " $ virt-ls -l -d guest /\n"
1724 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1725 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1731 #: ../cat/virt-ls.pod:109
1733 "Note that while this is useful for displaying a directory, do not try "
1734 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1739 #: ../cat/virt-ls.pod:113
1740 msgid "RECURSIVE LISTING"
1744 #: ../cat/virt-ls.pod:115
1746 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1747 "and directories recursively:"
1751 #: ../cat/virt-ls.pod:118
1754 " $ virt-ls -R -d guest /tmp\n"
1762 #: ../cat/virt-ls.pod:123
1764 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1765 "converts C<\\0> characters to C<\\n>."
1769 #: ../cat/virt-ls.pod:126
1770 msgid "RECURSIVE LONG LISTING"
1774 #: ../cat/virt-ls.pod:128
1776 "Using I<-lR> options together changes the output to display directories "
1777 "recursively, with file stats, and optionally other features such as "
1778 "checksums and extended attributes."
1782 #: ../cat/virt-ls.pod:132
1784 "Most of the interesting features of C<virt-ls> are only available when using "
1789 #: ../cat/virt-ls.pod:135
1791 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1792 "you cannot use the output in another program (because filenames can contain "
1793 "spaces and other unsafe characters). If the guest was untrusted and someone "
1794 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1795 "on you by creating filenames with embedded newline characters. To B<safely> "
1796 "parse the output in another program, use the I<--csv> (Comma-Separated "
1801 #: ../cat/virt-ls.pod:143
1803 "Note that this output format is completely unrelated to the C<ls -lR> "
1808 #: ../cat/virt-ls.pod:146
1811 " $ virt-ls -lR -d guest /bin\n"
1812 " d 0555 4096 /bin\n"
1813 " - 0755 123 /bin/alsaunmute\n"
1814 " - 0755 28328 /bin/arch\n"
1815 " l 0777 4 /bin/awk -> gawk\n"
1816 " - 0755 27216 /bin/basename\n"
1817 " - 0755 943360 /bin/bash\n"
1823 #: ../cat/virt-ls.pod:155
1824 msgid "These basic fields are always shown:"
1828 #: ../cat/virt-ls.pod:159
1833 #: ../cat/virt-ls.pod:161
1835 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1836 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1837 "link), C<s> (socket) or C<u> (unknown)."
1841 #: ../cat/virt-ls.pod:171
1846 #: ../cat/virt-ls.pod:173
1847 msgid "The Unix permissions, displayed as a 4 digit octal number."
1851 #: ../cat/virt-ls.pod:175
1856 #: ../cat/virt-ls.pod:177
1858 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
1859 "readable> option is given, in which case this is shown as a human-readable "
1864 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4214
1869 #: ../cat/virt-ls.pod:183
1870 msgid "The full path of the file or directory."
1874 #: ../cat/virt-ls.pod:185
1879 #: ../cat/virt-ls.pod:187
1880 msgid "For symbolic links only, the link target."
1884 #: ../cat/virt-ls.pod:191
1886 "In I<-lR> mode, additional command line options enable the display of more "
1891 #: ../cat/virt-ls.pod:194
1893 "With the I<--uids> flag, these additional fields are displayed before the "
1898 #: ../cat/virt-ls.pod:199
1903 #: ../cat/virt-ls.pod:201
1908 #: ../cat/virt-ls.pod:203
1910 "The UID and GID of the owner of the file (displayed numerically). Note "
1911 "these only make sense in the context of a Unix-like guest."
1915 #: ../cat/virt-ls.pod:208
1916 msgid "With the I<--times> flag, these additional fields are displayed:"
1920 #: ../cat/virt-ls.pod:212
1925 #: ../cat/virt-ls.pod:214
1926 msgid "The time of last access."
1930 #: ../cat/virt-ls.pod:216
1935 #: ../cat/virt-ls.pod:218
1936 msgid "The time of last modification."
1940 #: ../cat/virt-ls.pod:220
1945 #: ../cat/virt-ls.pod:222
1946 msgid "The time of last status change."
1950 #: ../cat/virt-ls.pod:226
1952 "The time fields are displayed as string dates and times, unless one of the "
1953 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1957 #: ../cat/virt-ls.pod:229
1958 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1962 #: ../cat/virt-ls.pod:233
1967 #: ../cat/virt-ls.pod:235
1969 "The device containing the file (displayed as major:minor). This may not "
1970 "match devices as known to the guest."
1974 #: ../cat/virt-ls.pod:238
1979 #: ../cat/virt-ls.pod:240
1980 msgid "The inode number."
1984 #: ../cat/virt-ls.pod:242
1989 #: ../cat/virt-ls.pod:244
1990 msgid "The number of hard links."
1994 #: ../cat/virt-ls.pod:246
1999 #: ../cat/virt-ls.pod:248
2001 "For block and char special files, the device (displayed as major:minor)."
2005 #: ../cat/virt-ls.pod:251
2010 #: ../cat/virt-ls.pod:253
2011 msgid "The number of 512 byte blocks allocated to the file."
2015 #: ../cat/virt-ls.pod:257
2017 "With the I<--checksum> flag, the checksum of the file contents is shown "
2018 "(only for regular files). Computing file checksums can take a considerable "
2023 #: ../cat/virt-ls.pod:280
2024 msgid "B<--checksum>"
2028 #: ../cat/virt-ls.pod:282
2029 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2033 #: ../cat/virt-ls.pod:284
2035 "Display checksum over file contents for regular files. With no argument, "
2036 "this defaults to using I<md5>. Using an argument, you can select the "
2037 "checksum type to use."
2041 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2042 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2043 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2045 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2050 #: ../cat/virt-ls.pod:316
2052 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2053 "so you cannot see what you are typing. If you are not worried about Tempest "
2054 "attacks and there is no one else in the room you can specify this flag to "
2055 "see what you are typing."
2059 #: ../cat/virt-ls.pod:321
2060 msgid "B<--extra-stats>"
2064 #: ../cat/virt-ls.pod:323
2065 msgid "Display extra stats."
2069 #: ../cat/virt-ls.pod:339
2072 " virt-ls --format=raw -a disk.img /dir\n"
2077 #: ../cat/virt-ls.pod:343
2080 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2085 #: ../cat/virt-ls.pod:356
2086 msgid "Display file sizes in human-readable format."
2090 #: ../cat/virt-ls.pod:370
2095 #: ../cat/virt-ls.pod:372
2096 msgid "B<--recursive>"
2100 #: ../cat/virt-ls.pod:374
2102 "Select the mode. With neither of these options, C<virt-ls> produces a "
2103 "simple, flat list of the files in the named directory. See L</SIMPLE "
2108 #: ../cat/virt-ls.pod:378
2110 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2115 #: ../cat/virt-ls.pod:381
2117 "C<virt-ls -R> produces a recursive list of files starting at the named "
2118 "directory. See L</RECURSIVE LISTING>."
2122 #: ../cat/virt-ls.pod:384
2124 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2125 "parsed. See L</RECURSIVE LONG LISTING>."
2129 #: ../cat/virt-ls.pod:387
2134 #: ../cat/virt-ls.pod:389
2135 msgid "Display time fields."
2139 #: ../cat/virt-ls.pod:394
2140 msgid "B<--time-days>"
2144 #: ../cat/virt-ls.pod:396
2145 msgid "Display time fields as days before now (negative if in the future)."
2149 #: ../cat/virt-ls.pod:398
2151 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2152 "of the file is between 0 and 86399 seconds."
2156 #: ../cat/virt-ls.pod:404
2157 msgid "B<--time-relative>"
2161 #: ../cat/virt-ls.pod:406
2162 msgid "Display time fields as seconds before now (negative if in the future)."
2166 #: ../cat/virt-ls.pod:411
2171 #: ../cat/virt-ls.pod:413
2172 msgid "Display time fields as seconds since the Unix epoch."
2176 #: ../cat/virt-ls.pod:418
2181 #: ../cat/virt-ls.pod:420
2182 msgid "Display UID and GID fields."
2186 #: ../cat/virt-ls.pod:445
2187 msgid "Previous versions of virt-ls allowed you to write either:"
2191 #: ../cat/virt-ls.pod:447
2194 " virt-ls disk.img [disk.img ...] /dir\n"
2199 #: ../cat/virt-ls.pod:451
2202 " virt-ls guestname /dir\n"
2207 #: ../cat/virt-ls.pod:497
2209 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2210 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2211 "L<http://libguestfs.org/>."
2215 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374
2216 #: ../rescue/virt-rescue.pod:298
2217 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2221 #: ../df/virt-df.pod:5
2222 msgid "virt-df - Display free space on virtual filesystems"
2226 #: ../df/virt-df.pod:9
2229 " virt-df [--options]\n"
2234 #: ../df/virt-df.pod:11
2237 " virt-df [--options] -d domname\n"
2242 #: ../df/virt-df.pod:13
2245 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2250 #: ../df/virt-df.pod:17
2253 " virt-df [--options] domname\n"
2258 #: ../df/virt-df.pod:19
2261 " virt-df [--options] disk.img [disk.img ...]\n"
2266 #: ../df/virt-df.pod:23
2268 "C<virt-df> is a command line tool to display free space on virtual machine "
2269 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2270 "allocated to a virtual machine, but can look inside disk images to see how "
2271 "much space is really being used."
2275 #: ../df/virt-df.pod:28
2277 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2278 "to get a list of all active and inactive guests, and performs a C<df>-type "
2279 "operation on each one in turn, printing out the results."
2283 #: ../df/virt-df.pod:32
2285 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2286 "type operation on either the single named libvirt domain, or on the disk "
2287 "image(s) listed on the command line (which must all belong to a single VM). "
2288 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2289 "guest>. If you want to run on multiple guests, then you have to invoke "
2290 "C<virt-df> multiple times."
2294 #: ../df/virt-df.pod:39
2296 "Use the I<--csv> option to get a format which can be easily parsed by other "
2297 "programs. Other options are similar to the standard L<df(1)> command."
2301 #: ../df/virt-df.pod:45
2303 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2304 "output human-readable:"
2308 #: ../df/virt-df.pod:48
2311 " # virt-df -d F14x64 -h\n"
2312 " Filesystem Size Used Available Use%\n"
2313 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2314 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2319 #: ../df/virt-df.pod:53
2320 msgid "Show disk usage for a disk image file called C<test.img>:"
2324 #: ../df/virt-df.pod:55
2327 " $ virt-df -a test1.img\n"
2328 " Filesystem 1K-blocks Used Available Use%\n"
2329 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2334 #: ../df/virt-df.pod:112
2337 " virt-df --format=raw -a disk.img\n"
2342 #: ../df/virt-df.pod:116
2345 " virt-df --format=raw -a disk.img --format -a another.img\n"
2350 #: ../df/virt-df.pod:129
2351 msgid "Print sizes in human-readable format."
2355 #: ../df/virt-df.pod:131
2356 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2360 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2365 #: ../df/virt-df.pod:135
2370 #: ../df/virt-df.pod:137
2371 msgid "Print inodes instead of blocks."
2375 #: ../df/virt-df.pod:139
2376 msgid "B<--one-per-guest>"
2380 #: ../df/virt-df.pod:141
2382 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2383 "disks from several guests to a single libguestfs appliance."
2387 #: ../df/virt-df.pod:144
2388 msgid "You might use this option in the following circumstances:"
2392 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266
2393 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
2394 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
2395 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
2396 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
2397 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
2398 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
2399 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
2400 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
2401 #: ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398
2402 #: ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412
2403 #: ../fish/guestfish-actions.pod:1104 ../fish/guestfish-actions.pod:1108
2404 #: ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116
2405 #: ../fish/guestfish-actions.pod:1124 ../fish/guestfish-actions.pod:1128
2406 #: ../fish/guestfish-actions.pod:1132 ../fish/guestfish-actions.pod:1142
2407 #: ../fish/guestfish-actions.pod:1146 ../fish/guestfish-actions.pod:1150
2408 #: ../fish/guestfish-actions.pod:1240 ../fish/guestfish-actions.pod:1244
2409 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1254
2410 #: ../fish/guestfish-actions.pod:1296 ../fish/guestfish-actions.pod:1300
2411 #: ../fish/guestfish-actions.pod:1305 ../fish/guestfish-actions.pod:1555
2412 #: ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:1569
2413 #: ../fish/guestfish-actions.pod:1964 ../fish/guestfish-actions.pod:1970
2414 #: ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:1985
2415 #: ../fish/guestfish-actions.pod:1992 ../fish/guestfish.pod:445
2416 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
2417 #: ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:393
2418 #: ../inspector/virt-inspector.pod:397 ../resize/virt-resize.pod:282
2419 #: ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295
2420 #: ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:22
2421 #: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:588
2422 #: ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:603
2423 #: ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1667
2424 #: ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1675
2425 #: ../src/guestfs-actions.pod:1679 ../src/guestfs-actions.pod:1687
2426 #: ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:1695
2427 #: ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1709
2428 #: ../src/guestfs-actions.pod:1713 ../src/guestfs-actions.pod:1851
2429 #: ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860
2430 #: ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1926
2431 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:1935
2432 #: ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2346
2433 #: ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:2890
2434 #: ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:2904
2435 #: ../src/guestfs-actions.pod:2911 ../src/guestfs-actions.pod:2918
2436 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
2437 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
2438 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1068
2439 #: ../src/guestfs.pod:1072 ../src/guestfs.pod:1076 ../src/guestfs.pod:1081
2440 #: ../src/guestfs.pod:1089 ../src/guestfs.pod:1108 ../src/guestfs.pod:1116
2441 #: ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146
2442 #: ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1158
2443 #: ../src/guestfs.pod:1648 ../src/guestfs.pod:1653 ../src/guestfs.pod:1657
2444 #: ../src/guestfs.pod:1759 ../src/guestfs.pod:1764 ../src/guestfs.pod:1768
2445 #: ../src/guestfs.pod:1778 ../src/guestfs.pod:2067 ../src/guestfs.pod:2072
2446 #: ../src/guestfs.pod:2078 ../src/guestfs.pod:2086 ../src/guestfs.pod:2533
2447 #: ../src/guestfs.pod:2539 ../src/guestfs.pod:2544 ../src/guestfs.pod:2550
2448 #: ../src/guestfs.pod:2933 ../src/guestfs.pod:2938 ../src/guestfs.pod:2942
2449 #: ../src/guestfs.pod:2946 ../src/guestfs.pod:2950 ../src/guestfs.pod:2964
2450 #: ../src/guestfs.pod:2969 ../src/guestfs.pod:3195 ../src/guestfs.pod:3199
2451 #: ../src/guestfs.pod:3203 ../src/guestfs.pod:3207
2452 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
2453 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
2454 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2459 #: ../df/virt-df.pod:150
2461 "If you think an untrusted guest might actively try to exploit the libguestfs "
2462 "appliance kernel, then this prevents one guest from interfering with the "
2463 "stats printed for another guest."
2467 #: ../df/virt-df.pod:156
2469 "If the kernel has a bug which stops it from accessing a filesystem in one "
2470 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2471 "and report stats for further guests."
2475 #: ../df/virt-df.pod:165
2477 "Print UUIDs instead of names. This is useful for following a guest even "
2478 "when the guest is migrated or renamed, or when two guests happen to have the "
2483 #: ../df/virt-df.pod:169
2485 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2486 "images, we still print the disk image name even when this option is "
2491 #: ../df/virt-df.pod:229
2493 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
2498 #: ../edit/virt-edit.pod:5
2499 msgid "virt-edit - Edit a file in a virtual machine"
2503 #: ../edit/virt-edit.pod:9
2506 " virt-edit [--options] -d domname file [file ...]\n"
2511 #: ../edit/virt-edit.pod:11
2514 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2519 #: ../edit/virt-edit.pod:13
2522 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2527 #: ../edit/virt-edit.pod:17
2530 " virt-edit domname file\n"
2535 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2538 " virt-edit disk.img [disk.img ...] file\n"
2543 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
2544 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
2545 #: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
2546 #: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2551 #: ../edit/virt-edit.pod:23
2553 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2554 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2555 "doing this, but doesn't catch all cases."
2559 #: ../edit/virt-edit.pod:29
2561 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2562 "exists in the named virtual machine (or disk image)."
2566 #: ../edit/virt-edit.pod:32
2568 "Multiple filenames can be given, in which case they are each edited in "
2569 "turn. Each filename must be a full path, starting at the root directory "
2570 "(starting with '/')."
2574 #: ../edit/virt-edit.pod:36
2575 msgid "If you want to just view a file, use L<virt-cat(1)>."
2579 #: ../edit/virt-edit.pod:38
2581 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
2582 "USING GUESTFISH> below)."
2586 #: ../edit/virt-edit.pod:41
2588 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2589 "that and much more."
2593 #: ../edit/virt-edit.pod:46
2594 msgid "Edit the named files interactively:"
2598 #: ../edit/virt-edit.pod:48
2601 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2606 #: ../edit/virt-edit.pod:50
2609 " virt-edit -d mydomain /etc/passwd\n"
2614 #: ../edit/virt-edit.pod:52
2615 msgid "For Windows guests, some Windows paths are understood:"
2619 #: ../edit/virt-edit.pod:54
2622 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2627 #: ../edit/virt-edit.pod:56
2629 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
2630 "INTERACTIVE EDITING> below). To change the init default level to 5:"
2634 #: ../edit/virt-edit.pod:60
2637 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2642 #: ../edit/virt-edit.pod:81
2643 msgid "B<-b> extension"
2647 #: ../edit/virt-edit.pod:83
2648 msgid "B<--backup> extension"
2652 #: ../edit/virt-edit.pod:85
2654 "Create a backup of the original file I<in the guest disk image>. The backup "
2655 "has the original filename with C<extension> added."
2659 #: ../edit/virt-edit.pod:88
2661 "Usually the first character of C<extension> would be a dot C<.> so you would "
2666 #: ../edit/virt-edit.pod:91
2669 " virt-edit -b .orig [etc]\n"
2674 #: ../edit/virt-edit.pod:93
2675 msgid "By default, no backup file is made."
2679 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
2680 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
2681 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
2682 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2687 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
2688 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
2689 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
2690 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2691 msgid "B<--connect URI>"
2695 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
2696 #: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
2697 #: ../tools/virt-win-reg.pl:135
2699 "If you specify guest block devices directly, then libvirt is not used at all."
2703 #: ../edit/virt-edit.pod:114
2705 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2706 "off so you cannot see what you are typing. If you are not worried about "
2707 "Tempest attacks and there is no one else in the room you can specify this "
2708 "flag to see what you are typing."
2712 #: ../edit/virt-edit.pod:119
2717 #: ../edit/virt-edit.pod:121
2718 msgid "B<--expr> EXPR"
2722 #: ../edit/virt-edit.pod:123
2724 "Instead of launching the external editor, non-interactively apply the Perl "
2725 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2730 #: ../edit/virt-edit.pod:127
2732 "Be careful to properly quote the expression to prevent it from being altered "
2737 #: ../edit/virt-edit.pod:130
2738 msgid "Note that this option is only available when Perl 5 is installed."
2742 #: ../edit/virt-edit.pod:132
2743 msgid "B<--format> raw|qcow2|..."
2747 #: ../edit/virt-edit.pod:143
2750 " virt-edit --format=raw -a disk.img file\n"
2755 #: ../edit/virt-edit.pod:147
2758 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2763 #: ../edit/virt-edit.pod:181
2764 msgid "Previous versions of virt-edit allowed you to write either:"
2768 #: ../edit/virt-edit.pod:187
2771 " virt-edit guestname file\n"
2776 #: ../edit/virt-edit.pod:195
2777 msgid "NON-INTERACTIVE EDITING"
2781 #: ../edit/virt-edit.pod:197
2783 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2784 "administrator can interactively edit the file."
2788 #: ../edit/virt-edit.pod:200
2790 "There are two ways also to use C<virt-edit> from scripts in order to make "
2791 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2792 "like this, it's less error-prone to write scripts directly using the "
2793 "libguestfs API and Augeas for configuration file editing.)"
2797 #: ../edit/virt-edit.pod:206
2799 "The first method is to temporarily set C<$EDITOR> to any script or program "
2800 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2801 "update C<tmpfile> in place however it likes."
2805 #: ../edit/virt-edit.pod:210
2807 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2808 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2809 "instances of C<foo> with C<bar> in a file:"
2813 #: ../edit/virt-edit.pod:214
2816 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2821 #: ../edit/virt-edit.pod:216
2823 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2824 "For example to delete root's password you could do:"
2828 #: ../edit/virt-edit.pod:219
2831 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2836 #: ../edit/virt-edit.pod:221
2838 "What really happens is that the snippet is evaluated as a Perl expression "
2839 "for each line of the file. The line, including the final C<\\n>, is passed "
2840 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2844 #: ../edit/virt-edit.pod:226
2846 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2847 "C<apache> user account from the password file you can do:"
2851 #: ../edit/virt-edit.pod:229
2854 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2859 #: ../edit/virt-edit.pod:231
2861 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2862 "the end of the file is rather difficult this way since there is no concept "
2863 "of \"last line of the file\" - your expression just doesn't get called "
2864 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2869 #: ../edit/virt-edit.pod:237
2871 "The variable C<$lineno> contains the current line number. As is "
2872 "traditional, the first line in the file is number C<1>."
2876 #: ../edit/virt-edit.pod:240
2878 "The return value from the expression is ignored, but the expression may call "
2879 "C<die> in order to abort the whole program, leaving the original file "
2884 #: ../edit/virt-edit.pod:244
2886 "Remember when matching the end of a line that C<$_> may contain the final C<"
2887 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2888 "newline then neither of these. Thus to match or substitute some text at the "
2889 "end of a line, use this regular expression:"
2893 #: ../edit/virt-edit.pod:249
2896 " /some text(\\r?\\n)?$/\n"
2901 #: ../edit/virt-edit.pod:251
2903 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
2904 "$_> itself (since that would remove all newlines from the file):"
2908 #: ../edit/virt-edit.pod:255
2911 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2916 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2917 msgid "WINDOWS PATHS"
2921 #: ../edit/virt-edit.pod:259
2923 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2924 "paths (eg. C<E:\\foo\\bar.txt>)."
2928 #: ../edit/virt-edit.pod:262
2929 msgid "If and only if the guest is running Windows then:"
2933 #: ../edit/virt-edit.pod:268
2935 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2936 "to the correct filesystem."
2940 #: ../edit/virt-edit.pod:273
2942 "Any backslash (C<\\>) characters in the path are replaced with forward "
2943 "slashes so that libguestfs can process it."
2947 #: ../edit/virt-edit.pod:278
2949 "The path is resolved case insensitively to locate the file that should be "
2954 #: ../edit/virt-edit.pod:283
2955 msgid "There are some known shortcomings:"
2959 #: ../edit/virt-edit.pod:289
2960 msgid "Some NTFS symbolic links may not be followed correctly."
2964 #: ../edit/virt-edit.pod:293
2965 msgid "NTFS junction points that cross filesystems are not followed."
2969 #: ../edit/virt-edit.pod:299
2971 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2972 "C<virt-edit> doesn't work."
2976 #: ../edit/virt-edit.pod:302
2977 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2981 #: ../edit/virt-edit.pod:304
2984 " guestfish --rw -i -d domname edit /file\n"
2989 #: ../edit/virt-edit.pod:306
2991 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2996 #: ../edit/virt-edit.pod:309
2998 "The command above uses libguestfs's guest inspection feature and so does not "
2999 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
3000 "disk images that don't contain guests. To edit a file on a disk image "
3005 #: ../edit/virt-edit.pod:314
3008 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
3013 #: ../edit/virt-edit.pod:316
3015 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
3016 "the disk image to edit, and C</file> is the full path to the file."
3020 #: ../edit/virt-edit.pod:320
3022 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
3023 "C<write> or C<upload> instead:"
3027 #: ../edit/virt-edit.pod:323
3030 " guestfish --rw -i -d domname touch /newfile\n"
3035 #: ../edit/virt-edit.pod:325
3038 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3043 #: ../edit/virt-edit.pod:327
3046 " guestfish --rw -i -d domname upload localfile /newfile\n"
3051 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086
3052 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:3080
3053 #: ../test-tool/libguestfs-test-tool.pod:95
3054 msgid "ENVIRONMENT VARIABLES"
3058 #: ../edit/virt-edit.pod:333
3063 #: ../edit/virt-edit.pod:335
3065 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3070 #: ../edit/virt-edit.pod:338
3071 msgid "If not set, C<vi> is used."
3075 #: ../edit/virt-edit.pod:356
3077 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3078 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3079 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3083 #: ../erlang/examples/guestfs-erlang.pod:5
3084 msgid "guestfs-erlang - How to use libguestfs from Erlang"
3088 #: ../erlang/examples/guestfs-erlang.pod:9
3091 " {ok, G} = guestfs:create(),\n"
3092 " ok = guestfs:add_drive_opts(G, Disk,\n"
3093 " [{format, \"raw\"}, {readonly, true}]),\n"
3094 " ok = guestfs:launch(G),\n"
3095 " [Device] = guestfs:list_devices(G),\n"
3096 " ok = guestfs:close(G).\n"
3101 #: ../erlang/examples/guestfs-erlang.pod:18
3103 "This manual page documents how to call libguestfs from the Erlang "
3104 "programming language. This page just documents the differences from the C "
3105 "API and gives some examples. If you are not familiar with using libguestfs, "
3106 "you also need to read L<guestfs(3)>."
3110 #: ../erlang/examples/guestfs-erlang.pod:23
3111 msgid "OPENING AND CLOSING THE HANDLE"
3115 #: ../erlang/examples/guestfs-erlang.pod:25
3117 "The Erlang bindings are implemented using an external program called C<erl-"
3118 "guestfs>. This program must be on the current PATH, or else you should "
3119 "specify the full path to the program:"
3123 #: ../erlang/examples/guestfs-erlang.pod:29
3126 " {ok, G} = guestfs:create().\n"
3131 #: ../erlang/examples/guestfs-erlang.pod:31
3134 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
3139 #: ../erlang/examples/guestfs-erlang.pod:33
3140 msgid "C<G> is the libguestfs handle which you should pass to other functions."
3144 #: ../erlang/examples/guestfs-erlang.pod:36
3145 msgid "To close the handle:"
3149 #: ../erlang/examples/guestfs-erlang.pod:38
3152 " ok = guestfs:close(G).\n"
3157 #: ../erlang/examples/guestfs-erlang.pod:40
3158 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
3162 #: ../erlang/examples/guestfs-erlang.pod:42
3164 "For functions that take optional arguments, the first arguments are the non-"
3165 "optional ones. The last argument is a list of tuples supplying the "
3166 "remaining optional arguments."
3170 #: ../erlang/examples/guestfs-erlang.pod:46
3173 " ok = guestfs:add_drive_opts(G, Disk,\n"
3174 " [{format, \"raw\"}, {readonly, true}]).\n"
3179 #: ../erlang/examples/guestfs-erlang.pod:49
3180 msgid "If the last argument would be an empty list, you can also omit it:"
3184 #: ../erlang/examples/guestfs-erlang.pod:51
3187 " ok = guestfs:add_drive_opts(G, Disk).\n"
3192 #: ../erlang/examples/guestfs-erlang.pod:53
3193 msgid "RETURN VALUES AND ERRORS"
3197 #: ../erlang/examples/guestfs-erlang.pod:55
3199 "On success, most functions return a C<Result> term (which could be a list, "
3200 "string, tuple etc.). If there is nothing for the function to return, then "
3201 "the atom C<ok> is returned."
3205 #: ../erlang/examples/guestfs-erlang.pod:59
3206 msgid "On error, you would see one of the following tuples:"
3210 #: ../erlang/examples/guestfs-erlang.pod:63
3211 msgid "C<{error, Msg, Errno}>"
3215 #: ../erlang/examples/guestfs-erlang.pod:65
3216 msgid "This indicates an ordinary error from the function."
3220 #: ../erlang/examples/guestfs-erlang.pod:67
3222 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
3227 #: ../erlang/examples/guestfs-erlang.pod:70
3228 msgid "C<Errno> can be zero. See L<guestfs(3)/guestfs_last_errno>."
3232 #: ../erlang/examples/guestfs-erlang.pod:72
3233 msgid "C<{unknown, Function}>"
3237 #: ../erlang/examples/guestfs-erlang.pod:74
3239 "This indicates that the function you called is not known. Generally this "
3240 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
3241 "which you should not do."
3245 #: ../erlang/examples/guestfs-erlang.pod:78
3246 msgid "C<Function> is the name of the unknown function."
3250 #: ../erlang/examples/guestfs-erlang.pod:80
3251 msgid "C<{unknownarg, Arg}>"
3255 #: ../erlang/examples/guestfs-erlang.pod:82
3257 "This indicates that you called a function with optional arguments, with an "
3258 "unknown argument name."
3262 #: ../erlang/examples/guestfs-erlang.pod:85
3263 msgid "C<Arg> is the name of the unknown argument."
3267 #: ../erlang/examples/guestfs-erlang.pod:89
3268 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
3269 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3270 #: ../python/examples/guestfs-python.pod:34
3271 #: ../ruby/examples/guestfs-ruby.pod:28
3272 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3276 #: ../erlang/examples/guestfs-erlang.pod:91
3277 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
3278 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3279 #: ../python/examples/guestfs-python.pod:36
3280 #: ../ruby/examples/guestfs-ruby.pod:30
3285 #: ../erlang/examples/guestfs-erlang.pod:93
3286 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
3287 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3288 #: ../python/examples/guestfs-python.pod:38
3289 #: ../ruby/examples/guestfs-ruby.pod:32
3290 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3294 #: ../erlang/examples/guestfs-erlang.pod:95
3295 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
3296 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3297 #: ../python/examples/guestfs-python.pod:40
3298 #: ../ruby/examples/guestfs-ruby.pod:34
3303 #: ../erlang/examples/guestfs-erlang.pod:99
3305 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
3306 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
3307 "L<guestfs-ruby(3)>, L<http://www.erlang.org/>. L<http://libguestfs.org/>."
3311 #: ../erlang/examples/guestfs-erlang.pod:110
3312 #: ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397
3313 #: ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60
3314 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3315 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:319
3316 #: ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:58
3317 #: ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52
3318 #: ../python/examples/guestfs-python.pod:54
3319 #: ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3214
3320 #: ../test-tool/libguestfs-test-tool.pod:106
3325 #: ../erlang/examples/guestfs-erlang.pod:112
3326 #: ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399
3327 #: ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62
3328 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
3329 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:321
3330 #: ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93
3331 #: ../perl/examples/guestfs-perl.pod:54
3332 #: ../python/examples/guestfs-python.pod:56
3333 #: ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3216
3334 #: ../test-tool/libguestfs-test-tool.pod:108
3335 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
3339 #: ../erlang/examples/guestfs-erlang.pod:116
3340 #: ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
3341 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
3345 #: ../erlang/examples/guestfs-erlang.pod:118
3346 #: ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405
3347 #: ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99
3348 #: ../perl/examples/guestfs-perl.pod:60
3349 #: ../python/examples/guestfs-python.pod:62
3350 #: ../ruby/examples/guestfs-ruby.pod:56
3352 "The examples in this manual page may be freely copied, modified and "
3353 "distributed without any restrictions."
3357 #: ../erlang/examples/guestfs-erlang.pod:121
3358 #: ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408
3359 #: ../java/examples/guestfs-java.pod:69
3360 #: ../ocaml/examples/guestfs-ocaml.pod:102
3361 #: ../perl/examples/guestfs-perl.pod:63
3362 #: ../python/examples/guestfs-python.pod:65
3363 #: ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3223
3365 "This library is free software; you can redistribute it and/or modify it "
3366 "under the terms of the GNU Lesser General Public License as published by the "
3367 "Free Software Foundation; either version 2 of the License, or (at your "
3368 "option) any later version."
3372 #: ../erlang/examples/guestfs-erlang.pod:126
3373 #: ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413
3374 #: ../java/examples/guestfs-java.pod:74
3375 #: ../ocaml/examples/guestfs-ocaml.pod:107
3376 #: ../perl/examples/guestfs-perl.pod:68
3377 #: ../python/examples/guestfs-python.pod:70
3378 #: ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3228
3380 "This library is distributed in the hope that it will be useful, but WITHOUT "
3381 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3382 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3387 #: ../erlang/examples/guestfs-erlang.pod:131
3388 #: ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418
3389 #: ../java/examples/guestfs-java.pod:79
3390 #: ../ocaml/examples/guestfs-ocaml.pod:112
3391 #: ../perl/examples/guestfs-perl.pod:73
3392 #: ../python/examples/guestfs-python.pod:75
3393 #: ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3233
3395 "You should have received a copy of the GNU Lesser General Public License "
3396 "along with this library; if not, write to the Free Software Foundation, "
3397 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3401 #: ../examples/guestfs-examples.pod:5
3402 msgid "guestfs-examples - Examples of using libguestfs from C"
3406 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3409 " #include <guestfs.h>\n"
3414 #: ../examples/guestfs-examples.pod:11
3417 " guestfs_h *g = guestfs_create ();\n"
3418 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3419 " guestfs_launch (g);\n"
3424 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3427 " cc prog.c -o prog -lguestfs\n"
3429 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3434 #: ../examples/guestfs-examples.pod:21
3436 "This manual page contains examples of calling libguestfs from the C "
3437 "programming language. If you are not familiar with using libguestfs, you "
3438 "also need to read L<guestfs(3)>."
3442 #: ../examples/guestfs-examples.pod:35
3444 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
3445 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
3446 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3450 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97
3451 #: ../python/examples/guestfs-python.pod:60
3452 #: ../ruby/examples/guestfs-ruby.pod:54
3453 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3457 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3462 #: ../examples/guestfs-recipes.pod:5
3464 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3465 "here. The only way which works for both sorts of output is to just write "
3466 "the URL directly. Do NOT use L<...> for URLs."
3470 #: ../examples/guestfs-recipes.pod:9
3472 "We break with tradition here and don't use ALL CAPS for the section "
3473 "headings, as this makes them much easier to read."
3477 #: ../examples/guestfs-recipes.pod:16
3478 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3482 #: ../examples/guestfs-recipes.pod:20
3484 "This page contains recipes for and links to things you can do using "
3485 "libguestfs, L<guestfish(1)> and the virt tools."
3489 #: ../examples/guestfs-recipes.pod:23
3490 msgid "Audit a virtual machine for setuid files"
3494 #: ../examples/guestfs-recipes.pod:25
3496 "The link below contains a small program which can be used to audit a Linux "
3497 "virtual machine to see what setuid and setgid files it contains."
3501 #: ../examples/guestfs-recipes.pod:28
3503 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
3508 #: ../examples/guestfs-recipes.pod:30
3509 msgid "Change the background image in a Windows XP VM"
3513 #: ../examples/guestfs-recipes.pod:32
3515 "The links below explain how to use L<guestfish(1)> to change the background "
3516 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3517 "be substantially different for each version of Windows."
3521 #: ../examples/guestfs-recipes.pod:37
3523 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
3524 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3528 #: ../examples/guestfs-recipes.pod:40
3529 msgid "Cloning a virtual machine (Linux)"
3533 #: ../examples/guestfs-recipes.pod:42
3535 "The guestfish technique described in the link below works well for most "
3536 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3541 #: ../examples/guestfs-recipes.pod:46
3543 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
3548 #: ../examples/guestfs-recipes.pod:48
3550 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3555 #: ../examples/guestfs-recipes.pod:51
3556 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3560 #: ../examples/guestfs-recipes.pod:53
3561 msgid "Cloning a virtual machine (Windows)"
3565 #: ../examples/guestfs-recipes.pod:55
3567 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3568 "straightforward. Currently there is code in the Aeolus Oz project which "
3569 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3570 "we may add sysprepping ability."
3574 #: ../examples/guestfs-recipes.pod:60
3576 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
3577 "list/2011-May/msg00019.html"
3581 #: ../examples/guestfs-recipes.pod:63
3582 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3586 #: ../examples/guestfs-recipes.pod:65
3587 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3591 #: ../examples/guestfs-recipes.pod:67
3594 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3599 #: ../examples/guestfs-recipes.pod:69
3600 msgid "To export just a subdirectory, eg. C</files>, do:"
3604 #: ../examples/guestfs-recipes.pod:71
3607 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3612 #: ../examples/guestfs-recipes.pod:73
3613 msgid "Create empty disk images"
3617 #: ../examples/guestfs-recipes.pod:75
3619 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3620 "The useful guide below explains the options available."
3624 #: ../examples/guestfs-recipes.pod:78
3626 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
3631 #: ../examples/guestfs-recipes.pod:80
3632 msgid "Dump raw filesystem content from inside a disk image or VM"
3636 #: ../examples/guestfs-recipes.pod:82
3638 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3639 "filesystem content from any filesystem in a disk image or a VM (even one "
3640 "which is encrypted or buried inside an LV):"
3644 #: ../examples/guestfs-recipes.pod:86
3647 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3652 #: ../examples/guestfs-recipes.pod:88
3655 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3660 #: ../examples/guestfs-recipes.pod:90
3661 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3665 #: ../examples/guestfs-recipes.pod:92
3666 msgid "Edit grub configuration in a VM"
3670 #: ../examples/guestfs-recipes.pod:94
3671 msgid "You can use this to:"
3675 #: ../examples/guestfs-recipes.pod:100
3676 msgid "Fix a virtual machine that does not boot."
3680 #: ../examples/guestfs-recipes.pod:104
3681 msgid "Change which kernel is used to boot the VM."
3685 #: ../examples/guestfs-recipes.pod:108
3686 msgid "Change kernel command line options."
3690 #: ../examples/guestfs-recipes.pod:112
3691 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3695 #: ../examples/guestfs-recipes.pod:114
3698 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3703 #: ../examples/guestfs-recipes.pod:116
3705 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3710 #: ../examples/guestfs-recipes.pod:119
3713 " virt-rescue -d BrokenGuest\n"
3718 #: ../examples/guestfs-recipes.pod:121
3719 msgid "Export any directory from a VM"
3723 #: ../examples/guestfs-recipes.pod:123
3725 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3729 #: ../examples/guestfs-recipes.pod:126
3732 " virt-copy-out -d Guest /home .\n"
3737 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
3738 #: ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod:1551
3739 #: ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:18
3740 #: ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:2335
3741 #: ../src/guestfs-actions.pod:2886 ../src/guestfs.pod:1644
3742 #: ../tools/virt-win-reg.pl:706
3747 #: ../examples/guestfs-recipes.pod:134
3749 "The final dot of the command is not a printing error. It means we want to "
3750 "copy out to the current directory."
3754 #: ../examples/guestfs-recipes.pod:139
3755 msgid "This creates a directory called C<home> under the current directory."
3759 #: ../examples/guestfs-recipes.pod:143
3761 "If the guest is a Windows guest then you can use drive letters and "
3762 "backslashes, but you must prefix the path with C<win:> and quote it to "
3763 "protect it from the shell, like this:"
3767 #: ../examples/guestfs-recipes.pod:147
3770 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3775 #: ../examples/guestfs-recipes.pod:149
3776 msgid "To get the output as a compressed tarball, do:"
3780 #: ../examples/guestfs-recipes.pod:151
3783 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3788 #: ../examples/guestfs-recipes.pod:153
3790 "Although it sounds tempting, this is usually not a reliable way to get a "
3791 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
3792 "org/FAQ.html#backup"
3796 #: ../examples/guestfs-recipes.pod:157
3797 msgid "Find out which user is using the most space"
3801 #: ../examples/guestfs-recipes.pod:159
3803 "This simple script examines a Linux guest to find out which user is using "
3804 "the most space in their home directory:"
3808 #: ../examples/guestfs-recipes.pod:162
3816 #: ../examples/guestfs-recipes.pod:164
3824 #: ../examples/guestfs-recipes.pod:166
3833 #: ../examples/guestfs-recipes.pod:169
3836 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3841 #: ../examples/guestfs-recipes.pod:171
3844 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3845 " echo -n \"$dir/$d\"\n"
3847 " guestfish --remote du \"$dir/$d\";\n"
3848 " done | sort -nr -k 2\n"
3853 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3856 " guestfish --remote exit\n"
3861 #: ../examples/guestfs-recipes.pod:179
3862 msgid "Get DHCP address from a VM"
3866 #: ../examples/guestfs-recipes.pod:181
3868 "The link below explains the many different possible techniques for getting "
3869 "the last assigned DHCP address of a virtual machine."
3873 #: ../examples/guestfs-recipes.pod:184
3875 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
3876 "a-virtual-machine-disk-image/#content"
3880 #: ../examples/guestfs-recipes.pod:186
3882 "In the libguestfs source examples directory you will find the latest version "
3883 "of the C<virt-dhcp-address.c> program."
3887 #: ../examples/guestfs-recipes.pod:189
3888 msgid "Get the operating system product name string"
3892 #: ../examples/guestfs-recipes.pod:191
3893 msgid "Save the following script into a file called C<product-name.sh>:"
3897 #: ../examples/guestfs-recipes.pod:193
3902 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3903 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3904 " guestfish --remote inspect-get-product-name \"$root\"\n"
3905 " guestfish --remote exit\n"
3910 #: ../examples/guestfs-recipes.pod:200
3911 msgid "Make the script executable and run it on a named guest:"
3915 #: ../examples/guestfs-recipes.pod:202
3918 " # product-name.sh RHEL60x64\n"
3919 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3924 #: ../examples/guestfs-recipes.pod:205
3926 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3927 "C<xpath> command line tool or from your favourite programming language:"
3931 #: ../examples/guestfs-recipes.pod:209
3934 " # virt-inspector RHEL60x64 > xml\n"
3935 " # xpath '//product_name' < xml\n"
3938 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
3943 #: ../examples/guestfs-recipes.pod:215
3944 msgid "Get the default boot kernel for a Linux VM"
3948 #: ../examples/guestfs-recipes.pod:217
3950 "The link below contains a program to print the default boot kernel for a "
3955 #: ../examples/guestfs-recipes.pod:220
3957 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
3958 "kernel-for-a-vm/#content"
3962 #: ../examples/guestfs-recipes.pod:222
3964 "It uses Augeas, and the technique is generally applicable for many different "
3969 #: ../examples/guestfs-recipes.pod:229
3970 msgid "listing the user accounts in the guest"
3974 #: ../examples/guestfs-recipes.pod:233
3975 msgid "what repositories is it configured to use"
3979 #: ../examples/guestfs-recipes.pod:237
3980 msgid "what NTP servers does it connect to"
3984 #: ../examples/guestfs-recipes.pod:241
3985 msgid "what were the boot messages last time it booted"
3989 #: ../examples/guestfs-recipes.pod:245
3990 msgid "listing who was logged in recently"
3994 #: ../examples/guestfs-recipes.pod:249
3995 msgid "http://augeas.net/"
3999 #: ../examples/guestfs-recipes.pod:251
4000 msgid "Install RPMs in a guest"
4004 #: ../examples/guestfs-recipes.pod:253
4006 "The link below contains a method to install RPMs in a guest. In fact the "
4007 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
4008 "installs them next time the guest is booted. You could use this technique "
4009 "to install vital security updates in an offline guest."
4013 #: ../examples/guestfs-recipes.pod:259
4015 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
4019 #: ../examples/guestfs-recipes.pod:261
4020 msgid "List applications installed in a VM"
4024 #: ../examples/guestfs-recipes.pod:263
4025 msgid "Save the following to a file C<list-apps.sh>:"
4029 #: ../examples/guestfs-recipes.pod:265
4034 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4035 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4036 " guestfish --remote inspect-list-applications \"$root\"\n"
4037 " guestfish --remote exit\n"
4042 #: ../examples/guestfs-recipes.pod:272
4044 "Make the file executable and then you can run it on any named virtual "
4049 #: ../examples/guestfs-recipes.pod:275
4052 " # list-apps.sh WinGuest\n"
4054 " app_name: Mozilla Firefox (3.6.12)\n"
4055 " app_display_name: Mozilla Firefox (3.6.12)\n"
4057 " app_version: 3.6.12 (en-GB)\n"
4059 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
4060 " app_trans_path:\n"
4061 " app_publisher: Mozilla\n"
4062 " app_url: http://www.mozilla.com/en-GB/\n"
4063 " app_source_package:\n"
4065 " app_description: Mozilla Firefox\n"
4068 " app_name: VLC media player\n"
4069 " app_display_name: VLC media player 1.1.5\n"
4071 " app_version: 1.1.5\n"
4073 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
4074 " app_trans_path:\n"
4075 " app_publisher: VideoLAN\n"
4076 " app_url: http://www.videolan.org/\n"
4077 " app_source_package:\n"
4079 " app_description:\n"
4085 #: ../examples/guestfs-recipes.pod:305
4087 "If you want to run the script on disk images (instead of libvirt virtual "
4088 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
4093 #: ../examples/guestfs-recipes.pod:309
4094 msgid "List files and directories in a VM"
4098 #: ../examples/guestfs-recipes.pod:311
4099 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
4103 #: ../examples/guestfs-recipes.pod:313
4106 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
4111 #: ../examples/guestfs-recipes.pod:315
4112 msgid "List services in a Windows VM"
4116 #: ../examples/guestfs-recipes.pod:317
4118 "The link below contains a script that can be used to list out the services "
4119 "from a Windows VM, and whether those services run at boot time or are loaded "
4124 #: ../examples/guestfs-recipes.pod:321
4126 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
4131 #: ../examples/guestfs-recipes.pod:323
4132 msgid "Make a disk image sparse"
4136 #: ../examples/guestfs-recipes.pod:325
4138 "The link below contains some guides for making a disk image sparse (or "
4139 "reintroducing sparseness)."
4143 #: ../examples/guestfs-recipes.pod:328
4145 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
4149 #: ../examples/guestfs-recipes.pod:330
4150 msgid "Monitor disk usage over time"
4154 #: ../examples/guestfs-recipes.pod:332
4156 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
4157 "The link below contains a guide."
4161 #: ../examples/guestfs-recipes.pod:335
4162 msgid "http://virt-tools.org/learning/advanced-virt-df/"
4166 #: ../examples/guestfs-recipes.pod:337
4167 msgid "Reading the Windows Event Log from Windows Vista (or later)"
4171 #: ../examples/guestfs-recipes.pod:339
4173 "L<guestfish(1)> plus the tools described in the link below can be used to "
4174 "read out the Windows Event Log from any virtual machine running Windows "
4175 "Vista or a later version."
4179 #: ../examples/guestfs-recipes.pod:343
4181 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
4182 "guestfish/#content"
4186 #: ../examples/guestfs-recipes.pod:345
4187 msgid "Remove root password (Linux)"
4191 #: ../examples/guestfs-recipes.pod:347
4193 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
4194 "files. One use is to remove the root password from a Linux guest:"
4198 #: ../examples/guestfs-recipes.pod:350
4201 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
4206 #: ../examples/guestfs-recipes.pod:352
4207 msgid "Remove Administrator password (Windows)"
4211 #: ../examples/guestfs-recipes.pod:354
4213 "The link below contains one technique for removing the Administrator "
4214 "password from a Windows VM, or to be more precise, it gives you a command "
4215 "prompt the next time you log in which you can use to bypass any security:"
4219 #: ../examples/guestfs-recipes.pod:359
4221 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
4222 "administrator-password-with-guestfish/"
4226 #: ../examples/guestfs-recipes.pod:361
4227 msgid "Unpack a live CD"
4231 #: ../examples/guestfs-recipes.pod:363
4233 "Linux live CDs often contain multiple layers of disk images wrapped like a "
4234 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
4235 "layers, as outlined in the guide below."
4239 #: ../examples/guestfs-recipes.pod:367
4241 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
4246 #: ../examples/guestfs-recipes.pod:369
4247 msgid "Uploading and downloading files"
4251 #: ../examples/guestfs-recipes.pod:371
4253 "The link below contains general tips on uploading (copying in) and "
4254 "downloading (copying out) files from VMs."
4258 #: ../examples/guestfs-recipes.pod:374
4260 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
4264 #: ../examples/guestfs-recipes.pod:376
4265 msgid "Use libguestfs tools on VMware ESX guests"
4269 #: ../examples/guestfs-recipes.pod:378
4271 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
4272 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
4276 #: ../examples/guestfs-recipes.pod:382
4278 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
4283 #: ../examples/guestfs-recipes.pod:386
4285 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)"
4286 ">, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
4287 "python(3)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
4291 #: ../examples/guestfs-recipes.pod:403
4292 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
4296 #: ../fish/guestfish-actions.pod:1
4301 #: ../fish/guestfish-actions.pod:3
4304 " add-cdrom filename\n"
4309 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
4310 msgid "This function adds a virtual CD-ROM disk image to the guest."
4314 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
4315 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
4319 #: ../fish/guestfish-actions.pod:15
4321 "This call checks for the existence of C<filename>. This stops you from "
4322 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4323 "and C<http:> URLs. To specify those, use the general L</config> call "
4328 #: ../fish/guestfish-actions.pod:22
4330 "If you just want to add an ISO file (often you use this as an efficient way "
4331 "to transfer large files into the guest), then you should probably use L</add-"
4332 "drive-ro> instead."
4336 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
4337 #: ../fish/guestfish-actions.pod:177
4339 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
4344 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
4345 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:991
4346 #: ../fish/guestfish-actions.pod:1351 ../fish/guestfish-actions.pod:1365
4347 #: ../fish/guestfish-actions.pod:3116 ../fish/guestfish-actions.pod:3323
4348 #: ../fish/guestfish-actions.pod:3437 ../fish/guestfish-actions.pod:3485
4349 #: ../fish/guestfish-actions.pod:4386 ../fish/guestfish-actions.pod:4409
4350 #: ../fish/guestfish-actions.pod:4431 ../fish/guestfish-actions.pod:4469
4351 #: ../fish/guestfish-actions.pod:5118 ../fish/guestfish-actions.pod:5224
4352 #: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:252
4353 #: ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:1508
4354 #: ../src/guestfs-actions.pod:2007 ../src/guestfs-actions.pod:2028
4355 #: ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4952
4356 #: ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5281
4357 #: ../src/guestfs-actions.pod:6547 ../src/guestfs-actions.pod:6591
4358 #: ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6688
4359 #: ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7729
4360 #: ../src/guestfs-actions.pod:7912
4362 "Deprecated functions will not be removed from the API, but the fact that "
4363 "they are deprecated indicates that there are problems with correct use of "
4368 #: ../fish/guestfish-actions.pod:35
4373 #: ../fish/guestfish-actions.pod:37
4378 #: ../fish/guestfish-actions.pod:39
4381 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
4386 #: ../fish/guestfish-actions.pod:41
4388 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4389 "It works by connecting to libvirt, requesting the domain and domain XML from "
4390 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
4394 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
4396 "The number of disks added is returned. This operation is atomic: if an "
4397 "error is returned, then no disks are added."
4401 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
4403 "This function does some minimal checks to make sure the libvirt domain is "
4404 "not running (unless C<readonly> is true). In a future version we will try "
4405 "to acquire the libvirt lock on each disk."
4409 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
4411 "Disks must be accessible locally. This often means that adding disks from a "
4412 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4413 "unless those disks are accessible via the same device path locally too."
4417 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
4419 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4420 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4421 "libvirt URI (or one set through an environment variable, see the libvirt "
4422 "documentation for full details)."
4426 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
4428 "The optional C<live> flag controls whether this call will try to connect to "
4429 "a running virtual machine C<guestfsd> process if it sees a suitable "
4430 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4431 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4432 "DAEMONS> for more information."
4436 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4438 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4439 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4440 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4445 #: ../fish/guestfish-actions.pod:76
4447 "The other optional parameters are passed directly through to L</add-drive-"
4452 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
4453 #: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1999
4454 #: ../fish/guestfish-actions.pod:3165 ../fish/guestfish-actions.pod:3338
4455 #: ../fish/guestfish-actions.pod:3473
4457 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
4461 #: ../fish/guestfish-actions.pod:81
4466 #: ../fish/guestfish-actions.pod:83
4469 " add-drive filename\n"
4474 #: ../fish/guestfish-actions.pod:85
4476 "This function is the equivalent of calling L</add-drive-opts> with no "
4477 "optional parameters, so the disk is added writable, with the format being "
4478 "detected automatically."
4482 #: ../fish/guestfish-actions.pod:89
4484 "Automatic detection of the format opens you up to a potential security hole "
4485 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4486 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4487 "you should think about replacing calls to this function with calls to L</add-"
4488 "drive-opts>, and specifying the format."
4492 #: ../fish/guestfish-actions.pod:96
4493 msgid "add-drive-opts"
4497 #: ../fish/guestfish-actions.pod:98
4502 #: ../fish/guestfish-actions.pod:100
4505 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4510 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4512 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4513 "The first time you call this function, the disk appears as C</dev/sda>, the "
4514 "second time as C</dev/sdb>, and so on."
4518 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4520 "You don't necessarily need to be root when using libguestfs. However you "
4521 "obviously do need sufficient permissions to access the filename for whatever "
4522 "operations you want to perform (ie. read access if you just want to read the "
4523 "image or write access if you want to modify the image)."
4527 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4528 msgid "This call checks that C<filename> exists."
4532 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3127
4533 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4686
4534 msgid "The optional arguments are:"
4538 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4543 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4545 "If true then the image is treated as read-only. Writes are still allowed, "
4546 "but they are stored in a temporary snapshot overlay which is discarded at "
4547 "the end. The disk that you add is not modified."
4551 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4556 #: ../fish/guestfish-actions.pod:127
4558 "This forces the image format. If you omit this (or use L</add-drive> or L</"
4559 "add-drive-ro>) then the format is automatically detected. Possible formats "
4560 "include C<raw> and C<qcow2>."
4564 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4566 "Automatic detection of the format opens you up to a potential security hole "
4567 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4568 "RHBZ#642934. Specifying the format closes this security hole."
4572 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4577 #: ../fish/guestfish-actions.pod:138
4579 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
4580 "add-drive-with-if> call (q.v.)"
4584 #: ../fish/guestfish-actions.pod:145
4585 msgid "add-drive-ro"
4589 #: ../fish/guestfish-actions.pod:147
4594 #: ../fish/guestfish-actions.pod:149
4597 " add-drive-ro filename\n"
4602 #: ../fish/guestfish-actions.pod:151
4604 "This function is the equivalent of calling L</add-drive-opts> with the "
4605 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4606 "is added read-only, with the format being detected automatically."
4610 #: ../fish/guestfish-actions.pod:156
4611 msgid "add-drive-ro-with-if"
4615 #: ../fish/guestfish-actions.pod:158
4618 " add-drive-ro-with-if filename iface\n"
4623 #: ../fish/guestfish-actions.pod:160
4625 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4626 "interface emulation to use at run time."
4630 #: ../fish/guestfish-actions.pod:170
4631 msgid "add-drive-with-if"
4635 #: ../fish/guestfish-actions.pod:172
4638 " add-drive-with-if filename iface\n"
4643 #: ../fish/guestfish-actions.pod:174
4645 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4646 "interface emulation to use at run time."
4650 #: ../fish/guestfish-actions.pod:184
4655 #: ../fish/guestfish-actions.pod:186
4658 " aug-clear augpath\n"
4663 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4665 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4666 "L<augtool(1)> C<clear> command."
4670 #: ../fish/guestfish-actions.pod:191
4675 #: ../fish/guestfish-actions.pod:193
4683 #: ../fish/guestfish-actions.pod:195
4685 "Close the current Augeas handle and free up any resources used by it. After "
4686 "calling this, you have to call L</aug-init> again before you can use any "
4687 "other Augeas functions."
4691 #: ../fish/guestfish-actions.pod:200
4696 #: ../fish/guestfish-actions.pod:202
4699 " aug-defnode name expr val\n"
4704 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4706 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4710 #: ../fish/guestfish-actions.pod:207
4712 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4713 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4714 "containing that single node."
4718 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4720 "On success this returns a pair containing the number of nodes in the "
4721 "nodeset, and a boolean flag if a node was created."
4725 #: ../fish/guestfish-actions.pod:215
4730 #: ../fish/guestfish-actions.pod:217
4733 " aug-defvar name expr\n"
4738 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4740 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4741 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4745 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4747 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4748 "evaluates to something which is not a nodeset."
4752 #: ../fish/guestfish-actions.pod:226
4757 #: ../fish/guestfish-actions.pod:228
4760 " aug-get augpath\n"
4765 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4767 "Look up the value associated with C<path>. If C<path> matches exactly one "
4768 "node, the C<value> is returned."
4772 #: ../fish/guestfish-actions.pod:233
4777 #: ../fish/guestfish-actions.pod:235
4780 " aug-init root flags\n"
4785 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4787 "Create a new Augeas handle for editing configuration files. If there was "
4788 "any previous Augeas handle associated with this guestfs session, then it is "
4793 #: ../fish/guestfish-actions.pod:241
4794 msgid "You must call this before using any other L</aug-*> commands."
4798 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4800 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4804 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4806 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4807 "logical I<or> of the following integers:"
4811 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4812 msgid "C<AUG_SAVE_BACKUP> = 1"
4816 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4817 msgid "Keep the original file with a C<.augsave> extension."
4821 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4822 msgid "C<AUG_SAVE_NEWFILE> = 2"
4826 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4828 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4829 "original. Overrides C<AUG_SAVE_BACKUP>."
4833 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4834 msgid "C<AUG_TYPE_CHECK> = 4"
4838 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4839 msgid "Typecheck lenses."
4843 #: ../fish/guestfish-actions.pod:266
4845 "This option is only useful when debugging Augeas lenses. Use of this option "
4846 "may require additional memory for the libguestfs appliance. You may need to "
4847 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4851 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4852 msgid "C<AUG_NO_STDINC> = 8"
4856 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4857 msgid "Do not use standard load path for modules."
4861 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4862 msgid "C<AUG_SAVE_NOOP> = 16"
4866 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4867 msgid "Make save a no-op, just record what would have been changed."
4871 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4872 msgid "C<AUG_NO_LOAD> = 32"
4876 #: ../fish/guestfish-actions.pod:281
4877 msgid "Do not load the tree in L</aug-init>."
4881 #: ../fish/guestfish-actions.pod:285
4882 msgid "To close the handle, you can call L</aug-close>."
4886 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4887 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4891 #: ../fish/guestfish-actions.pod:289
4896 #: ../fish/guestfish-actions.pod:291
4899 " aug-insert augpath label true|false\n"
4904 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4906 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4907 "or after C<path> (depending on the boolean flag C<before>)."
4911 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4913 "C<path> must match exactly one existing node in the tree, and C<label> must "
4914 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4918 #: ../fish/guestfish-actions.pod:301
4923 #: ../fish/guestfish-actions.pod:303
4931 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4932 msgid "Load files into the tree."
4936 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4937 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4941 #: ../fish/guestfish-actions.pod:310
4946 #: ../fish/guestfish-actions.pod:312
4954 #: ../fish/guestfish-actions.pod:314
4956 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4957 "resulting nodes into alphabetical order."
4961 #: ../fish/guestfish-actions.pod:317
4966 #: ../fish/guestfish-actions.pod:319
4969 " aug-match augpath\n"
4974 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4976 "Returns a list of paths which match the path expression C<path>. The "
4977 "returned paths are sufficiently qualified so that they match exactly one "
4978 "node in the current tree."
4982 #: ../fish/guestfish-actions.pod:325
4987 #: ../fish/guestfish-actions.pod:327
4990 " aug-mv src dest\n"
4995 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4997 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4998 "C<dest> is overwritten if it exists."
5002 #: ../fish/guestfish-actions.pod:332
5007 #: ../fish/guestfish-actions.pod:334
5015 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
5016 msgid "Remove C<path> and all of its children."
5020 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
5021 msgid "On success this returns the number of entries which were removed."
5025 #: ../fish/guestfish-actions.pod:340
5030 #: ../fish/guestfish-actions.pod:342
5038 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
5039 msgid "This writes all pending changes to disk."
5043 #: ../fish/guestfish-actions.pod:346
5045 "The flags which were passed to L</aug-init> affect exactly how files are "
5050 #: ../fish/guestfish-actions.pod:349
5055 #: ../fish/guestfish-actions.pod:351
5058 " aug-set augpath val\n"
5063 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
5064 msgid "Set the value associated with C<path> to C<val>."
5068 #: ../fish/guestfish-actions.pod:355
5070 "In the Augeas API, it is possible to clear a node by setting the value to "
5071 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5072 "this call. Instead you must use the L</aug-clear> call."
5076 #: ../fish/guestfish-actions.pod:360
5081 #: ../fish/guestfish-actions.pod:362
5084 " available 'groups ...'\n"
5089 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
5091 "This command is used to check the availability of some groups of "
5092 "functionality in the appliance, which not all builds of the libguestfs "
5093 "appliance will be able to provide."
5097 #: ../fish/guestfish-actions.pod:368
5099 "The libguestfs groups, and the functions that those groups correspond to, "
5100 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5101 "runtime by calling L</available-all-groups>."
5105 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
5107 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5108 "\"]> would check for the availability of the Linux inotify functions and "
5109 "Augeas (configuration file editing) functions."
5113 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
5114 msgid "The command returns no error if I<all> requested groups are available."
5118 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
5120 "It fails with an error if one or more of the requested groups is unavailable "
5125 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
5127 "If an unknown group name is included in the list of groups then an error is "
5132 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
5137 #: ../fish/guestfish-actions.pod:392
5138 msgid "You must call L</launch> before calling this function."
5142 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
5144 "The reason is because we don't know what groups are supported by the "
5145 "appliance/daemon until it is running and can be queried."
5149 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
5151 "If a group of functions is available, this does not necessarily mean that "
5152 "they will work. You still have to check for errors when calling individual "
5153 "API functions even if they are available."
5157 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
5159 "It is usually the job of distro packagers to build complete functionality "
5160 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5161 "with all requirements satisfied, will support everything."
5165 #: ../fish/guestfish-actions.pod:414
5167 "This call was added in version C<1.0.80>. In previous versions of "
5168 "libguestfs all you could do would be to speculatively execute a command to "
5169 "find out if the daemon implemented it. See also L</version>."
5173 #: ../fish/guestfish-actions.pod:421
5174 msgid "available-all-groups"
5178 #: ../fish/guestfish-actions.pod:423
5181 " available-all-groups\n"
5186 #: ../fish/guestfish-actions.pod:425
5188 "This command returns a list of all optional groups that this daemon knows "
5189 "about. Note this returns both supported and unsupported groups. To find "
5190 "out which ones the daemon can actually support you have to call L</"
5191 "available> on each member of the returned list."
5195 #: ../fish/guestfish-actions.pod:431
5196 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
5200 #: ../fish/guestfish-actions.pod:433
5205 #: ../fish/guestfish-actions.pod:435
5208 " base64-in (base64file|-) filename\n"
5213 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
5215 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5219 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449
5220 #: ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:867
5221 #: ../fish/guestfish-actions.pod:886 ../fish/guestfish-actions.pod:1260
5222 #: ../fish/guestfish-actions.pod:4689 ../fish/guestfish-actions.pod:4701
5223 #: ../fish/guestfish-actions.pod:4712 ../fish/guestfish-actions.pod:4723
5224 #: ../fish/guestfish-actions.pod:4775 ../fish/guestfish-actions.pod:4784
5225 #: ../fish/guestfish-actions.pod:4838 ../fish/guestfish-actions.pod:4861
5226 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
5230 #: ../fish/guestfish-actions.pod:442
5235 #: ../fish/guestfish-actions.pod:444
5238 " base64-out filename (base64file|-)\n"
5243 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
5245 "This command downloads the contents of C<filename>, writing it out to local "
5246 "file C<base64file> encoded as base64."
5250 #: ../fish/guestfish-actions.pod:451
5251 msgid "blockdev-flushbufs"
5255 #: ../fish/guestfish-actions.pod:453
5258 " blockdev-flushbufs device\n"
5263 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
5265 "This tells the kernel to flush internal buffers associated with C<device>."
5269 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469
5270 #: ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488
5271 #: ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513
5272 #: ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532
5273 #: ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548
5274 #: ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696
5275 #: ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727
5276 #: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764
5277 #: ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796
5278 #: ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
5279 msgid "This uses the L<blockdev(8)> command."
5283 #: ../fish/guestfish-actions.pod:460
5284 msgid "blockdev-getbsz"
5288 #: ../fish/guestfish-actions.pod:462
5291 " blockdev-getbsz device\n"
5296 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
5297 msgid "This returns the block size of a device."
5301 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529
5302 #: ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
5304 "(Note this is different from both I<size in blocks> and I<filesystem block "
5309 #: ../fish/guestfish-actions.pod:471
5310 msgid "blockdev-getro"
5314 #: ../fish/guestfish-actions.pod:473
5317 " blockdev-getro device\n"
5322 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
5324 "Returns a boolean indicating if the block device is read-only (true if read-"
5325 "only, false if not)."
5329 #: ../fish/guestfish-actions.pod:480
5330 msgid "blockdev-getsize64"
5334 #: ../fish/guestfish-actions.pod:482
5337 " blockdev-getsize64 device\n"
5342 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
5343 msgid "This returns the size of the device in bytes."
5347 #: ../fish/guestfish-actions.pod:486
5348 msgid "See also L</blockdev-getsz>."
5352 #: ../fish/guestfish-actions.pod:490
5353 msgid "blockdev-getss"
5357 #: ../fish/guestfish-actions.pod:492
5360 " blockdev-getss device\n"
5365 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
5367 "This returns the size of sectors on a block device. Usually 512, but can be "
5368 "larger for modern devices."
5372 #: ../fish/guestfish-actions.pod:497
5374 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
5378 #: ../fish/guestfish-actions.pod:502
5379 msgid "blockdev-getsz"
5383 #: ../fish/guestfish-actions.pod:504
5386 " blockdev-getsz device\n"
5391 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
5393 "This returns the size of the device in units of 512-byte sectors (even if "
5394 "the sectorsize isn't 512 bytes ... weird)."
5398 #: ../fish/guestfish-actions.pod:509
5400 "See also L</blockdev-getss> for the real sector size of the device, and L</"
5401 "blockdev-getsize64> for the more useful I<size in bytes>."
5405 #: ../fish/guestfish-actions.pod:515
5406 msgid "blockdev-rereadpt"
5410 #: ../fish/guestfish-actions.pod:517
5413 " blockdev-rereadpt device\n"
5418 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
5419 msgid "Reread the partition table on C<device>."
5423 #: ../fish/guestfish-actions.pod:523
5424 msgid "blockdev-setbsz"
5428 #: ../fish/guestfish-actions.pod:525
5431 " blockdev-setbsz device blocksize\n"
5436 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
5437 msgid "This sets the block size of a device."
5441 #: ../fish/guestfish-actions.pod:534
5442 msgid "blockdev-setro"
5446 #: ../fish/guestfish-actions.pod:536
5449 " blockdev-setro device\n"
5454 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
5455 msgid "Sets the block device named C<device> to read-only."
5459 #: ../fish/guestfish-actions.pod:542
5460 msgid "blockdev-setrw"
5464 #: ../fish/guestfish-actions.pod:544
5467 " blockdev-setrw device\n"
5472 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
5473 msgid "Sets the block device named C<device> to read-write."
5477 #: ../fish/guestfish-actions.pod:550
5478 msgid "btrfs-filesystem-resize"
5482 #: ../fish/guestfish-actions.pod:552
5485 " btrfs-filesystem-resize mountpoint [size:..]\n"
5490 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
5491 msgid "This command resizes a btrfs filesystem."
5495 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
5497 "Note that unlike other resize calls, the filesystem has to be mounted and "
5498 "the parameter is the mountpoint not the device (this is a requirement of "
5503 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3448
5504 #: ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5220
5505 msgid "The optional parameters are:"
5509 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3452
5510 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5224
5515 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5517 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
5518 "resized to the maximum size."
5522 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
5523 msgid "See also L<btrfs(8)>."
5527 #: ../fish/guestfish-actions.pod:575
5528 msgid "case-sensitive-path"
5532 #: ../fish/guestfish-actions.pod:577
5535 " case-sensitive-path path\n"
5540 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5542 "This can be used to resolve case insensitive paths on a filesystem which is "
5543 "case sensitive. The use case is to resolve paths which you have read from "
5544 "Windows configuration files or the Windows Registry, to the true path."
5548 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5550 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5551 "(and probably others), which is that although the underlying filesystem is "
5552 "case-insensitive, the driver exports the filesystem to Linux as case-"
5557 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
5559 "One consequence of this is that special directories such as C<c:\\windows> "
5560 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5561 "precise details of how they were created. In Windows itself this would not "
5566 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
5568 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5573 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
5575 "This function resolves the true case of each element in the path and returns "
5576 "the case-sensitive path."
5580 #: ../fish/guestfish-actions.pod:601
5582 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
5583 "WINDOWS/system32\"> (the exact return value would depend on details of how "
5584 "the directories were originally created under Windows)."
5588 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
5589 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5593 #: ../fish/guestfish-actions.pod:609
5594 msgid "See also L</realpath>."
5598 #: ../fish/guestfish-actions.pod:611
5603 #: ../fish/guestfish-actions.pod:613
5611 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3868
5612 #: ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5863
5613 msgid "Return the contents of the file named C<path>."
5617 #: ../fish/guestfish-actions.pod:617
5619 "Note that this function cannot correctly handle binary files (specifically, "
5620 "files containing C<\\0> character which is treated as end of string). For "
5621 "those you need to use the L</read-file> or L</download> functions which have "
5622 "a more complex interface."
5626 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757
5627 #: ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:945
5628 #: ../fish/guestfish-actions.pod:955 ../fish/guestfish-actions.pod:1022
5629 #: ../fish/guestfish-actions.pod:1032 ../fish/guestfish-actions.pod:1224
5630 #: ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1541
5631 #: ../fish/guestfish-actions.pod:1591 ../fish/guestfish-actions.pod:1606
5632 #: ../fish/guestfish-actions.pod:1616 ../fish/guestfish-actions.pod:1635
5633 #: ../fish/guestfish-actions.pod:3738 ../fish/guestfish-actions.pod:3753
5634 #: ../fish/guestfish-actions.pod:3829 ../fish/guestfish-actions.pod:3846
5635 #: ../fish/guestfish-actions.pod:3861 ../fish/guestfish-actions.pod:4530
5636 #: ../fish/guestfish-actions.pod:4576 ../fish/guestfish-actions.pod:4661
5637 #: ../fish/guestfish-actions.pod:4676 ../fish/guestfish-actions.pod:5082
5638 #: ../fish/guestfish-actions.pod:5094 ../fish/guestfish-actions.pod:5112
5639 #: ../fish/guestfish-actions.pod:5129 ../fish/guestfish-actions.pod:5139
5640 #: ../fish/guestfish-actions.pod:5196 ../fish/guestfish-actions.pod:5206
5641 #: ../fish/guestfish-actions.pod:5235 ../fish/guestfish-actions.pod:5245
5642 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127
5643 #: ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1443
5644 #: ../src/guestfs-actions.pod:1462 ../src/guestfs-actions.pod:1565
5645 #: ../src/guestfs-actions.pod:1584 ../src/guestfs-actions.pod:1830
5646 #: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2320
5647 #: ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2409
5648 #: ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2455
5649 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5671
5650 #: ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5828
5651 #: ../src/guestfs-actions.pod:5852 ../src/guestfs-actions.pod:6803
5652 #: ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:7004
5653 #: ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7693
5654 #: ../src/guestfs-actions.pod:7713 ../src/guestfs-actions.pod:7746
5655 #: ../src/guestfs-actions.pod:7765 ../src/guestfs-actions.pod:7784
5656 #: ../src/guestfs-actions.pod:7878 ../src/guestfs-actions.pod:7897
5657 #: ../src/guestfs-actions.pod:7943 ../src/guestfs-actions.pod:7962
5659 "Because of the message protocol, there is a transfer limit of somewhere "
5660 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5664 #: ../fish/guestfish-actions.pod:625
5669 #: ../fish/guestfish-actions.pod:627
5672 " checksum csumtype path\n"
5677 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
5679 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5683 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5685 "The type of checksum to compute is given by the C<csumtype> parameter which "
5686 "must have one of the following values:"
5690 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5695 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5697 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5702 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5707 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5708 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5712 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5717 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5718 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5722 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5727 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5728 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5732 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5737 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5738 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5742 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5747 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5748 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5752 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5757 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5758 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5762 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5763 msgid "The checksum is returned as a printable string."
5767 #: ../fish/guestfish-actions.pod:670
5768 msgid "To get the checksum for a device, use L</checksum-device>."
5772 #: ../fish/guestfish-actions.pod:672
5773 msgid "To get the checksums for many files, use L</checksums-out>."
5777 #: ../fish/guestfish-actions.pod:674
5778 msgid "checksum-device"
5782 #: ../fish/guestfish-actions.pod:676
5785 " checksum-device csumtype device\n"
5790 #: ../fish/guestfish-actions.pod:678
5792 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5793 "device named C<device>. For the types of checksums supported see the L</"
5794 "checksum> command."
5798 #: ../fish/guestfish-actions.pod:682
5799 msgid "checksums-out"
5803 #: ../fish/guestfish-actions.pod:684
5806 " checksums-out csumtype directory (sumsfile|-)\n"
5811 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5813 "This command computes the checksums of all regular files in C<directory> and "
5814 "then emits a list of those checksums to the local output file C<sumsfile>."
5818 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5820 "This can be used for verifying the integrity of a virtual machine. However "
5821 "to be properly secure you should pay attention to the output of the checksum "
5822 "command (it uses the ones from GNU coreutils). In particular when the "
5823 "filename is not printable, coreutils uses a special backslash syntax. For "
5824 "more information, see the GNU coreutils info file."
5828 #: ../fish/guestfish-actions.pod:700
5833 #: ../fish/guestfish-actions.pod:702
5836 " chmod mode path\n"
5841 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5843 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5848 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5850 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5851 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5856 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3091
5857 #: ../fish/guestfish-actions.pod:3230 ../fish/guestfish-actions.pod:3240
5858 #: ../fish/guestfish-actions.pod:3250 ../src/guestfs-actions.pod:1064
5859 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4826
5860 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4864
5861 msgid "The mode actually set is affected by the umask."
5865 #: ../fish/guestfish-actions.pod:713
5870 #: ../fish/guestfish-actions.pod:715
5873 " chown owner group path\n"
5878 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5879 msgid "Change the file owner to C<owner> and group to C<group>."
5883 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2526
5884 #: ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3688
5886 "Only numeric uid and gid are supported. If you want to use names, you will "
5887 "need to locate and parse the password file yourself (Augeas support makes "
5888 "this relatively easy)."
5892 #: ../fish/guestfish-actions.pod:723
5897 #: ../fish/guestfish-actions.pod:725
5900 " command 'arguments ...'\n"
5905 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5907 "This call runs a command from the guest filesystem. The filesystem must be "
5908 "mounted, and must contain a compatible operating system (ie. something "
5909 "Linux, with the same or compatible processor architecture)."
5913 #: ../fish/guestfish-actions.pod:732
5915 "The single parameter is an argv-style list of arguments. The first element "
5916 "is the name of the program to run. Subsequent elements are parameters. The "
5917 "list must be non-empty (ie. must contain a program name). Note that the "
5918 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5922 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5923 msgid "The return value is anything printed to I<stdout> by the command."
5927 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5929 "If the command returns a non-zero exit status, then this function returns an "
5930 "error message. The error message string is the content of I<stderr> from "
5935 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5937 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
5938 "bin>. If you require a program from another location, you should provide "
5939 "the full path in the first parameter."
5943 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5945 "Shared libraries and data files required by the program must be available on "
5946 "filesystems which are mounted in the correct places. It is the caller's "
5947 "responsibility to ensure all filesystems that are needed are mounted at the "
5952 #: ../fish/guestfish-actions.pod:760
5953 msgid "command-lines"
5957 #: ../fish/guestfish-actions.pod:762
5960 " command-lines 'arguments ...'\n"
5965 #: ../fish/guestfish-actions.pod:764
5967 "This is the same as L</command>, but splits the result into a list of lines."
5971 #: ../fish/guestfish-actions.pod:767
5972 msgid "See also: L</sh-lines>"
5976 #: ../fish/guestfish-actions.pod:772
5981 #: ../fish/guestfish-actions.pod:774
5984 " config qemuparam qemuvalue\n"
5989 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5991 "This can be used to add arbitrary qemu command line parameters of the form "
5992 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5993 "setting some parameters which would interfere with parameters that we use."
5997 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5998 msgid "The first character of C<param> string must be a C<-> (dash)."
6002 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
6003 msgid "C<value> can be NULL."
6007 #: ../fish/guestfish-actions.pod:785
6012 #: ../fish/guestfish-actions.pod:787
6015 " copy-size src dest size\n"
6020 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
6022 "This command copies exactly C<size> bytes from one source device or file "
6023 "C<src> to another destination device or file C<dest>."
6027 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
6029 "Note this will fail if the source is too short or if the destination is not "
6034 #: ../fish/guestfish-actions.pod:795
6039 #: ../fish/guestfish-actions.pod:797
6047 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
6049 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6050 "destination filename or destination directory."
6054 #: ../fish/guestfish-actions.pod:802
6059 #: ../fish/guestfish-actions.pod:804
6067 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
6069 "This copies a file or directory from C<src> to C<dest> recursively using the "
6074 #: ../fish/guestfish-actions.pod:809
6079 #: ../fish/guestfish-actions.pod:811
6087 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
6089 "This command copies from one source device or file C<src> to another "
6090 "destination device or file C<dest>. Normally you would use this to copy to "
6091 "or from a device or partition, for example to duplicate a filesystem."
6095 #: ../fish/guestfish-actions.pod:818
6097 "If the destination is a device, it must be as large or larger than the "
6098 "source file or device, otherwise the copy will fail. This command cannot do "
6099 "partial copies (see L</copy-size>)."
6103 #: ../fish/guestfish-actions.pod:822
6108 #: ../fish/guestfish-actions.pod:824
6116 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
6117 msgid "This command runs the C<df> command to report disk space used."
6121 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
6123 "This command is mostly useful for interactive sessions. It is I<not> "
6124 "intended that you try to parse the output string. Use L</statvfs> from "
6129 #: ../fish/guestfish-actions.pod:832
6134 #: ../fish/guestfish-actions.pod:834
6142 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
6144 "This command runs the C<df -h> command to report disk space used in human-"
6149 #: ../fish/guestfish-actions.pod:843
6154 #: ../fish/guestfish-actions.pod:845
6162 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
6164 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6165 "This is sometimes useful for extended debugging of problems."
6169 #: ../fish/guestfish-actions.pod:851
6171 "Another way to get the same information is to enable verbose messages with "
6172 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
6173 "before running the program."
6177 #: ../fish/guestfish-actions.pod:856
6182 #: ../fish/guestfish-actions.pod:858
6185 " download remotefilename (filename|-)\n"
6190 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873
6191 #: ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
6193 "Download file C<remotefilename> and save it as C<filename> on the local "
6198 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4834
6199 #: ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7263
6200 msgid "C<filename> can also be a named pipe."
6204 #: ../fish/guestfish-actions.pod:865
6205 msgid "See also L</upload>, L</cat>."
6209 #: ../fish/guestfish-actions.pod:869
6210 msgid "download-offset"
6214 #: ../fish/guestfish-actions.pod:871
6217 " download-offset remotefilename (filename|-) offset size\n"
6222 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
6224 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6225 "region must be within the file or device)."
6229 #: ../fish/guestfish-actions.pod:879
6231 "Note that there is no limit on the amount of data that can be downloaded "
6232 "with this call, unlike with L</pread>, and this call always reads the full "
6233 "amount unless an error occurs."
6237 #: ../fish/guestfish-actions.pod:884
6238 msgid "See also L</download>, L</pread>."
6242 #: ../fish/guestfish-actions.pod:888
6247 #: ../fish/guestfish-actions.pod:890
6250 " drop-caches whattodrop\n"
6255 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
6257 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6258 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6259 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6263 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
6264 msgid "Setting C<whattodrop> to 3 should drop everything."
6268 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
6270 "This automatically calls L<sync(2)> before the operation, so that the "
6271 "maximum guest memory is freed."
6275 #: ../fish/guestfish-actions.pod:902
6280 #: ../fish/guestfish-actions.pod:904
6288 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
6290 "This command runs the C<du -s> command to estimate file space usage for "
6295 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
6297 "C<path> can be a file or a directory. If C<path> is a directory then the "
6298 "estimate includes the contents of the directory and all subdirectories "
6303 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
6305 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6309 #: ../fish/guestfish-actions.pod:916
6314 #: ../fish/guestfish-actions.pod:918
6317 " e2fsck-f device\n"
6322 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
6324 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6325 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
6330 #: ../fish/guestfish-actions.pod:924
6332 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
6333 "should use L</fsck>."
6337 #: ../fish/guestfish-actions.pod:927
6342 #: ../fish/guestfish-actions.pod:929
6345 " echo-daemon 'words ...'\n"
6350 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
6352 "This command concatenates the list of C<words> passed with single spaces "
6353 "between them and returns the resulting string."
6357 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
6358 msgid "You can use this command to test the connection through to the daemon."
6362 #: ../fish/guestfish-actions.pod:936
6363 msgid "See also L</ping-daemon>."
6367 #: ../fish/guestfish-actions.pod:938
6372 #: ../fish/guestfish-actions.pod:940
6375 " egrep regex path\n"
6380 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
6382 "This calls the external C<egrep> program and returns the matching lines."
6386 #: ../fish/guestfish-actions.pod:948
6391 #: ../fish/guestfish-actions.pod:950
6394 " egrepi regex path\n"
6399 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
6401 "This calls the external C<egrep -i> program and returns the matching lines."
6405 #: ../fish/guestfish-actions.pod:958
6410 #: ../fish/guestfish-actions.pod:960
6413 " equal file1 file2\n"
6418 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
6420 "This compares the two files C<file1> and C<file2> and returns true if their "
6421 "content is exactly equal, or false otherwise."
6425 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
6426 msgid "The external L<cmp(1)> program is used for the comparison."
6430 #: ../fish/guestfish-actions.pod:967
6435 #: ../fish/guestfish-actions.pod:969
6443 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
6445 "This returns C<true> if and only if there is a file, directory (or anything) "
6446 "with the given C<path> name."
6450 #: ../fish/guestfish-actions.pod:974
6451 msgid "See also L</is-file>, L</is-dir>, L</stat>."
6455 #: ../fish/guestfish-actions.pod:976
6460 #: ../fish/guestfish-actions.pod:978
6463 " fallocate path len\n"
6468 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999
6469 #: ../src/guestfs-actions.pod:1512 ../src/guestfs-actions.pod:1531
6471 "This command preallocates a file (containing zero bytes) named C<path> of "
6472 "size C<len> bytes. If the file exists already, it is overwritten."
6476 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1516
6478 "Do not confuse this with the guestfish-specific C<alloc> command which "
6479 "allocates a file in the host and attaches it as a device."
6483 #: ../fish/guestfish-actions.pod:988
6485 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
6490 #: ../fish/guestfish-actions.pod:995
6495 #: ../fish/guestfish-actions.pod:997
6498 " fallocate64 path len\n"
6503 #: ../fish/guestfish-actions.pod:1003
6505 "Note that this call allocates disk blocks for the file. To create a sparse "
6506 "file use L</truncate-size> instead."
6510 #: ../fish/guestfish-actions.pod:1006
6512 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6513 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6514 "maximum size of files created through that call to 1GB."
6518 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
6520 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6521 "commands which create a file in the host and attach it as a device."
6525 #: ../fish/guestfish-actions.pod:1015
6530 #: ../fish/guestfish-actions.pod:1017
6533 " fgrep pattern path\n"
6538 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
6540 "This calls the external C<fgrep> program and returns the matching lines."
6544 #: ../fish/guestfish-actions.pod:1025
6549 #: ../fish/guestfish-actions.pod:1027
6552 " fgrepi pattern path\n"
6557 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
6559 "This calls the external C<fgrep -i> program and returns the matching lines."
6563 #: ../fish/guestfish-actions.pod:1035
6568 #: ../fish/guestfish-actions.pod:1037
6576 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
6578 "This call uses the standard L<file(1)> command to determine the type or "
6579 "contents of the file."
6583 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
6585 "This call will also transparently look inside various types of compressed "
6590 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
6592 "The exact command which runs is C<file -zb path>. Note in particular that "
6593 "the filename is not prepended to the output (the I<-b> option)."
6597 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
6599 "The output depends on the output of the underlying L<file(1)> command and it "
6600 "can change in future in ways beyond our control. In other words, the output "
6601 "is not guaranteed by the ABI."
6605 #: ../fish/guestfish-actions.pod:1053
6607 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6608 "(etc), L</is-zero>."
6612 #: ../fish/guestfish-actions.pod:1056
6613 msgid "file-architecture"
6617 #: ../fish/guestfish-actions.pod:1058
6620 " file-architecture filename\n"
6625 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
6627 "This detects the architecture of the binary C<filename>, and returns it if "
6632 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
6633 msgid "Currently defined architectures are:"
6637 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
6642 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
6644 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6645 "irrespective of the precise processor requirements of the binary."
6649 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
6654 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
6655 msgid "64 bit x86-64."
6659 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
6664 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
6665 msgid "32 bit SPARC."
6669 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
6674 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
6675 msgid "64 bit SPARC V9 and above."
6679 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
6684 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
6685 msgid "Intel Itanium."
6689 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
6694 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
6695 msgid "32 bit Power PC."
6699 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
6704 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
6705 msgid "64 bit Power PC."
6709 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
6710 msgid "Libguestfs may return other architecture strings in future."
6714 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6715 msgid "The function works on at least the following types of files:"
6719 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6720 msgid "many types of Un*x and Linux binary"
6724 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6725 msgid "many types of Un*x and Linux shared library"
6729 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6730 msgid "Windows Win32 and Win64 binaries"
6734 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6735 msgid "Windows Win32 and Win64 DLLs"
6739 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6740 msgid "Win32 binaries and DLLs return C<i386>."
6744 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6745 msgid "Win64 binaries and DLLs return C<x86_64>."
6749 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6750 msgid "Linux kernel modules"
6754 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6755 msgid "Linux new-style initrd images"
6759 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6760 msgid "some non-x86 Linux vmlinuz kernels"
6764 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6765 msgid "What it can't do currently:"
6769 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6770 msgid "static libraries (libfoo.a)"
6774 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6775 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6779 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6780 msgid "x86 Linux vmlinuz kernels"
6784 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6786 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6787 "compressed code, and are horribly hard to unpack. If you want to find the "
6788 "architecture of a kernel, use the architecture of the associated initrd or "
6789 "kernel module(s) instead."
6793 #: ../fish/guestfish-actions.pod:1161
6798 #: ../fish/guestfish-actions.pod:1163
6806 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6807 msgid "This command returns the size of C<file> in bytes."
6811 #: ../fish/guestfish-actions.pod:1167
6813 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
6814 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
6818 #: ../fish/guestfish-actions.pod:1171
6823 #: ../fish/guestfish-actions.pod:1173
6826 " fill c len path\n"
6831 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6833 "This command creates a new file called C<path>. The initial content of the "
6834 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
6839 #: ../fish/guestfish-actions.pod:1179
6841 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6842 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6847 #: ../fish/guestfish-actions.pod:1184
6848 msgid "fill-pattern"
6852 #: ../fish/guestfish-actions.pod:1186
6855 " fill-pattern pattern len path\n"
6860 #: ../fish/guestfish-actions.pod:1188
6862 "This function is like L</fill> except that it creates a new file of length "
6863 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6864 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6869 #: ../fish/guestfish-actions.pod:1193
6874 #: ../fish/guestfish-actions.pod:1195
6882 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6884 "This command lists out all files and directories, recursively, starting at "
6885 "C<directory>. It is essentially equivalent to running the shell command "
6886 "C<find directory -print> but some post-processing happens on the output, "
6891 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6893 "This returns a list of strings I<without any prefix>. Thus if the directory "
6898 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6908 #: ../fish/guestfish-actions.pod:1209
6909 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6913 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6924 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6925 msgid "If C<directory> is not a directory, then this command returns an error."
6929 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6930 msgid "The returned list is sorted."
6934 #: ../fish/guestfish-actions.pod:1222
6935 msgid "See also L</find0>."
6939 #: ../fish/guestfish-actions.pod:1227
6944 #: ../fish/guestfish-actions.pod:1229
6947 " find0 directory (files|-)\n"
6952 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6954 "This command lists out all files and directories, recursively, starting at "
6955 "C<directory>, placing the resulting list in the external file called "
6960 #: ../fish/guestfish-actions.pod:1235
6962 "This command works the same way as L</find> with the following exceptions:"
6966 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6967 msgid "The resulting list is written to an external file."
6971 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6973 "Items (filenames) in the result are separated by C<\\0> characters. See "
6974 "L<find(1)> option I<-print0>."
6978 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6979 msgid "This command is not limited in the number of names that it can return."
6983 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6984 msgid "The result list is not sorted."
6988 #: ../fish/guestfish-actions.pod:1262
6989 msgid "findfs-label"
6993 #: ../fish/guestfish-actions.pod:1264
6996 " findfs-label label\n"
7001 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
7003 "This command searches the filesystems and returns the one which has the "
7004 "given label. An error is returned if no such filesystem can be found."
7008 #: ../fish/guestfish-actions.pod:1270
7009 msgid "To find the label of a filesystem, use L</vfs-label>."
7013 #: ../fish/guestfish-actions.pod:1272
7018 #: ../fish/guestfish-actions.pod:1274
7021 " findfs-uuid uuid\n"
7026 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
7028 "This command searches the filesystems and returns the one which has the "
7029 "given UUID. An error is returned if no such filesystem can be found."
7033 #: ../fish/guestfish-actions.pod:1280
7034 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
7038 #: ../fish/guestfish-actions.pod:1282
7043 #: ../fish/guestfish-actions.pod:1284
7046 " fsck fstype device\n"
7051 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
7053 "This runs the filesystem checker (fsck) on C<device> which should have "
7054 "filesystem type C<fstype>."
7058 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
7060 "The returned integer is the status. See L<fsck(8)> for the list of status "
7061 "codes from C<fsck>."
7065 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
7066 msgid "Multiple status codes can be summed together."
7070 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
7072 "A non-zero return code can mean \"success\", for example if errors have been "
7073 "corrected on the filesystem."
7077 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
7078 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7082 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
7084 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7088 #: ../fish/guestfish-actions.pod:1314
7093 #: ../fish/guestfish-actions.pod:1316
7101 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
7103 "Return the additional kernel options which are added to the guest kernel "
7108 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
7109 msgid "If C<NULL> then no options are added."
7113 #: ../fish/guestfish-actions.pod:1323
7114 msgid "get-attach-method"
7118 #: ../fish/guestfish-actions.pod:1325
7121 " get-attach-method\n"
7126 #: ../fish/guestfish-actions.pod:1327
7127 msgid "Return the current attach method. See L</set-attach-method>."
7131 #: ../fish/guestfish-actions.pod:1329
7132 msgid "get-autosync"
7136 #: ../fish/guestfish-actions.pod:1331
7144 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
7145 msgid "Get the autosync flag."
7149 #: ../fish/guestfish-actions.pod:1335
7154 #: ../fish/guestfish-actions.pod:1337
7162 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
7163 msgid "Return the direct appliance mode flag."
7167 #: ../fish/guestfish-actions.pod:1341
7172 #: ../fish/guestfish-actions.pod:1343
7175 " get-e2label device\n"
7180 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2011
7182 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7186 #: ../fish/guestfish-actions.pod:1348
7188 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
7193 #: ../fish/guestfish-actions.pod:1355
7198 #: ../fish/guestfish-actions.pod:1357
7201 " get-e2uuid device\n"
7206 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2032
7208 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7212 #: ../fish/guestfish-actions.pod:1362
7214 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
7219 #: ../fish/guestfish-actions.pod:1369
7224 #: ../fish/guestfish-actions.pod:1371
7232 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
7234 "This gets the memory size in megabytes allocated to the qemu subprocess."
7238 #: ../fish/guestfish-actions.pod:1376
7240 "If L</set-memsize> was not called on this handle, and if "
7241 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7242 "value for memsize."
7246 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437
7247 #: ../fish/guestfish-actions.pod:4194 ../fish/guestfish-actions.pod:4296
7248 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144
7249 #: ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6450
7251 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7255 #: ../fish/guestfish-actions.pod:1383
7260 #: ../fish/guestfish-actions.pod:1385
7268 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
7269 msgid "This returns the enable network flag."
7273 #: ../fish/guestfish-actions.pod:1389
7278 #: ../fish/guestfish-actions.pod:1391
7286 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
7287 msgid "Return the current search path."
7291 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
7293 "This is always non-NULL. If it wasn't set already, then this will return "
7298 #: ../fish/guestfish-actions.pod:1398
7303 #: ../fish/guestfish-actions.pod:1400
7311 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
7312 msgid "This returns the process group flag."
7316 #: ../fish/guestfish-actions.pod:1404
7321 #: ../fish/guestfish-actions.pod:1406
7326 #: ../fish/guestfish-actions.pod:1408
7334 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
7336 "Return the process ID of the qemu subprocess. If there is no qemu "
7337 "subprocess, then this will return an error."
7341 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
7342 msgid "This is an internal call used for debugging and testing."
7346 #: ../fish/guestfish-actions.pod:1415
7351 #: ../fish/guestfish-actions.pod:1417
7359 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
7360 msgid "Return the current qemu binary."
7364 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
7366 "This is always non-NULL. If it wasn't set already, then this will return "
7367 "the default qemu binary name."
7371 #: ../fish/guestfish-actions.pod:1424
7372 msgid "get-recovery-proc"
7376 #: ../fish/guestfish-actions.pod:1426
7379 " get-recovery-proc\n"
7384 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
7385 msgid "Return the recovery process enabled flag."
7389 #: ../fish/guestfish-actions.pod:1430
7394 #: ../fish/guestfish-actions.pod:1432
7402 #: ../fish/guestfish-actions.pod:1434
7404 "This returns the current setting of the selinux flag which is passed to the "
7405 "appliance at boot time. See L</set-selinux>."
7409 #: ../fish/guestfish-actions.pod:1440
7414 #: ../fish/guestfish-actions.pod:1442
7422 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
7424 "This returns the current state as an opaque integer. This is only useful "
7425 "for printing debug and internal error messages."
7429 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2393
7430 #: ../fish/guestfish-actions.pod:2411 ../fish/guestfish-actions.pod:2449
7431 #: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:2159
7432 #: ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3494
7433 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3582
7434 msgid "For more information on states, see L<guestfs(3)>."
7438 #: ../fish/guestfish-actions.pod:1449
7443 #: ../fish/guestfish-actions.pod:1451
7451 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
7452 msgid "Return the command trace flag."
7456 #: ../fish/guestfish-actions.pod:1455
7461 #: ../fish/guestfish-actions.pod:1457
7469 #: ../fish/guestfish-actions.pod:1459
7471 "Return the current umask. By default the umask is C<022> unless it has been "
7472 "set by calling L</umask>."
7476 #: ../fish/guestfish-actions.pod:1462
7481 #: ../fish/guestfish-actions.pod:1464
7489 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
7490 msgid "This returns the verbose messages flag."
7494 #: ../fish/guestfish-actions.pod:1468
7499 #: ../fish/guestfish-actions.pod:1470
7507 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
7508 msgid "This gets the SELinux security context of the daemon."
7512 #: ../fish/guestfish-actions.pod:1474
7513 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7517 #: ../fish/guestfish-actions.pod:1477
7522 #: ../fish/guestfish-actions.pod:1479
7525 " getxattr path name\n"
7530 #: ../fish/guestfish-actions.pod:1481
7532 "Get a single extended attribute from file C<path> named C<name>. This call "
7533 "follows symlinks. If you want to lookup an extended attribute for the "
7534 "symlink itself, use L</lgetxattr>."
7538 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2538
7540 "Normally it is better to get all extended attributes from a file in one go "
7541 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7542 "buggy and do not provide a way to list out attributes. For these "
7543 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7544 "attributes you want in advance and call this function."
7548 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2545
7549 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3715
7551 "Extended attribute values are blobs of binary data. If there is no extended "
7552 "attribute named C<name>, this returns an error."
7556 #: ../fish/guestfish-actions.pod:1495
7557 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7561 #: ../fish/guestfish-actions.pod:1497
7566 #: ../fish/guestfish-actions.pod:1499
7574 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
7576 "This call lists the extended attributes of the file or directory C<path>."
7580 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
7582 "At the system call level, this is a combination of the L<listxattr(2)> and "
7583 "L<getxattr(2)> calls."
7587 #: ../fish/guestfish-actions.pod:1507
7588 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7592 #: ../fish/guestfish-actions.pod:1509
7597 #: ../fish/guestfish-actions.pod:1511
7600 " glob-expand pattern\n"
7605 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
7607 "This command searches for all the pathnames matching C<pattern> according to "
7608 "the wildcard expansion rules used by the shell."
7612 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
7614 "If no paths match, then this returns an empty list (note: not an error)."
7618 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
7620 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
7621 "GLOB_BRACE>. See that manual page for more details."
7625 #: ../fish/guestfish-actions.pod:1524
7630 #: ../fish/guestfish-actions.pod:1526
7633 " grep regex path\n"
7638 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
7639 msgid "This calls the external C<grep> program and returns the matching lines."
7643 #: ../fish/guestfish-actions.pod:1534
7648 #: ../fish/guestfish-actions.pod:1536
7651 " grepi regex path\n"
7656 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
7658 "This calls the external C<grep -i> program and returns the matching lines."
7662 #: ../fish/guestfish-actions.pod:1544
7663 msgid "grub-install"
7667 #: ../fish/guestfish-actions.pod:1546
7670 " grub-install root device\n"
7675 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
7677 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
7678 "with the root directory being C<root>."
7682 #: ../fish/guestfish-actions.pod:1557 ../src/guestfs-actions.pod:2341
7684 "There is currently no way in the API to install grub2, which is used by most "
7685 "modern Linux guests. It is possible to run the grub2 command from the "
7686 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
7690 #: ../fish/guestfish-actions.pod:1564 ../src/guestfs-actions.pod:2348
7692 "This uses C<grub-install> from the host. Unfortunately grub is not always "
7693 "compatible with itself, so this only works in rather narrow circumstances. "
7694 "Careful testing with each guest version is advisable."
7698 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2355
7700 "If grub-install reports the error \"No suitable drive was found in the "
7701 "generated device map.\" it may be that you need to create a C</boot/grub/"
7702 "device.map> file first that contains the mapping between grub device names "
7703 "and Linux device names. It is usually sufficient to create a file "
7708 #: ../fish/guestfish-actions.pod:1578 ../src/guestfs-actions.pod:2362
7716 #: ../fish/guestfish-actions.pod:1580 ../src/guestfs-actions.pod:2364
7717 msgid "replacing C</dev/vda> with the name of the installation device."
7721 #: ../fish/guestfish-actions.pod:1584
7726 #: ../fish/guestfish-actions.pod:1586
7734 #: ../fish/guestfish-actions.pod:1588 ../src/guestfs-actions.pod:2378
7736 "This command returns up to the first 10 lines of a file as a list of strings."
7740 #: ../fish/guestfish-actions.pod:1594
7745 #: ../fish/guestfish-actions.pod:1596
7748 " head-n nrlines path\n"
7753 #: ../fish/guestfish-actions.pod:1598 ../src/guestfs-actions.pod:2397
7755 "If the parameter C<nrlines> is a positive number, this returns the first "
7756 "C<nrlines> lines of the file C<path>."
7760 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2400
7762 "If the parameter C<nrlines> is a negative number, this returns lines from "
7763 "the file C<path>, excluding the last C<nrlines> lines."
7767 #: ../fish/guestfish-actions.pod:1604 ../fish/guestfish-actions.pod:4674
7768 #: ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:7022
7769 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7773 #: ../fish/guestfish-actions.pod:1609
7778 #: ../fish/guestfish-actions.pod:1611
7786 #: ../fish/guestfish-actions.pod:1613 ../src/guestfs-actions.pod:2420
7788 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
7789 "readable, canonical hex dump of the file."
7793 #: ../fish/guestfish-actions.pod:1619
7798 #: ../fish/guestfish-actions.pod:1621
7801 " initrd-cat initrdpath filename\n"
7806 #: ../fish/guestfish-actions.pod:1623 ../src/guestfs-actions.pod:2439
7808 "This command unpacks the file C<filename> from the initrd file called "
7809 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7814 #: ../fish/guestfish-actions.pod:1627 ../src/guestfs-actions.pod:2443
7816 "For example, in guestfish you could use the following command to examine the "
7817 "boot script (usually called C</init>) contained in a Linux initrd or "
7822 #: ../fish/guestfish-actions.pod:1631 ../src/guestfs-actions.pod:2447
7825 " initrd-cat /boot/initrd-<version>.img init\n"
7830 #: ../fish/guestfish-actions.pod:1633
7831 msgid "See also L</initrd-list>."
7835 #: ../fish/guestfish-actions.pod:1638
7840 #: ../fish/guestfish-actions.pod:1640
7843 " initrd-list path\n"
7848 #: ../fish/guestfish-actions.pod:1642 ../src/guestfs-actions.pod:2466
7849 msgid "This command lists out files contained in an initrd."
7853 #: ../fish/guestfish-actions.pod:1644 ../src/guestfs-actions.pod:2468
7855 "The files are listed without any initial C</> character. The files are "
7856 "listed in the order they appear (not necessarily alphabetical). Directory "
7857 "names are listed as separate items."
7861 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2472
7863 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7864 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7869 #: ../fish/guestfish-actions.pod:1652
7870 msgid "inotify-add-watch"
7874 #: ../fish/guestfish-actions.pod:1654
7877 " inotify-add-watch path mask\n"
7882 #: ../fish/guestfish-actions.pod:1656 ../src/guestfs-actions.pod:2489
7883 msgid "Watch C<path> for the events listed in C<mask>."
7887 #: ../fish/guestfish-actions.pod:1658 ../src/guestfs-actions.pod:2491
7889 "Note that if C<path> is a directory then events within that directory are "
7890 "watched, but this does I<not> happen recursively (in subdirectories)."
7894 #: ../fish/guestfish-actions.pod:1662 ../src/guestfs-actions.pod:2495
7896 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7897 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7901 #: ../fish/guestfish-actions.pod:1666
7902 msgid "inotify-close"
7906 #: ../fish/guestfish-actions.pod:1668
7914 #: ../fish/guestfish-actions.pod:1670 ../src/guestfs-actions.pod:2508
7916 "This closes the inotify handle which was previously opened by inotify_init. "
7917 "It removes all watches, throws away any pending events, and deallocates all "
7922 #: ../fish/guestfish-actions.pod:1674
7923 msgid "inotify-files"
7927 #: ../fish/guestfish-actions.pod:1676
7935 #: ../fish/guestfish-actions.pod:1678
7937 "This function is a helpful wrapper around L</inotify-read> which just "
7938 "returns a list of pathnames of objects that were touched. The returned "
7939 "pathnames are sorted and deduplicated."
7943 #: ../fish/guestfish-actions.pod:1682
7944 msgid "inotify-init"
7948 #: ../fish/guestfish-actions.pod:1684
7951 " inotify-init maxevents\n"
7956 #: ../fish/guestfish-actions.pod:1686 ../src/guestfs-actions.pod:2537
7958 "This command creates a new inotify handle. The inotify subsystem can be "
7959 "used to notify events which happen to objects in the guest filesystem."
7963 #: ../fish/guestfish-actions.pod:1690
7965 "C<maxevents> is the maximum number of events which will be queued up between "
7966 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7967 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7968 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7969 "but records the fact that it threw them away by setting a flag "
7970 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7974 #: ../fish/guestfish-actions.pod:1700
7976 "Before any events are generated, you have to add some watches to the "
7977 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7978 "L</inotify-watch-all>."
7982 #: ../fish/guestfish-actions.pod:1706
7984 "Queued up events should be read periodically by calling L</inotify-read> (or "
7985 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7986 "If you don't read the events out often enough then you risk the internal "
7987 "queue overflowing."
7991 #: ../fish/guestfish-actions.pod:1713
7993 "The handle should be closed after use by calling L</inotify-close>. This "
7994 "also removes any watches automatically."
7998 #: ../fish/guestfish-actions.pod:1717 ../src/guestfs-actions.pod:2568
8000 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8001 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8002 "that there is one global inotify handle per libguestfs instance."
8006 #: ../fish/guestfish-actions.pod:1722
8007 msgid "inotify-read"
8011 #: ../fish/guestfish-actions.pod:1724
8019 #: ../fish/guestfish-actions.pod:1726 ../src/guestfs-actions.pod:2582
8021 "Return the complete queue of events that have happened since the previous "
8026 #: ../fish/guestfish-actions.pod:1729 ../src/guestfs-actions.pod:2585
8027 msgid "If no events have happened, this returns an empty list."
8031 #: ../fish/guestfish-actions.pod:1731 ../src/guestfs-actions.pod:2587
8033 "I<Note>: In order to make sure that all events have been read, you must call "
8034 "this function repeatedly until it returns an empty list. The reason is that "
8035 "the call will read events up to the maximum appliance-to-host message size "
8036 "and leave remaining events in the queue."
8040 #: ../fish/guestfish-actions.pod:1737
8041 msgid "inotify-rm-watch"
8045 #: ../fish/guestfish-actions.pod:1739
8048 " inotify-rm-watch wd\n"
8053 #: ../fish/guestfish-actions.pod:1741
8054 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
8058 #: ../fish/guestfish-actions.pod:1744
8059 msgid "inspect-get-arch"
8063 #: ../fish/guestfish-actions.pod:1746
8066 " inspect-get-arch root\n"
8071 #: ../fish/guestfish-actions.pod:1748
8073 "This returns the architecture of the inspected operating system. The "
8074 "possible return values are listed under L</file-architecture>."
8078 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2622
8080 "If the architecture could not be determined, then the string C<unknown> is "
8085 #: ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1842
8086 #: ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1933
8087 #: ../fish/guestfish-actions.pod:2017 ../fish/guestfish-actions.pod:2078
8088 #: ../fish/guestfish-actions.pod:2099 ../fish/guestfish-actions.pod:2113
8089 #: ../fish/guestfish-actions.pod:2153 ../fish/guestfish-actions.pod:2185
8090 #: ../fish/guestfish-actions.pod:2198 ../fish/guestfish-actions.pod:2211
8091 #: ../fish/guestfish-actions.pod:2221 ../fish/guestfish-actions.pod:2231
8092 #: ../fish/guestfish-actions.pod:2243 ../fish/guestfish-actions.pod:2339
8093 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:2625
8094 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2823
8095 #: ../src/guestfs-actions.pod:2842 ../src/guestfs-actions.pod:2973
8096 #: ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3084
8097 #: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3158
8098 #: ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3218
8099 #: ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3255
8100 #: ../src/guestfs-actions.pod:3271 ../src/guestfs-actions.pod:3289
8101 #: ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3432
8102 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8106 #: ../fish/guestfish-actions.pod:1757
8107 msgid "inspect-get-distro"
8111 #: ../fish/guestfish-actions.pod:1759
8114 " inspect-get-distro root\n"
8119 #: ../fish/guestfish-actions.pod:1761 ../src/guestfs-actions.pod:2638
8121 "This returns the distro (distribution) of the inspected operating system."
8125 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
8126 msgid "Currently defined distros are:"
8130 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
8131 msgid "\"archlinux\""
8135 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
8140 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
8145 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
8150 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
8155 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
8160 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
8165 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
8170 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
8175 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
8180 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
8181 msgid "\"linuxmint\""
8185 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
8190 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
8191 msgid "\"mandriva\""
8195 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
8200 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
8205 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
8210 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
8215 #: ../fish/guestfish-actions.pod:1802 ../src/guestfs-actions.pod:2679
8220 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
8221 msgid "\"redhat-based\""
8225 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2683
8226 msgid "Some Red Hat-derived distro."
8230 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
8235 #: ../fish/guestfish-actions.pod:1810 ../src/guestfs-actions.pod:2687
8236 msgid "Red Hat Enterprise Linux."
8240 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2689
8241 msgid "\"scientificlinux\""
8245 #: ../fish/guestfish-actions.pod:1814 ../src/guestfs-actions.pod:2691
8246 msgid "Scientific Linux."
8250 #: ../fish/guestfish-actions.pod:1816 ../src/guestfs-actions.pod:2693
8251 msgid "\"slackware\""
8255 #: ../fish/guestfish-actions.pod:1818 ../src/guestfs-actions.pod:2695
8260 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2697
8261 msgid "\"ttylinux\""
8265 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2699
8270 #: ../fish/guestfish-actions.pod:1824 ../src/guestfs-actions.pod:2701
8275 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2703
8280 #: ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1912
8281 #: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:2705
8282 #: ../src/guestfs-actions.pod:2814 ../src/guestfs-actions.pod:3189
8287 #: ../fish/guestfish-actions.pod:1830 ../src/guestfs-actions.pod:2707
8288 msgid "The distro could not be determined."
8292 #: ../fish/guestfish-actions.pod:1832 ../fish/guestfish-actions.pod:2168
8293 #: ../src/guestfs-actions.pod:2709 ../src/guestfs-actions.pod:3181
8298 #: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2711
8300 "Windows does not have distributions. This string is returned if the OS type "
8305 #: ../fish/guestfish-actions.pod:1839 ../fish/guestfish-actions.pod:1918
8306 #: ../fish/guestfish-actions.pod:2182 ../src/guestfs-actions.pod:2716
8307 #: ../src/guestfs-actions.pod:2820 ../src/guestfs-actions.pod:3195
8309 "Future versions of libguestfs may return other strings here. The caller "
8310 "should be prepared to handle any string."
8314 #: ../fish/guestfish-actions.pod:1844
8315 msgid "inspect-get-drive-mappings"
8319 #: ../fish/guestfish-actions.pod:1846
8322 " inspect-get-drive-mappings root\n"
8327 #: ../fish/guestfish-actions.pod:1848 ../src/guestfs-actions.pod:2732
8329 "This call is useful for Windows which uses a primitive system of assigning "
8330 "drive letters (like \"C:\") to partitions. This inspection API examines the "
8331 "Windows Registry to find out how disks/partitions are mapped to drive "
8332 "letters, and returns a hash table as in the example below:"
8336 #: ../fish/guestfish-actions.pod:1854 ../src/guestfs-actions.pod:2738
8346 #: ../fish/guestfish-actions.pod:1858 ../src/guestfs-actions.pod:2742
8348 "Note that keys are drive letters. For Windows, the key is case insensitive "
8349 "and just contains the drive letter, without the customary colon separator "
8354 #: ../fish/guestfish-actions.pod:1862 ../src/guestfs-actions.pod:2746
8356 "In future we may support other operating systems that also used drive "
8357 "letters, but the keys for those might not be case insensitive and might be "
8358 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
8363 #: ../fish/guestfish-actions.pod:1867 ../src/guestfs-actions.pod:2751
8365 "For Windows guests, currently only hard drive mappings are returned. "
8366 "Removable disks (eg. DVD-ROMs) are ignored."
8370 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2754
8372 "For guests that do not use drive mappings, or if the drive mappings could "
8373 "not be determined, this returns an empty hash table."
8377 #: ../fish/guestfish-actions.pod:1873
8379 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8380 "get-mountpoints>, L</inspect-get-filesystems>."
8384 #: ../fish/guestfish-actions.pod:1877
8385 msgid "inspect-get-filesystems"
8389 #: ../fish/guestfish-actions.pod:1879
8392 " inspect-get-filesystems root\n"
8397 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2775
8399 "This returns a list of all the filesystems that we think are associated with "
8400 "this operating system. This includes the root filesystem, other ordinary "
8401 "filesystems, and non-mounted devices like swap partitions."
8405 #: ../fish/guestfish-actions.pod:1886 ../src/guestfs-actions.pod:2780
8407 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8408 "to be shared between operating systems."
8412 #: ../fish/guestfish-actions.pod:1889
8414 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8419 #: ../fish/guestfish-actions.pod:1892
8420 msgid "inspect-get-format"
8424 #: ../fish/guestfish-actions.pod:1894
8427 " inspect-get-format root\n"
8432 #: ../fish/guestfish-actions.pod:1896 ../src/guestfs-actions.pod:2798
8434 "This returns the format of the inspected operating system. You can use it "
8435 "to detect install images, live CDs and similar."
8439 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2801
8440 msgid "Currently defined formats are:"
8444 #: ../fish/guestfish-actions.pod:1903 ../src/guestfs-actions.pod:2805
8445 msgid "\"installed\""
8449 #: ../fish/guestfish-actions.pod:1905 ../src/guestfs-actions.pod:2807
8450 msgid "This is an installed operating system."
8454 #: ../fish/guestfish-actions.pod:1907 ../src/guestfs-actions.pod:2809
8455 msgid "\"installer\""
8459 #: ../fish/guestfish-actions.pod:1909 ../src/guestfs-actions.pod:2811
8461 "The disk image being inspected is not an installed operating system, but a "
8462 "I<bootable> install disk, live CD, or similar."
8466 #: ../fish/guestfish-actions.pod:1914 ../src/guestfs-actions.pod:2816
8467 msgid "The format of this disk image is not known."
8471 #: ../fish/guestfish-actions.pod:1923
8472 msgid "inspect-get-hostname"
8476 #: ../fish/guestfish-actions.pod:1925
8479 " inspect-get-hostname root\n"
8484 #: ../fish/guestfish-actions.pod:1927 ../src/guestfs-actions.pod:2836
8486 "This function returns the hostname of the operating system as found by "
8487 "inspection of the guest's configuration files."
8491 #: ../fish/guestfish-actions.pod:1930 ../src/guestfs-actions.pod:2839
8493 "If the hostname could not be determined, then the string C<unknown> is "
8498 #: ../fish/guestfish-actions.pod:1935
8499 msgid "inspect-get-icon"
8503 #: ../fish/guestfish-actions.pod:1937
8506 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8511 #: ../fish/guestfish-actions.pod:1939 ../src/guestfs-actions.pod:2865
8513 "This function returns an icon corresponding to the inspected operating "
8514 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
8515 "to PNG if necessary)."
8519 #: ../fish/guestfish-actions.pod:1943 ../src/guestfs-actions.pod:2869
8521 "If it was not possible to get an icon this function returns a zero-length "
8522 "(non-NULL) buffer. I<Callers must check for this case>."
8526 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
8528 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8529 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8530 "this file will be returned. You can disable favicons by passing the "
8531 "optional C<favicon> boolean as false (default is true)."
8535 #: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:2878
8537 "If finding the favicon fails, then we look in other places in the guest for "
8542 #: ../fish/guestfish-actions.pod:1955 ../src/guestfs-actions.pod:2881
8544 "If the optional C<highquality> boolean is true then only high quality icons "
8545 "are returned, which means only icons of high resolution with an alpha "
8546 "channel. The default (false) is to return any icon we can, even if it is of "
8547 "substandard quality."
8551 #: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:2892
8553 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8554 "before you call this, since it needs to read information from the guest "
8555 "filesystem during the call."
8559 #: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:2898
8561 "B<Security:> The icon data comes from the untrusted guest, and should be "
8562 "treated with caution. PNG files have been known to contain exploits. "
8563 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8564 "trying to process or display the icon."
8568 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:2906
8570 "The PNG image returned can be any size. It might not be square. Libguestfs "
8571 "tries to return the largest, highest quality icon available. The "
8572 "application must scale the icon to the required size."
8576 #: ../fish/guestfish-actions.pod:1987 ../src/guestfs-actions.pod:2913
8578 "Extracting icons from Windows guests requires the external C<wrestool> "
8579 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8580 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8581 "installed separately."
8585 #: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:2920
8587 "Operating system icons are usually trademarks. Seek legal advice before "
8588 "using trademarks in applications."
8592 #: ../fish/guestfish-actions.pod:2001
8593 msgid "inspect-get-major-version"
8597 #: ../fish/guestfish-actions.pod:2003
8600 " inspect-get-major-version root\n"
8605 #: ../fish/guestfish-actions.pod:2005 ../src/guestfs-actions.pod:2961
8607 "This returns the major version number of the inspected operating system."
8611 #: ../fish/guestfish-actions.pod:2008 ../src/guestfs-actions.pod:2964
8613 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8614 "popular public names used by the operating system. Notably the operating "
8615 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8616 "1). You can find out the real versions corresponding to releases of Windows "
8617 "by consulting Wikipedia or MSDN."
8621 #: ../fish/guestfish-actions.pod:2015 ../fish/guestfish-actions.pod:2026
8622 #: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:2988
8623 msgid "If the version could not be determined, then C<0> is returned."
8627 #: ../fish/guestfish-actions.pod:2019
8628 msgid "inspect-get-minor-version"
8632 #: ../fish/guestfish-actions.pod:2021
8635 " inspect-get-minor-version root\n"
8640 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2985
8642 "This returns the minor version number of the inspected operating system."
8646 #: ../fish/guestfish-actions.pod:2028
8648 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8649 "get-major-version>."
8653 #: ../fish/guestfish-actions.pod:2031
8654 msgid "inspect-get-mountpoints"
8658 #: ../fish/guestfish-actions.pod:2033
8661 " inspect-get-mountpoints root\n"
8666 #: ../fish/guestfish-actions.pod:2035 ../src/guestfs-actions.pod:3003
8668 "This returns a hash of where we think the filesystems associated with this "
8669 "operating system should be mounted. Callers should note that this is at "
8670 "best an educated guess made by reading configuration files such as C</etc/"
8671 "fstab>. I<In particular note> that this may return filesystems which are "
8672 "non-existent or not mountable and callers should be prepared to handle or "
8673 "ignore failures if they try to mount them."
8677 #: ../fish/guestfish-actions.pod:2044 ../src/guestfs-actions.pod:3012
8679 "Each element in the returned hashtable has a key which is the path of the "
8680 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8681 "mounted there (eg. C</dev/sda1>)."
8685 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3017
8687 "Non-mounted devices such as swap devices are I<not> returned in this list."
8691 #: ../fish/guestfish-actions.pod:2052
8693 "For operating systems like Windows which still use drive letters, this call "
8694 "will only return an entry for the first drive \"mounted on\" C</>. For "
8695 "information about the mapping of drive letters to partitions, see L</inspect-"
8696 "get-drive-mappings>."
8700 #: ../fish/guestfish-actions.pod:2058
8702 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8707 #: ../fish/guestfish-actions.pod:2061
8708 msgid "inspect-get-package-format"
8712 #: ../fish/guestfish-actions.pod:2063
8715 " inspect-get-package-format root\n"
8720 #: ../fish/guestfish-actions.pod:2065
8722 "This function and L</inspect-get-package-management> return the package "
8723 "format and package management tool used by the inspected operating system. "
8724 "For example for Fedora these functions would return C<rpm> (package format) "
8725 "and C<yum> (package management)."
8729 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3049
8731 "This returns the string C<unknown> if we could not determine the package "
8732 "format I<or> if the operating system does not have a real packaging system "
8737 #: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3053
8739 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8740 "Future versions of libguestfs may return other strings."
8744 #: ../fish/guestfish-actions.pod:2080
8745 msgid "inspect-get-package-management"
8749 #: ../fish/guestfish-actions.pod:2082
8752 " inspect-get-package-management root\n"
8757 #: ../fish/guestfish-actions.pod:2084
8759 "L</inspect-get-package-format> and this function return the package format "
8760 "and package management tool used by the inspected operating system. For "
8761 "example for Fedora these functions would return C<rpm> (package format) and "
8762 "C<yum> (package management)."
8766 #: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3075
8768 "This returns the string C<unknown> if we could not determine the package "
8769 "management tool I<or> if the operating system does not have a real packaging "
8770 "system (eg. Windows)."
8774 #: ../fish/guestfish-actions.pod:2094 ../src/guestfs-actions.pod:3079
8776 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8777 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8778 "libguestfs may return other strings."
8782 #: ../fish/guestfish-actions.pod:2101
8783 msgid "inspect-get-product-name"
8787 #: ../fish/guestfish-actions.pod:2103
8790 " inspect-get-product-name root\n"
8795 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3097
8797 "This returns the product name of the inspected operating system. The "
8798 "product name is generally some freeform string which can be displayed to the "
8799 "user, but should not be parsed by programs."
8803 #: ../fish/guestfish-actions.pod:2110 ../src/guestfs-actions.pod:3102
8805 "If the product name could not be determined, then the string C<unknown> is "
8810 #: ../fish/guestfish-actions.pod:2115
8811 msgid "inspect-get-product-variant"
8815 #: ../fish/guestfish-actions.pod:2117
8818 " inspect-get-product-variant root\n"
8823 #: ../fish/guestfish-actions.pod:2119 ../src/guestfs-actions.pod:3118
8824 msgid "This returns the product variant of the inspected operating system."
8828 #: ../fish/guestfish-actions.pod:2122 ../src/guestfs-actions.pod:3121
8830 "For Windows guests, this returns the contents of the Registry key C<HKLM"
8831 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
8832 "is usually a string such as C<Client> or C<Server> (other values are "
8833 "possible). This can be used to distinguish consumer and enterprise versions "
8834 "of Windows that have the same version number (for example, Windows 7 and "
8835 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8836 "the latter is C<Server>)."
8840 #: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3130
8842 "For enterprise Linux guests, in future we intend this to return the product "
8843 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8844 "implemented at present."
8848 #: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3134
8850 "If the product variant could not be determined, then the string C<unknown> "
8855 #: ../fish/guestfish-actions.pod:2138
8857 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
8858 "get-product-name>, L</inspect-get-major-version>."
8862 #: ../fish/guestfish-actions.pod:2142
8863 msgid "inspect-get-roots"
8867 #: ../fish/guestfish-actions.pod:2144
8870 " inspect-get-roots\n"
8875 #: ../fish/guestfish-actions.pod:2146
8877 "This function is a convenient way to get the list of root devices, as "
8878 "returned from a previous call to L</inspect-os>, but without redoing the "
8879 "whole inspection process."
8883 #: ../fish/guestfish-actions.pod:2150
8885 "This returns an empty list if either no root devices were found or the "
8886 "caller has not called L</inspect-os>."
8890 #: ../fish/guestfish-actions.pod:2155
8891 msgid "inspect-get-type"
8895 #: ../fish/guestfish-actions.pod:2157
8898 " inspect-get-type root\n"
8903 #: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3172
8905 "This returns the type of the inspected operating system. Currently defined "
8910 #: ../fish/guestfish-actions.pod:2164 ../src/guestfs-actions.pod:3177
8915 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3179
8916 msgid "Any Linux-based operating system."
8920 #: ../fish/guestfish-actions.pod:2170 ../src/guestfs-actions.pod:3183
8921 msgid "Any Microsoft Windows operating system."
8925 #: ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:3185
8930 #: ../fish/guestfish-actions.pod:2174 ../src/guestfs-actions.pod:3187
8935 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3191
8936 msgid "The operating system type could not be determined."
8940 #: ../fish/guestfish-actions.pod:2187
8941 msgid "inspect-get-windows-current-control-set"
8945 #: ../fish/guestfish-actions.pod:2189
8948 " inspect-get-windows-current-control-set root\n"
8953 #: ../fish/guestfish-actions.pod:2191 ../src/guestfs-actions.pod:3211
8955 "This returns the Windows CurrentControlSet of the inspected guest. The "
8956 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8960 #: ../fish/guestfish-actions.pod:2194 ../src/guestfs-actions.pod:3214
8962 "This call assumes that the guest is Windows and that the Registry could be "
8963 "examined by inspection. If this is not the case then an error is returned."
8967 #: ../fish/guestfish-actions.pod:2200
8968 msgid "inspect-get-windows-systemroot"
8972 #: ../fish/guestfish-actions.pod:2202
8975 " inspect-get-windows-systemroot root\n"
8980 #: ../fish/guestfish-actions.pod:2204 ../src/guestfs-actions.pod:3231
8982 "This returns the Windows systemroot of the inspected guest. The systemroot "
8983 "is a directory path such as C</WINDOWS>."
8987 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3234
8989 "This call assumes that the guest is Windows and that the systemroot could be "
8990 "determined by inspection. If this is not the case then an error is returned."
8994 #: ../fish/guestfish-actions.pod:2213
8995 msgid "inspect-is-live"
8999 #: ../fish/guestfish-actions.pod:2215
9002 " inspect-is-live root\n"
9007 #: ../fish/guestfish-actions.pod:2217
9009 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
9010 "then this returns true if a live image was detected on the disk."
9014 #: ../fish/guestfish-actions.pod:2223
9015 msgid "inspect-is-multipart"
9019 #: ../fish/guestfish-actions.pod:2225
9022 " inspect-is-multipart root\n"
9027 #: ../fish/guestfish-actions.pod:2227
9029 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
9030 "then this returns true if the disk is part of a set."
9034 #: ../fish/guestfish-actions.pod:2233
9035 msgid "inspect-is-netinst"
9039 #: ../fish/guestfish-actions.pod:2235
9042 " inspect-is-netinst root\n"
9047 #: ../fish/guestfish-actions.pod:2237
9049 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
9050 "then this returns true if the disk is a network installer, ie. not a self-"
9051 "contained install CD but one which is likely to require network access to "
9052 "complete the install."
9056 #: ../fish/guestfish-actions.pod:2245
9057 msgid "inspect-list-applications"
9061 #: ../fish/guestfish-actions.pod:2247
9064 " inspect-list-applications root\n"
9069 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
9070 msgid "Return the list of applications installed in the operating system."
9074 #: ../fish/guestfish-actions.pod:2251
9076 "I<Note:> This call works differently from other parts of the inspection "
9077 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
9078 "then mount up the disks, before calling this. Listing applications is a "
9079 "significantly more difficult operation which requires access to the full "
9080 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
9081 "are just returning data cached in the libguestfs handle, this call actually "
9082 "reads parts of the mounted filesystems during the call."
9086 #: ../fish/guestfish-actions.pod:2261 ../src/guestfs-actions.pod:3313
9088 "This returns an empty list if the inspection code was not able to determine "
9089 "the list of applications."
9093 #: ../fish/guestfish-actions.pod:2264 ../src/guestfs-actions.pod:3316
9094 msgid "The application structure contains the following fields:"
9098 #: ../fish/guestfish-actions.pod:2268 ../src/guestfs-actions.pod:3320
9103 #: ../fish/guestfish-actions.pod:2270 ../src/guestfs-actions.pod:3322
9105 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9106 "guests, this is the package name."
9110 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
9111 msgid "C<app_display_name>"
9115 #: ../fish/guestfish-actions.pod:2275 ../src/guestfs-actions.pod:3327
9117 "The display name of the application, sometimes localized to the install "
9118 "language of the guest operating system."
9122 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
9124 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9125 "to display something can use C<app_name> instead."
9129 #: ../fish/guestfish-actions.pod:2281 ../src/guestfs-actions.pod:3333
9130 msgid "C<app_epoch>"
9134 #: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3335
9136 "For package managers which use epochs, this contains the epoch of the "
9137 "package (an integer). If unavailable, this is returned as C<0>."
9141 #: ../fish/guestfish-actions.pod:2286 ../src/guestfs-actions.pod:3338
9142 msgid "C<app_version>"
9146 #: ../fish/guestfish-actions.pod:2288 ../src/guestfs-actions.pod:3340
9148 "The version string of the application or package. If unavailable this is "
9149 "returned as an empty string C<\"\">."
9153 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
9154 msgid "C<app_release>"
9158 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
9160 "The release string of the application or package, for package managers that "
9161 "use this. If unavailable this is returned as an empty string C<\"\">."
9165 #: ../fish/guestfish-actions.pod:2297 ../src/guestfs-actions.pod:3349
9166 msgid "C<app_install_path>"
9170 #: ../fish/guestfish-actions.pod:2299 ../src/guestfs-actions.pod:3351
9172 "The installation path of the application (on operating systems such as "
9173 "Windows which use installation paths). This path is in the format used by "
9174 "the guest operating system, it is not a libguestfs path."
9178 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3356
9179 msgid "If unavailable this is returned as an empty string C<\"\">."
9183 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
9184 msgid "C<app_trans_path>"
9188 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
9190 "The install path translated into a libguestfs path. If unavailable this is "
9191 "returned as an empty string C<\"\">."
9195 #: ../fish/guestfish-actions.pod:2311 ../src/guestfs-actions.pod:3363
9196 msgid "C<app_publisher>"
9200 #: ../fish/guestfish-actions.pod:2313 ../src/guestfs-actions.pod:3365
9202 "The name of the publisher of the application, for package managers that use "
9203 "this. If unavailable this is returned as an empty string C<\"\">."
9207 #: ../fish/guestfish-actions.pod:2317 ../src/guestfs-actions.pod:3369
9212 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3371
9214 "The URL (eg. upstream URL) of the application. If unavailable this is "
9215 "returned as an empty string C<\"\">."
9219 #: ../fish/guestfish-actions.pod:2322 ../src/guestfs-actions.pod:3374
9220 msgid "C<app_source_package>"
9224 #: ../fish/guestfish-actions.pod:2324 ../src/guestfs-actions.pod:3376
9226 "For packaging systems which support this, the name of the source package. "
9227 "If unavailable this is returned as an empty string C<\"\">."
9231 #: ../fish/guestfish-actions.pod:2327 ../src/guestfs-actions.pod:3379
9232 msgid "C<app_summary>"
9236 #: ../fish/guestfish-actions.pod:2329 ../src/guestfs-actions.pod:3381
9238 "A short (usually one line) description of the application or package. If "
9239 "unavailable this is returned as an empty string C<\"\">."
9243 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3384
9244 msgid "C<app_description>"
9248 #: ../fish/guestfish-actions.pod:2334 ../src/guestfs-actions.pod:3386
9250 "A longer description of the application or package. If unavailable this is "
9251 "returned as an empty string C<\"\">."
9255 #: ../fish/guestfish-actions.pod:2341
9260 #: ../fish/guestfish-actions.pod:2343
9268 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3404
9270 "This function uses other libguestfs functions and certain heuristics to "
9271 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9272 "for operating systems."
9276 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3408
9277 msgid "The list returned is empty if no operating systems were found."
9281 #: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3410
9283 "If one operating system was found, then this returns a list with a single "
9284 "element, which is the name of the root filesystem of this operating system. "
9285 "It is also possible for this function to return a list containing more than "
9286 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9287 "element being the root filesystem of one of the operating systems."
9291 #: ../fish/guestfish-actions.pod:2358
9293 "You can pass the root string(s) returned to other L</inspect-get-*> "
9294 "functions in order to query further information about each operating system, "
9295 "such as the name and version."
9299 #: ../fish/guestfish-actions.pod:2363
9301 "This function uses other libguestfs features such as L</mount-ro> and L</"
9302 "umount-all> in order to mount and unmount filesystems and look at the "
9303 "contents. This should be called with no disks currently mounted. The "
9304 "function may also use Augeas, so any existing Augeas handle will be closed."
9308 #: ../fish/guestfish-actions.pod:2369 ../src/guestfs-actions.pod:3428
9310 "This function cannot decrypt encrypted disks. The caller must do that first "
9311 "(supplying the necessary keys) if the disk is encrypted."
9315 #: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2573
9316 #: ../fish/guestfish-actions.pod:2632
9317 msgid "See also L</list-filesystems>."
9321 #: ../fish/guestfish-actions.pod:2377
9326 #: ../fish/guestfish-actions.pod:2379
9329 " is-blockdev path\n"
9334 #: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3448
9336 "This returns C<true> if and only if there is a block device with the given "
9341 #: ../fish/guestfish-actions.pod:2384 ../fish/guestfish-actions.pod:2402
9342 #: ../fish/guestfish-actions.pod:2421 ../fish/guestfish-actions.pod:2430
9343 #: ../fish/guestfish-actions.pod:2440 ../fish/guestfish-actions.pod:2474
9344 #: ../fish/guestfish-actions.pod:2483
9345 msgid "See also L</stat>."
9349 #: ../fish/guestfish-actions.pod:2386
9354 #: ../fish/guestfish-actions.pod:2388
9362 #: ../fish/guestfish-actions.pod:2390 ../src/guestfs-actions.pod:3462
9364 "This returns true iff this handle is busy processing a command (in the "
9369 #: ../fish/guestfish-actions.pod:2395
9374 #: ../fish/guestfish-actions.pod:2397
9377 " is-chardev path\n"
9382 #: ../fish/guestfish-actions.pod:2399 ../src/guestfs-actions.pod:3477
9384 "This returns C<true> if and only if there is a character device with the "
9385 "given C<path> name."
9389 #: ../fish/guestfish-actions.pod:2404
9394 #: ../fish/guestfish-actions.pod:2406
9402 #: ../fish/guestfish-actions.pod:2408 ../src/guestfs-actions.pod:3491
9404 "This returns true iff this handle is being configured (in the C<CONFIG> "
9409 #: ../fish/guestfish-actions.pod:2413
9414 #: ../fish/guestfish-actions.pod:2415
9422 #: ../fish/guestfish-actions.pod:2417 ../src/guestfs-actions.pod:3506
9424 "This returns C<true> if and only if there is a directory with the given "
9425 "C<path> name. Note that it returns false for other objects like files."
9429 #: ../fish/guestfish-actions.pod:2423
9434 #: ../fish/guestfish-actions.pod:2425
9442 #: ../fish/guestfish-actions.pod:2427 ../src/guestfs-actions.pod:3522
9444 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9445 "given C<path> name."
9449 #: ../fish/guestfish-actions.pod:2432
9454 #: ../fish/guestfish-actions.pod:2434
9462 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3537
9464 "This returns C<true> if and only if there is a regular file with the given "
9465 "C<path> name. Note that it returns false for other objects like directories."
9469 #: ../fish/guestfish-actions.pod:2442
9470 msgid "is-launching"
9474 #: ../fish/guestfish-actions.pod:2444
9482 #: ../fish/guestfish-actions.pod:2446 ../src/guestfs-actions.pod:3552
9484 "This returns true iff this handle is launching the subprocess (in the "
9485 "C<LAUNCHING> state)."
9489 #: ../fish/guestfish-actions.pod:2451
9494 #: ../fish/guestfish-actions.pod:2453
9502 #: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3567
9504 "This command tests whether C<device> is a logical volume, and returns true "
9505 "iff this is the case."
9509 #: ../fish/guestfish-actions.pod:2458
9514 #: ../fish/guestfish-actions.pod:2460
9522 #: ../fish/guestfish-actions.pod:2462 ../src/guestfs-actions.pod:3579
9524 "This returns true iff this handle is ready to accept commands (in the "
9529 #: ../fish/guestfish-actions.pod:2467
9534 #: ../fish/guestfish-actions.pod:2469
9542 #: ../fish/guestfish-actions.pod:2471 ../src/guestfs-actions.pod:3594
9544 "This returns C<true> if and only if there is a Unix domain socket with the "
9545 "given C<path> name."
9549 #: ../fish/guestfish-actions.pod:2476
9554 #: ../fish/guestfish-actions.pod:2478
9557 " is-symlink path\n"
9562 #: ../fish/guestfish-actions.pod:2480 ../src/guestfs-actions.pod:3609
9564 "This returns C<true> if and only if there is a symbolic link with the given "
9569 #: ../fish/guestfish-actions.pod:2485
9574 #: ../fish/guestfish-actions.pod:2487
9582 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3624
9584 "This returns true iff the file exists and the file is empty or it contains "
9589 #: ../fish/guestfish-actions.pod:2492
9590 msgid "is-zero-device"
9594 #: ../fish/guestfish-actions.pod:2494
9597 " is-zero-device device\n"
9602 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3637
9603 msgid "This returns true iff the device exists and contains all zero bytes."
9607 #: ../fish/guestfish-actions.pod:2498 ../src/guestfs-actions.pod:3639
9608 msgid "Note that for large devices this can take a long time to run."
9612 #: ../fish/guestfish-actions.pod:2500
9613 msgid "kill-subprocess"
9617 #: ../fish/guestfish-actions.pod:2502
9620 " kill-subprocess\n"
9625 #: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3650
9626 msgid "This kills the qemu subprocess. You should never need to call this."
9630 #: ../fish/guestfish-actions.pod:2506
9635 #: ../fish/guestfish-actions.pod:2508
9640 #: ../fish/guestfish-actions.pod:2510
9648 #: ../fish/guestfish-actions.pod:2512 ../src/guestfs-actions.pod:3661
9650 "Internally libguestfs is implemented by running a virtual machine using "
9655 #: ../fish/guestfish-actions.pod:2515 ../src/guestfs-actions.pod:3664
9657 "You should call this after configuring the handle (eg. adding drives) but "
9658 "before performing any actions."
9662 #: ../fish/guestfish-actions.pod:2518
9667 #: ../fish/guestfish-actions.pod:2520
9670 " lchown owner group path\n"
9675 #: ../fish/guestfish-actions.pod:2522
9677 "Change the file owner to C<owner> and group to C<group>. This is like L</"
9678 "chown> but if C<path> is a symlink then the link itself is changed, not the "
9683 #: ../fish/guestfish-actions.pod:2530
9688 #: ../fish/guestfish-actions.pod:2532
9691 " lgetxattr path name\n"
9696 #: ../fish/guestfish-actions.pod:2534 ../src/guestfs-actions.pod:3704
9698 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9699 "is a symlink, then this call returns an extended attribute from the symlink."
9703 #: ../fish/guestfish-actions.pod:2548
9704 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9708 #: ../fish/guestfish-actions.pod:2550
9713 #: ../fish/guestfish-actions.pod:2552
9716 " lgetxattrs path\n"
9721 #: ../fish/guestfish-actions.pod:2554
9723 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9724 "it returns the extended attributes of the link itself."
9728 #: ../fish/guestfish-actions.pod:2558
9733 #: ../fish/guestfish-actions.pod:2560
9741 #: ../fish/guestfish-actions.pod:2562 ../src/guestfs-actions.pod:3747
9743 "List all 9p filesystems attached to the guest. A list of mount tags is "
9748 #: ../fish/guestfish-actions.pod:2565
9749 msgid "list-devices"
9753 #: ../fish/guestfish-actions.pod:2567
9761 #: ../fish/guestfish-actions.pod:2569 ../src/guestfs-actions.pod:3761
9762 msgid "List all the block devices."
9766 #: ../fish/guestfish-actions.pod:2571 ../src/guestfs-actions.pod:3763
9767 msgid "The full block device names are returned, eg. C</dev/sda>."
9771 #: ../fish/guestfish-actions.pod:2575
9772 msgid "list-dm-devices"
9776 #: ../fish/guestfish-actions.pod:2577
9779 " list-dm-devices\n"
9784 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3778
9785 msgid "List all device mapper devices."
9789 #: ../fish/guestfish-actions.pod:2581
9791 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9792 "previous call to L</luks-open>."
9796 #: ../fish/guestfish-actions.pod:2584
9798 "Device mapper devices which correspond to logical volumes are I<not> "
9799 "returned in this list. Call L</lvs> if you want to list logical volumes."
9803 #: ../fish/guestfish-actions.pod:2588
9804 msgid "list-filesystems"
9808 #: ../fish/guestfish-actions.pod:2590
9811 " list-filesystems\n"
9816 #: ../fish/guestfish-actions.pod:2592 ../src/guestfs-actions.pod:3798
9818 "This inspection command looks for filesystems on partitions, block devices "
9819 "and logical volumes, returning a list of devices containing filesystems and "
9824 #: ../fish/guestfish-actions.pod:2596 ../src/guestfs-actions.pod:3802
9826 "The return value is a hash, where the keys are the devices containing "
9827 "filesystems, and the values are the filesystem types. For example:"
9831 #: ../fish/guestfish-actions.pod:2600 ../src/guestfs-actions.pod:3806
9834 " \"/dev/sda1\" => \"ntfs\"\n"
9835 " \"/dev/sda2\" => \"ext2\"\n"
9836 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9837 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9842 #: ../fish/guestfish-actions.pod:2605 ../src/guestfs-actions.pod:3811
9844 "The value can have the special value \"unknown\", meaning the content of the "
9845 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9849 #: ../fish/guestfish-actions.pod:2609
9851 "This command runs other libguestfs commands, which might include L</mount> "
9852 "and L</umount>, and therefore you should use this soon after launch and only "
9853 "when nothing is mounted."
9857 #: ../fish/guestfish-actions.pod:2613
9859 "Not all of the filesystems returned will be mountable. In particular, swap "
9860 "partitions are returned in the list. Also this command does not check that "
9861 "each filesystem found is valid and mountable, and some filesystems might be "
9862 "mountable but require special options. Filesystems may not all belong to a "
9863 "single logical operating system (use L</inspect-os> to look for OSes)."
9867 #: ../fish/guestfish-actions.pod:2621
9868 msgid "list-partitions"
9872 #: ../fish/guestfish-actions.pod:2623
9875 " list-partitions\n"
9880 #: ../fish/guestfish-actions.pod:2625 ../src/guestfs-actions.pod:3840
9881 msgid "List all the partitions detected on all block devices."
9885 #: ../fish/guestfish-actions.pod:2627 ../src/guestfs-actions.pod:3842
9886 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9890 #: ../fish/guestfish-actions.pod:2629
9892 "This does not return logical volumes. For that you will need to call L</"
9897 #: ../fish/guestfish-actions.pod:2634
9902 #: ../fish/guestfish-actions.pod:2636
9910 #: ../fish/guestfish-actions.pod:2638 ../src/guestfs-actions.pod:3861
9912 "List the files in C<directory> (relative to the root directory, there is no "
9913 "cwd) in the format of 'ls -la'."
9917 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3864
9919 "This command is mostly useful for interactive sessions. It is I<not> "
9920 "intended that you try to parse the output string."
9924 #: ../fish/guestfish-actions.pod:2644
9929 #: ../fish/guestfish-actions.pod:2646
9932 " ln target linkname\n"
9937 #: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:3879
9938 msgid "This command creates a hard link using the C<ln> command."
9942 #: ../fish/guestfish-actions.pod:2650
9947 #: ../fish/guestfish-actions.pod:2652
9950 " ln-f target linkname\n"
9955 #: ../fish/guestfish-actions.pod:2654 ../src/guestfs-actions.pod:3892
9957 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9958 "option removes the link (C<linkname>) if it exists already."
9962 #: ../fish/guestfish-actions.pod:2657
9967 #: ../fish/guestfish-actions.pod:2659
9970 " ln-s target linkname\n"
9975 #: ../fish/guestfish-actions.pod:2661 ../src/guestfs-actions.pod:3906
9976 msgid "This command creates a symbolic link using the C<ln -s> command."
9980 #: ../fish/guestfish-actions.pod:2663
9985 #: ../fish/guestfish-actions.pod:2665
9988 " ln-sf target linkname\n"
9993 #: ../fish/guestfish-actions.pod:2667 ../src/guestfs-actions.pod:3919
9995 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9996 "option removes the link (C<linkname>) if it exists already."
10000 #: ../fish/guestfish-actions.pod:2670
10001 msgid "lremovexattr"
10005 #: ../fish/guestfish-actions.pod:2672
10008 " lremovexattr xattr path\n"
10013 #: ../fish/guestfish-actions.pod:2674
10015 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
10016 "it removes an extended attribute of the link itself."
10020 #: ../fish/guestfish-actions.pod:2678
10025 #: ../fish/guestfish-actions.pod:2680
10033 #: ../fish/guestfish-actions.pod:2682 ../src/guestfs-actions.pod:3947
10035 "List the files in C<directory> (relative to the root directory, there is no "
10036 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10040 #: ../fish/guestfish-actions.pod:2686
10042 "This command is mostly useful for interactive sessions. Programs should "
10043 "probably use L</readdir> instead."
10047 #: ../fish/guestfish-actions.pod:2689
10052 #: ../fish/guestfish-actions.pod:2691
10055 " lsetxattr xattr val vallen path\n"
10060 #: ../fish/guestfish-actions.pod:2693
10062 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
10063 "sets an extended attribute of the link itself."
10067 #: ../fish/guestfish-actions.pod:2697
10072 #: ../fish/guestfish-actions.pod:2699
10080 #: ../fish/guestfish-actions.pod:2701 ../fish/guestfish-actions.pod:4509
10081 #: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:6762
10082 msgid "Returns file information for the given C<path>."
10086 #: ../fish/guestfish-actions.pod:2703
10088 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
10089 "the link is stat-ed, not the file it refers to."
10093 #: ../fish/guestfish-actions.pod:2707 ../src/guestfs-actions.pod:3989
10094 msgid "This is the same as the C<lstat(2)> system call."
10098 #: ../fish/guestfish-actions.pod:2709
10103 #: ../fish/guestfish-actions.pod:2711
10106 " lstatlist path 'names ...'\n"
10111 #: ../fish/guestfish-actions.pod:2713
10113 "This call allows you to perform the L</lstat> operation on multiple files, "
10114 "where all files are in the directory C<path>. C<names> is the list of files "
10115 "from this directory."
10119 #: ../fish/guestfish-actions.pod:2717 ../src/guestfs-actions.pod:4008
10121 "On return you get a list of stat structs, with a one-to-one correspondence "
10122 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10123 "then the C<ino> field of that structure is set to C<-1>."
10127 #: ../fish/guestfish-actions.pod:2722
10129 "This call is intended for programs that want to efficiently list a directory "
10130 "contents without making many round-trips. See also L</lxattrlist> for a "
10131 "similarly efficient call for getting extended attributes. Very long "
10132 "directory listings might cause the protocol message size to be exceeded, "
10133 "causing this call to fail. The caller must split up such requests into "
10134 "smaller groups of names."
10138 #: ../fish/guestfish-actions.pod:2730
10139 msgid "luks-add-key"
10143 #: ../fish/guestfish-actions.pod:2732
10146 " luks-add-key device keyslot\n"
10151 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4036
10153 "This command adds a new key on LUKS device C<device>. C<key> is any "
10154 "existing key, and is used to access the device. C<newkey> is the new key to "
10155 "add. C<keyslot> is the key slot that will be replaced."
10159 #: ../fish/guestfish-actions.pod:2739
10161 "Note that if C<keyslot> already contains a key, then this command will "
10162 "fail. You have to use L</luks-kill-slot> first to remove that key."
10166 #: ../fish/guestfish-actions.pod:2743 ../fish/guestfish-actions.pod:2765
10167 #: ../fish/guestfish-actions.pod:2778 ../fish/guestfish-actions.pod:2792
10168 #: ../fish/guestfish-actions.pod:2818 ../fish/guestfish-actions.pod:2828
10170 "This command has one or more key or passphrase parameters. Guestfish will "
10171 "prompt for these separately."
10175 #: ../fish/guestfish-actions.pod:2746
10180 #: ../fish/guestfish-actions.pod:2748
10183 " luks-close device\n"
10188 #: ../fish/guestfish-actions.pod:2750
10190 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
10191 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
10192 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
10197 #: ../fish/guestfish-actions.pod:2756
10198 msgid "luks-format"
10202 #: ../fish/guestfish-actions.pod:2758
10205 " luks-format device keyslot\n"
10210 #: ../fish/guestfish-actions.pod:2760 ../src/guestfs-actions.pod:4077
10212 "This command erases existing data on C<device> and formats the device as a "
10213 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10214 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10218 #: ../fish/guestfish-actions.pod:2768 ../fish/guestfish-actions.pod:2781
10219 #: ../fish/guestfish-actions.pod:2868 ../fish/guestfish-actions.pod:3529
10220 #: ../fish/guestfish-actions.pod:4055 ../fish/guestfish-actions.pod:4380
10221 #: ../fish/guestfish-actions.pod:4403 ../fish/guestfish-actions.pod:4425
10222 #: ../fish/guestfish-actions.pod:5171 ../src/guestfs-actions.pod:4084
10223 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:4250
10224 #: ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:6141
10225 #: ../src/guestfs-actions.pod:6576 ../src/guestfs-actions.pod:6606
10226 #: ../src/guestfs-actions.pod:6639 ../src/guestfs-actions.pod:7838
10228 "B<This command is dangerous. Without careful use you can easily destroy all "
10233 #: ../fish/guestfish-actions.pod:2771
10234 msgid "luks-format-cipher"
10238 #: ../fish/guestfish-actions.pod:2773
10241 " luks-format-cipher device keyslot cipher\n"
10246 #: ../fish/guestfish-actions.pod:2775
10248 "This command is the same as L</luks-format> but it also allows you to set "
10249 "the C<cipher> used."
10253 #: ../fish/guestfish-actions.pod:2784
10254 msgid "luks-kill-slot"
10258 #: ../fish/guestfish-actions.pod:2786
10261 " luks-kill-slot device keyslot\n"
10266 #: ../fish/guestfish-actions.pod:2788 ../src/guestfs-actions.pod:4124
10268 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10269 "device C<device>. C<key> must be one of the I<other> keys."
10273 #: ../fish/guestfish-actions.pod:2795
10278 #: ../fish/guestfish-actions.pod:2797
10281 " luks-open device mapname\n"
10286 #: ../fish/guestfish-actions.pod:2799 ../src/guestfs-actions.pod:4144
10288 "This command opens a block device which has been encrypted according to the "
10289 "Linux Unified Key Setup (LUKS) standard."
10293 #: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4147
10294 msgid "C<device> is the encrypted block device or partition."
10298 #: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4149
10300 "The caller must supply one of the keys associated with the LUKS block "
10301 "device, in the C<key> parameter."
10305 #: ../fish/guestfish-actions.pod:2807 ../src/guestfs-actions.pod:4152
10307 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10308 "writes to this block device are decrypted from and encrypted to the "
10309 "underlying C<device> respectively."
10313 #: ../fish/guestfish-actions.pod:2811
10315 "If this block device contains LVM volume groups, then calling L</vgscan> "
10316 "followed by L</vg-activate-all> will make them visible."
10320 #: ../fish/guestfish-actions.pod:2815
10321 msgid "Use L</list-dm-devices> to list all device mapper devices."
10325 #: ../fish/guestfish-actions.pod:2821
10326 msgid "luks-open-ro"
10330 #: ../fish/guestfish-actions.pod:2823
10333 " luks-open-ro device mapname\n"
10338 #: ../fish/guestfish-actions.pod:2825
10340 "This is the same as L</luks-open> except that a read-only mapping is created."
10344 #: ../fish/guestfish-actions.pod:2831
10349 #: ../fish/guestfish-actions.pod:2833
10352 " lvcreate logvol volgroup mbytes\n"
10357 #: ../fish/guestfish-actions.pod:2835 ../src/guestfs-actions.pod:4198
10359 "This creates an LVM logical volume called C<logvol> on the volume group "
10360 "C<volgroup>, with C<size> megabytes."
10364 #: ../fish/guestfish-actions.pod:2838
10365 msgid "lvm-canonical-lv-name"
10369 #: ../fish/guestfish-actions.pod:2840
10372 " lvm-canonical-lv-name lvname\n"
10377 #: ../fish/guestfish-actions.pod:2842 ../src/guestfs-actions.pod:4211
10379 "This converts alternative naming schemes for LVs that you might find to the "
10380 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10385 #: ../fish/guestfish-actions.pod:2846 ../src/guestfs-actions.pod:4215
10387 "This command returns an error if the C<lvname> parameter does not refer to a "
10392 #: ../fish/guestfish-actions.pod:2849
10393 msgid "See also L</is-lv>."
10397 #: ../fish/guestfish-actions.pod:2851
10398 msgid "lvm-clear-filter"
10402 #: ../fish/guestfish-actions.pod:2853
10405 " lvm-clear-filter\n"
10410 #: ../fish/guestfish-actions.pod:2855
10412 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
10417 #: ../fish/guestfish-actions.pod:2858 ../fish/guestfish-actions.pod:2889
10418 #: ../src/guestfs-actions.pod:4233 ../src/guestfs-actions.pod:4275
10420 "This command also clears the LVM cache and performs a volume group scan."
10424 #: ../fish/guestfish-actions.pod:2861
10425 msgid "lvm-remove-all"
10429 #: ../fish/guestfish-actions.pod:2863
10432 " lvm-remove-all\n"
10437 #: ../fish/guestfish-actions.pod:2865 ../src/guestfs-actions.pod:4245
10439 "This command removes all LVM logical volumes, volume groups and physical "
10444 #: ../fish/guestfish-actions.pod:2871
10445 msgid "lvm-set-filter"
10449 #: ../fish/guestfish-actions.pod:2873
10452 " lvm-set-filter 'devices ...'\n"
10457 #: ../fish/guestfish-actions.pod:2875 ../src/guestfs-actions.pod:4261
10459 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10460 "block devices in the list C<devices>, and will ignore all other attached "
10465 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4265
10467 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10468 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10469 "there are two types of duplication possible: either cloned PVs/VGs which "
10470 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10471 "same name. In normal operation you cannot create this situation, but you "
10472 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10473 "inside the LVM metadata."
10477 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4278
10478 msgid "You can filter whole block devices or individual partitions."
10482 #: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4280
10484 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10485 "filesystem), even if you are not filtering out that VG."
10489 #: ../fish/guestfish-actions.pod:2898
10494 #: ../fish/guestfish-actions.pod:2900
10497 " lvremove device\n"
10502 #: ../fish/guestfish-actions.pod:2902 ../src/guestfs-actions.pod:4294
10504 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10505 "LV, such as C</dev/VG/LV>."
10509 #: ../fish/guestfish-actions.pod:2905 ../src/guestfs-actions.pod:4297
10511 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10516 #: ../fish/guestfish-actions.pod:2908
10521 #: ../fish/guestfish-actions.pod:2910
10524 " lvrename logvol newlogvol\n"
10529 #: ../fish/guestfish-actions.pod:2912 ../src/guestfs-actions.pod:4311
10530 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10534 #: ../fish/guestfish-actions.pod:2914
10539 #: ../fish/guestfish-actions.pod:2916
10542 " lvresize device mbytes\n"
10547 #: ../fish/guestfish-actions.pod:2918 ../src/guestfs-actions.pod:4324
10549 "This resizes (expands or shrinks) an existing LVM logical volume to "
10550 "C<mbytes>. When reducing, data in the reduced part is lost."
10554 #: ../fish/guestfish-actions.pod:2922
10555 msgid "lvresize-free"
10559 #: ../fish/guestfish-actions.pod:2924
10562 " lvresize-free lv percent\n"
10567 #: ../fish/guestfish-actions.pod:2926 ../src/guestfs-actions.pod:4339
10569 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10570 "remaining free space in the volume group. Commonly you would call this with "
10571 "pc = 100 which expands the logical volume as much as possible, using all "
10572 "remaining free space in the volume group."
10576 #: ../fish/guestfish-actions.pod:2932
10581 #: ../fish/guestfish-actions.pod:2934
10589 #: ../fish/guestfish-actions.pod:2936 ../src/guestfs-actions.pod:4354
10591 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10596 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4357
10598 "This returns a list of the logical volume device names (eg. C</dev/"
10599 "VolGroup00/LogVol00>)."
10603 #: ../fish/guestfish-actions.pod:2942
10604 msgid "See also L</lvs-full>, L</list-filesystems>."
10608 #: ../fish/guestfish-actions.pod:2944
10613 #: ../fish/guestfish-actions.pod:2946
10621 #: ../fish/guestfish-actions.pod:2948 ../src/guestfs-actions.pod:4373
10623 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10624 "(8)> command. The \"full\" version includes all fields."
10628 #: ../fish/guestfish-actions.pod:2951
10633 #: ../fish/guestfish-actions.pod:2953
10641 #: ../fish/guestfish-actions.pod:2955 ../src/guestfs-actions.pod:4388
10642 msgid "This command returns the UUID of the LVM LV C<device>."
10646 #: ../fish/guestfish-actions.pod:2957
10651 #: ../fish/guestfish-actions.pod:2959
10654 " lxattrlist path 'names ...'\n"
10659 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4402
10661 "This call allows you to get the extended attributes of multiple files, where "
10662 "all files are in the directory C<path>. C<names> is the list of files from "
10667 #: ../fish/guestfish-actions.pod:2965 ../src/guestfs-actions.pod:4406
10669 "On return you get a flat list of xattr structs which must be interpreted "
10670 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10671 "C<attrval> in this struct is zero-length to indicate there was an error "
10672 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10673 "number (the number of following attributes for this file, which could be C<"
10674 "\"0\">). Then after the first xattr struct are the zero or more attributes "
10675 "for the first named file. This repeats for the second and subsequent files."
10679 #: ../fish/guestfish-actions.pod:2975
10681 "This call is intended for programs that want to efficiently list a directory "
10682 "contents without making many round-trips. See also L</lstatlist> for a "
10683 "similarly efficient call for getting standard stats. Very long directory "
10684 "listings might cause the protocol message size to be exceeded, causing this "
10685 "call to fail. The caller must split up such requests into smaller groups of "
10690 #: ../fish/guestfish-actions.pod:2983
10695 #: ../fish/guestfish-actions.pod:2985
10703 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4436
10704 msgid "Create a directory named C<path>."
10708 #: ../fish/guestfish-actions.pod:2989
10713 #: ../fish/guestfish-actions.pod:2991
10716 " mkdir-mode path mode\n"
10721 #: ../fish/guestfish-actions.pod:2993 ../src/guestfs-actions.pod:4449
10723 "This command creates a directory, setting the initial permissions of the "
10724 "directory to C<mode>."
10728 #: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4452
10730 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10731 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10736 #: ../fish/guestfish-actions.pod:3000
10737 msgid "See also L</mkdir>, L</umask>"
10741 #: ../fish/guestfish-actions.pod:3002
10746 #: ../fish/guestfish-actions.pod:3004
10754 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4468
10756 "Create a directory named C<path>, creating any parent directories as "
10757 "necessary. This is like the C<mkdir -p> shell command."
10761 #: ../fish/guestfish-actions.pod:3009
10766 #: ../fish/guestfish-actions.pod:3011
10769 " mkdtemp template\n"
10774 #: ../fish/guestfish-actions.pod:3013 ../src/guestfs-actions.pod:4481
10776 "This command creates a temporary directory. The C<template> parameter "
10777 "should be a full pathname for the temporary directory name with the final "
10778 "six characters being \"XXXXXX\"."
10782 #: ../fish/guestfish-actions.pod:3018 ../src/guestfs-actions.pod:4486
10784 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10785 "being suitable for Windows filesystems."
10789 #: ../fish/guestfish-actions.pod:3021 ../src/guestfs-actions.pod:4489
10790 msgid "The name of the temporary directory that was created is returned."
10794 #: ../fish/guestfish-actions.pod:3024 ../src/guestfs-actions.pod:4492
10795 msgid "The temporary directory is created with mode 0700 and is owned by root."
10799 #: ../fish/guestfish-actions.pod:3027 ../src/guestfs-actions.pod:4495
10801 "The caller is responsible for deleting the temporary directory and its "
10802 "contents after use."
10806 #: ../fish/guestfish-actions.pod:3030 ../src/guestfs-actions.pod:4498
10807 msgid "See also: L<mkdtemp(3)>"
10811 #: ../fish/guestfish-actions.pod:3032
10816 #: ../fish/guestfish-actions.pod:3034
10819 " mke2fs-J fstype blocksize device journal\n"
10824 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4514
10826 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10827 "C<journal>. It is equivalent to the command:"
10831 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4518
10834 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10839 #: ../fish/guestfish-actions.pod:3042
10840 msgid "See also L</mke2journal>."
10844 #: ../fish/guestfish-actions.pod:3044
10849 #: ../fish/guestfish-actions.pod:3046
10852 " mke2fs-JL fstype blocksize device label\n"
10857 #: ../fish/guestfish-actions.pod:3048 ../src/guestfs-actions.pod:4535
10859 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10860 "the journal labeled C<label>."
10864 #: ../fish/guestfish-actions.pod:3051
10865 msgid "See also L</mke2journal-L>."
10869 #: ../fish/guestfish-actions.pod:3053
10874 #: ../fish/guestfish-actions.pod:3055
10877 " mke2fs-JU fstype blocksize device uuid\n"
10882 #: ../fish/guestfish-actions.pod:3057 ../src/guestfs-actions.pod:4553
10884 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10885 "the journal with UUID C<uuid>."
10889 #: ../fish/guestfish-actions.pod:3060
10890 msgid "See also L</mke2journal-U>."
10894 #: ../fish/guestfish-actions.pod:3062
10895 msgid "mke2journal"
10899 #: ../fish/guestfish-actions.pod:3064
10902 " mke2journal blocksize device\n"
10907 #: ../fish/guestfish-actions.pod:3066 ../src/guestfs-actions.pod:4569
10909 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10914 #: ../fish/guestfish-actions.pod:3069 ../src/guestfs-actions.pod:4572
10917 " mke2fs -O journal_dev -b blocksize device\n"
10922 #: ../fish/guestfish-actions.pod:3071
10923 msgid "mke2journal-L"
10927 #: ../fish/guestfish-actions.pod:3073
10930 " mke2journal-L blocksize label device\n"
10935 #: ../fish/guestfish-actions.pod:3075 ../src/guestfs-actions.pod:4586
10936 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10940 #: ../fish/guestfish-actions.pod:3077
10941 msgid "mke2journal-U"
10945 #: ../fish/guestfish-actions.pod:3079
10948 " mke2journal-U blocksize uuid device\n"
10953 #: ../fish/guestfish-actions.pod:3081 ../src/guestfs-actions.pod:4600
10954 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10958 #: ../fish/guestfish-actions.pod:3083
10963 #: ../fish/guestfish-actions.pod:3085
10966 " mkfifo mode path\n"
10971 #: ../fish/guestfish-actions.pod:3087
10973 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10974 "is just a convenient wrapper around L</mknod>."
10978 #: ../fish/guestfish-actions.pod:3093
10983 #: ../fish/guestfish-actions.pod:3095
10986 " mkfs fstype device\n"
10991 #: ../fish/guestfish-actions.pod:3097 ../src/guestfs-actions.pod:4630
10993 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10994 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10998 #: ../fish/guestfish-actions.pod:3101
11003 #: ../fish/guestfish-actions.pod:3103
11006 " mkfs-b fstype blocksize device\n"
11011 #: ../fish/guestfish-actions.pod:3105
11013 "This call is similar to L</mkfs>, but it allows you to control the block "
11014 "size of the resulting filesystem. Supported block sizes depend on the "
11015 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11019 #: ../fish/guestfish-actions.pod:3110 ../fish/guestfish-actions.pod:3137
11020 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4696
11022 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11027 #: ../fish/guestfish-actions.pod:3113
11029 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
11034 #: ../fish/guestfish-actions.pod:3120
11039 #: ../fish/guestfish-actions.pod:3122
11042 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
11047 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
11049 "This function creates a filesystem on C<device>. The filesystem type is "
11050 "C<fstype>, for example C<ext3>."
11054 #: ../fish/guestfish-actions.pod:3131 ../src/guestfs-actions.pod:4690
11055 msgid "C<blocksize>"
11059 #: ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4692
11061 "The filesystem block size. Supported block sizes depend on the filesystem "
11062 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11067 #: ../fish/guestfish-actions.pod:3140 ../src/guestfs-actions.pod:4699
11068 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
11072 #: ../fish/guestfish-actions.pod:3142 ../src/guestfs-actions.pod:4701
11073 msgid "C<features>"
11077 #: ../fish/guestfish-actions.pod:3144 ../src/guestfs-actions.pod:4703
11078 msgid "This passes the I<-O> parameter to the external mkfs program."
11082 #: ../fish/guestfish-actions.pod:3146 ../src/guestfs-actions.pod:4705
11084 "For certain filesystem types, this allows extra filesystem features to be "
11085 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
11089 #: ../fish/guestfish-actions.pod:3150 ../src/guestfs-actions.pod:4709
11091 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
11096 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4712
11101 #: ../fish/guestfish-actions.pod:3155 ../src/guestfs-actions.pod:4714
11103 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
11104 "sets the inode size (only for ext2/3/4 filesystems at present)."
11108 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4717
11109 msgid "C<sectorsize>"
11113 #: ../fish/guestfish-actions.pod:3160 ../src/guestfs-actions.pod:4719
11115 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
11116 "sets sector size for ufs filesystem."
11120 #: ../fish/guestfish-actions.pod:3167
11121 msgid "mkmountpoint"
11125 #: ../fish/guestfish-actions.pod:3169
11128 " mkmountpoint exemptpath\n"
11133 #: ../fish/guestfish-actions.pod:3171
11135 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
11136 "to create extra mountpoints before mounting the first filesystem."
11140 #: ../fish/guestfish-actions.pod:3175 ../src/guestfs-actions.pod:4762
11142 "These calls are I<only> necessary in some very limited circumstances, mainly "
11143 "the case where you want to mount a mix of unrelated and/or read-only "
11144 "filesystems together."
11148 #: ../fish/guestfish-actions.pod:3179 ../src/guestfs-actions.pod:4766
11150 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11151 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11152 "inside that. You can unpack this as follows in guestfish:"
11156 #: ../fish/guestfish-actions.pod:3184 ../src/guestfs-actions.pod:4771
11159 " add-ro Fedora-11-i686-Live.iso\n"
11161 " mkmountpoint /cd\n"
11162 " mkmountpoint /sqsh\n"
11163 " mkmountpoint /ext3fs\n"
11164 " mount /dev/sda /cd\n"
11165 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11166 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11171 #: ../fish/guestfish-actions.pod:3193 ../src/guestfs-actions.pod:4780
11172 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11176 #: ../fish/guestfish-actions.pod:3195
11178 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
11179 "unexpected errors if you try to mix these calls. It is safest to manually "
11180 "unmount filesystems and remove mountpoints after use."
11184 #: ../fish/guestfish-actions.pod:3199
11186 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
11187 "for this to work for manual mountpoints, you must ensure that the innermost "
11188 "mountpoints have the longest pathnames, as in the example code above."
11192 #: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4791
11194 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11198 #: ../fish/guestfish-actions.pod:3206
11200 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
11201 "L</umount-all> to be called when the handle is closed which can also trigger "
11206 #: ../fish/guestfish-actions.pod:3210
11211 #: ../fish/guestfish-actions.pod:3212
11214 " mknod mode devmajor devminor path\n"
11219 #: ../fish/guestfish-actions.pod:3214 ../src/guestfs-actions.pod:4810
11221 "This call creates block or character special devices, or named pipes (FIFOs)."
11225 #: ../fish/guestfish-actions.pod:3217 ../src/guestfs-actions.pod:4813
11227 "The C<mode> parameter should be the mode, using the standard constants. "
11228 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11229 "used when creating block and character special devices."
11233 #: ../fish/guestfish-actions.pod:3222
11235 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11236 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11237 "regular file). These constants are available in the standard Linux header "
11238 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
11239 "wrappers around this command which bitwise OR in the appropriate constant "
11244 #: ../fish/guestfish-actions.pod:3232
11249 #: ../fish/guestfish-actions.pod:3234
11252 " mknod-b mode devmajor devminor path\n"
11257 #: ../fish/guestfish-actions.pod:3236
11259 "This call creates a block device node called C<path> with mode C<mode> and "
11260 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11261 "wrapper around L</mknod>."
11265 #: ../fish/guestfish-actions.pod:3242
11270 #: ../fish/guestfish-actions.pod:3244
11273 " mknod-c mode devmajor devminor path\n"
11278 #: ../fish/guestfish-actions.pod:3246
11280 "This call creates a char device node called C<path> with mode C<mode> and "
11281 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11282 "wrapper around L</mknod>."
11286 #: ../fish/guestfish-actions.pod:3252
11291 #: ../fish/guestfish-actions.pod:3254
11299 #: ../fish/guestfish-actions.pod:3256 ../src/guestfs-actions.pod:4876
11300 msgid "Create a swap partition on C<device>."
11304 #: ../fish/guestfish-actions.pod:3258
11309 #: ../fish/guestfish-actions.pod:3260
11312 " mkswap-L label device\n"
11317 #: ../fish/guestfish-actions.pod:3262 ../src/guestfs-actions.pod:4889
11318 msgid "Create a swap partition on C<device> with label C<label>."
11322 #: ../fish/guestfish-actions.pod:3264 ../src/guestfs-actions.pod:4891
11324 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11325 "sda>), just to a partition. This appears to be a limitation of the kernel "
11330 #: ../fish/guestfish-actions.pod:3268
11335 #: ../fish/guestfish-actions.pod:3270
11338 " mkswap-U uuid device\n"
11343 #: ../fish/guestfish-actions.pod:3272 ../src/guestfs-actions.pod:4906
11344 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11348 #: ../fish/guestfish-actions.pod:3274
11349 msgid "mkswap-file"
11353 #: ../fish/guestfish-actions.pod:3276
11356 " mkswap-file path\n"
11361 #: ../fish/guestfish-actions.pod:3278 ../src/guestfs-actions.pod:4918
11362 msgid "Create a swap file."
11366 #: ../fish/guestfish-actions.pod:3280
11368 "This command just writes a swap file signature to an existing file. To "
11369 "create the file itself, use something like L</fallocate>."
11373 #: ../fish/guestfish-actions.pod:3283
11378 #: ../fish/guestfish-actions.pod:3285
11381 " modprobe modulename\n"
11386 #: ../fish/guestfish-actions.pod:3287 ../src/guestfs-actions.pod:4933
11387 msgid "This loads a kernel module in the appliance."
11391 #: ../fish/guestfish-actions.pod:3289 ../src/guestfs-actions.pod:4935
11393 "The kernel module must have been whitelisted when libguestfs was built (see "
11394 "C<appliance/kmod.whitelist.in> in the source)."
11398 #: ../fish/guestfish-actions.pod:3292
11403 #: ../fish/guestfish-actions.pod:3294
11406 " mount device mountpoint\n"
11411 #: ../fish/guestfish-actions.pod:3296 ../src/guestfs-actions.pod:4956
11413 "Mount a guest disk at a position in the filesystem. Block devices are named "
11414 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11415 "those block devices contain partitions, they will have the usual names (eg. "
11416 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11420 #: ../fish/guestfish-actions.pod:3302 ../src/guestfs-actions.pod:4962
11422 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11423 "mounted on C</> before others can be mounted. Other filesystems can only be "
11424 "mounted on directories which already exist."
11428 #: ../fish/guestfish-actions.pod:3307 ../src/guestfs-actions.pod:4967
11430 "The mounted filesystem is writable, if we have sufficient permissions on the "
11431 "underlying device."
11435 #: ../fish/guestfish-actions.pod:3310
11437 "B<Important note:> When you use this call, the filesystem options C<sync> "
11438 "and C<noatime> are set implicitly. This was originally done because we "
11439 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11440 "very large negative performance impact and negligible effect on "
11441 "reliability. Therefore we recommend that you avoid using L</mount> in any "
11442 "code that needs performance, and instead use L</mount-options> (use an empty "
11443 "string for the first parameter if you don't want any options)."
11447 #: ../fish/guestfish-actions.pod:3320
11449 "I<This function is deprecated.> In new code, use the L</mount_options> call "
11454 #: ../fish/guestfish-actions.pod:3327
11459 #: ../fish/guestfish-actions.pod:3329
11462 " mount-9p mounttag mountpoint [options:..]\n"
11467 #: ../fish/guestfish-actions.pod:3331 ../src/guestfs-actions.pod:4999
11469 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
11474 #: ../fish/guestfish-actions.pod:3334 ../src/guestfs-actions.pod:5002
11476 "If required, C<trans=virtio> will be automatically added to the options. "
11477 "Any other options required can be passed in the optional C<options> "
11482 #: ../fish/guestfish-actions.pod:3340
11487 #: ../fish/guestfish-actions.pod:3342
11490 " mount-loop file mountpoint\n"
11495 #: ../fish/guestfish-actions.pod:3344 ../src/guestfs-actions.pod:5041
11497 "This command lets you mount C<file> (a filesystem image in a file) on a "
11498 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11503 #: ../fish/guestfish-actions.pod:3348
11504 msgid "mount-options"
11508 #: ../fish/guestfish-actions.pod:3350
11511 " mount-options options device mountpoint\n"
11516 #: ../fish/guestfish-actions.pod:3352
11518 "This is the same as the L</mount> command, but it allows you to set the "
11519 "mount options as for the L<mount(8)> I<-o> flag."
11523 #: ../fish/guestfish-actions.pod:3356 ../src/guestfs-actions.pod:5061
11525 "If the C<options> parameter is an empty string, then no options are passed "
11526 "(all options default to whatever the filesystem uses)."
11530 #: ../fish/guestfish-actions.pod:3360
11535 #: ../fish/guestfish-actions.pod:3362
11538 " mount-ro device mountpoint\n"
11543 #: ../fish/guestfish-actions.pod:3364
11545 "This is the same as the L</mount> command, but it mounts the filesystem with "
11546 "the read-only (I<-o ro>) flag."
11550 #: ../fish/guestfish-actions.pod:3367
11555 #: ../fish/guestfish-actions.pod:3369
11558 " mount-vfs options vfstype device mountpoint\n"
11563 #: ../fish/guestfish-actions.pod:3371
11565 "This is the same as the L</mount> command, but it allows you to set both the "
11566 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11570 #: ../fish/guestfish-actions.pod:3375
11571 msgid "mountpoints"
11575 #: ../fish/guestfish-actions.pod:3377
11583 #: ../fish/guestfish-actions.pod:3379
11585 "This call is similar to L</mounts>. That call returns a list of devices. "
11586 "This one returns a hash table (map) of device name to directory where the "
11587 "device is mounted."
11591 #: ../fish/guestfish-actions.pod:3383
11596 #: ../fish/guestfish-actions.pod:3385
11604 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5122
11606 "This returns the list of currently mounted filesystems. It returns the list "
11607 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11611 #: ../fish/guestfish-actions.pod:3390 ../src/guestfs-actions.pod:5125
11612 msgid "Some internal mounts are not shown."
11616 #: ../fish/guestfish-actions.pod:3392
11617 msgid "See also: L</mountpoints>"
11621 #: ../fish/guestfish-actions.pod:3394
11626 #: ../fish/guestfish-actions.pod:3396
11634 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5142
11636 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11637 "destination filename or destination directory."
11641 #: ../fish/guestfish-actions.pod:3401
11642 msgid "ntfs-3g-probe"
11646 #: ../fish/guestfish-actions.pod:3403
11649 " ntfs-3g-probe true|false device\n"
11654 #: ../fish/guestfish-actions.pod:3405 ../src/guestfs-actions.pod:5156
11656 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11657 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11658 "write, and some cannot be mounted at all)."
11662 #: ../fish/guestfish-actions.pod:3409 ../src/guestfs-actions.pod:5160
11664 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11665 "can be mounted read-write. Set it to false if you want to test if the "
11666 "volume can be mounted read-only."
11670 #: ../fish/guestfish-actions.pod:3413 ../src/guestfs-actions.pod:5164
11672 "The return value is an integer which C<0> if the operation would succeed, or "
11673 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11677 #: ../fish/guestfish-actions.pod:3417
11682 #: ../fish/guestfish-actions.pod:3419
11685 " ntfsresize device\n"
11690 #: ../fish/guestfish-actions.pod:3421 ../fish/guestfish-actions.pod:3445
11691 #: ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:5217
11693 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11694 "size of the underlying device."
11698 #: ../fish/guestfish-actions.pod:3424 ../src/guestfs-actions.pod:5188
11700 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11701 "consistency check (for safety). You have to boot into Windows to perform "
11702 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11703 "resize filesystems which have been marked in this way. So in effect it is "
11704 "not possible to call ntfsresize multiple times on a single filesystem "
11705 "without booting into Windows between each resize."
11709 #: ../fish/guestfish-actions.pod:3432 ../fish/guestfish-actions.pod:3471
11710 #: ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5243
11711 msgid "See also L<ntfsresize(8)>."
11715 #: ../fish/guestfish-actions.pod:3434 ../fish/guestfish-actions.pod:3482
11717 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
11722 #: ../fish/guestfish-actions.pod:3441
11723 msgid "ntfsresize-opts"
11727 #: ../fish/guestfish-actions.pod:3443
11730 " ntfsresize-opts device [size:..] [force:..]\n"
11735 #: ../fish/guestfish-actions.pod:3454 ../src/guestfs-actions.pod:5226
11737 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11738 "resized to fit the container (eg. partition)."
11742 #: ../fish/guestfish-actions.pod:3457 ../src/guestfs-actions.pod:5229
11747 #: ../fish/guestfish-actions.pod:3459 ../src/guestfs-actions.pod:5231
11749 "If this option is true, then force the resize of the filesystem even if the "
11750 "filesystem is marked as requiring a consistency check."
11754 #: ../fish/guestfish-actions.pod:3462
11756 "After the resize operation, the filesystem is always marked as requiring a "
11757 "consistency check (for safety). You have to boot into Windows to perform "
11758 "this check and clear this condition. If you I<don't> set the C<force> "
11759 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11760 "a single filesystem without booting into Windows between each resize."
11764 #: ../fish/guestfish-actions.pod:3475
11765 msgid "ntfsresize-size"
11769 #: ../fish/guestfish-actions.pod:3477
11772 " ntfsresize-size device size\n"
11777 #: ../fish/guestfish-actions.pod:3479
11779 "This command is the same as L</ntfsresize> except that it allows you to "
11780 "specify the new size (in bytes) explicitly."
11784 #: ../fish/guestfish-actions.pod:3489
11789 #: ../fish/guestfish-actions.pod:3491
11792 " part-add device prlogex startsect endsect\n"
11797 #: ../fish/guestfish-actions.pod:3493
11799 "This command adds a partition to C<device>. If there is no partition table "
11800 "on the device, call L</part-init> first."
11804 #: ../fish/guestfish-actions.pod:3496 ../src/guestfs-actions.pod:5304
11806 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11807 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11808 "C<logical>) and C<e> (or C<extended>) partition types."
11812 #: ../fish/guestfish-actions.pod:3501 ../src/guestfs-actions.pod:5309
11814 "C<startsect> and C<endsect> are the start and end of the partition in "
11815 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11816 "from the end of the disk (C<-1> is the last sector)."
11820 #: ../fish/guestfish-actions.pod:3505
11822 "Creating a partition which covers the whole disk is not so easy. Use L</"
11823 "part-disk> to do that."
11827 #: ../fish/guestfish-actions.pod:3508
11832 #: ../fish/guestfish-actions.pod:3510
11835 " part-del device partnum\n"
11840 #: ../fish/guestfish-actions.pod:3512 ../src/guestfs-actions.pod:5327
11841 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11845 #: ../fish/guestfish-actions.pod:3514 ../src/guestfs-actions.pod:5329
11847 "Note that in the case of MBR partitioning, deleting an extended partition "
11848 "also deletes any logical partitions it contains."
11852 #: ../fish/guestfish-actions.pod:3518
11857 #: ../fish/guestfish-actions.pod:3520
11860 " part-disk device parttype\n"
11865 #: ../fish/guestfish-actions.pod:3522
11867 "This command is simply a combination of L</part-init> followed by L</part-"
11868 "add> to create a single primary partition covering the whole disk."
11872 #: ../fish/guestfish-actions.pod:3526
11874 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11875 "possible values are described in L</part-init>."
11879 #: ../fish/guestfish-actions.pod:3532
11880 msgid "part-get-bootable"
11884 #: ../fish/guestfish-actions.pod:3534
11887 " part-get-bootable device partnum\n"
11892 #: ../fish/guestfish-actions.pod:3536 ../src/guestfs-actions.pod:5365
11894 "This command returns true if the partition C<partnum> on C<device> has the "
11895 "bootable flag set."
11899 #: ../fish/guestfish-actions.pod:3539
11900 msgid "See also L</part-set-bootable>."
11904 #: ../fish/guestfish-actions.pod:3541
11905 msgid "part-get-mbr-id"
11909 #: ../fish/guestfish-actions.pod:3543
11912 " part-get-mbr-id device partnum\n"
11917 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5381
11919 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11920 "partition C<partnum>."
11924 #: ../fish/guestfish-actions.pod:3548 ../fish/guestfish-actions.pod:3692
11926 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11927 "undefined results for other partition table types (see L</part-get-"
11932 #: ../fish/guestfish-actions.pod:3552
11933 msgid "part-get-parttype"
11937 #: ../fish/guestfish-actions.pod:3554
11940 " part-get-parttype device\n"
11945 #: ../fish/guestfish-actions.pod:3556 ../src/guestfs-actions.pod:5398
11947 "This command examines the partition table on C<device> and returns the "
11948 "partition table type (format) being used."
11952 #: ../fish/guestfish-actions.pod:3559
11954 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11955 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11956 "possible, although unusual. See L</part-init> for a full list."
11960 #: ../fish/guestfish-actions.pod:3564
11965 #: ../fish/guestfish-actions.pod:3566
11968 " part-init device parttype\n"
11973 #: ../fish/guestfish-actions.pod:3568 ../src/guestfs-actions.pod:5418
11975 "This creates an empty partition table on C<device> of one of the partition "
11976 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11977 "(for large disks)."
11981 #: ../fish/guestfish-actions.pod:3572
11983 "Initially there are no partitions. Following this, you should call L</part-"
11984 "add> for each partition required."
11988 #: ../fish/guestfish-actions.pod:3575 ../src/guestfs-actions.pod:5425
11989 msgid "Possible values for C<parttype> are:"
11993 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11998 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
12003 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
12004 msgid "Intel EFI / GPT partition table."
12008 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
12010 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12011 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12012 "the C<mbr> format."
12016 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
12021 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
12026 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
12028 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12029 "Windows. This partition type will B<only> work for device sizes up to 2 "
12030 "TB. For large disks we recommend using C<gpt>."
12034 #: ../fish/guestfish-actions.pod:3600 ../src/guestfs-actions.pod:5450
12036 "Other partition table types that may work but are not supported include:"
12040 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
12045 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
12046 msgid "AIX disk labels."
12050 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
12055 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
12060 #: ../fish/guestfish-actions.pod:3613 ../src/guestfs-actions.pod:5463
12061 msgid "Amiga \"Rigid Disk Block\" format."
12065 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5465
12070 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5467
12071 msgid "BSD disk labels."
12075 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5469
12080 #: ../fish/guestfish-actions.pod:3621 ../src/guestfs-actions.pod:5471
12081 msgid "DASD, used on IBM mainframes."
12085 #: ../fish/guestfish-actions.pod:3623 ../src/guestfs-actions.pod:5473
12090 #: ../fish/guestfish-actions.pod:3625 ../src/guestfs-actions.pod:5475
12091 msgid "MIPS/SGI volumes."
12095 #: ../fish/guestfish-actions.pod:3627 ../src/guestfs-actions.pod:5477
12100 #: ../fish/guestfish-actions.pod:3629 ../src/guestfs-actions.pod:5479
12101 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12105 #: ../fish/guestfish-actions.pod:3631 ../src/guestfs-actions.pod:5481
12110 #: ../fish/guestfish-actions.pod:3633 ../src/guestfs-actions.pod:5483
12111 msgid "NEC PC-98 format, common in Japan apparently."
12115 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5485
12120 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5487
12121 msgid "Sun disk labels."
12125 #: ../fish/guestfish-actions.pod:3641
12130 #: ../fish/guestfish-actions.pod:3643
12133 " part-list device\n"
12138 #: ../fish/guestfish-actions.pod:3645 ../src/guestfs-actions.pod:5501
12140 "This command parses the partition table on C<device> and returns the list of "
12141 "partitions found."
12145 #: ../fish/guestfish-actions.pod:3648 ../src/guestfs-actions.pod:5504
12146 msgid "The fields in the returned structure are:"
12150 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5508
12151 msgid "B<part_num>"
12155 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5510
12156 msgid "Partition number, counting from 1."
12160 #: ../fish/guestfish-actions.pod:3656 ../src/guestfs-actions.pod:5512
12161 msgid "B<part_start>"
12165 #: ../fish/guestfish-actions.pod:3658
12167 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12168 "the device's sector size, see L</blockdev-getss>."
12172 #: ../fish/guestfish-actions.pod:3661 ../src/guestfs-actions.pod:5517
12173 msgid "B<part_end>"
12177 #: ../fish/guestfish-actions.pod:3663 ../src/guestfs-actions.pod:5519
12178 msgid "End of the partition in bytes."
12182 #: ../fish/guestfish-actions.pod:3665 ../src/guestfs-actions.pod:5521
12183 msgid "B<part_size>"
12187 #: ../fish/guestfish-actions.pod:3667 ../src/guestfs-actions.pod:5523
12188 msgid "Size of the partition in bytes."
12192 #: ../fish/guestfish-actions.pod:3671
12193 msgid "part-set-bootable"
12197 #: ../fish/guestfish-actions.pod:3673
12200 " part-set-bootable device partnum true|false\n"
12205 #: ../fish/guestfish-actions.pod:3675 ../src/guestfs-actions.pod:5541
12207 "This sets the bootable flag on partition numbered C<partnum> on device "
12208 "C<device>. Note that partitions are numbered from 1."
12212 #: ../fish/guestfish-actions.pod:3678 ../src/guestfs-actions.pod:5544
12214 "The bootable flag is used by some operating systems (notably Windows) to "
12215 "determine which partition to boot from. It is by no means universally "
12220 #: ../fish/guestfish-actions.pod:3682
12221 msgid "part-set-mbr-id"
12225 #: ../fish/guestfish-actions.pod:3684
12228 " part-set-mbr-id device partnum idbyte\n"
12233 #: ../fish/guestfish-actions.pod:3686 ../src/guestfs-actions.pod:5560
12235 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12236 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12237 "documentation are in fact hexadecimal numbers, but usually documented "
12238 "without any leading \"0x\" which might be confusing."
12242 #: ../fish/guestfish-actions.pod:3696
12243 msgid "part-set-name"
12247 #: ../fish/guestfish-actions.pod:3698
12250 " part-set-name device partnum name\n"
12255 #: ../fish/guestfish-actions.pod:3700 ../src/guestfs-actions.pod:5582
12257 "This sets the partition name on partition numbered C<partnum> on device "
12258 "C<device>. Note that partitions are numbered from 1."
12262 #: ../fish/guestfish-actions.pod:3703 ../src/guestfs-actions.pod:5585
12264 "The partition name can only be set on certain types of partition table. "
12265 "This works on C<gpt> but not on C<mbr> partitions."
12269 #: ../fish/guestfish-actions.pod:3706
12270 msgid "part-to-dev"
12274 #: ../fish/guestfish-actions.pod:3708
12277 " part-to-dev partition\n"
12282 #: ../fish/guestfish-actions.pod:3710 ../src/guestfs-actions.pod:5598
12284 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12285 "partition number, returning the device name (eg. \"/dev/sdb\")."
12289 #: ../fish/guestfish-actions.pod:3714
12291 "The named partition must exist, for example as a string returned from L</"
12292 "list-partitions>."
12296 #: ../fish/guestfish-actions.pod:3717
12297 msgid "ping-daemon"
12301 #: ../fish/guestfish-actions.pod:3719
12309 #: ../fish/guestfish-actions.pod:3721 ../src/guestfs-actions.pod:5615
12311 "This is a test probe into the guestfs daemon running inside the qemu "
12312 "subprocess. Calling this function checks that the daemon responds to the "
12313 "ping message, without affecting the daemon or attached block device(s) in "
12318 #: ../fish/guestfish-actions.pod:3726
12323 #: ../fish/guestfish-actions.pod:3728
12326 " pread path count offset\n"
12331 #: ../fish/guestfish-actions.pod:3730 ../src/guestfs-actions.pod:5633
12333 "This command lets you read part of a file. It reads C<count> bytes of the "
12334 "file, starting at C<offset>, from file C<path>."
12338 #: ../fish/guestfish-actions.pod:3733 ../fish/guestfish-actions.pod:3748
12339 #: ../src/guestfs-actions.pod:5636 ../src/guestfs-actions.pod:5662
12341 "This may read fewer bytes than requested. For further details see the "
12342 "L<pread(2)> system call."
12346 #: ../fish/guestfish-actions.pod:3736
12347 msgid "See also L</pwrite>, L</pread-device>."
12351 #: ../fish/guestfish-actions.pod:3741
12352 msgid "pread-device"
12356 #: ../fish/guestfish-actions.pod:3743
12359 " pread-device device count offset\n"
12364 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5659
12366 "This command lets you read part of a file. It reads C<count> bytes of "
12367 "C<device>, starting at C<offset>."
12371 #: ../fish/guestfish-actions.pod:3751
12372 msgid "See also L</pread>."
12376 #: ../fish/guestfish-actions.pod:3756
12381 #: ../fish/guestfish-actions.pod:3758
12384 " pvcreate device\n"
12389 #: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5682
12391 "This creates an LVM physical volume on the named C<device>, where C<device> "
12392 "should usually be a partition name such as C</dev/sda1>."
12396 #: ../fish/guestfish-actions.pod:3764
12401 #: ../fish/guestfish-actions.pod:3766
12404 " pvremove device\n"
12409 #: ../fish/guestfish-actions.pod:3768 ../src/guestfs-actions.pod:5696
12411 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12416 #: ../fish/guestfish-actions.pod:3771 ../src/guestfs-actions.pod:5699
12418 "The implementation uses the C<pvremove> command which refuses to wipe "
12419 "physical volumes that contain any volume groups, so you have to remove those "
12424 #: ../fish/guestfish-actions.pod:3775
12429 #: ../fish/guestfish-actions.pod:3777
12432 " pvresize device\n"
12437 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5713
12439 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12440 "the new size of the underlying device."
12444 #: ../fish/guestfish-actions.pod:3782
12445 msgid "pvresize-size"
12449 #: ../fish/guestfish-actions.pod:3784
12452 " pvresize-size device size\n"
12457 #: ../fish/guestfish-actions.pod:3786
12459 "This command is the same as L</pvresize> except that it allows you to "
12460 "specify the new size (in bytes) explicitly."
12464 #: ../fish/guestfish-actions.pod:3789
12469 #: ../fish/guestfish-actions.pod:3791
12477 #: ../fish/guestfish-actions.pod:3793 ../src/guestfs-actions.pod:5739
12479 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12484 #: ../fish/guestfish-actions.pod:3796 ../src/guestfs-actions.pod:5742
12486 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12491 #: ../fish/guestfish-actions.pod:3799
12492 msgid "See also L</pvs-full>."
12496 #: ../fish/guestfish-actions.pod:3801
12501 #: ../fish/guestfish-actions.pod:3803
12509 #: ../fish/guestfish-actions.pod:3805 ../src/guestfs-actions.pod:5758
12511 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12512 "(8)> command. The \"full\" version includes all fields."
12516 #: ../fish/guestfish-actions.pod:3808
12521 #: ../fish/guestfish-actions.pod:3810
12529 #: ../fish/guestfish-actions.pod:3812 ../src/guestfs-actions.pod:5773
12530 msgid "This command returns the UUID of the LVM PV C<device>."
12534 #: ../fish/guestfish-actions.pod:3814
12539 #: ../fish/guestfish-actions.pod:3816
12542 " pwrite path content offset\n"
12547 #: ../fish/guestfish-actions.pod:3818 ../src/guestfs-actions.pod:5789
12549 "This command writes to part of a file. It writes the data buffer C<content> "
12550 "to the file C<path> starting at offset C<offset>."
12554 #: ../fish/guestfish-actions.pod:3821 ../src/guestfs-actions.pod:5792
12556 "This command implements the L<pwrite(2)> system call, and like that system "
12557 "call it may not write the full data requested. The return value is the "
12558 "number of bytes that were actually written to the file. This could even be "
12559 "0, although short writes are unlikely for regular files in ordinary "
12564 #: ../fish/guestfish-actions.pod:3827
12565 msgid "See also L</pread>, L</pwrite-device>."
12569 #: ../fish/guestfish-actions.pod:3832
12570 msgid "pwrite-device"
12574 #: ../fish/guestfish-actions.pod:3834
12577 " pwrite-device device content offset\n"
12582 #: ../fish/guestfish-actions.pod:3836 ../src/guestfs-actions.pod:5816
12584 "This command writes to part of a device. It writes the data buffer "
12585 "C<content> to C<device> starting at offset C<offset>."
12589 #: ../fish/guestfish-actions.pod:3839 ../src/guestfs-actions.pod:5819
12591 "This command implements the L<pwrite(2)> system call, and like that system "
12592 "call it may not write the full data requested (although short writes to disk "
12593 "devices and partitions are probably impossible with standard Linux kernels)."
12597 #: ../fish/guestfish-actions.pod:3844
12598 msgid "See also L</pwrite>."
12602 #: ../fish/guestfish-actions.pod:3849
12607 #: ../fish/guestfish-actions.pod:3851
12610 " read-file path\n"
12615 #: ../fish/guestfish-actions.pod:3853 ../src/guestfs-actions.pod:5840
12616 msgid "This calls returns the contents of the file C<path> as a buffer."
12620 #: ../fish/guestfish-actions.pod:3856
12622 "Unlike L</cat>, this function can correctly handle files that contain "
12623 "embedded ASCII NUL characters. However unlike L</download>, this function "
12624 "is limited in the total size of file that can be handled."
12628 #: ../fish/guestfish-actions.pod:3864
12633 #: ../fish/guestfish-actions.pod:3866
12636 " read-lines path\n"
12641 #: ../fish/guestfish-actions.pod:3870 ../src/guestfs-actions.pod:5865
12643 "The file contents are returned as a list of lines. Trailing C<LF> and "
12644 "C<CRLF> character sequences are I<not> returned."
12648 #: ../fish/guestfish-actions.pod:3873
12650 "Note that this function cannot correctly handle binary files (specifically, "
12651 "files containing C<\\0> character which is treated as end of line). For "
12652 "those you need to use the L</read-file> function which has a more complex "
12657 #: ../fish/guestfish-actions.pod:3878
12662 #: ../fish/guestfish-actions.pod:3880
12670 #: ../fish/guestfish-actions.pod:3882 ../src/guestfs-actions.pod:5885
12671 msgid "This returns the list of directory entries in directory C<dir>."
12675 #: ../fish/guestfish-actions.pod:3884 ../src/guestfs-actions.pod:5887
12677 "All entries in the directory are returned, including C<.> and C<..>. The "
12678 "entries are I<not> sorted, but returned in the same order as the underlying "
12683 #: ../fish/guestfish-actions.pod:3888 ../src/guestfs-actions.pod:5891
12685 "Also this call returns basic file type information about each file. The "
12686 "C<ftyp> field will contain one of the following characters:"
12690 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
12695 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
12696 msgid "Block special"
12700 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
12705 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
12706 msgid "Char special"
12710 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
12715 #: ../fish/guestfish-actions.pod:3903 ../src/guestfs-actions.pod:5906
12720 #: ../fish/guestfish-actions.pod:3905 ../src/guestfs-actions.pod:5908
12725 #: ../fish/guestfish-actions.pod:3907 ../src/guestfs-actions.pod:5910
12726 msgid "FIFO (named pipe)"
12730 #: ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:5912
12735 #: ../fish/guestfish-actions.pod:3911 ../src/guestfs-actions.pod:5914
12736 msgid "Symbolic link"
12740 #: ../fish/guestfish-actions.pod:3913 ../src/guestfs-actions.pod:5916
12745 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:5918
12746 msgid "Regular file"
12750 #: ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:5920
12755 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:5922
12760 #: ../fish/guestfish-actions.pod:3921 ../src/guestfs-actions.pod:5924
12765 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:5926
12766 msgid "Unknown file type"
12770 #: ../fish/guestfish-actions.pod:3925 ../src/guestfs-actions.pod:5928
12775 #: ../fish/guestfish-actions.pod:3927 ../src/guestfs-actions.pod:5930
12777 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12781 #: ../fish/guestfish-actions.pod:3932
12783 "This function is primarily intended for use by programs. To get a simple "
12784 "list of names, use L</ls>. To get a printable directory for human "
12785 "consumption, use L</ll>."
12789 #: ../fish/guestfish-actions.pod:3936
12794 #: ../fish/guestfish-actions.pod:3938
12802 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:5951
12803 msgid "This command reads the target of a symbolic link."
12807 #: ../fish/guestfish-actions.pod:3942
12808 msgid "readlinklist"
12812 #: ../fish/guestfish-actions.pod:3944
12815 " readlinklist path 'names ...'\n"
12820 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5965
12822 "This call allows you to do a C<readlink> operation on multiple files, where "
12823 "all files are in the directory C<path>. C<names> is the list of files from "
12828 #: ../fish/guestfish-actions.pod:3950 ../src/guestfs-actions.pod:5969
12830 "On return you get a list of strings, with a one-to-one correspondence to the "
12831 "C<names> list. Each string is the value of the symbolic link."
12835 #: ../fish/guestfish-actions.pod:3954 ../src/guestfs-actions.pod:5973
12837 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12838 "result string is the empty string C<\"\">. However the whole operation is "
12839 "completed even if there were C<readlink(2)> errors, and so you can call this "
12840 "function with names where you don't know if they are symbolic links already "
12841 "(albeit slightly less efficient)."
12845 #: ../fish/guestfish-actions.pod:3961 ../src/guestfs-actions.pod:5980
12847 "This call is intended for programs that want to efficiently list a directory "
12848 "contents without making many round-trips. Very long directory listings "
12849 "might cause the protocol message size to be exceeded, causing this call to "
12850 "fail. The caller must split up such requests into smaller groups of names."
12854 #: ../fish/guestfish-actions.pod:3968
12859 #: ../fish/guestfish-actions.pod:3970
12867 #: ../fish/guestfish-actions.pod:3972 ../src/guestfs-actions.pod:5999
12869 "Return the canonicalized absolute pathname of C<path>. The returned path "
12870 "has no C<.>, C<..> or symbolic link path elements."
12874 #: ../fish/guestfish-actions.pod:3975
12875 msgid "removexattr"
12879 #: ../fish/guestfish-actions.pod:3977
12882 " removexattr xattr path\n"
12887 #: ../fish/guestfish-actions.pod:3979 ../src/guestfs-actions.pod:6014
12889 "This call removes the extended attribute named C<xattr> of the file C<path>."
12893 #: ../fish/guestfish-actions.pod:3982
12894 msgid "See also: L</lremovexattr>, L<attr(5)>."
12898 #: ../fish/guestfish-actions.pod:3984
12903 #: ../fish/guestfish-actions.pod:3986
12906 " resize2fs device\n"
12911 #: ../fish/guestfish-actions.pod:3988 ../src/guestfs-actions.pod:6029
12913 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12914 "underlying device."
12918 #: ../fish/guestfish-actions.pod:3991
12920 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12921 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12922 "gives an error about this and sometimes not. In any case, it is always safe "
12923 "to call L</e2fsck-f> before calling this function."
12927 #: ../fish/guestfish-actions.pod:3997
12928 msgid "resize2fs-M"
12932 #: ../fish/guestfish-actions.pod:3999
12935 " resize2fs-M device\n"
12940 #: ../fish/guestfish-actions.pod:4001
12942 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12943 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12948 #: ../fish/guestfish-actions.pod:4005
12950 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12951 "and read the C<Block size> and C<Block count> values. These two numbers, "
12952 "multiplied together, give the resulting size of the minimal filesystem in "
12957 #: ../fish/guestfish-actions.pod:4010
12958 msgid "resize2fs-size"
12962 #: ../fish/guestfish-actions.pod:4012
12965 " resize2fs-size device size\n"
12970 #: ../fish/guestfish-actions.pod:4014
12972 "This command is the same as L</resize2fs> except that it allows you to "
12973 "specify the new size (in bytes) explicitly."
12977 #: ../fish/guestfish-actions.pod:4017
12982 #: ../fish/guestfish-actions.pod:4019
12990 #: ../fish/guestfish-actions.pod:4021 ../src/guestfs-actions.pod:6081
12991 msgid "Remove the single file C<path>."
12995 #: ../fish/guestfish-actions.pod:4023
13000 #: ../fish/guestfish-actions.pod:4025
13008 #: ../fish/guestfish-actions.pod:4027 ../src/guestfs-actions.pod:6093
13010 "Remove the file or directory C<path>, recursively removing the contents if "
13011 "its a directory. This is like the C<rm -rf> shell command."
13015 #: ../fish/guestfish-actions.pod:4031
13020 #: ../fish/guestfish-actions.pod:4033
13028 #: ../fish/guestfish-actions.pod:4035 ../src/guestfs-actions.pod:6107
13029 msgid "Remove the single directory C<path>."
13033 #: ../fish/guestfish-actions.pod:4037
13034 msgid "rmmountpoint"
13038 #: ../fish/guestfish-actions.pod:4039
13041 " rmmountpoint exemptpath\n"
13046 #: ../fish/guestfish-actions.pod:4041
13048 "This calls removes a mountpoint that was previously created with L</"
13049 "mkmountpoint>. See L</mkmountpoint> for full details."
13053 #: ../fish/guestfish-actions.pod:4045
13054 msgid "scrub-device"
13058 #: ../fish/guestfish-actions.pod:4047
13061 " scrub-device device\n"
13066 #: ../fish/guestfish-actions.pod:4049 ../src/guestfs-actions.pod:6133
13068 "This command writes patterns over C<device> to make data retrieval more "
13073 #: ../fish/guestfish-actions.pod:4052 ../fish/guestfish-actions.pod:4067
13074 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6136
13075 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6176
13077 "It is an interface to the L<scrub(1)> program. See that manual page for "
13082 #: ../fish/guestfish-actions.pod:4058
13087 #: ../fish/guestfish-actions.pod:4060
13090 " scrub-file file\n"
13095 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6152
13097 "This command writes patterns over a file to make data retrieval more "
13102 #: ../fish/guestfish-actions.pod:4065 ../src/guestfs-actions.pod:6155
13103 msgid "The file is I<removed> after scrubbing."
13107 #: ../fish/guestfish-actions.pod:4070
13108 msgid "scrub-freespace"
13112 #: ../fish/guestfish-actions.pod:4072
13115 " scrub-freespace dir\n"
13120 #: ../fish/guestfish-actions.pod:4074
13122 "This command creates the directory C<dir> and then fills it with files until "
13123 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
13124 "deletes them. The intention is to scrub any free space on the partition "
13125 "containing C<dir>."
13129 #: ../fish/guestfish-actions.pod:4083
13134 #: ../fish/guestfish-actions.pod:4085
13139 #: ../fish/guestfish-actions.pod:4087
13142 " set-append append\n"
13147 #: ../fish/guestfish-actions.pod:4089 ../src/guestfs-actions.pod:6189
13149 "This function is used to add additional options to the guest kernel command "
13154 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6192
13156 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13157 "environment variable."
13161 #: ../fish/guestfish-actions.pod:4095 ../src/guestfs-actions.pod:6195
13163 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13164 "(libguestfs always adds a few of its own)."
13168 #: ../fish/guestfish-actions.pod:4098
13169 msgid "set-attach-method"
13173 #: ../fish/guestfish-actions.pod:4100
13174 msgid "attach-method"
13178 #: ../fish/guestfish-actions.pod:4102
13181 " set-attach-method attachmethod\n"
13186 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6208
13188 "Set the method that libguestfs uses to connect to the back end guestfsd "
13189 "daemon. Possible methods are:"
13193 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6213
13194 #: ../src/guestfs.pod:2800
13195 msgid "C<appliance>"
13199 #: ../fish/guestfish-actions.pod:4111 ../src/guestfs-actions.pod:6215
13201 "Launch an appliance and connect to it. This is the ordinary method and the "
13206 #: ../fish/guestfish-actions.pod:4114 ../src/guestfs-actions.pod:6218
13207 msgid "C<unix:I<path>>"
13211 #: ../fish/guestfish-actions.pod:4116 ../src/guestfs-actions.pod:6220
13212 msgid "Connect to the Unix domain socket I<path>."
13216 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6222
13218 "This method lets you connect to an existing daemon or (using virtio-serial) "
13219 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
13220 "RUNNING DAEMONS>."
13224 #: ../fish/guestfish-actions.pod:4124
13225 msgid "set-autosync"
13229 #: ../fish/guestfish-actions.pod:4126
13234 #: ../fish/guestfish-actions.pod:4128
13237 " set-autosync true|false\n"
13242 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6238
13244 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13245 "effort attempt to make filesystems consistent and synchronized when the "
13246 "handle is closed (also if the program exits without closing handles)."
13250 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6243
13252 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13253 "disabled by default)."
13257 #: ../fish/guestfish-actions.pod:4138
13262 #: ../fish/guestfish-actions.pod:4140
13267 #: ../fish/guestfish-actions.pod:4142
13270 " set-direct true|false\n"
13275 #: ../fish/guestfish-actions.pod:4144 ../src/guestfs-actions.pod:6256
13277 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13278 "passed directly through to the appliance once it is launched."
13282 #: ../fish/guestfish-actions.pod:4148
13284 "One consequence of this is that log messages aren't caught by the library "
13285 "and handled by L</set-log-message-callback>, but go straight to stdout."
13289 #: ../fish/guestfish-actions.pod:4152 ../src/guestfs-actions.pod:6264
13290 msgid "You probably don't want to use this unless you know what you are doing."
13294 #: ../fish/guestfish-actions.pod:4155 ../src/guestfs-actions.pod:6267
13295 msgid "The default is disabled."
13299 #: ../fish/guestfish-actions.pod:4157
13300 msgid "set-e2label"
13304 #: ../fish/guestfish-actions.pod:4159
13307 " set-e2label device label\n"
13312 #: ../fish/guestfish-actions.pod:4161 ../src/guestfs-actions.pod:6280
13314 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13315 "C<label>. Filesystem labels are limited to 16 characters."
13319 #: ../fish/guestfish-actions.pod:4165
13321 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
13322 "label on a filesystem."
13326 #: ../fish/guestfish-actions.pod:4168
13331 #: ../fish/guestfish-actions.pod:4170
13334 " set-e2uuid device uuid\n"
13339 #: ../fish/guestfish-actions.pod:4172 ../src/guestfs-actions.pod:6298
13341 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13342 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13343 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13347 #: ../fish/guestfish-actions.pod:4177
13349 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
13350 "UUID of a filesystem."
13354 #: ../fish/guestfish-actions.pod:4180
13355 msgid "set-memsize"
13359 #: ../fish/guestfish-actions.pod:4182
13364 #: ../fish/guestfish-actions.pod:4184
13367 " set-memsize memsize\n"
13372 #: ../fish/guestfish-actions.pod:4186
13374 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13375 "This only has any effect if called before L</launch>."
13379 #: ../fish/guestfish-actions.pod:4190 ../src/guestfs-actions.pod:6320
13381 "You can also change this by setting the environment variable "
13382 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13386 #: ../fish/guestfish-actions.pod:4197
13387 msgid "set-network"
13391 #: ../fish/guestfish-actions.pod:4199
13396 #: ../fish/guestfish-actions.pod:4201
13399 " set-network true|false\n"
13404 #: ../fish/guestfish-actions.pod:4203 ../src/guestfs-actions.pod:6337
13406 "If C<network> is true, then the network is enabled in the libguestfs "
13407 "appliance. The default is false."
13411 #: ../fish/guestfish-actions.pod:4206 ../src/guestfs-actions.pod:6340
13413 "This affects whether commands are able to access the network (see L<guestfs"
13414 "(3)/RUNNING COMMANDS>)."
13418 #: ../fish/guestfish-actions.pod:4209
13420 "You must call this before calling L</launch>, otherwise it has no effect."
13424 #: ../fish/guestfish-actions.pod:4212
13429 #: ../fish/guestfish-actions.pod:4216
13432 " set-path searchpath\n"
13437 #: ../fish/guestfish-actions.pod:4218 ../src/guestfs-actions.pod:6356
13438 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13442 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6358
13444 "The default is C<$libdir/guestfs> unless overridden by setting "
13445 "C<LIBGUESTFS_PATH> environment variable."
13449 #: ../fish/guestfish-actions.pod:4223 ../src/guestfs-actions.pod:6361
13450 msgid "Setting C<path> to C<NULL> restores the default path."
13454 #: ../fish/guestfish-actions.pod:4225
13459 #: ../fish/guestfish-actions.pod:4227
13464 #: ../fish/guestfish-actions.pod:4229
13467 " set-pgroup true|false\n"
13472 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6373
13474 "If C<pgroup> is true, child processes are placed into their own process "
13479 #: ../fish/guestfish-actions.pod:4234 ../src/guestfs-actions.pod:6376
13481 "The practical upshot of this is that signals like C<SIGINT> (from users "
13482 "pressing C<^C>) won't be received by the child process."
13486 #: ../fish/guestfish-actions.pod:4237 ../src/guestfs-actions.pod:6379
13488 "The default for this flag is false, because usually you want C<^C> to kill "
13493 #: ../fish/guestfish-actions.pod:4240
13498 #: ../fish/guestfish-actions.pod:4242
13503 #: ../fish/guestfish-actions.pod:4244
13511 #: ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6392
13512 msgid "Set the qemu binary that we will use."
13516 #: ../fish/guestfish-actions.pod:4248 ../src/guestfs-actions.pod:6394
13518 "The default is chosen when the library was compiled by the configure script."
13522 #: ../fish/guestfish-actions.pod:4251 ../src/guestfs-actions.pod:6397
13524 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13529 #: ../fish/guestfish-actions.pod:4254 ../src/guestfs-actions.pod:6400
13530 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13534 #: ../fish/guestfish-actions.pod:4256 ../src/guestfs-actions.pod:6402
13536 "Note that you should call this function as early as possible after creating "
13537 "the handle. This is because some pre-launch operations depend on testing "
13538 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13539 "don't retest features, and so you might see inconsistent results. Using the "
13540 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13541 "the qemu binary at the same time as the handle is created."
13545 #: ../fish/guestfish-actions.pod:4264
13546 msgid "set-recovery-proc"
13550 #: ../fish/guestfish-actions.pod:4266
13551 msgid "recovery-proc"
13555 #: ../fish/guestfish-actions.pod:4268
13558 " set-recovery-proc true|false\n"
13563 #: ../fish/guestfish-actions.pod:4270
13565 "If this is called with the parameter C<false> then L</launch> does not "
13566 "create a recovery process. The purpose of the recovery process is to stop "
13567 "runaway qemu processes in the case where the main program aborts abruptly."
13571 #: ../fish/guestfish-actions.pod:4275
13573 "This only has any effect if called before L</launch>, and the default is "
13578 #: ../fish/guestfish-actions.pod:4278 ../src/guestfs-actions.pod:6428
13580 "About the only time when you would want to disable this is if the main "
13581 "process will fork itself into the background (\"daemonize\" itself). In "
13582 "this case the recovery process thinks that the main program has disappeared "
13583 "and so kills qemu, which is not very helpful."
13587 #: ../fish/guestfish-actions.pod:4284
13588 msgid "set-selinux"
13592 #: ../fish/guestfish-actions.pod:4286
13597 #: ../fish/guestfish-actions.pod:4288
13600 " set-selinux true|false\n"
13605 #: ../fish/guestfish-actions.pod:4290 ../src/guestfs-actions.pod:6444
13607 "This sets the selinux flag that is passed to the appliance at boot time. "
13608 "The default is C<selinux=0> (disabled)."
13612 #: ../fish/guestfish-actions.pod:4293 ../src/guestfs-actions.pod:6447
13614 "Note that if SELinux is enabled, it is always in Permissive mode "
13615 "(C<enforcing=0>)."
13619 #: ../fish/guestfish-actions.pod:4299
13624 #: ../fish/guestfish-actions.pod:4301
13629 #: ../fish/guestfish-actions.pod:4303
13632 " set-trace true|false\n"
13637 #: ../fish/guestfish-actions.pod:4305 ../src/guestfs-actions.pod:6463
13639 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13640 "return values are traced."
13644 #: ../fish/guestfish-actions.pod:4308 ../src/guestfs-actions.pod:6466
13646 "If you want to trace C API calls into libguestfs (and other libraries) then "
13647 "possibly a better way is to use the external ltrace(1) command."
13651 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6470
13653 "Command traces are disabled unless the environment variable "
13654 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13658 #: ../fish/guestfish-actions.pod:4315
13660 "Trace messages are normally sent to C<stderr>, unless you register a "
13661 "callback to send them somewhere else (see L</set-event-callback>)."
13665 #: ../fish/guestfish-actions.pod:4319
13666 msgid "set-verbose"
13670 #: ../fish/guestfish-actions.pod:4321
13675 #: ../fish/guestfish-actions.pod:4323
13678 " set-verbose true|false\n"
13683 #: ../fish/guestfish-actions.pod:4325 ../src/guestfs-actions.pod:6487
13684 msgid "If C<verbose> is true, this turns on verbose messages."
13688 #: ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:6489
13690 "Verbose messages are disabled unless the environment variable "
13691 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13695 #: ../fish/guestfish-actions.pod:4330
13697 "Verbose messages are normally sent to C<stderr>, unless you register a "
13698 "callback to send them somewhere else (see L</set-event-callback>)."
13702 #: ../fish/guestfish-actions.pod:4334
13707 #: ../fish/guestfish-actions.pod:4336
13710 " setcon context\n"
13715 #: ../fish/guestfish-actions.pod:4338 ../src/guestfs-actions.pod:6506
13717 "This sets the SELinux security context of the daemon to the string "
13722 #: ../fish/guestfish-actions.pod:4341 ../src/guestfs-actions.pod:6509
13723 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13727 #: ../fish/guestfish-actions.pod:4343
13732 #: ../fish/guestfish-actions.pod:4345
13735 " setxattr xattr val vallen path\n"
13740 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6524
13742 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13743 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13747 #: ../fish/guestfish-actions.pod:4351
13748 msgid "See also: L</lsetxattr>, L<attr(5)>."
13752 #: ../fish/guestfish-actions.pod:4353
13757 #: ../fish/guestfish-actions.pod:4355
13760 " sfdisk device cyls heads sectors 'lines ...'\n"
13765 #: ../fish/guestfish-actions.pod:4357 ../src/guestfs-actions.pod:6551
13767 "This is a direct interface to the L<sfdisk(8)> program for creating "
13768 "partitions on block devices."
13772 #: ../fish/guestfish-actions.pod:4360 ../src/guestfs-actions.pod:6554
13773 msgid "C<device> should be a block device, for example C</dev/sda>."
13777 #: ../fish/guestfish-actions.pod:4362 ../src/guestfs-actions.pod:6556
13779 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13780 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
13781 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13782 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13783 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13784 "the kernel) cannot work out the right geometry and you will need to tell it."
13788 #: ../fish/guestfish-actions.pod:4370 ../src/guestfs-actions.pod:6564
13790 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13791 "refer to the L<sfdisk(8)> manpage."
13795 #: ../fish/guestfish-actions.pod:4373 ../src/guestfs-actions.pod:6567
13797 "To create a single partition occupying the whole disk, you would pass "
13798 "C<lines> as a single element list, when the single element being the string "
13803 #: ../fish/guestfish-actions.pod:4377
13804 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13808 #: ../fish/guestfish-actions.pod:4383 ../fish/guestfish-actions.pod:4406
13809 #: ../fish/guestfish-actions.pod:4428
13811 "I<This function is deprecated.> In new code, use the L</part_add> call "
13816 #: ../fish/guestfish-actions.pod:4390
13821 #: ../fish/guestfish-actions.pod:4392
13824 " sfdiskM device 'lines ...'\n"
13829 #: ../fish/guestfish-actions.pod:4394
13831 "This is a simplified interface to the L</sfdisk> command, where partition "
13832 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13833 "you don't need to specify the cyls, heads and sectors parameters which were "
13834 "rarely if ever used anyway."
13838 #: ../fish/guestfish-actions.pod:4400
13839 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13843 #: ../fish/guestfish-actions.pod:4413
13848 #: ../fish/guestfish-actions.pod:4415
13851 " sfdisk-N device partnum cyls heads sectors line\n"
13856 #: ../fish/guestfish-actions.pod:4417 ../src/guestfs-actions.pod:6629
13858 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13859 "(note: C<n> counts from 1)."
13863 #: ../fish/guestfish-actions.pod:4420
13865 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13866 "cyls/heads/sectors parameters."
13870 #: ../fish/guestfish-actions.pod:4423
13871 msgid "See also: L</part-add>"
13875 #: ../fish/guestfish-actions.pod:4435
13876 msgid "sfdisk-disk-geometry"
13880 #: ../fish/guestfish-actions.pod:4437
13883 " sfdisk-disk-geometry device\n"
13888 #: ../fish/guestfish-actions.pod:4439
13890 "This displays the disk geometry of C<device> read from the partition table. "
13891 "Especially in the case where the underlying block device has been resized, "
13892 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
13893 "kernel-geometry>)."
13897 #: ../fish/guestfish-actions.pod:4444 ../fish/guestfish-actions.pod:4453
13898 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6671
13899 msgid "The result is in human-readable format, and not designed to be parsed."
13903 #: ../fish/guestfish-actions.pod:4447
13904 msgid "sfdisk-kernel-geometry"
13908 #: ../fish/guestfish-actions.pod:4449
13911 " sfdisk-kernel-geometry device\n"
13916 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6669
13917 msgid "This displays the kernel's idea of the geometry of C<device>."
13921 #: ../fish/guestfish-actions.pod:4456
13926 #: ../fish/guestfish-actions.pod:4458
13929 " sfdisk-l device\n"
13934 #: ../fish/guestfish-actions.pod:4460 ../src/guestfs-actions.pod:6692
13936 "This displays the partition table on C<device>, in the human-readable output "
13937 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13941 #: ../fish/guestfish-actions.pod:4464
13942 msgid "See also: L</part-list>"
13946 #: ../fish/guestfish-actions.pod:4466
13948 "I<This function is deprecated.> In new code, use the L</part_list> call "
13953 #: ../fish/guestfish-actions.pod:4473
13958 #: ../fish/guestfish-actions.pod:4475
13966 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6709
13968 "This call runs a command from the guest filesystem via the guest's C</bin/"
13973 #: ../fish/guestfish-actions.pod:4480
13974 msgid "This is like L</command>, but passes the command to:"
13978 #: ../fish/guestfish-actions.pod:4482 ../src/guestfs-actions.pod:6714
13981 " /bin/sh -c \"command\"\n"
13986 #: ../fish/guestfish-actions.pod:4484 ../src/guestfs-actions.pod:6716
13988 "Depending on the guest's shell, this usually results in wildcards being "
13989 "expanded, shell expressions being interpolated and so on."
13993 #: ../fish/guestfish-actions.pod:4488
13994 msgid "All the provisos about L</command> apply to this call."
13998 #: ../fish/guestfish-actions.pod:4490
14003 #: ../fish/guestfish-actions.pod:4492
14006 " sh-lines command\n"
14011 #: ../fish/guestfish-actions.pod:4494
14012 msgid "This is the same as L</sh>, but splits the result into a list of lines."
14016 #: ../fish/guestfish-actions.pod:4497
14017 msgid "See also: L</command-lines>"
14021 #: ../fish/guestfish-actions.pod:4499
14026 #: ../fish/guestfish-actions.pod:4501
14034 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6750
14035 msgid "Sleep for C<secs> seconds."
14039 #: ../fish/guestfish-actions.pod:4505
14044 #: ../fish/guestfish-actions.pod:4507
14052 #: ../fish/guestfish-actions.pod:4511 ../src/guestfs-actions.pod:6764
14053 msgid "This is the same as the C<stat(2)> system call."
14057 #: ../fish/guestfish-actions.pod:4513
14062 #: ../fish/guestfish-actions.pod:4515
14070 #: ../fish/guestfish-actions.pod:4517 ../src/guestfs-actions.pod:6778
14072 "Returns file system statistics for any mounted file system. C<path> should "
14073 "be a file or directory in the mounted file system (typically it is the mount "
14074 "point itself, but it doesn't need to be)."
14078 #: ../fish/guestfish-actions.pod:4521 ../src/guestfs-actions.pod:6782
14079 msgid "This is the same as the C<statvfs(2)> system call."
14083 #: ../fish/guestfish-actions.pod:4523
14088 #: ../fish/guestfish-actions.pod:4525
14096 #: ../fish/guestfish-actions.pod:4527 ../src/guestfs-actions.pod:6796
14098 "This runs the L<strings(1)> command on a file and returns the list of "
14099 "printable strings found."
14103 #: ../fish/guestfish-actions.pod:4533
14108 #: ../fish/guestfish-actions.pod:4535
14111 " strings-e encoding path\n"
14116 #: ../fish/guestfish-actions.pod:4537
14118 "This is like the L</strings> command, but allows you to specify the encoding "
14119 "of strings that are looked for in the source file C<path>."
14123 #: ../fish/guestfish-actions.pod:4541 ../src/guestfs-actions.pod:6819
14124 msgid "Allowed encodings are:"
14128 #: ../fish/guestfish-actions.pod:4545 ../src/guestfs-actions.pod:6823
14133 #: ../fish/guestfish-actions.pod:4547
14135 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14136 "ISO-8859-X (this is what L</strings> uses)."
14140 #: ../fish/guestfish-actions.pod:4550 ../src/guestfs-actions.pod:6828
14145 #: ../fish/guestfish-actions.pod:4552 ../src/guestfs-actions.pod:6830
14146 msgid "Single 8-bit-byte characters."
14150 #: ../fish/guestfish-actions.pod:4554 ../src/guestfs-actions.pod:6832
14155 #: ../fish/guestfish-actions.pod:4556 ../src/guestfs-actions.pod:6834
14156 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14160 #: ../fish/guestfish-actions.pod:4559 ../src/guestfs-actions.pod:6837
14161 msgid "l (lower case letter L)"
14165 #: ../fish/guestfish-actions.pod:4561 ../src/guestfs-actions.pod:6839
14167 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14168 "examining binaries in Windows guests."
14172 #: ../fish/guestfish-actions.pod:4564 ../src/guestfs-actions.pod:6842
14177 #: ../fish/guestfish-actions.pod:4566 ../src/guestfs-actions.pod:6844
14178 msgid "32-bit big endian such as UCS-4BE."
14182 #: ../fish/guestfish-actions.pod:4568 ../src/guestfs-actions.pod:6846
14187 #: ../fish/guestfish-actions.pod:4570 ../src/guestfs-actions.pod:6848
14188 msgid "32-bit little endian such as UCS-4LE."
14192 #: ../fish/guestfish-actions.pod:4574 ../src/guestfs-actions.pod:6852
14193 msgid "The returned strings are transcoded to UTF-8."
14197 #: ../fish/guestfish-actions.pod:4579
14198 msgid "swapoff-device"
14202 #: ../fish/guestfish-actions.pod:4581
14205 " swapoff-device device\n"
14210 #: ../fish/guestfish-actions.pod:4583
14212 "This command disables the libguestfs appliance swap device or partition "
14213 "named C<device>. See L</swapon-device>."
14217 #: ../fish/guestfish-actions.pod:4587
14218 msgid "swapoff-file"
14222 #: ../fish/guestfish-actions.pod:4589
14225 " swapoff-file file\n"
14230 #: ../fish/guestfish-actions.pod:4591 ../src/guestfs-actions.pod:6883
14231 msgid "This command disables the libguestfs appliance swap on file."
14235 #: ../fish/guestfish-actions.pod:4593
14236 msgid "swapoff-label"
14240 #: ../fish/guestfish-actions.pod:4595
14243 " swapoff-label label\n"
14248 #: ../fish/guestfish-actions.pod:4597 ../src/guestfs-actions.pod:6895
14250 "This command disables the libguestfs appliance swap on labeled swap "
14255 #: ../fish/guestfish-actions.pod:4600
14256 msgid "swapoff-uuid"
14260 #: ../fish/guestfish-actions.pod:4602
14263 " swapoff-uuid uuid\n"
14268 #: ../fish/guestfish-actions.pod:4604 ../src/guestfs-actions.pod:6908
14270 "This command disables the libguestfs appliance swap partition with the given "
14275 #: ../fish/guestfish-actions.pod:4607
14276 msgid "swapon-device"
14280 #: ../fish/guestfish-actions.pod:4609
14283 " swapon-device device\n"
14288 #: ../fish/guestfish-actions.pod:4611
14290 "This command enables the libguestfs appliance to use the swap device or "
14291 "partition named C<device>. The increased memory is made available for all "
14292 "commands, for example those run using L</command> or L</sh>."
14296 #: ../fish/guestfish-actions.pod:4616 ../src/guestfs-actions.pod:6926
14298 "Note that you should not swap to existing guest swap partitions unless you "
14299 "know what you are doing. They may contain hibernation information, or other "
14300 "information that the guest doesn't want you to trash. You also risk leaking "
14301 "information about the host to the guest this way. Instead, attach a new "
14302 "host device to the guest and swap on that."
14306 #: ../fish/guestfish-actions.pod:4623
14307 msgid "swapon-file"
14311 #: ../fish/guestfish-actions.pod:4625
14314 " swapon-file file\n"
14319 #: ../fish/guestfish-actions.pod:4627
14321 "This command enables swap to a file. See L</swapon-device> for other notes."
14325 #: ../fish/guestfish-actions.pod:4630
14326 msgid "swapon-label"
14330 #: ../fish/guestfish-actions.pod:4632
14333 " swapon-label label\n"
14338 #: ../fish/guestfish-actions.pod:4634
14340 "This command enables swap to a labeled swap partition. See L</swapon-"
14341 "device> for other notes."
14345 #: ../fish/guestfish-actions.pod:4637
14346 msgid "swapon-uuid"
14350 #: ../fish/guestfish-actions.pod:4639
14353 " swapon-uuid uuid\n"
14358 #: ../fish/guestfish-actions.pod:4641
14360 "This command enables swap to a swap partition with the given UUID. See L</"
14361 "swapon-device> for other notes."
14365 #: ../fish/guestfish-actions.pod:4644
14370 #: ../fish/guestfish-actions.pod:4646
14378 #: ../fish/guestfish-actions.pod:4648 ../src/guestfs-actions.pod:6981
14380 "This syncs the disk, so that any writes are flushed through to the "
14381 "underlying disk image."
14385 #: ../fish/guestfish-actions.pod:4651 ../src/guestfs-actions.pod:6984
14387 "You should always call this if you have modified a disk image, before "
14388 "closing the handle."
14392 #: ../fish/guestfish-actions.pod:4654
14397 #: ../fish/guestfish-actions.pod:4656
14405 #: ../fish/guestfish-actions.pod:4658 ../src/guestfs-actions.pod:6997
14407 "This command returns up to the last 10 lines of a file as a list of strings."
14411 #: ../fish/guestfish-actions.pod:4664
14416 #: ../fish/guestfish-actions.pod:4666
14419 " tail-n nrlines path\n"
14424 #: ../fish/guestfish-actions.pod:4668 ../src/guestfs-actions.pod:7016
14426 "If the parameter C<nrlines> is a positive number, this returns the last "
14427 "C<nrlines> lines of the file C<path>."
14431 #: ../fish/guestfish-actions.pod:4671 ../src/guestfs-actions.pod:7019
14433 "If the parameter C<nrlines> is a negative number, this returns lines from "
14434 "the file C<path>, starting with the C<-nrlines>th line."
14438 #: ../fish/guestfish-actions.pod:4679
14443 #: ../fish/guestfish-actions.pod:4681
14446 " tar-in (tarfile|-) directory\n"
14451 #: ../fish/guestfish-actions.pod:4683 ../src/guestfs-actions.pod:7040
14453 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14454 "tar file) into C<directory>."
14458 #: ../fish/guestfish-actions.pod:4686
14459 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
14463 #: ../fish/guestfish-actions.pod:4691
14468 #: ../fish/guestfish-actions.pod:4693
14471 " tar-out directory (tarfile|-)\n"
14476 #: ../fish/guestfish-actions.pod:4695 ../src/guestfs-actions.pod:7057
14478 "This command packs the contents of C<directory> and downloads it to local "
14483 #: ../fish/guestfish-actions.pod:4698
14484 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14488 #: ../fish/guestfish-actions.pod:4703
14493 #: ../fish/guestfish-actions.pod:4705
14496 " tgz-in (tarball|-) directory\n"
14501 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7074
14503 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14504 "tar file) into C<directory>."
14508 #: ../fish/guestfish-actions.pod:4710
14509 msgid "To upload an uncompressed tarball, use L</tar-in>."
14513 #: ../fish/guestfish-actions.pod:4714
14518 #: ../fish/guestfish-actions.pod:4716
14521 " tgz-out directory (tarball|-)\n"
14526 #: ../fish/guestfish-actions.pod:4718 ../src/guestfs-actions.pod:7090
14528 "This command packs the contents of C<directory> and downloads it to local "
14533 #: ../fish/guestfish-actions.pod:4721
14534 msgid "To download an uncompressed tarball, use L</tar-out>."
14538 #: ../fish/guestfish-actions.pod:4725
14543 #: ../fish/guestfish-actions.pod:4727
14551 #: ../fish/guestfish-actions.pod:4729 ../src/guestfs-actions.pod:7105
14553 "Touch acts like the L<touch(1)> command. It can be used to update the "
14554 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14559 #: ../fish/guestfish-actions.pod:4733 ../src/guestfs-actions.pod:7109
14561 "This command only works on regular files, and will fail on other file types "
14562 "such as directories, symbolic links, block special etc."
14566 #: ../fish/guestfish-actions.pod:4736
14571 #: ../fish/guestfish-actions.pod:4738
14579 #: ../fish/guestfish-actions.pod:4740 ../src/guestfs-actions.pod:7122
14581 "This command truncates C<path> to a zero-length file. The file must exist "
14586 #: ../fish/guestfish-actions.pod:4743
14587 msgid "truncate-size"
14591 #: ../fish/guestfish-actions.pod:4745
14594 " truncate-size path size\n"
14599 #: ../fish/guestfish-actions.pod:4747 ../src/guestfs-actions.pod:7136
14601 "This command truncates C<path> to size C<size> bytes. The file must exist "
14606 #: ../fish/guestfish-actions.pod:4750
14608 "If the current file size is less than C<size> then the file is extended to "
14609 "the required size with zero bytes. This creates a sparse file (ie. disk "
14610 "blocks are not allocated for the file until you write to it). To create a "
14611 "non-sparse file of zeroes, use L</fallocate64> instead."
14615 #: ../fish/guestfish-actions.pod:4756
14620 #: ../fish/guestfish-actions.pod:4758
14623 " tune2fs-l device\n"
14628 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7155
14630 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14635 #: ../fish/guestfish-actions.pod:4763 ../src/guestfs-actions.pod:7158
14637 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14638 "for more details. The list of fields returned isn't clearly defined, and "
14639 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14640 "and the filesystem itself."
14644 #: ../fish/guestfish-actions.pod:4768
14649 #: ../fish/guestfish-actions.pod:4770
14652 " txz-in (tarball|-) directory\n"
14657 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7178
14659 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14660 "tar file) into C<directory>."
14664 #: ../fish/guestfish-actions.pod:4777
14669 #: ../fish/guestfish-actions.pod:4779
14672 " txz-out directory (tarball|-)\n"
14677 #: ../fish/guestfish-actions.pod:4781 ../src/guestfs-actions.pod:7192
14679 "This command packs the contents of C<directory> and downloads it to local "
14680 "file C<tarball> (as an xz compressed tar archive)."
14684 #: ../fish/guestfish-actions.pod:4786
14689 #: ../fish/guestfish-actions.pod:4788
14697 #: ../fish/guestfish-actions.pod:4790 ../src/guestfs-actions.pod:7205
14699 "This function sets the mask used for creating new files and device nodes to "
14704 #: ../fish/guestfish-actions.pod:4793 ../src/guestfs-actions.pod:7208
14706 "Typical umask values would be C<022> which creates new files with "
14707 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14708 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14712 #: ../fish/guestfish-actions.pod:4798 ../src/guestfs-actions.pod:7213
14714 "The default umask is C<022>. This is important because it means that "
14715 "directories and device nodes will be created with C<0644> or C<0755> mode "
14716 "even if you specify C<0777>."
14720 #: ../fish/guestfish-actions.pod:4802
14721 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14725 #: ../fish/guestfish-actions.pod:4805 ../src/guestfs-actions.pod:7220
14726 msgid "This call returns the previous umask."
14730 #: ../fish/guestfish-actions.pod:4807
14735 #: ../fish/guestfish-actions.pod:4809
14740 #: ../fish/guestfish-actions.pod:4811
14743 " umount pathordevice\n"
14748 #: ../fish/guestfish-actions.pod:4813 ../src/guestfs-actions.pod:7232
14750 "This unmounts the given filesystem. The filesystem may be specified either "
14751 "by its mountpoint (path) or the device which contains the filesystem."
14755 #: ../fish/guestfish-actions.pod:4817
14760 #: ../fish/guestfish-actions.pod:4819
14761 msgid "unmount-all"
14765 #: ../fish/guestfish-actions.pod:4821
14773 #: ../fish/guestfish-actions.pod:4823 ../src/guestfs-actions.pod:7245
14774 msgid "This unmounts all mounted filesystems."
14778 #: ../fish/guestfish-actions.pod:4825 ../src/guestfs-actions.pod:7247
14779 msgid "Some internal mounts are not unmounted by this call."
14783 #: ../fish/guestfish-actions.pod:4827
14788 #: ../fish/guestfish-actions.pod:4829
14791 " upload (filename|-) remotefilename\n"
14796 #: ../fish/guestfish-actions.pod:4831 ../fish/guestfish-actions.pod:4844
14797 #: ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7284
14798 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14802 #: ../fish/guestfish-actions.pod:4836
14803 msgid "See also L</download>."
14807 #: ../fish/guestfish-actions.pod:4840
14808 msgid "upload-offset"
14812 #: ../fish/guestfish-actions.pod:4842
14815 " upload-offset (filename|-) remotefilename offset\n"
14820 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7287
14822 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14823 "The intention is to overwrite parts of existing files or devices, although "
14824 "if a non-existant file is specified then it is created with a \"hole\" "
14825 "before C<offset>. The size of the data written is implicit in the size of "
14826 "the source C<filename>."
14830 #: ../fish/guestfish-actions.pod:4854
14832 "Note that there is no limit on the amount of data that can be uploaded with "
14833 "this call, unlike with L</pwrite>, and this call always writes the full "
14834 "amount unless an error occurs."
14838 #: ../fish/guestfish-actions.pod:4859
14839 msgid "See also L</upload>, L</pwrite>."
14843 #: ../fish/guestfish-actions.pod:4863
14848 #: ../fish/guestfish-actions.pod:4865
14851 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14856 #: ../fish/guestfish-actions.pod:4867 ../src/guestfs-actions.pod:7320
14857 msgid "This command sets the timestamps of a file with nanosecond precision."
14861 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7323
14863 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14868 #: ../fish/guestfish-actions.pod:4873 ../src/guestfs-actions.pod:7326
14870 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14871 "nanoseconds from the epoch."
14875 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7329
14877 "If the C<*nsecs> field contains the special value C<-1> then the "
14878 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14879 "ignored in this case)."
14883 #: ../fish/guestfish-actions.pod:4880 ../src/guestfs-actions.pod:7333
14885 "If the C<*nsecs> field contains the special value C<-2> then the "
14886 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14891 #: ../fish/guestfish-actions.pod:4884
14896 #: ../fish/guestfish-actions.pod:4886
14904 #: ../fish/guestfish-actions.pod:4888 ../src/guestfs-actions.pod:7346
14906 "Return the libguestfs version number that the program is linked against."
14910 #: ../fish/guestfish-actions.pod:4891 ../src/guestfs-actions.pod:7349
14912 "Note that because of dynamic linking this is not necessarily the version of "
14913 "libguestfs that you compiled against. You can compile the program, and then "
14914 "at runtime dynamically link against a completely different C<libguestfs.so> "
14919 #: ../fish/guestfish-actions.pod:4896 ../src/guestfs-actions.pod:7354
14921 "This call was added in version C<1.0.58>. In previous versions of "
14922 "libguestfs there was no way to get the version number. From C code you can "
14923 "use dynamic linker functions to find out if this symbol exists (if it "
14924 "doesn't, then it's an earlier version)."
14928 #: ../fish/guestfish-actions.pod:4902 ../src/guestfs-actions.pod:7360
14930 "The call returns a structure with four elements. The first three (C<major>, "
14931 "C<minor> and C<release>) are numbers and correspond to the usual version "
14932 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14933 "but may be used for distro-specific information."
14937 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7366
14939 "To construct the original version string: C<$major.$minor.$release$extra>"
14943 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7369
14944 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14948 #: ../fish/guestfish-actions.pod:4913
14950 "I<Note:> Don't use this call to test for availability of features. In "
14951 "enterprise distributions we backport features from later versions into "
14952 "earlier versions, making this an unreliable way to test for features. Use "
14953 "L</available> instead."
14957 #: ../fish/guestfish-actions.pod:4919
14962 #: ../fish/guestfish-actions.pod:4921
14965 " vfs-label device\n"
14970 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7389
14971 msgid "This returns the filesystem label of the filesystem on C<device>."
14975 #: ../fish/guestfish-actions.pod:4926 ../src/guestfs-actions.pod:7392
14976 msgid "If the filesystem is unlabeled, this returns the empty string."
14980 #: ../fish/guestfish-actions.pod:4928
14981 msgid "To find a filesystem from the label, use L</findfs-label>."
14985 #: ../fish/guestfish-actions.pod:4930
14990 #: ../fish/guestfish-actions.pod:4932
14993 " vfs-type device\n"
14998 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7407
15000 "This command gets the filesystem type corresponding to the filesystem on "
15005 #: ../fish/guestfish-actions.pod:4937 ../src/guestfs-actions.pod:7410
15007 "For most filesystems, the result is the name of the Linux VFS module which "
15008 "would be used to mount this filesystem if you mounted it without specifying "
15009 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15013 #: ../fish/guestfish-actions.pod:4942
15018 #: ../fish/guestfish-actions.pod:4944
15021 " vfs-uuid device\n"
15026 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7426
15027 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15031 #: ../fish/guestfish-actions.pod:4949 ../src/guestfs-actions.pod:7429
15032 msgid "If the filesystem does not have a UUID, this returns the empty string."
15036 #: ../fish/guestfish-actions.pod:4951
15037 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
15041 #: ../fish/guestfish-actions.pod:4953
15042 msgid "vg-activate"
15046 #: ../fish/guestfish-actions.pod:4955
15049 " vg-activate true|false 'volgroups ...'\n"
15054 #: ../fish/guestfish-actions.pod:4957 ../src/guestfs-actions.pod:7445
15056 "This command activates or (if C<activate> is false) deactivates all logical "
15057 "volumes in the listed volume groups C<volgroups>."
15061 #: ../fish/guestfish-actions.pod:4960 ../src/guestfs-actions.pod:7448
15062 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15066 #: ../fish/guestfish-actions.pod:4962 ../src/guestfs-actions.pod:7450
15068 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15069 "activated or deactivated."
15073 #: ../fish/guestfish-actions.pod:4965
15074 msgid "vg-activate-all"
15078 #: ../fish/guestfish-actions.pod:4967
15081 " vg-activate-all true|false\n"
15086 #: ../fish/guestfish-actions.pod:4969 ../src/guestfs-actions.pod:7463
15088 "This command activates or (if C<activate> is false) deactivates all logical "
15089 "volumes in all volume groups."
15093 #: ../fish/guestfish-actions.pod:4972 ../src/guestfs-actions.pod:7466
15094 msgid "This command is the same as running C<vgchange -a y|n>"
15098 #: ../fish/guestfish-actions.pod:4974
15103 #: ../fish/guestfish-actions.pod:4976
15106 " vgcreate volgroup 'physvols ...'\n"
15111 #: ../fish/guestfish-actions.pod:4978 ../src/guestfs-actions.pod:7479
15113 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15114 "of physical volumes C<physvols>."
15118 #: ../fish/guestfish-actions.pod:4981
15123 #: ../fish/guestfish-actions.pod:4983
15126 " vglvuuids vgname\n"
15131 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7492
15133 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15134 "volumes created in this volume group."
15138 #: ../fish/guestfish-actions.pod:4988
15140 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
15141 "logical volumes and volume groups."
15145 #: ../fish/guestfish-actions.pod:4991
15146 msgid "See also L</vgpvuuids>."
15150 #: ../fish/guestfish-actions.pod:4993
15155 #: ../fish/guestfish-actions.pod:4995
15158 " vgpvuuids vgname\n"
15163 #: ../fish/guestfish-actions.pod:4997 ../src/guestfs-actions.pod:7512
15165 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15166 "volumes that this volume group resides on."
15170 #: ../fish/guestfish-actions.pod:5000
15172 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
15173 "physical volumes and volume groups."
15177 #: ../fish/guestfish-actions.pod:5003
15178 msgid "See also L</vglvuuids>."
15182 #: ../fish/guestfish-actions.pod:5005
15187 #: ../fish/guestfish-actions.pod:5007
15190 " vgremove vgname\n"
15195 #: ../fish/guestfish-actions.pod:5009 ../src/guestfs-actions.pod:7532
15196 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15200 #: ../fish/guestfish-actions.pod:5011 ../src/guestfs-actions.pod:7534
15202 "This also forcibly removes all logical volumes in the volume group (if any)."
15206 #: ../fish/guestfish-actions.pod:5014
15211 #: ../fish/guestfish-actions.pod:5016
15214 " vgrename volgroup newvolgroup\n"
15219 #: ../fish/guestfish-actions.pod:5018 ../src/guestfs-actions.pod:7548
15220 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15224 #: ../fish/guestfish-actions.pod:5020
15229 #: ../fish/guestfish-actions.pod:5022
15237 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7559
15239 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15244 #: ../fish/guestfish-actions.pod:5027 ../src/guestfs-actions.pod:7562
15246 "This returns a list of just the volume group names that were detected (eg. "
15251 #: ../fish/guestfish-actions.pod:5030
15252 msgid "See also L</vgs-full>."
15256 #: ../fish/guestfish-actions.pod:5032
15261 #: ../fish/guestfish-actions.pod:5034
15269 #: ../fish/guestfish-actions.pod:5036 ../src/guestfs-actions.pod:7578
15271 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15272 "> command. The \"full\" version includes all fields."
15276 #: ../fish/guestfish-actions.pod:5039
15281 #: ../fish/guestfish-actions.pod:5041
15289 #: ../fish/guestfish-actions.pod:5043 ../src/guestfs-actions.pod:7592
15291 "This rescans all block devices and rebuilds the list of LVM physical "
15292 "volumes, volume groups and logical volumes."
15296 #: ../fish/guestfish-actions.pod:5046
15301 #: ../fish/guestfish-actions.pod:5048
15309 #: ../fish/guestfish-actions.pod:5050 ../src/guestfs-actions.pod:7605
15310 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15314 #: ../fish/guestfish-actions.pod:5052
15319 #: ../fish/guestfish-actions.pod:5054
15327 #: ../fish/guestfish-actions.pod:5056 ../src/guestfs-actions.pod:7645
15329 "This command counts the characters in a file, using the C<wc -c> external "
15334 #: ../fish/guestfish-actions.pod:5059
15339 #: ../fish/guestfish-actions.pod:5061
15347 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7658
15349 "This command counts the lines in a file, using the C<wc -l> external command."
15353 #: ../fish/guestfish-actions.pod:5066
15358 #: ../fish/guestfish-actions.pod:5068
15366 #: ../fish/guestfish-actions.pod:5070 ../src/guestfs-actions.pod:7671
15368 "This command counts the words in a file, using the C<wc -w> external command."
15372 #: ../fish/guestfish-actions.pod:5073
15377 #: ../fish/guestfish-actions.pod:5075
15380 " write path content\n"
15385 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7686
15387 "This call creates a file called C<path>. The content of the file is the "
15388 "string C<content> (which can contain any 8 bit data)."
15392 #: ../fish/guestfish-actions.pod:5080
15393 msgid "See also L</write-append>."
15397 #: ../fish/guestfish-actions.pod:5085
15398 msgid "write-append"
15402 #: ../fish/guestfish-actions.pod:5087
15405 " write-append path content\n"
15410 #: ../fish/guestfish-actions.pod:5089 ../src/guestfs-actions.pod:7706
15412 "This call appends C<content> to the end of file C<path>. If C<path> does "
15413 "not exist, then a new file is created."
15417 #: ../fish/guestfish-actions.pod:5092
15418 msgid "See also L</write>."
15422 #: ../fish/guestfish-actions.pod:5097
15427 #: ../fish/guestfish-actions.pod:5099
15430 " write-file path content size\n"
15435 #: ../fish/guestfish-actions.pod:5101 ../src/guestfs-actions.pod:7733
15437 "This call creates a file called C<path>. The contents of the file is the "
15438 "string C<content> (which can contain any 8 bit data), with length C<size>."
15442 #: ../fish/guestfish-actions.pod:5105 ../src/guestfs-actions.pod:7737
15444 "As a special case, if C<size> is C<0> then the length is calculated using "
15445 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15449 #: ../fish/guestfish-actions.pod:5109 ../src/guestfs-actions.pod:7741
15451 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15452 "I<not> work, even if the length is specified."
15456 #: ../fish/guestfish-actions.pod:5115
15458 "I<This function is deprecated.> In new code, use the L</write> call instead."
15462 #: ../fish/guestfish-actions.pod:5122
15467 #: ../fish/guestfish-actions.pod:5124
15470 " zegrep regex path\n"
15475 #: ../fish/guestfish-actions.pod:5126 ../src/guestfs-actions.pod:7758
15477 "This calls the external C<zegrep> program and returns the matching lines."
15481 #: ../fish/guestfish-actions.pod:5132
15486 #: ../fish/guestfish-actions.pod:5134
15489 " zegrepi regex path\n"
15494 #: ../fish/guestfish-actions.pod:5136 ../src/guestfs-actions.pod:7777
15496 "This calls the external C<zegrep -i> program and returns the matching lines."
15500 #: ../fish/guestfish-actions.pod:5142
15505 #: ../fish/guestfish-actions.pod:5144
15513 #: ../fish/guestfish-actions.pod:5146 ../src/guestfs-actions.pod:7795
15514 msgid "This command writes zeroes over the first few blocks of C<device>."
15518 #: ../fish/guestfish-actions.pod:5148 ../src/guestfs-actions.pod:7797
15520 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15521 "securely wipe the device). It should be sufficient to remove any partition "
15522 "tables, filesystem superblocks and so on."
15526 #: ../fish/guestfish-actions.pod:5152 ../fish/guestfish-actions.pod:5167
15527 #: ../src/guestfs-actions.pod:7801 ../src/guestfs-actions.pod:7827
15529 "If blocks are already zero, then this command avoids writing zeroes. This "
15530 "prevents the underlying device from becoming non-sparse or growing "
15535 #: ../fish/guestfish-actions.pod:5156
15536 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15540 #: ../fish/guestfish-actions.pod:5159
15541 msgid "zero-device"
15545 #: ../fish/guestfish-actions.pod:5161
15548 " zero-device device\n"
15553 #: ../fish/guestfish-actions.pod:5163
15555 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
15556 "which just zeroes the first few blocks of a device."
15560 #: ../fish/guestfish-actions.pod:5174
15565 #: ../fish/guestfish-actions.pod:5176
15568 " zerofree device\n"
15573 #: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7849
15575 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15576 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15577 "possible to compress the filesystem more effectively."
15581 #: ../fish/guestfish-actions.pod:5183 ../src/guestfs-actions.pod:7854
15582 msgid "You should B<not> run this program if the filesystem is mounted."
15586 #: ../fish/guestfish-actions.pod:5186 ../src/guestfs-actions.pod:7857
15588 "It is possible that using this program can damage the filesystem or data on "
15593 #: ../fish/guestfish-actions.pod:5189
15598 #: ../fish/guestfish-actions.pod:5191
15601 " zfgrep pattern path\n"
15606 #: ../fish/guestfish-actions.pod:5193 ../src/guestfs-actions.pod:7871
15608 "This calls the external C<zfgrep> program and returns the matching lines."
15612 #: ../fish/guestfish-actions.pod:5199
15617 #: ../fish/guestfish-actions.pod:5201
15620 " zfgrepi pattern path\n"
15625 #: ../fish/guestfish-actions.pod:5203 ../src/guestfs-actions.pod:7890
15627 "This calls the external C<zfgrep -i> program and returns the matching lines."
15631 #: ../fish/guestfish-actions.pod:5209
15636 #: ../fish/guestfish-actions.pod:5211
15639 " zfile meth path\n"
15644 #: ../fish/guestfish-actions.pod:5213 ../src/guestfs-actions.pod:7916
15646 "This command runs C<file> after first decompressing C<path> using C<method>."
15650 #: ../fish/guestfish-actions.pod:5216 ../src/guestfs-actions.pod:7919
15651 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15655 #: ../fish/guestfish-actions.pod:5218
15657 "Since 1.0.63, use L</file> instead which can now process compressed files."
15661 #: ../fish/guestfish-actions.pod:5221
15663 "I<This function is deprecated.> In new code, use the L</file> call instead."
15667 #: ../fish/guestfish-actions.pod:5228
15672 #: ../fish/guestfish-actions.pod:5230
15675 " zgrep regex path\n"
15680 #: ../fish/guestfish-actions.pod:5232 ../src/guestfs-actions.pod:7936
15682 "This calls the external C<zgrep> program and returns the matching lines."
15686 #: ../fish/guestfish-actions.pod:5238
15691 #: ../fish/guestfish-actions.pod:5240
15694 " zgrepi regex path\n"
15699 #: ../fish/guestfish-actions.pod:5242 ../src/guestfs-actions.pod:7955
15701 "This calls the external C<zgrep -i> program and returns the matching lines."
15705 #: ../fish/guestfish-commands.pod:1
15710 #: ../fish/guestfish-commands.pod:3
15715 #: ../fish/guestfish-commands.pod:5
15718 " alloc filename size\n"
15723 #: ../fish/guestfish-commands.pod:7
15725 "This creates an empty (zeroed) file of the given size, and then adds so it "
15726 "can be further examined."
15730 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
15731 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15735 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
15736 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15740 #: ../fish/guestfish-commands.pod:14
15742 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15743 "image, see L</PREPARED DISK IMAGES>."
15747 #: ../fish/guestfish-commands.pod:17
15752 #: ../fish/guestfish-commands.pod:19
15755 " copy-in local [local ...] /remotedir\n"
15760 #: ../fish/guestfish-commands.pod:21
15762 "C<copy-in> copies local files or directories recursively into the disk "
15763 "image, placing them in the directory called C</remotedir> (which must "
15764 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15765 "other commands as necessary."
15769 #: ../fish/guestfish-commands.pod:26
15771 "Multiple local files and directories can be specified, but the last "
15772 "parameter must always be a remote directory. Wildcards cannot be used."
15776 #: ../fish/guestfish-commands.pod:30
15781 #: ../fish/guestfish-commands.pod:32
15784 " copy-out remote [remote ...] localdir\n"
15789 #: ../fish/guestfish-commands.pod:34
15791 "C<copy-out> copies remote files or directories recursively out of the disk "
15792 "image, placing them on the host disk in a local directory called C<localdir> "
15793 "(which must exist). This guestfish meta-command turns into a sequence of L</"
15794 "download>, L</tar-out> and other commands as necessary."
15798 #: ../fish/guestfish-commands.pod:40
15800 "Multiple remote files and directories can be specified, but the last "
15801 "parameter must always be a local directory. To download to the current "
15802 "directory, use C<.> as in:"
15806 #: ../fish/guestfish-commands.pod:44
15809 " copy-out /home .\n"
15814 #: ../fish/guestfish-commands.pod:46
15816 "Wildcards cannot be used in the ordinary command, but you can use them with "
15817 "the help of L</glob> like this:"
15821 #: ../fish/guestfish-commands.pod:49
15824 " glob copy-out /home/* .\n"
15829 #: ../fish/guestfish-commands.pod:51
15834 #: ../fish/guestfish-commands.pod:53
15837 " display filename\n"
15842 #: ../fish/guestfish-commands.pod:55
15844 "Use C<display> (a graphical display program) to display an image file. It "
15845 "downloads the file, and runs C<display> on it."
15849 #: ../fish/guestfish-commands.pod:58
15851 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15852 "environment variable. For example to use the GNOME display program:"
15856 #: ../fish/guestfish-commands.pod:61
15859 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15864 #: ../fish/guestfish-commands.pod:63
15865 msgid "See also L<display(1)>."
15869 #: ../fish/guestfish-commands.pod:65
15874 #: ../fish/guestfish-commands.pod:67
15877 " echo [params ...]\n"
15882 #: ../fish/guestfish-commands.pod:69
15883 msgid "This echos the parameters to the terminal."
15887 #: ../fish/guestfish-commands.pod:71
15892 #: ../fish/guestfish-commands.pod:73
15897 #: ../fish/guestfish-commands.pod:75
15902 #: ../fish/guestfish-commands.pod:77
15910 #: ../fish/guestfish-commands.pod:79
15912 "This is used to edit a file. It downloads the file, edits it locally using "
15913 "your editor, then uploads the result."
15917 #: ../fish/guestfish-commands.pod:82
15919 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15920 "or C<emacs> you will get those corresponding editors."
15924 #: ../fish/guestfish-commands.pod:86
15929 #: ../fish/guestfish-commands.pod:88
15932 " glob command args...\n"
15937 #: ../fish/guestfish-commands.pod:90
15939 "Expand wildcards in any paths in the args list, and run C<command> "
15940 "repeatedly on each matching path."
15944 #: ../fish/guestfish-commands.pod:93
15945 msgid "See L</WILDCARDS AND GLOBBING>."
15949 #: ../fish/guestfish-commands.pod:95
15954 #: ../fish/guestfish-commands.pod:97
15957 " hexedit <filename|device>\n"
15958 " hexedit <filename|device> <max>\n"
15959 " hexedit <filename|device> <start> <max>\n"
15964 #: ../fish/guestfish-commands.pod:101
15966 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15971 #: ../fish/guestfish-commands.pod:104
15973 "This command works by downloading potentially the whole file or device, "
15974 "editing it locally, then uploading it. If the file or device is large, you "
15975 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15976 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15977 "usual modifiers allowed such as C<1M> (1 megabyte)."
15981 #: ../fish/guestfish-commands.pod:111
15982 msgid "For example to edit the first few sectors of a disk you might do:"
15986 #: ../fish/guestfish-commands.pod:114
15989 " hexedit /dev/sda 1M\n"
15994 #: ../fish/guestfish-commands.pod:116
15996 "which would allow you to edit anywhere within the first megabyte of the disk."
16000 #: ../fish/guestfish-commands.pod:119
16001 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
16005 #: ../fish/guestfish-commands.pod:121
16008 " hexedit /dev/sda1 0x400 0x400\n"
16013 #: ../fish/guestfish-commands.pod:123
16014 msgid "(assuming the superblock is in the standard location)."
16018 #: ../fish/guestfish-commands.pod:125
16020 "This command requires the external L<hexedit(1)> program. You can specify "
16021 "another program to use by setting the C<HEXEDITOR> environment variable."
16025 #: ../fish/guestfish-commands.pod:129
16026 msgid "See also L</hexdump>."
16030 #: ../fish/guestfish-commands.pod:131
16035 #: ../fish/guestfish-commands.pod:133
16043 #: ../fish/guestfish-commands.pod:135
16045 "Change the local directory, ie. the current directory of guestfish itself."
16049 #: ../fish/guestfish-commands.pod:138
16050 msgid "Note that C<!cd> won't do what you might expect."
16054 #: ../fish/guestfish-commands.pod:140
16059 #: ../fish/guestfish-commands.pod:142
16064 #: ../fish/guestfish-commands.pod:144
16072 #: ../fish/guestfish-commands.pod:146
16073 msgid "Opens the manual page for guestfish."
16077 #: ../fish/guestfish-commands.pod:148
16082 #: ../fish/guestfish-commands.pod:150
16087 #: ../fish/guestfish-commands.pod:152
16095 #: ../fish/guestfish-commands.pod:154
16103 #: ../fish/guestfish-commands.pod:156
16104 msgid "This is used to view a file."
16108 #: ../fish/guestfish-commands.pod:158
16110 "The default viewer is C<$PAGER>. However if you use the alternate command "
16111 "C<less> you will get the C<less> command specifically."
16115 #: ../fish/guestfish-commands.pod:161
16120 #: ../fish/guestfish-commands.pod:163
16128 #: ../fish/guestfish-commands.pod:165
16130 "Close and reopen the libguestfs handle. It is not necessary to use this "
16131 "normally, because the handle is closed properly when guestfish exits. "
16132 "However this is occasionally useful for testing."
16136 #: ../fish/guestfish-commands.pod:169
16141 #: ../fish/guestfish-commands.pod:171
16144 " setenv VAR value\n"
16149 #: ../fish/guestfish-commands.pod:173
16150 msgid "Set the environment variable C<VAR> to the string C<value>."
16154 #: ../fish/guestfish-commands.pod:175
16156 "To print the value of an environment variable use a shell command such as:"
16160 #: ../fish/guestfish-commands.pod:178
16168 #: ../fish/guestfish-commands.pod:180
16173 #: ../fish/guestfish-commands.pod:182
16176 " sparse filename size\n"
16181 #: ../fish/guestfish-commands.pod:184
16183 "This creates an empty sparse file of the given size, and then adds so it can "
16184 "be further examined."
16188 #: ../fish/guestfish-commands.pod:187
16190 "In all respects it works the same as the L</alloc> command, except that the "
16191 "image file is allocated sparsely, which means that disk blocks are not "
16192 "assigned to the file until they are needed. Sparse disk files only use "
16193 "space when written to, but they are slower and there is a danger you could "
16194 "run out of real disk space during a write operation."
16198 #: ../fish/guestfish-commands.pod:197
16203 #: ../fish/guestfish-commands.pod:199
16211 #: ../fish/guestfish-commands.pod:201
16213 "This command returns a list of the optional groups known to the daemon, and "
16214 "indicates which ones are supported by this build of the libguestfs appliance."
16218 #: ../fish/guestfish-commands.pod:205
16219 msgid "See also L<guestfs(3)/AVAILABILITY>."
16223 #: ../fish/guestfish-commands.pod:207
16228 #: ../fish/guestfish-commands.pod:209
16231 " time command args...\n"
16236 #: ../fish/guestfish-commands.pod:211
16238 "Run the command as usual, but print the elapsed time afterwards. This can "
16239 "be useful for benchmarking operations."
16243 #: ../fish/guestfish-commands.pod:214
16248 #: ../fish/guestfish-commands.pod:216
16256 #: ../fish/guestfish-commands.pod:218
16257 msgid "Remove C<VAR> from the environment."
16261 #: ../fish/guestfish.pod:5
16262 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16266 #: ../fish/guestfish.pod:9
16269 " guestfish [--options] [commands]\n"
16274 #: ../fish/guestfish.pod:11
16282 #: ../fish/guestfish.pod:13
16285 " guestfish [--ro|--rw] -a disk.img\n"
16290 #: ../fish/guestfish.pod:15
16293 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16298 #: ../fish/guestfish.pod:17
16301 " guestfish -d libvirt-domain\n"
16306 #: ../fish/guestfish.pod:19
16309 " guestfish [--ro|--rw] -a disk.img -i\n"
16314 #: ../fish/guestfish.pod:21
16317 " guestfish -d libvirt-domain -i\n"
16322 #: ../fish/guestfish.pod:25
16324 "Using guestfish in read/write mode on live virtual machines can be "
16325 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16326 "option to use guestfish safely if the disk image or virtual machine might be "
16331 #: ../fish/guestfish.pod:32
16333 "Guestfish is a shell and command-line tool for examining and modifying "
16334 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16335 "functionality of the guestfs API, see L<guestfs(3)>."
16339 #: ../fish/guestfish.pod:36
16341 "Guestfish gives you structured access to the libguestfs API, from shell "
16342 "scripts or the command line or interactively. If you want to rescue a "
16343 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16348 #: ../fish/guestfish.pod:43
16349 msgid "As an interactive shell"
16353 #: ../fish/guestfish.pod:45
16361 #: ../fish/guestfish.pod:47
16364 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16365 " editing virtual machine filesystems.\n"
16370 #: ../fish/guestfish.pod:50
16373 " Type: 'help' for a list of commands\n"
16374 " 'man' to read the manual\n"
16375 " 'quit' to quit the shell\n"
16380 #: ../fish/guestfish.pod:54
16383 " ><fs> add-ro disk.img\n"
16385 " ><fs> list-filesystems\n"
16386 " /dev/sda1: ext4\n"
16387 " /dev/vg_guest/lv_root: ext4\n"
16388 " /dev/vg_guest/lv_swap: swap\n"
16389 " ><fs> mount /dev/vg_guest/lv_root /\n"
16390 " ><fs> cat /etc/fstab\n"
16392 " # Created by anaconda\n"
16399 #: ../fish/guestfish.pod:67
16400 msgid "From shell scripts"
16404 #: ../fish/guestfish.pod:69
16405 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16409 #: ../fish/guestfish.pod:71
16412 " guestfish <<_EOF_\n"
16415 " mount /dev/vg_guest/lv_root /\n"
16416 " write /etc/motd \"Welcome, new users\"\n"
16422 #: ../fish/guestfish.pod:78
16423 msgid "List the LVM logical volumes in a disk image:"
16427 #: ../fish/guestfish.pod:80
16430 " guestfish -a disk.img --ro <<_EOF_\n"
16438 #: ../fish/guestfish.pod:85
16439 msgid "List all the filesystems in a disk image:"
16443 #: ../fish/guestfish.pod:87
16446 " guestfish -a disk.img --ro <<_EOF_\n"
16448 " list-filesystems\n"
16454 #: ../fish/guestfish.pod:92
16455 msgid "On one command line"
16459 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
16460 msgid "Update C</etc/resolv.conf> in a guest:"
16464 #: ../fish/guestfish.pod:96
16468 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16469 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16474 #: ../fish/guestfish.pod:100
16475 msgid "Edit C</boot/grub/grub.conf> interactively:"
16479 #: ../fish/guestfish.pod:102
16482 " guestfish --rw --add disk.img \\\n"
16483 " --mount /dev/vg_guest/lv_root \\\n"
16484 " --mount /dev/sda1:/boot \\\n"
16485 " edit /boot/grub/grub.conf\n"
16490 #: ../fish/guestfish.pod:107
16491 msgid "Mount disks automatically"
16495 #: ../fish/guestfish.pod:109
16497 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
16501 #: ../fish/guestfish.pod:112
16504 " guestfish --ro -a disk.img -i cat /etc/group\n"
16509 #: ../fish/guestfish.pod:114
16512 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16517 #: ../fish/guestfish.pod:116
16518 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16522 #: ../fish/guestfish.pod:118
16525 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16530 #: ../fish/guestfish.pod:120
16531 msgid "As a script interpreter"
16535 #: ../fish/guestfish.pod:122
16536 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16540 #: ../fish/guestfish.pod:124
16543 " #!/usr/bin/guestfish -f\n"
16544 " sparse test1.img 100M\n"
16546 " part-disk /dev/sda mbr\n"
16547 " mkfs ext2 /dev/sda1\n"
16552 #: ../fish/guestfish.pod:130
16553 msgid "Start with a prepared disk"
16557 #: ../fish/guestfish.pod:132
16559 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16560 "single ext2-formatted partition:"
16564 #: ../fish/guestfish.pod:135
16567 " guestfish -N fs\n"
16572 #: ../fish/guestfish.pod:137
16573 msgid "To list what is available do:"
16577 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
16580 " guestfish -N help | less\n"
16585 #: ../fish/guestfish.pod:141
16586 msgid "Remote control"
16590 #: ../fish/guestfish.pod:143
16593 " eval \"`guestfish --listen`\"\n"
16594 " guestfish --remote add-ro disk.img\n"
16595 " guestfish --remote run\n"
16596 " guestfish --remote lvs\n"
16601 #: ../fish/guestfish.pod:154
16602 msgid "Displays general help on options."
16606 #: ../fish/guestfish.pod:158
16607 msgid "B<--cmd-help>"
16611 #: ../fish/guestfish.pod:160
16612 msgid "Lists all available guestfish commands."
16616 #: ../fish/guestfish.pod:162
16621 #: ../fish/guestfish.pod:164
16622 msgid "B<--cmd-help cmd>"
16626 #: ../fish/guestfish.pod:166
16627 msgid "Displays detailed help on a single command C<cmd>."
16631 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16632 msgid "B<-a image>"
16636 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16637 msgid "B<--add image>"
16641 #: ../fish/guestfish.pod:172
16642 msgid "Add a block device or virtual machine image to the shell."
16646 #: ../fish/guestfish.pod:177
16648 "Using this flag is mostly equivalent to using the C<add> command, with "
16649 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16650 "the I<--format=...> flag was given."
16654 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16656 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16657 "URI to use. The default is to use the default libvirt connection."
16661 #: ../fish/guestfish.pod:189
16666 #: ../fish/guestfish.pod:191
16668 "If using the I<--listen> option and a csh-like shell, use this option. See "
16669 "section L</REMOTE CONTROL AND CSH> below."
16673 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16674 msgid "B<-d libvirt-domain>"
16678 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16679 msgid "B<--domain libvirt-domain>"
16683 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16685 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16686 "used, then any libvirt domain can be used. However in write mode, only "
16687 "libvirt domains which are shut down can be named here."
16691 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16692 msgid "Domain UUIDs can be used instead of names."
16696 #: ../fish/guestfish.pod:204
16698 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16699 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16700 "if the I<--format:...> flag was given."
16704 #: ../fish/guestfish.pod:208
16709 #: ../fish/guestfish.pod:210
16710 msgid "B<--no-dest-paths>"
16714 #: ../fish/guestfish.pod:212
16716 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16717 "to hit the tab key to complete paths on the guest filesystem, but this "
16718 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16719 "allow this feature to be disabled."
16723 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16725 "When prompting for keys and passphrases, guestfish normally turns echoing "
16726 "off so you cannot see what you are typing. If you are not worried about "
16727 "Tempest attacks and there is no one else in the room you can specify this "
16728 "flag to see what you are typing."
16732 #: ../fish/guestfish.pod:224
16737 #: ../fish/guestfish.pod:226
16738 msgid "B<--file file>"
16742 #: ../fish/guestfish.pod:228
16743 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16747 #: ../fish/guestfish.pod:231
16750 " #!/usr/bin/guestfish -f\n"
16755 #: ../fish/guestfish.pod:244
16758 " guestfish --format=raw -a disk.img\n"
16763 #: ../fish/guestfish.pod:248
16766 " guestfish --format=raw -a disk.img --format -a another.img\n"
16771 #: ../fish/guestfish.pod:253
16773 "If you have untrusted raw-format guest disk images, you should use this "
16774 "option to specify the disk format. This avoids a possible security problem "
16775 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16779 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16780 msgid "B<--inspector>"
16784 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16786 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16787 "system and mount filesystems as they would be mounted on the real virtual "
16792 #: ../fish/guestfish.pod:266
16793 msgid "Typical usage is either:"
16797 #: ../fish/guestfish.pod:268
16800 " guestfish -d myguest -i\n"
16805 #: ../fish/guestfish.pod:270
16806 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16810 #: ../fish/guestfish.pod:272
16813 " guestfish --ro -d myguest -i\n"
16818 #: ../fish/guestfish.pod:274
16819 msgid "(for active domains, readonly), or specify the block device directly:"
16823 #: ../fish/guestfish.pod:276
16826 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16831 #: ../fish/guestfish.pod:278
16833 "Note that the command line syntax changed slightly over older versions of "
16834 "guestfish. You can still use the old syntax:"
16838 #: ../fish/guestfish.pod:281
16841 " guestfish [--ro] -i disk.img\n"
16846 #: ../fish/guestfish.pod:283
16849 " guestfish [--ro] -i libvirt-domain\n"
16854 #: ../fish/guestfish.pod:285
16856 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16857 "then using other commands to mount the filesystems that were found."
16861 #: ../fish/guestfish.pod:294
16862 msgid "B<--listen>"
16866 #: ../fish/guestfish.pod:296
16868 "Fork into the background and listen for remote commands. See section L</"
16869 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16873 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16878 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16880 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
16881 "ATTACHING TO RUNNING DAEMONS>)."
16885 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16886 msgid "B<-m dev[:mountpoint[:options]]>"
16890 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16891 msgid "B<--mount dev[:mountpoint[:options]]>"
16895 #: ../fish/guestfish.pod:308
16896 msgid "Mount the named partition or logical volume on the given mountpoint."
16900 #: ../fish/guestfish.pod:310
16901 msgid "If the mountpoint is omitted, it defaults to C</>."
16905 #: ../fish/guestfish.pod:312
16906 msgid "You have to mount something on C</> before most commands will work."
16910 #: ../fish/guestfish.pod:314
16912 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16917 #: ../fish/guestfish.pod:317
16919 "If you don't know what filesystems a disk image contains, you can either run "
16920 "guestfish without this option, then list the partitions, filesystems and LVs "
16921 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16922 "commands), or you can use the L<virt-filesystems(1)> program."
16926 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16928 "The third (and rarely used) part of the mount parameter is the list of mount "
16929 "options used to mount the underlying filesystem. If this is not given, then "
16930 "the mount options are either the empty string or C<ro> (the latter if the "
16931 "I<--ro> flag is used). By specifying the mount options, you override this "
16932 "default choice. Probably the only time you would use this is to enable ACLs "
16933 "and/or extended attributes if the filesystem can support them:"
16937 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16940 " -m /dev/sda1:/:acl,user_xattr\n"
16945 #: ../fish/guestfish.pod:333
16946 msgid "Using this flag is equivalent to using the C<mount-options> command."
16950 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
16951 #: ../resize/virt-resize.pod:358
16956 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16957 msgid "B<--no-sync>"
16961 #: ../fish/guestfish.pod:339
16963 "Disable autosync. This is enabled by default. See the discussion of "
16964 "autosync in the L<guestfs(3)> manpage."
16968 #: ../fish/guestfish.pod:342
16973 #: ../fish/guestfish.pod:344
16974 msgid "B<--new type>"
16978 #: ../fish/guestfish.pod:346
16983 #: ../fish/guestfish.pod:348
16985 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16986 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16987 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16992 #: ../fish/guestfish.pod:353
16993 msgid "B<--progress-bars>"
16997 #: ../fish/guestfish.pod:355
16998 msgid "Enable progress bars, even when guestfish is used non-interactively."
17002 #: ../fish/guestfish.pod:357
17004 "Progress bars are enabled by default when guestfish is used as an "
17005 "interactive shell."
17009 #: ../fish/guestfish.pod:360
17010 msgid "B<--no-progress-bars>"
17014 #: ../fish/guestfish.pod:362
17015 msgid "Disable progress bars."
17019 #: ../fish/guestfish.pod:364
17020 msgid "B<--remote[=pid]>"
17024 #: ../fish/guestfish.pod:366
17026 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17027 "CONTROL GUESTFISH OVER A SOCKET> below."
17031 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
17032 #: ../rescue/virt-rescue.pod:161
17037 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
17038 #: ../rescue/virt-rescue.pod:163
17043 #: ../fish/guestfish.pod:373
17045 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
17046 "mounts are done read-only."
17050 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
17052 "The option must always be used if the disk image or virtual machine might be "
17053 "running, and is generally recommended in cases where you don't need write "
17054 "access to the disk."
17058 #: ../fish/guestfish.pod:380
17060 "Note that prepared disk images created with I<-N> are not affected by this "
17061 "option. Also commands like C<add> are not affected - you have to specify "
17062 "the C<readonly:true> option explicitly if you need it."
17066 #: ../fish/guestfish.pod:384
17067 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17071 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
17072 #: ../rescue/virt-rescue.pod:173
17073 msgid "B<--selinux>"
17077 #: ../fish/guestfish.pod:388
17078 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17082 #: ../fish/guestfish.pod:394
17084 "Enable very verbose messages. This is particularly useful if you find a bug."
17088 #: ../fish/guestfish.pod:401
17089 msgid "Display the guestfish / libguestfs version number and exit."
17093 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
17094 #: ../rescue/virt-rescue.pod:190
17099 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
17100 #: ../rescue/virt-rescue.pod:192
17105 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
17107 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
17108 "mounts are done read-write."
17112 #: ../fish/guestfish.pod:410
17113 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
17117 #: ../fish/guestfish.pod:414
17118 msgid "Echo each command before executing it."
17122 #: ../fish/guestfish.pod:418
17123 msgid "COMMANDS ON COMMAND LINE"
17127 #: ../fish/guestfish.pod:420
17129 "Any additional (non-option) arguments are treated as commands to execute."
17133 #: ../fish/guestfish.pod:423
17135 "Commands to execute should be separated by a colon (C<:>), where the colon "
17136 "is a separate parameter. Thus:"
17140 #: ../fish/guestfish.pod:426
17143 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17148 #: ../fish/guestfish.pod:428
17150 "If there are no additional arguments, then we enter a shell, either an "
17151 "interactive shell with a prompt (if the input is a terminal) or a non-"
17152 "interactive shell."
17156 #: ../fish/guestfish.pod:432
17158 "In either command line mode or non-interactive shell, the first command that "
17159 "gives an error causes the whole shell to exit. In interactive mode (with a "
17160 "prompt) if a command fails, you can continue to enter commands."
17164 #: ../fish/guestfish.pod:437
17165 msgid "USING launch (OR run)"
17169 #: ../fish/guestfish.pod:439
17171 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17172 "then launch it, then mount any disks you need, and finally issue actions/"
17173 "commands. So the general order of the day is:"
17177 #: ../fish/guestfish.pod:447
17178 msgid "add or -a/--add"
17182 #: ../fish/guestfish.pod:451
17183 msgid "launch (aka run)"
17187 #: ../fish/guestfish.pod:455
17188 msgid "mount or -m/--mount"
17192 #: ../fish/guestfish.pod:459
17193 msgid "any other commands"
17197 #: ../fish/guestfish.pod:463
17199 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17200 "guest before mounting or performing any other commands."
17204 #: ../fish/guestfish.pod:466
17206 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17207 "I<--new> options were given then C<run> is done automatically, simply "
17208 "because guestfish can't perform the action you asked for without doing this."
17212 #: ../fish/guestfish.pod:471
17213 msgid "OPENING DISKS FOR READ AND WRITE"
17217 #: ../fish/guestfish.pod:473
17219 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
17220 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
17221 "I<-i> and I<-m> open disk images read-only or for writing."
17225 #: ../fish/guestfish.pod:478
17227 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
17228 "opening disk images supplied on the command line for write. To open a disk "
17229 "image read-only you have to do I<-a image --ro>."
17233 #: ../fish/guestfish.pod:482
17235 "This matters: If you accidentally open a live VM disk image writable then "
17236 "you will cause irreversible disk corruption."
17240 #: ../fish/guestfish.pod:485
17242 "In a future libguestfs we intend to change the default the other way. Disk "
17243 "images will be opened read-only. You will have to either specify "
17244 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
17245 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
17246 "access for disk images specified by those other command line options."
17250 #: ../fish/guestfish.pod:492
17252 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
17253 "which does nothing (it is already the default). However it is highly "
17254 "recommended that you use this option to indicate that you need write access, "
17255 "and prepare your scripts for the day when this option will be required for "
17260 #: ../fish/guestfish.pod:498
17262 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17263 "other libguestfs program apart from guestfish and guestmount."
17267 #: ../fish/guestfish.pod:501
17272 #: ../fish/guestfish.pod:503
17274 "You can quote ordinary parameters using either single or double quotes. For "
17279 #: ../fish/guestfish.pod:506
17282 " add \"file with a space.img\"\n"
17287 #: ../fish/guestfish.pod:508
17290 " rm '/file name'\n"
17295 #: ../fish/guestfish.pod:510
17303 #: ../fish/guestfish.pod:512
17305 "A few commands require a list of strings to be passed. For these, use a "
17306 "whitespace-separated list, enclosed in quotes. Strings containing "
17307 "whitespace to be passed through must be enclosed in single quotes. A "
17308 "literal single quote must be escaped with a backslash."
17312 #: ../fish/guestfish.pod:517
17315 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17316 " command \"/bin/echo 'foo bar'\"\n"
17317 " command \"/bin/echo \\'foo\\'\"\n"
17322 #: ../fish/guestfish.pod:521
17323 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
17327 #: ../fish/guestfish.pod:523
17329 "In double-quoted arguments (only) use backslash to insert special characters:"
17333 #: ../fish/guestfish.pod:528
17338 #: ../fish/guestfish.pod:530
17339 msgid "Alert (bell) character."
17343 #: ../fish/guestfish.pod:532
17348 #: ../fish/guestfish.pod:534
17349 msgid "Backspace character."
17353 #: ../fish/guestfish.pod:536
17358 #: ../fish/guestfish.pod:538
17359 msgid "Form feed character."
17363 #: ../fish/guestfish.pod:540
17368 #: ../fish/guestfish.pod:542
17369 msgid "Newline character."
17373 #: ../fish/guestfish.pod:544
17378 #: ../fish/guestfish.pod:546
17379 msgid "Carriage return character."
17383 #: ../fish/guestfish.pod:548
17388 #: ../fish/guestfish.pod:550
17389 msgid "Horizontal tab character."
17393 #: ../fish/guestfish.pod:552
17398 #: ../fish/guestfish.pod:554
17399 msgid "Vertical tab character."
17403 #: ../fish/guestfish.pod:556
17408 #: ../fish/guestfish.pod:558
17409 msgid "A literal double quote character."
17413 #: ../fish/guestfish.pod:560
17418 #: ../fish/guestfish.pod:562
17420 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
17425 #: ../fish/guestfish.pod:565
17430 #: ../fish/guestfish.pod:567
17432 "A character with hex value I<hh>. There must be precisely 2 hex digits."
17436 #: ../fish/guestfish.pod:570
17438 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
17443 #: ../fish/guestfish.pod:573
17448 #: ../fish/guestfish.pod:575
17449 msgid "A literal backslash character."
17453 #: ../fish/guestfish.pod:579
17454 msgid "OPTIONAL ARGUMENTS"
17458 #: ../fish/guestfish.pod:581
17460 "Some commands take optional arguments. These arguments appear in this "
17461 "documentation as C<[argname:..]>. You can use them as in these examples:"
17465 #: ../fish/guestfish.pod:585
17468 " add-drive-opts filename\n"
17473 #: ../fish/guestfish.pod:587
17476 " add-drive-opts filename readonly:true\n"
17481 #: ../fish/guestfish.pod:589
17484 " add-drive-opts filename format:qcow2 readonly:false\n"
17489 #: ../fish/guestfish.pod:591
17491 "Each optional argument can appear at most once. All optional arguments must "
17492 "appear after the required ones."
17496 #: ../fish/guestfish.pod:594
17501 #: ../fish/guestfish.pod:596
17503 "This section applies to all commands which can take integers as parameters."
17507 #: ../fish/guestfish.pod:599
17508 msgid "SIZE SUFFIX"
17512 #: ../fish/guestfish.pod:601
17514 "When the command takes a parameter measured in bytes, you can use one of the "
17515 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17519 #: ../fish/guestfish.pod:607
17520 msgid "B<k> or B<K> or B<KiB>"
17524 #: ../fish/guestfish.pod:609
17525 msgid "The size in kilobytes (multiplied by 1024)."
17529 #: ../fish/guestfish.pod:611
17534 #: ../fish/guestfish.pod:613
17535 msgid "The size in SI 1000 byte units."
17539 #: ../fish/guestfish.pod:615
17540 msgid "B<M> or B<MiB>"
17544 #: ../fish/guestfish.pod:617
17545 msgid "The size in megabytes (multiplied by 1048576)."
17549 #: ../fish/guestfish.pod:619
17554 #: ../fish/guestfish.pod:621
17555 msgid "The size in SI 1000000 byte units."
17559 #: ../fish/guestfish.pod:623
17560 msgid "B<G> or B<GiB>"
17564 #: ../fish/guestfish.pod:625
17565 msgid "The size in gigabytes (multiplied by 2**30)."
17569 #: ../fish/guestfish.pod:627
17574 #: ../fish/guestfish.pod:629
17575 msgid "The size in SI 10**9 byte units."
17579 #: ../fish/guestfish.pod:631
17580 msgid "B<T> or B<TiB>"
17584 #: ../fish/guestfish.pod:633
17585 msgid "The size in terabytes (multiplied by 2**40)."
17589 #: ../fish/guestfish.pod:635
17594 #: ../fish/guestfish.pod:637
17595 msgid "The size in SI 10**12 byte units."
17599 #: ../fish/guestfish.pod:639
17600 msgid "B<P> or B<PiB>"
17604 #: ../fish/guestfish.pod:641
17605 msgid "The size in petabytes (multiplied by 2**50)."
17609 #: ../fish/guestfish.pod:643
17614 #: ../fish/guestfish.pod:645
17615 msgid "The size in SI 10**15 byte units."
17619 #: ../fish/guestfish.pod:647
17620 msgid "B<E> or B<EiB>"
17624 #: ../fish/guestfish.pod:649
17625 msgid "The size in exabytes (multiplied by 2**60)."
17629 #: ../fish/guestfish.pod:651
17634 #: ../fish/guestfish.pod:653
17635 msgid "The size in SI 10**18 byte units."
17639 #: ../fish/guestfish.pod:655
17640 msgid "B<Z> or B<ZiB>"
17644 #: ../fish/guestfish.pod:657
17645 msgid "The size in zettabytes (multiplied by 2**70)."
17649 #: ../fish/guestfish.pod:659
17654 #: ../fish/guestfish.pod:661
17655 msgid "The size in SI 10**21 byte units."
17659 #: ../fish/guestfish.pod:663
17660 msgid "B<Y> or B<YiB>"
17664 #: ../fish/guestfish.pod:665
17665 msgid "The size in yottabytes (multiplied by 2**80)."
17669 #: ../fish/guestfish.pod:667
17674 #: ../fish/guestfish.pod:669
17675 msgid "The size in SI 10**24 byte units."
17679 #: ../fish/guestfish.pod:675
17682 " truncate-size /file 1G\n"
17687 #: ../fish/guestfish.pod:677
17688 msgid "would truncate the file to 1 gigabyte."
17692 #: ../fish/guestfish.pod:679
17694 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
17695 "the parameter to L</memsize> is specified in megabytes already). Adding a "
17696 "suffix will probably not do what you expect."
17700 #: ../fish/guestfish.pod:683
17701 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17705 #: ../fish/guestfish.pod:685
17707 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17708 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17712 #: ../fish/guestfish.pod:688
17715 " 1234 decimal number 1234\n"
17716 " 02322 octal number, equivalent to decimal 1234\n"
17717 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17722 #: ../fish/guestfish.pod:692
17724 "When using the C<chmod> command, you almost always want to specify an octal "
17725 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17726 "L<chmod(1)> program):"
17730 #: ../fish/guestfish.pod:696
17733 " chmod 0777 /public # OK\n"
17734 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17739 #: ../fish/guestfish.pod:699
17741 "Commands that return numbers usually print them in decimal, but some "
17742 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17743 "octal, preceeded by C<0>)."
17747 #: ../fish/guestfish.pod:703
17748 msgid "WILDCARDS AND GLOBBING"
17752 #: ../fish/guestfish.pod:705
17754 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17755 "(globbing) by default. So for example the following will not do what you "
17760 #: ../fish/guestfish.pod:709
17768 #: ../fish/guestfish.pod:711
17770 "Assuming you don't have a directory called literally C</home/*> then the "
17771 "above command will return an error."
17775 #: ../fish/guestfish.pod:714
17776 msgid "To perform wildcard expansion, use the C<glob> command."
17780 #: ../fish/guestfish.pod:716
17783 " glob rm-rf /home/*\n"
17788 #: ../fish/guestfish.pod:718
17790 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17791 "many times), equivalent to:"
17795 #: ../fish/guestfish.pod:721
17798 " rm-rf /home/jim\n"
17799 " rm-rf /home/joe\n"
17800 " rm-rf /home/mary\n"
17805 #: ../fish/guestfish.pod:725
17806 msgid "C<glob> only works on simple guest paths and not on device names."
17810 #: ../fish/guestfish.pod:727
17812 "If you have several parameters, each containing a wildcard, then glob will "
17813 "perform a Cartesian product."
17817 #: ../fish/guestfish.pod:730
17822 #: ../fish/guestfish.pod:732
17824 "Any line which starts with a I<#> character is treated as a comment and "
17825 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17826 "a command. For example:"
17830 #: ../fish/guestfish.pod:736
17833 " # this is a comment\n"
17834 " # this is a comment\n"
17835 " foo # NOT a comment\n"
17840 #: ../fish/guestfish.pod:740
17841 msgid "Blank lines are also ignored."
17845 #: ../fish/guestfish.pod:742
17846 msgid "RUNNING COMMANDS LOCALLY"
17850 #: ../fish/guestfish.pod:744
17852 "Any line which starts with a I<!> character is treated as a command sent to "
17853 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17857 #: ../fish/guestfish.pod:748
17861 " tgz-out /remote local/remote-data.tar.gz\n"
17866 #: ../fish/guestfish.pod:751
17868 "will create a directory C<local> on the host, and then export the contents "
17869 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17870 "(See C<tgz-out>)."
17874 #: ../fish/guestfish.pod:755
17876 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17877 "effect, due to the way that subprocesses work in Unix."
17881 #: ../fish/guestfish.pod:758
17882 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17886 #: ../fish/guestfish.pod:760
17888 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17889 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17890 "and executed as guestfish commands."
17894 #: ../fish/guestfish.pod:764
17896 "Thus you can use shell script to construct arbitrary guestfish commands "
17897 "which are then parsed by guestfish."
17901 #: ../fish/guestfish.pod:767
17903 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17904 "through C</foo.100>) using guestfish commands alone. However this is simple "
17905 "if we use a shell script to create the guestfish commands for us:"
17909 #: ../fish/guestfish.pod:772
17912 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17917 #: ../fish/guestfish.pod:774
17918 msgid "or with names like C</foo.001>:"
17922 #: ../fish/guestfish.pod:776
17925 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17930 #: ../fish/guestfish.pod:778
17932 "When using guestfish interactively it can be helpful to just run the shell "
17933 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17934 "ordinary I<!> local command), see what guestfish commands it would run, and "
17935 "when you are happy with those prepend the C<E<lt>> character to run the "
17936 "guestfish commands for real."
17940 #: ../fish/guestfish.pod:784
17945 #: ../fish/guestfish.pod:786
17947 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17948 "command (a guestfish command) to the second command (any host command). For "
17953 #: ../fish/guestfish.pod:790
17956 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17961 #: ../fish/guestfish.pod:792
17963 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17964 "program). The above command would list all accounts in the guest filesystem "
17965 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17969 #: ../fish/guestfish.pod:797
17972 " hexdump /bin/ls | head\n"
17973 " list-devices | tail -1\n"
17974 " tgz-out / - | tar ztf -\n"
17979 #: ../fish/guestfish.pod:801
17981 "The space before the pipe symbol is required, any space after the pipe "
17982 "symbol is optional. Everything after the pipe symbol is just passed "
17983 "straight to the host shell, so it can contain redirections, globs and "
17984 "anything else that makes sense on the host side."
17988 #: ../fish/guestfish.pod:806
17990 "To use a literal argument which begins with a pipe symbol, you have to quote "
17995 #: ../fish/guestfish.pod:809
18003 #: ../fish/guestfish.pod:811
18004 msgid "HOME DIRECTORIES"
18008 #: ../fish/guestfish.pod:813
18010 "If a parameter starts with the character C<~> then the tilde may be expanded "
18011 "as a home directory path (either C<~> for the current user's home directory, "
18012 "or C<~user> for another user)."
18016 #: ../fish/guestfish.pod:817
18018 "Note that home directory expansion happens for users known I<on the host>, "
18019 "not in the guest filesystem."
18023 #: ../fish/guestfish.pod:820
18025 "To use a literal argument which begins with a tilde, you have to quote it, "
18030 #: ../fish/guestfish.pod:823
18038 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
18039 msgid "ENCRYPTED DISKS"
18043 #: ../fish/guestfish.pod:827
18045 "Libguestfs has some support for Linux guests encrypted according to the "
18046 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18047 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18048 "LUKS is supported."
18052 #: ../fish/guestfish.pod:832
18053 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18057 #: ../fish/guestfish.pod:834
18060 " ><fs> vfs-type /dev/sda2\n"
18066 #: ../fish/guestfish.pod:837
18068 "Then open those devices using L</luks-open>. This creates a device-mapper "
18069 "device called C</dev/mapper/luksdev>."
18073 #: ../fish/guestfish.pod:840
18076 " ><fs> luks-open /dev/sda2 luksdev\n"
18077 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18082 #: ../fish/guestfish.pod:843
18084 "Finally you have to tell LVM to scan for volume groups on the newly created "
18089 #: ../fish/guestfish.pod:846
18093 " vg-activate-all true\n"
18098 #: ../fish/guestfish.pod:849
18099 msgid "The logical volume(s) can now be mounted in the usual way."
18103 #: ../fish/guestfish.pod:851
18105 "Before closing a LUKS device you must unmount any logical volumes on it and "
18106 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18107 "one. Then you can close the mapper device:"
18111 #: ../fish/guestfish.pod:855
18114 " vg-activate false /dev/VG\n"
18115 " luks-close /dev/mapper/luksdev\n"
18120 #: ../fish/guestfish.pod:860
18122 "If a path is prefixed with C<win:> then you can use Windows-style drive "
18123 "letters and paths (with some limitations). The following commands are "
18128 #: ../fish/guestfish.pod:864
18131 " file /WINDOWS/system32/config/system.LOG\n"
18136 #: ../fish/guestfish.pod:866
18139 " file win:\\windows\\system32\\config\\system.log\n"
18144 #: ../fish/guestfish.pod:868
18147 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
18152 #: ../fish/guestfish.pod:870
18154 "The parameter is rewritten \"behind the scenes\" by looking up the position "
18155 "where the drive is mounted, prepending that to the path, changing all "
18156 "backslash characters to forward slash, then resolving the result using L</"
18157 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
18158 "the parameter might be rewritten like this:"
18162 #: ../fish/guestfish.pod:876
18165 " win:e:\\foo\\bar => /e/FOO/bar\n"
18170 #: ../fish/guestfish.pod:878
18171 msgid "This only works in argument positions that expect a path."
18175 #: ../fish/guestfish.pod:880
18176 msgid "UPLOADING AND DOWNLOADING FILES"
18180 #: ../fish/guestfish.pod:882
18182 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18183 "others which upload from or download to a local file, you can use the "
18184 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18188 #: ../fish/guestfish.pod:886
18196 #: ../fish/guestfish.pod:888
18198 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18202 #: ../fish/guestfish.pod:891
18205 " tar-out /etc - | tar tf -\n"
18210 #: ../fish/guestfish.pod:893
18212 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18213 "command (see L</PIPES>)."
18217 #: ../fish/guestfish.pod:896
18219 "When using C<-> to read from stdin, the input is read up to the end of "
18220 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18221 "some arbitrary end marker:"
18225 #: ../fish/guestfish.pod:900
18228 " upload -<<END /foo\n"
18237 #: ../fish/guestfish.pod:906
18239 "Any string of characters can be used instead of C<END>. The end marker must "
18240 "appear on a line of its own, without any preceeding or following characters "
18241 "(not even spaces)."
18245 #: ../fish/guestfish.pod:910
18247 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18248 "upload local files (so-called \"FileIn\" parameters in the generator)."
18252 #: ../fish/guestfish.pod:913
18253 msgid "EXIT ON ERROR BEHAVIOUR"
18257 #: ../fish/guestfish.pod:915
18259 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18260 "taking commands from a human over a tty), and will exit on the first error "
18261 "in non-interactive mode (scripts, commands given on the command line)."
18265 #: ../fish/guestfish.pod:920
18267 "If you prefix a command with a I<-> character, then that command will not "
18268 "cause guestfish to exit, even if that (one) command returns an error."
18272 #: ../fish/guestfish.pod:924
18273 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18277 #: ../fish/guestfish.pod:926
18279 "Guestfish can be remote-controlled over a socket. This is useful "
18280 "particularly in shell scripts where you want to make several different "
18281 "changes to a filesystem, but you don't want the overhead of starting up a "
18282 "guestfish process each time."
18286 #: ../fish/guestfish.pod:931
18287 msgid "Start a guestfish server process using:"
18291 #: ../fish/guestfish.pod:933
18294 " eval \"`guestfish --listen`\"\n"
18299 #: ../fish/guestfish.pod:935
18300 msgid "and then send it commands by doing:"
18304 #: ../fish/guestfish.pod:937
18307 " guestfish --remote cmd [...]\n"
18312 #: ../fish/guestfish.pod:939
18313 msgid "To cause the server to exit, send it the exit command:"
18317 #: ../fish/guestfish.pod:943
18319 "Note that the server will normally exit if there is an error in a command. "
18320 "You can change this in the usual way. See section L</EXIT ON ERROR "
18325 #: ../fish/guestfish.pod:947
18326 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18330 #: ../fish/guestfish.pod:949
18332 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18333 "is how the I<--remote> option knows where to send the commands. You can "
18334 "have several guestfish listener processes running using:"
18338 #: ../fish/guestfish.pod:953
18341 " eval \"`guestfish --listen`\"\n"
18342 " pid1=$GUESTFISH_PID\n"
18343 " eval \"`guestfish --listen`\"\n"
18344 " pid2=$GUESTFISH_PID\n"
18346 " guestfish --remote=$pid1 cmd\n"
18347 " guestfish --remote=$pid2 cmd\n"
18352 #: ../fish/guestfish.pod:961
18353 msgid "REMOTE CONTROL AND CSH"
18357 #: ../fish/guestfish.pod:963
18359 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18364 #: ../fish/guestfish.pod:966
18367 " eval \"`guestfish --listen --csh`\"\n"
18372 #: ../fish/guestfish.pod:968
18373 msgid "REMOTE CONTROL DETAILS"
18377 #: ../fish/guestfish.pod:970
18379 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18380 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18381 "and C<$PID> is the process ID of the server."
18385 #: ../fish/guestfish.pod:974
18386 msgid "Guestfish client and server versions must match exactly."
18390 #: ../fish/guestfish.pod:976
18391 msgid "REMOTE CONTROL RUN COMMAND HANGING"
18395 #: ../fish/guestfish.pod:978
18397 "Using the C<run> (or C<launch>) command remotely in a command substitution "
18398 "context hangs, ie. don't do (note the backquotes):"
18402 #: ../fish/guestfish.pod:981
18405 " a=`guestfish --remote run`\n"
18410 #: ../fish/guestfish.pod:983
18412 "Since the C<run> command produces no output on stdout, this is not useful "
18413 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
18418 #: ../fish/guestfish.pod:987
18419 msgid "PREPARED DISK IMAGES"
18423 #: ../fish/guestfish.pod:989
18425 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18426 "preformatted disk images that guestfish can make for you to save typing. "
18427 "This is particularly useful for testing purposes. This option is used "
18428 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18429 "can be mixed with I<-a>)."
18433 #: ../fish/guestfish.pod:995
18435 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18436 "the second and so on. Existing files in the current directory are "
18441 #: ../fish/guestfish.pod:999
18443 "The type briefly describes how the disk should be sized, partitioned, how "
18444 "filesystem(s) should be created, and how content should be added. "
18445 "Optionally the type can be followed by extra parameters, separated by C<:> "
18446 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18447 "allocated disk, containing a single partition, with the partition formatted "
18448 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18453 #: ../fish/guestfish.pod:1007
18454 msgid "To list the available types and any extra parameters they take, run:"
18458 #: ../fish/guestfish.pod:1011
18460 "Note that the prepared filesystem is not mounted. You would usually have to "
18461 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18465 #: ../fish/guestfish.pod:1015
18467 "If any I<-N> or I<--new> options are given, the guest is automatically "
18472 #: ../fish/guestfish.pod:1020
18473 msgid "Create a 100MB disk with an ext4-formatted partition:"
18477 #: ../fish/guestfish.pod:1022
18480 " guestfish -N fs:ext4\n"
18485 #: ../fish/guestfish.pod:1024
18486 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18490 #: ../fish/guestfish.pod:1026
18493 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18498 #: ../fish/guestfish.pod:1028
18499 msgid "Create a blank 200MB disk:"
18503 #: ../fish/guestfish.pod:1030
18506 " guestfish -N disk:200M\n"
18511 #: ../fish/guestfish.pod:1032
18512 msgid "PROGRESS BARS"
18516 #: ../fish/guestfish.pod:1034
18518 "Some (not all) long-running commands send progress notification messages as "
18519 "they are running. Guestfish turns these messages into progress bars."
18523 #: ../fish/guestfish.pod:1038
18525 "When a command that supports progress bars takes longer than two seconds to "
18526 "run, and if progress bars are enabled, then you will see one appearing below "
18531 #: ../fish/guestfish.pod:1042
18534 " ><fs> copy-size /large-file /another-file 2048M\n"
18535 " / 10% [#####-----------------------------------------] 00:30\n"
18540 #: ../fish/guestfish.pod:1045
18542 "The spinner on the left hand side moves round once for every progress "
18543 "notification received from the backend. This is a (reasonably) golden "
18544 "assurance that the command is \"doing something\" even if the progress bar "
18545 "is not moving, because the command is able to send the progress "
18546 "notifications. When the bar reaches 100% and the command finishes, the "
18547 "spinner disappears."
18551 #: ../fish/guestfish.pod:1052
18553 "Progress bars are enabled by default when guestfish is used interactively. "
18554 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18555 "and you can disable them completely using I<--no-progress-bars>."
18559 #: ../fish/guestfish.pod:1057
18560 msgid "GUESTFISH COMMANDS"
18564 #: ../fish/guestfish.pod:1059
18566 "The commands in this section are guestfish convenience commands, in other "
18567 "words, they are not part of the L<guestfs(3)> API."
18571 #: ../fish/guestfish.pod:1062
18576 #: ../fish/guestfish.pod:1064
18585 #: ../fish/guestfish.pod:1067
18586 msgid "Without any parameter, this provides general help."
18590 #: ../fish/guestfish.pod:1069
18591 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18595 #: ../fish/guestfish.pod:1071
18596 msgid "quit | exit"
18600 #: ../fish/guestfish.pod:1073
18601 msgid "This exits guestfish. You can also use C<^D> key."
18605 #: ../fish/guestfish.pod:1075
18606 msgid "@FISH_COMMANDS@"
18610 #: ../fish/guestfish.pod:1077
18615 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1479
18620 #: ../fish/guestfish.pod:1083
18622 "guestfish returns 0 if the commands completed without error, or 1 if there "
18627 #: ../fish/guestfish.pod:1090
18632 #: ../fish/guestfish.pod:1092
18634 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18639 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:3084
18640 msgid "FEBOOTSTRAP_KERNEL"
18644 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:3086
18645 msgid "FEBOOTSTRAP_MODULES"
18649 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:3088
18651 "These two environment variables allow the kernel that libguestfs uses in the "
18652 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18653 "most recent host kernel is chosen. For more information about kernel "
18654 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
18655 "available in febootstrap E<ge> 3.8."
18659 #: ../fish/guestfish.pod:1105
18660 msgid "GUESTFISH_DISPLAY_IMAGE"
18664 #: ../fish/guestfish.pod:1107
18666 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18667 "If not set, it uses L<display(1)>."
18671 #: ../fish/guestfish.pod:1110
18672 msgid "GUESTFISH_PID"
18676 #: ../fish/guestfish.pod:1112
18678 "Used with the I<--remote> option to specify the remote guestfish process to "
18679 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18683 #: ../fish/guestfish.pod:1116
18688 #: ../fish/guestfish.pod:1118
18690 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18691 "not specified, the external L<hexedit(1)> program is used."
18695 #: ../fish/guestfish.pod:1122
18700 #: ../fish/guestfish.pod:1124
18702 "If compiled with GNU readline support, various files in the home directory "
18703 "can be used. See L</FILES>."
18707 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:3094
18708 msgid "LIBGUESTFS_APPEND"
18712 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:3096
18713 msgid "Pass additional options to the guest kernel."
18717 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:3098
18718 msgid "LIBGUESTFS_DEBUG"
18722 #: ../fish/guestfish.pod:1133
18724 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18725 "effect as using the B<-v> option."
18729 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:3103
18730 msgid "LIBGUESTFS_MEMSIZE"
18734 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:3105
18736 "Set the memory allocated to the qemu process, in megabytes. For example:"
18740 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:3108
18743 " LIBGUESTFS_MEMSIZE=700\n"
18748 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:3110
18749 msgid "LIBGUESTFS_PATH"
18753 #: ../fish/guestfish.pod:1145
18755 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18756 "the discussion of paths in L<guestfs(3)>."
18760 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3115
18761 msgid "LIBGUESTFS_QEMU"
18765 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3117
18767 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18768 "which was found at compile time by the configure script is used."
18772 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3123
18773 msgid "LIBGUESTFS_TRACE"
18777 #: ../fish/guestfish.pod:1156
18778 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18782 #: ../fish/guestfish.pod:1158
18787 #: ../fish/guestfish.pod:1160
18789 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18794 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3128
18799 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3130
18801 "Location of temporary directory, defaults to C</tmp> except for the cached "
18802 "supermin appliance which defaults to C</var/tmp>."
18806 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3133
18808 "If libguestfs was compiled to use the supermin appliance then the real "
18809 "appliance is cached in this directory, shared between all handles belonging "
18810 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18811 "use in case C</var/tmp> is not large enough."
18815 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288
18816 #: ../rescue/virt-rescue.pod:269
18821 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292
18822 #: ../rescue/virt-rescue.pod:273
18823 msgid "$HOME/.libguestfs-tools.rc"
18827 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294
18828 #: ../rescue/virt-rescue.pod:275
18829 msgid "/etc/libguestfs-tools.conf"
18833 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296
18834 #: ../rescue/virt-rescue.pod:277
18836 "This configuration file controls the default read-only or read-write mode "
18837 "(I<--ro> or I<--rw>)."
18841 #: ../fish/guestfish.pod:1187
18842 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18846 #: ../fish/guestfish.pod:1189
18847 msgid "$HOME/.guestfish"
18851 #: ../fish/guestfish.pod:1191
18853 "If compiled with GNU readline support, then the command history is saved in "
18858 #: ../fish/guestfish.pod:1194
18859 msgid "$HOME/.inputrc"
18863 #: ../fish/guestfish.pod:1196
18864 msgid "/etc/inputrc"
18868 #: ../fish/guestfish.pod:1198
18870 "If compiled with GNU readline support, then these files can be used to "
18871 "configure readline. For further information, please see L<readline(3)/"
18872 "INITIALIZATION FILE>."
18876 #: ../fish/guestfish.pod:1202
18877 msgid "To write rules which only apply to guestfish, use:"
18881 #: ../fish/guestfish.pod:1204
18891 #: ../fish/guestfish.pod:1208
18893 "Variables that you can set in inputrc that change the behaviour of guestfish "
18894 "in useful ways include:"
18898 #: ../fish/guestfish.pod:1213
18899 msgid "completion-ignore-case (default: on)"
18903 #: ../fish/guestfish.pod:1215
18905 "By default, guestfish will ignore case when tab-completing paths on the "
18910 #: ../fish/guestfish.pod:1218
18913 " set completion-ignore-case off\n"
18918 #: ../fish/guestfish.pod:1220
18919 msgid "to make guestfish case sensitive."
18923 #: ../fish/guestfish.pod:1224
18928 #: ../fish/guestfish.pod:1226
18929 msgid "test2.img (etc)"
18933 #: ../fish/guestfish.pod:1228
18935 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18936 "will be created in the file C<test1.img> in the current directory. The "
18937 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18938 "the same name will be overwritten."
18942 #: ../fish/guestfish.pod:1237
18944 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
18945 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
18946 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
18947 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
18948 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
18949 ">, L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
18953 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3220
18954 #: ../test-tool/libguestfs-test-tool.pod:112
18955 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18959 #: ../fish/virt-copy-in.pod:5
18961 "virt-copy-in - Copy files and directories into a virtual machine disk image."
18965 #: ../fish/virt-copy-in.pod:9
18968 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18973 #: ../fish/virt-copy-in.pod:11
18976 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18981 #: ../fish/virt-copy-in.pod:15
18983 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18984 "causing disk corruption. The virtual machine must be shut down before you "
18985 "use this command."
18989 #: ../fish/virt-copy-in.pod:21
18991 "C<virt-copy-in> copies files and directories from the local disk into a "
18992 "virtual machine disk image or named libvirt domain."
18996 #: ../fish/virt-copy-in.pod:24
18998 "You can give one of more filenames and directories on the command line. "
18999 "Directories are copied in recursively. The final parameter must be the "
19000 "destination directory in the disk image which must be an absolute path "
19001 "starting with a C</> character."
19005 #: ../fish/virt-copy-in.pod:33
19008 " virt-copy-in -d MyGuest resolv.conf /etc\n"
19013 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
19014 msgid "Upload a home directory to a guest:"
19018 #: ../fish/virt-copy-in.pod:37
19021 " virt-copy-in -d MyGuest skel /home\n"
19026 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
19027 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
19028 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
19032 #: ../fish/virt-copy-in.pod:41
19034 "This command is just a simple shell script wrapper around the L<guestfish(1)"
19035 "> C<copy-in> command. For anything more complex than a trivial copy, you "
19036 "are probably better off using guestfish directly."
19040 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
19041 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
19043 "Since the shell script just passes options straight to guestfish, read "
19044 "L<guestfish(1)> to see the full list of options."
19048 #: ../fish/virt-copy-in.pod:52
19050 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
19051 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
19055 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
19056 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
19057 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
19061 #: ../fish/virt-copy-out.pod:5
19063 "virt-copy-out - Copy files and directories out of a virtual machine disk "
19068 #: ../fish/virt-copy-out.pod:9
19071 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
19076 #: ../fish/virt-copy-out.pod:11
19079 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
19084 #: ../fish/virt-copy-out.pod:15
19086 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
19087 "image or named libvirt domain."
19091 #: ../fish/virt-copy-out.pod:18
19093 "You can give one of more filenames and directories on the command line. "
19094 "Directories are copied out recursively."
19098 #: ../fish/virt-copy-out.pod:23
19099 msgid "Download the home directories from a virtual machine:"
19103 #: ../fish/virt-copy-out.pod:25
19107 " virt-copy-out -d MyGuest /home homes\n"
19112 #: ../fish/virt-copy-out.pod:30
19114 "This command is just a simple shell script wrapper around the L<guestfish(1)"
19115 "> C<copy-out> command. For anything more complex than a trivial copy, you "
19116 "are probably better off using guestfish directly."
19120 #: ../fish/virt-copy-out.pod:41
19122 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
19123 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
19127 #: ../fish/virt-tar-in.pod:5
19128 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
19132 #: ../fish/virt-tar-in.pod:9
19135 " virt-tar-in -a disk.img data.tar /destination\n"
19140 #: ../fish/virt-tar-in.pod:11
19143 " virt-tar-in -d domain data.tar /destination\n"
19148 #: ../fish/virt-tar-in.pod:13
19151 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
19156 #: ../fish/virt-tar-in.pod:17
19158 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
19159 "causing disk corruption. The virtual machine must be shut down before you "
19160 "use this command."
19164 #: ../fish/virt-tar-in.pod:23
19166 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
19167 "image or named libvirt domain."
19171 #: ../fish/virt-tar-in.pod:26
19173 "The first parameter is the tar file. Use C<-> to read the tar file from "
19174 "standard input. The second parameter is the absolute target directory to "
19179 #: ../fish/virt-tar-in.pod:34
19182 " virt-tar-in -d MyGuest homes.tar /home\n"
19187 #: ../fish/virt-tar-in.pod:38
19189 "This command is just a simple shell script wrapper around the L<guestfish(1)"
19190 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
19191 "probably better off using guestfish directly."
19195 #: ../fish/virt-tar-in.pod:49
19197 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
19198 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
19203 #: ../fish/virt-tar-out.pod:5
19205 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
19209 #: ../fish/virt-tar-out.pod:9
19212 " virt-tar-out -a disk.img /dir files.tar\n"
19217 #: ../fish/virt-tar-out.pod:11
19220 " virt-tar-out -d domain /dir files.tar\n"
19225 #: ../fish/virt-tar-out.pod:13
19228 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
19233 #: ../fish/virt-tar-out.pod:17
19235 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
19239 #: ../fish/virt-tar-out.pod:20
19241 "The first parameter is the absolute path of the virtual machine directory. "
19242 "The second parameter is the tar file to write. Use C<-> to write to "
19247 #: ../fish/virt-tar-out.pod:26
19248 msgid "Download the home directories from a guest:"
19252 #: ../fish/virt-tar-out.pod:28
19255 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
19260 #: ../fish/virt-tar-out.pod:32
19262 "This command is just a simple shell script wrapper around the L<guestfish(1)"
19263 "> C<tar-out> command. For anything more complex than a trivial copy, you "
19264 "are probably better off using guestfish directly."
19268 #: ../fish/virt-tar-out.pod:43
19270 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
19271 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
19275 #: ../fuse/guestmount.pod:5
19277 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
19281 #: ../fuse/guestmount.pod:9
19284 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
19289 #: ../fuse/guestmount.pod:11
19292 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
19297 #: ../fuse/guestmount.pod:13
19300 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
19305 #: ../fuse/guestmount.pod:17
19307 "You must I<not> use C<guestmount> in read-write mode on live virtual "
19308 "machines. If you do this, you risk disk corruption in the VM."
19312 #: ../fuse/guestmount.pod:22
19314 "The guestmount program can be used to mount virtual machine filesystems and "
19315 "other disk images on the host. It uses libguestfs for access to the guest "
19316 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
19317 "a mountable device."
19321 #: ../fuse/guestmount.pod:27
19323 "Along with other options, you have to give at least one device (I<-a> "
19324 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
19325 "option) or use the I<-i> inspection option. How this works is better "
19326 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
19331 #: ../fuse/guestmount.pod:33
19333 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
19334 "by you, and the filesystem will not be visible to any other users unless you "
19335 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
19336 "the filesystem, use the C<fusermount -u> command."
19340 #: ../fuse/guestmount.pod:41
19342 "For a typical Windows guest which has its main filesystem on the first "
19347 #: ../fuse/guestmount.pod:44
19350 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
19355 #: ../fuse/guestmount.pod:46
19357 "For a typical Linux guest which has a /boot filesystem on the first "
19358 "partition, and the root filesystem on a logical volume:"
19362 #: ../fuse/guestmount.pod:49
19365 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
19370 #: ../fuse/guestmount.pod:51
19371 msgid "To get libguestfs to detect guest mountpoints for you:"
19375 #: ../fuse/guestmount.pod:53
19378 " guestmount -a guest.img -i --ro /mnt\n"
19383 #: ../fuse/guestmount.pod:55
19384 msgid "For a libvirt guest called \"Guest\" you could do:"
19388 #: ../fuse/guestmount.pod:57
19391 " guestmount -d Guest -i --ro /mnt\n"
19396 #: ../fuse/guestmount.pod:59
19398 "If you don't know what filesystems are contained in a guest or disk image, "
19399 "use L<virt-filesystems(1)> first:"
19403 #: ../fuse/guestmount.pod:62
19406 " virt-filesystems MyGuest\n"
19411 #: ../fuse/guestmount.pod:64
19413 "If you want to trace the libguestfs calls but without excessive debugging "
19414 "information, we recommend:"
19418 #: ../fuse/guestmount.pod:67
19421 " guestmount [...] --trace /mnt\n"
19426 #: ../fuse/guestmount.pod:69
19427 msgid "If you want to debug the program, we recommend:"
19431 #: ../fuse/guestmount.pod:71
19434 " guestmount [...] --trace --verbose /mnt\n"
19439 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
19440 #: ../resize/virt-resize.pod:544
19445 #: ../fuse/guestmount.pod:75
19446 msgid "Other users cannot see the filesystem by default"
19450 #: ../fuse/guestmount.pod:77
19452 "If you mount a filesystem as one user (eg. root), then other users will not "
19453 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
19454 "option when mounting:"
19458 #: ../fuse/guestmount.pod:81
19461 " sudo guestmount [...] -o allow_other /mnt\n"
19466 #: ../fuse/guestmount.pod:91
19467 msgid "Add a block device or virtual machine image."
19471 #: ../fuse/guestmount.pod:114
19472 msgid "B<--dir-cache-timeout N>"
19476 #: ../fuse/guestmount.pod:116
19478 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
19479 "seconds. The readdir cache [actually, there are several semi-independent "
19480 "caches] is populated after a readdir(2) call with the stat and extended "
19481 "attributes of the files in the directory, in anticipation that they will be "
19482 "requested soon after."
19486 #: ../fuse/guestmount.pod:122
19488 "There is also a different attribute cache implemented by FUSE (see the FUSE "
19489 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
19490 "requests, only cache existing ones."
19494 #: ../fuse/guestmount.pod:142
19496 "If you have untrusted raw-format guest disk images, you should use this "
19497 "option to specify the disk format. This avoids a possible security problem "
19498 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
19499 "guestfs_add_drive_opts>."
19503 #: ../fuse/guestmount.pod:147
19504 msgid "B<--fuse-help>"
19508 #: ../fuse/guestmount.pod:149
19509 msgid "Display help on special FUSE options (see I<-o> below)."
19513 #: ../fuse/guestmount.pod:153
19514 msgid "Display brief help and exit."
19518 #: ../fuse/guestmount.pod:177
19520 "Mount the named partition or logical volume on the given mountpoint B<in the "
19521 "guest> (this has nothing to do with mountpoints in the host)."
19525 #: ../fuse/guestmount.pod:180
19527 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
19528 "something on C</>."
19532 #: ../fuse/guestmount.pod:197
19534 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19535 "unmounted. If you specify this option, then we don't attempt to sync the "
19536 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
19540 #: ../fuse/guestmount.pod:202
19541 msgid "B<-o option>"
19545 #: ../fuse/guestmount.pod:204
19546 msgid "B<--option option>"
19550 #: ../fuse/guestmount.pod:206
19551 msgid "Pass extra options to FUSE."
19555 #: ../fuse/guestmount.pod:208
19557 "To get a list of all the extra options supported by FUSE, use the command "
19558 "below. Note that only the FUSE I<-o> options can be passed, and only some "
19559 "of them are a good idea."
19563 #: ../fuse/guestmount.pod:212
19566 " guestmount --fuse-help\n"
19571 #: ../fuse/guestmount.pod:214
19572 msgid "Some potentially useful FUSE options:"
19576 #: ../fuse/guestmount.pod:218
19577 msgid "B<-o allow_other>"
19581 #: ../fuse/guestmount.pod:220
19582 msgid "Allow other users to see the filesystem."
19586 #: ../fuse/guestmount.pod:222
19587 msgid "B<-o attr_timeout=N>"
19591 #: ../fuse/guestmount.pod:224
19592 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19596 #: ../fuse/guestmount.pod:226
19597 msgid "B<-o kernel_cache>"
19601 #: ../fuse/guestmount.pod:228
19603 "Allow the kernel to cache files (reduces the number of reads that have to go "
19604 "through the L<guestfs(3)> API). This is generally a good idea if you can "
19605 "afford the extra memory usage."
19609 #: ../fuse/guestmount.pod:232
19610 msgid "B<-o uid=N> B<-o gid=N>"
19614 #: ../fuse/guestmount.pod:234
19616 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19617 "the chosen values."
19621 #: ../fuse/guestmount.pod:243
19623 "Add devices and mount everything read-only. Also disallow writes and make "
19624 "the disk appear read-only to FUSE."
19628 #: ../fuse/guestmount.pod:246
19630 "This is highly recommended if you are not going to edit the guest disk. If "
19631 "the guest is running and this option is I<not> supplied, then there is a "
19632 "strong risk of disk corruption in the guest. We try to prevent this from "
19633 "happening, but it is not always possible."
19637 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19638 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19642 #: ../fuse/guestmount.pod:255
19643 msgid "Enable SELinux support for the guest."
19647 #: ../fuse/guestmount.pod:261
19648 msgid "Enable verbose messages from underlying libguestfs."
19652 #: ../fuse/guestmount.pod:267
19653 msgid "Display the program version and exit."
19657 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
19658 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
19659 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19663 #: ../fuse/guestmount.pod:280
19668 #: ../fuse/guestmount.pod:282
19669 msgid "Trace libguestfs calls and entry into each FUSE function."
19673 #: ../fuse/guestmount.pod:284
19674 msgid "This also stops the daemon from forking into the background."
19678 #: ../fuse/guestmount.pod:310
19680 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19681 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
19686 #: ../fuse/guestmount.pod:325
19687 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19691 #: ../inspector/virt-inspector.pod:5
19693 "virt-inspector - Display operating system version and other information "
19694 "about a virtual machine"
19698 #: ../inspector/virt-inspector.pod:9
19701 " virt-inspector [--options] -d domname\n"
19706 #: ../inspector/virt-inspector.pod:11
19709 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19714 #: ../inspector/virt-inspector.pod:15
19717 " virt-inspector domname\n"
19722 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19725 " virt-inspector disk.img [disk.img ...]\n"
19730 #: ../inspector/virt-inspector.pod:21
19732 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19733 "determine the version of the operating system and other information about "
19734 "the virtual machine."
19738 #: ../inspector/virt-inspector.pod:25
19739 msgid "Virt-inspector produces XML output for feeding into other programs."
19743 #: ../inspector/virt-inspector.pod:27
19745 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19746 "the libvirt domain (see: C<virsh list --all>)."
19750 #: ../inspector/virt-inspector.pod:30
19752 "You can also run virt-inspector directly on disk images from a single "
19753 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19754 "has several block devices, in which case you should list several I<-a> "
19755 "options one after another, with the first corresponding to the guest's C</"
19756 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
19760 #: ../inspector/virt-inspector.pod:37
19762 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19763 "keys and similar."
19767 #: ../inspector/virt-inspector.pod:40
19769 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19770 "inspect several virtual machines, you have to run virt-inspector several "
19771 "times (for example, from a shell script for-loop)."
19775 #: ../inspector/virt-inspector.pod:45
19777 "Because virt-inspector needs direct access to guest images, it won't "
19778 "normally work over remote libvirt connections."
19782 #: ../inspector/virt-inspector.pod:48
19784 "All of the information available from virt-inspector is also available "
19785 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19786 "The same information can also be fetched using guestfish or via libguestfs "
19787 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19788 "WITH OTHER PROGRAMMING LANGUAGES>)."
19792 #: ../inspector/virt-inspector.pod:81
19794 "Libvirt is only used if you specify a C<domname> on the command line. If "
19795 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19800 #: ../inspector/virt-inspector.pod:94
19802 "When prompting for keys and passphrases, virt-inspector normally turns "
19803 "echoing off so you cannot see what you are typing. If you are not worried "
19804 "about Tempest attacks and there is no one else in the room you can specify "
19805 "this flag to see what you are typing."
19809 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
19810 #: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
19811 #: ../tools/virt-win-reg.pl:144
19813 "Specify the format of disk images given on the command line. If this is "
19814 "omitted then the format is autodetected from the content of the disk image."
19818 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97
19819 #: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
19820 #: ../tools/virt-win-reg.pl:148
19822 "If disk images are requested from libvirt, then this program asks libvirt "
19823 "for this information. In this case, the value of the format parameter is "
19828 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314
19829 #: ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101
19830 #: ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151
19831 #: ../tools/virt-win-reg.pl:152
19833 "If working with untrusted raw-format guest disk images, you should ensure "
19834 "the format is always specified."
19838 #: ../inspector/virt-inspector.pod:139
19839 msgid "Previous versions of virt-inspector allowed you to write either:"
19843 #: ../inspector/virt-inspector.pod:145
19846 " virt-inspector guestname\n"
19851 #: ../inspector/virt-inspector.pod:153
19856 #: ../inspector/virt-inspector.pod:155
19858 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19859 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19860 "just an overview."
19864 #: ../inspector/virt-inspector.pod:159
19866 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19867 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19868 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19869 "which is vanishingly rare in real world VMs."
19873 #: ../inspector/virt-inspector.pod:164
19874 msgid "E<lt>operatingsystemE<gt>"
19878 #: ../inspector/virt-inspector.pod:166
19880 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19881 "describe the operating system, its architecture, the descriptive \"product "
19882 "name\" string, the type of OS and so on, as in this example:"
19886 #: ../inspector/virt-inspector.pod:170
19889 " <operatingsystems>\n"
19890 " <operatingsystem>\n"
19891 " <root>/dev/sda2</root>\n"
19892 " <name>windows</name>\n"
19893 " <arch>i386</arch>\n"
19894 " <distro>windows</distro>\n"
19895 " <product_name>Windows 7 Enterprise</product_name>\n"
19896 " <product_variant>Client</product_variant>\n"
19897 " <major_version>6</major_version>\n"
19898 " <minor_version>1</minor_version>\n"
19899 " <windows_systemroot>/Windows</windows_systemroot>\n"
19900 " <format>installed</format>\n"
19905 #: ../inspector/virt-inspector.pod:183
19907 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19908 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19909 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19910 "architecture. The other fields are fairly self-explanatory, but because "
19911 "these fields are taken directly from the libguestfs inspection API you can "
19912 "find precise information from L<guestfs(3)/INSPECTION>."
19916 #: ../inspector/virt-inspector.pod:191
19918 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19919 "of view of libguestfs (block devices may have completely different names "
19920 "inside the VM itself)."
19924 #: ../inspector/virt-inspector.pod:195
19925 msgid "E<lt>mountpointsE<gt>"
19929 #: ../inspector/virt-inspector.pod:197
19931 "Un*x-like guests typically have multiple filesystems which are mounted at "
19932 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19933 "element which looks like this:"
19937 #: ../inspector/virt-inspector.pod:201
19940 " <operatingsystems>\n"
19941 " <operatingsystem>\n"
19944 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19945 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19946 " </mountpoints>\n"
19951 #: ../inspector/virt-inspector.pod:209
19953 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19954 "and may have completely different names inside the guest. Only mountable "
19955 "filesystems appear in this list, not things like swap devices."
19959 #: ../inspector/virt-inspector.pod:214
19960 msgid "E<lt>filesystemsE<gt>"
19964 #: ../inspector/virt-inspector.pod:216
19966 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19967 "filesystems belonging to the guest, including swap and empty partitions. "
19968 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19969 "this OS or shared with this OS and other OSes)."
19973 #: ../inspector/virt-inspector.pod:222
19974 msgid "You might see something like this:"
19978 #: ../inspector/virt-inspector.pod:224
19981 " <operatingsystems>\n"
19982 " <operatingsystem>\n"
19985 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19986 " <type>ext4</type>\n"
19987 " <label>Fedora-13-x86_64</label>\n"
19988 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19994 #: ../inspector/virt-inspector.pod:234
19996 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19997 "the label, and the UUID."
20001 #: ../inspector/virt-inspector.pod:237
20002 msgid "E<lt>applicationsE<gt>"
20006 #: ../inspector/virt-inspector.pod:239
20008 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
20009 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
20014 #: ../inspector/virt-inspector.pod:243
20016 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
20017 "Typical values would be C<rpm> and C<deb>."
20021 #: ../inspector/virt-inspector.pod:246
20023 "E<lt>package_managementE<gt>, if present, describes the package manager. "
20024 "Typical values include C<yum>, C<up2date> and C<apt>"
20028 #: ../inspector/virt-inspector.pod:249
20029 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
20033 #: ../inspector/virt-inspector.pod:252
20036 " <operatingsystems>\n"
20037 " <operatingsystem>\n"
20039 " <applications>\n"
20041 " <name>coreutils</name>\n"
20042 " <version>8.5</version>\n"
20043 " <release>1</release>\n"
20044 " </application>\n"
20049 #: ../inspector/virt-inspector.pod:262
20051 "The version and release fields may not be available for some types guests. "
20052 "Other fields are possible, see L<guestfs(3)/"
20053 "guestfs_inspect_list_applications>."
20057 #: ../inspector/virt-inspector.pod:266
20058 msgid "E<lt>drive_mappingsE<gt>"
20062 #: ../inspector/virt-inspector.pod:268
20064 "For operating systems like Windows which use drive letters, virt-inspector "
20065 "is able to find out how drive letters map to filesystems."
20069 #: ../inspector/virt-inspector.pod:272
20072 " <operatingsystems>\n"
20073 " <operatingsystem>\n"
20075 " <drive_mappings>\n"
20076 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
20077 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
20078 " </drive_mappings>\n"
20083 #: ../inspector/virt-inspector.pod:280
20085 "In the example above, drive C maps to the filesystem on the second partition "
20086 "on the first disk, and drive E maps to the filesystem on the first partition "
20087 "on the second disk."
20091 #: ../inspector/virt-inspector.pod:284
20093 "Note that this only covers permanent local filesystem mappings, not things "
20094 "like network shares. Furthermore NTFS volume mount points may not be listed "
20099 #: ../inspector/virt-inspector.pod:288
20100 msgid "E<lt>iconE<gt>"
20104 #: ../inspector/virt-inspector.pod:290
20106 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
20107 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
20108 "very large and high quality."
20112 #: ../inspector/virt-inspector.pod:294
20115 " <operatingsystems>\n"
20116 " <operatingsystem>\n"
20119 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
20120 " [... many lines of base64 data ...]\n"
20126 #: ../inspector/virt-inspector.pod:302
20128 "To display the icon, you have to extract it and convert the base64 data back "
20129 "to a binary file. Use an XPath query or simply an editor to extract the "
20130 "data, then use the coreutils L<base64(1)> program to do the conversion back "
20135 #: ../inspector/virt-inspector.pod:307
20138 " base64 -i -d < icon.data > icon.png\n"
20143 #: ../inspector/virt-inspector.pod:309
20144 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
20148 #: ../inspector/virt-inspector.pod:311
20150 "Virt-inspector can detect some operating system installers on install disks, "
20151 "live CDs, bootable USB keys and more."
20155 #: ../inspector/virt-inspector.pod:314
20157 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
20158 "fields may be present to indicate a live CD, network installer, or one part "
20159 "of a multipart CD. For example:"
20163 #: ../inspector/virt-inspector.pod:318
20166 " <operatingsystems>\n"
20167 " <operatingsystem>\n"
20168 " <root>/dev/sda</root>\n"
20169 " <name>linux</name>\n"
20170 " <arch>i386</arch>\n"
20171 " <distro>ubuntu</distro>\n"
20172 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
20173 " <major_version>10</major_version>\n"
20174 " <minor_version>10</minor_version>\n"
20175 " <format>installer</format>\n"
20181 #: ../inspector/virt-inspector.pod:330
20182 msgid "USING XPATH"
20186 #: ../inspector/virt-inspector.pod:332
20188 "You can use the XPath query language to select parts of the XML. We "
20189 "recommend using C<xmlstarlet> to perform XPath queries from the command line."
20193 #: ../inspector/virt-inspector.pod:338
20196 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
20198 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
20199 " <type>ext4</type>\n"
20205 #: ../inspector/virt-inspector.pod:344
20208 " $ virt-inspector -d Guest | \\\n"
20209 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
20215 #: ../inspector/virt-inspector.pod:348
20218 " $ virt-inspector -d Guest | \\\n"
20219 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
20220 " [displays the guest icon, if there is one]\n"
20225 #: ../inspector/virt-inspector.pod:359
20226 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
20230 #: ../inspector/virt-inspector.pod:361
20232 "Early versions of libguestfs shipped with a different virt-inspector program "
20233 "written in Perl (the current version is written in C). The XML output of "
20234 "the Perl virt-inspector was different and it could also output in other "
20235 "formats like text."
20239 #: ../inspector/virt-inspector.pod:366
20241 "The old virt-inspector is no longer supported or shipped with libguestfs."
20245 #: ../inspector/virt-inspector.pod:369
20247 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
20248 "versions of virt-inspector with different names:"
20252 #: ../inspector/virt-inspector.pod:372
20255 " virt-inspector Old Perl version.\n"
20256 " virt-inspector2 New C version.\n"
20261 #: ../inspector/virt-inspector.pod:382
20263 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
20264 ">, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
20268 #: ../inspector/virt-inspector.pod:399
20269 msgid "Matthew Booth L<mbooth@redhat.com>"
20273 #: ../java/examples/guestfs-java.pod:5
20274 msgid "guestfs-java - How to use libguestfs from Java"
20278 #: ../java/examples/guestfs-java.pod:9
20281 " import com.redhat.et.libguestfs.*;\n"
20286 #: ../java/examples/guestfs-java.pod:11
20289 " GuestFS g = new GuestFS ();\n"
20290 " g.add_drive_opts (\"disk.img\", null);\n"
20296 #: ../java/examples/guestfs-java.pod:17
20298 "This manual page documents how to call libguestfs from the Java programming "
20299 "language. This page just documents the differences from the C API and gives "
20300 "some examples. If you are not familiar with using libguestfs, you also need "
20301 "to read L<guestfs(3)>."
20305 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
20306 msgid "CLOSING THE HANDLE"
20310 #: ../java/examples/guestfs-java.pod:24
20312 "The handle is closed when it is reaped by the garbage collector. Because "
20313 "libguestfs handles include a lot of state, it is also possible to close (and "
20314 "hence free) them explicitly by calling the C<close> method."
20318 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
20319 #: ../python/examples/guestfs-python.pod:21
20320 #: ../ruby/examples/guestfs-ruby.pod:22
20325 #: ../java/examples/guestfs-java.pod:31
20327 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
20328 "exception. This has a single parameter which is the error message (a "
20333 #: ../java/examples/guestfs-java.pod:35
20334 msgid "Calling any method on a closed handle raises the same exception."
20338 #: ../java/examples/guestfs-java.pod:47
20340 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-ocaml"
20341 "(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
20342 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
20346 #: ../ocaml/examples/guestfs-ocaml.pod:5
20347 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
20351 #: ../ocaml/examples/guestfs-ocaml.pod:9
20352 msgid "Module style:"
20356 #: ../ocaml/examples/guestfs-ocaml.pod:11
20359 " let g = Guestfs.create () in\n"
20360 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20361 " Guestfs.launch g;\n"
20366 #: ../ocaml/examples/guestfs-ocaml.pod:15
20367 msgid "Object-oriented style:"
20371 #: ../ocaml/examples/guestfs-ocaml.pod:17
20374 " let g = new Guestfs.guestfs () in\n"
20375 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
20381 #: ../ocaml/examples/guestfs-ocaml.pod:21
20384 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
20386 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
20391 #: ../ocaml/examples/guestfs-ocaml.pod:27
20393 "This manual page documents how to call libguestfs from the OCaml programming "
20394 "language. This page just documents the differences from the C API and gives "
20395 "some examples. If you are not familiar with using libguestfs, you also need "
20396 "to read L<guestfs(3)>."
20400 #: ../ocaml/examples/guestfs-ocaml.pod:32
20401 msgid "PROGRAMMING STYLES"
20405 #: ../ocaml/examples/guestfs-ocaml.pod:34
20407 "There are two different programming styles supported by the OCaml bindings. "
20408 "You can use a module style, with each C function mapped to an OCaml function:"
20412 #: ../ocaml/examples/guestfs-ocaml.pod:38
20415 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
20420 #: ../ocaml/examples/guestfs-ocaml.pod:40
20425 #: ../ocaml/examples/guestfs-ocaml.pod:42
20428 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
20433 #: ../ocaml/examples/guestfs-ocaml.pod:44
20435 "Alternately you can use an object-oriented style, calling methods on the "
20436 "class C<Guestfs.guestfs>:"
20440 #: ../ocaml/examples/guestfs-ocaml.pod:47
20443 " method set_verbose : bool -> unit\n"
20448 #: ../ocaml/examples/guestfs-ocaml.pod:49
20450 "The object-oriented style is usually briefer, and the minor performance "
20451 "penalty isn't noticable in the general overhead of performing libguestfs "
20456 #: ../ocaml/examples/guestfs-ocaml.pod:55
20458 "The handle is closed when it is reaped by the garbage collector. Because "
20459 "libguestfs handles include a lot of state, it is also possible to close (and "
20460 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
20465 #: ../ocaml/examples/guestfs-ocaml.pod:62
20467 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
20468 "exception. This has a single parameter which is the error message (a "
20473 #: ../ocaml/examples/guestfs-ocaml.pod:66
20475 "Calling any function/method on a closed handle raises C<Guestfs."
20476 "Handle_closed>. The single parameter is the name of the function that you "
20481 #: ../ocaml/examples/guestfs-ocaml.pod:80
20483 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
20484 "(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
20485 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
20489 #: ../perl/examples/guestfs-perl.pod:5
20490 msgid "guestfs-perl - How to use libguestfs from Perl"
20494 #: ../perl/examples/guestfs-perl.pod:9
20497 " use Sys::Guestfs;\n"
20502 #: ../perl/examples/guestfs-perl.pod:11
20505 " my $h = Sys::Guestfs->new ();\n"
20506 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
20507 " $h->launch ();\n"
20508 " $h->mount_options ('', '/dev/sda1', '/');\n"
20509 " $h->touch ('/hello');\n"
20515 #: ../perl/examples/guestfs-perl.pod:20
20517 "This manual page documents how to call libguestfs from the Perl programming "
20518 "language. This page just documents the differences from the C API and gives "
20519 "some examples. If you are not familiar with using libguestfs, you also need "
20520 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
20524 #: ../perl/examples/guestfs-perl.pod:26
20529 #: ../perl/examples/guestfs-perl.pod:28
20531 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
20536 #: ../perl/examples/guestfs-perl.pod:41
20538 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang"
20539 "(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
20540 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20544 #: ../python/examples/guestfs-python.pod:5
20545 msgid "guestfs-python - How to use libguestfs from Python"
20549 #: ../python/examples/guestfs-python.pod:9
20552 " import guestfs\n"
20553 " g = guestfs.GuestFS ()\n"
20554 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20560 #: ../python/examples/guestfs-python.pod:16
20562 "This manual page documents how to call libguestfs from the Python "
20563 "programming language. This page just documents the differences from the C "
20564 "API and gives some examples. If you are not familiar with using libguestfs, "
20565 "you also need to read L<guestfs(3)>."
20569 #: ../python/examples/guestfs-python.pod:23
20571 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20572 "single string argument which is the error message."
20576 #: ../python/examples/guestfs-python.pod:26
20577 msgid "MORE DOCUMENTATION"
20581 #: ../python/examples/guestfs-python.pod:28
20586 #: ../python/examples/guestfs-python.pod:30
20590 " >>> import guestfs\n"
20591 " >>> help (guestfs)\n"
20596 #: ../python/examples/guestfs-python.pod:44
20598 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
20599 "(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
20600 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20604 #: ../rescue/virt-rescue.pod:5
20605 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20609 #: ../rescue/virt-rescue.pod:9
20612 " virt-rescue [--options] -d domname\n"
20617 #: ../rescue/virt-rescue.pod:11
20620 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20625 #: ../rescue/virt-rescue.pod:15
20628 " virt-rescue [--options] domname\n"
20633 #: ../rescue/virt-rescue.pod:17
20636 " virt-rescue [--options] disk.img [disk.img ...]\n"
20641 #: ../rescue/virt-rescue.pod:21
20643 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20644 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20645 "you from doing this, but doesn't catch all cases."
20649 #: ../rescue/virt-rescue.pod:25
20651 "However if you use the I<--ro> (read only) option, then you can attach a "
20652 "shell to a live virtual machine. The results might be strange or "
20653 "inconsistent at times but you won't get disk corruption."
20657 #: ../rescue/virt-rescue.pod:31
20659 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20660 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20661 "recovery tools which you can use to examine or rescue a virtual machine or "
20666 #: ../rescue/virt-rescue.pod:36
20668 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20669 "on disk image(s):"
20673 #: ../rescue/virt-rescue.pod:39
20676 " virt-rescue -d GuestName\n"
20681 #: ../rescue/virt-rescue.pod:41
20684 " virt-rescue --ro -a /path/to/disk.img\n"
20689 #: ../rescue/virt-rescue.pod:43
20692 " virt-rescue -a /dev/sdc\n"
20697 #: ../rescue/virt-rescue.pod:45
20698 msgid "For live VMs you I<must> use the --ro option."
20702 #: ../rescue/virt-rescue.pod:47
20704 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20705 "in an interactive bash shell where you can use many ordinary Linux "
20706 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20707 "appliance. You must mount the virtual machine's filesystems by hand. There "
20708 "is an empty directory called C</sysroot> where you can mount filesystems."
20712 #: ../rescue/virt-rescue.pod:54
20714 "In the example below, we list logical volumes, then choose one to mount "
20715 "under C</sysroot>:"
20719 #: ../rescue/virt-rescue.pod:57
20723 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20724 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20725 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20726 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20727 " ><rescue> ls /sysroot\n"
20732 #: ../rescue/virt-rescue.pod:64
20734 "If you don't know what filesystems are available on the virtual machine then "
20735 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20739 #: ../rescue/virt-rescue.pod:70
20741 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20742 "virtual machine. For example you can use it on a blank file if you want to "
20743 "partition that file (although we would recommend using L<guestfish(1)> "
20744 "instead as it is more suitable for this purpose). You can even use virt-"
20745 "rescue on things like SD cards."
20749 #: ../rescue/virt-rescue.pod:76
20751 "Virt-rescue does not require root. You only need to run it as root if you "
20752 "need root to open the disk image."
20756 #: ../rescue/virt-rescue.pod:79
20758 "This tool is just designed for quick interactive hacking on a virtual "
20759 "machine. For more structured access to a virtual machine disk image, you "
20760 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20761 "make scripted changes to guests, use L<guestfish(1)>."
20765 #: ../rescue/virt-rescue.pod:103
20766 msgid "B<--append kernelopts>"
20770 #: ../rescue/virt-rescue.pod:105
20771 msgid "Pass additional options to the rescue kernel."
20775 #: ../rescue/virt-rescue.pod:135
20778 " virt-rescue --format=raw -a disk.img\n"
20783 #: ../rescue/virt-rescue.pod:139
20786 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20791 #: ../rescue/virt-rescue.pod:148
20796 #: ../rescue/virt-rescue.pod:150
20797 msgid "B<--memsize MB>"
20801 #: ../rescue/virt-rescue.pod:152
20803 "Change the amount of memory allocated to the rescue system. The default is "
20804 "set by libguestfs and is small but adequate for running system tools. The "
20805 "occasional program might need more memory. The parameter is specified in "
20810 #: ../rescue/virt-rescue.pod:157
20811 msgid "B<--network>"
20815 #: ../rescue/virt-rescue.pod:159
20816 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20820 #: ../rescue/virt-rescue.pod:165
20821 msgid "Open the image read-only."
20825 #: ../rescue/virt-rescue.pod:175
20827 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
20828 "SELINUX> before using this option."
20832 #: ../rescue/virt-rescue.pod:194
20834 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20835 "are done read-write."
20839 #: ../rescue/virt-rescue.pod:207
20840 msgid "Previous versions of virt-rescue allowed you to write either:"
20844 #: ../rescue/virt-rescue.pod:209
20847 " virt-rescue disk.img [disk.img ...]\n"
20852 #: ../rescue/virt-rescue.pod:213
20855 " virt-rescue guestname\n"
20860 #: ../rescue/virt-rescue.pod:221
20865 #: ../rescue/virt-rescue.pod:223
20867 "Adding the I<--network> option enables QEMU user networking in the rescue "
20868 "appliance. There are some differences between user networking and ordinary "
20873 #: ../rescue/virt-rescue.pod:229
20874 msgid "ping does not work"
20878 #: ../rescue/virt-rescue.pod:231
20880 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20881 "send the ping packets, and because virt-rescue must be able to run as non-"
20882 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
20883 "The ping command will appear to resolve addresses but will not be able to "
20884 "send or receive any packets. This does not mean that the network is not "
20889 #: ../rescue/virt-rescue.pod:238
20890 msgid "cannot receive connections"
20894 #: ../rescue/virt-rescue.pod:240
20895 msgid "QEMU user networking cannot receive incoming connections."
20899 #: ../rescue/virt-rescue.pod:242
20900 msgid "making TCP connections"
20904 #: ../rescue/virt-rescue.pod:244
20906 "The virt-rescue appliance needs to be small and so does not include many "
20907 "network tools. In particular there is no L<telnet(1)> command. You can "
20908 "make TCP connections from the shell using the magical C</dev/tcp/"
20909 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20913 #: ../rescue/virt-rescue.pod:249
20916 " exec 3<>/dev/tcp/redhat.com/80\n"
20917 " echo \"GET /\" >&3\n"
20923 #: ../rescue/virt-rescue.pod:253
20924 msgid "See L<bash(1)> for more details."
20928 #: ../rescue/virt-rescue.pod:259
20930 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
20931 "ENVIRONMENT VARIABLES> for the complete list."
20935 #: ../rescue/virt-rescue.pod:286
20937 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
20938 "libguestfs.org/>."
20942 #: ../resize/virt-resize.pod:5
20943 msgid "virt-resize - Resize a virtual machine disk"
20947 #: ../resize/virt-resize.pod:9
20950 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20951 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20952 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20957 #: ../resize/virt-resize.pod:15
20959 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20960 "larger or smaller overall, and resizing or deleting any partitions contained "
20965 #: ../resize/virt-resize.pod:19
20967 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20968 "not> be used on live virtual machines - for consistent results, shut the "
20969 "virtual machine down before resizing it."
20973 #: ../resize/virt-resize.pod:23
20975 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20976 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20980 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:520
20981 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1261 ../src/guestfs.pod:1400
20982 #: ../src/guestfs.pod:2578
20987 #: ../resize/virt-resize.pod:33
20989 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20990 "fill the extra 5GB of space."
20994 #: ../resize/virt-resize.pod:36
20997 " virt-filesystems --long -h --all -a olddisk\n"
21002 #: ../resize/virt-resize.pod:38
21005 " truncate -r olddisk newdisk\n"
21006 " truncate -s +5G newdisk\n"
21011 #: ../resize/virt-resize.pod:41
21014 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
21015 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
21020 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:527
21021 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1265 ../src/guestfs.pod:1404
21022 #: ../src/guestfs.pod:2603
21027 #: ../resize/virt-resize.pod:46
21029 "As above, but make the /boot partition 200MB bigger, while giving the "
21030 "remaining space to /dev/sda2:"
21034 #: ../resize/virt-resize.pod:49
21037 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
21038 " olddisk newdisk\n"
21043 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:533
21044 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1410
21049 #: ../resize/virt-resize.pod:54
21051 "As in the first example, but expand a logical volume as the final step. "
21052 "This is what you would typically use for Linux guests that use LVM:"
21056 #: ../resize/virt-resize.pod:58
21059 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
21060 " olddisk newdisk\n"
21065 #: ../resize/virt-resize.pod:61
21070 #: ../resize/virt-resize.pod:63
21072 "As in the first example, but the output format will be qcow2 instead of a "
21077 #: ../resize/virt-resize.pod:66
21080 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
21081 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
21086 #: ../resize/virt-resize.pod:71
21087 msgid "DETAILED USAGE"
21091 #: ../resize/virt-resize.pod:73
21092 msgid "EXPANDING A VIRTUAL MACHINE DISK"
21096 #: ../resize/virt-resize.pod:77
21097 msgid "1. Shut down the virtual machine"
21101 #: ../resize/virt-resize.pod:79
21102 msgid "2. Locate input disk image"
21106 #: ../resize/virt-resize.pod:81
21108 "Locate the input disk image (ie. the file or device on the host containing "
21109 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
21110 "dumpxml> like this to find the disk image name:"
21114 #: ../resize/virt-resize.pod:85
21117 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
21118 " Found 1 nodes:\n"
21120 " <source dev=\"/dev/vg/lv_guest\" />\n"
21125 #: ../resize/virt-resize.pod:90
21126 msgid "3. Look at current sizing"
21130 #: ../resize/virt-resize.pod:92
21131 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
21135 #: ../resize/virt-resize.pod:95
21138 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
21139 " Name Type Size Parent\n"
21140 " /dev/sda1 partition 101M /dev/sda\n"
21141 " /dev/sda2 partition 7.9G /dev/sda\n"
21142 " /dev/sda device 8.0G -\n"
21147 #: ../resize/virt-resize.pod:101
21149 "(This example is a virtual machine with an 8 GB disk which we would like to "
21150 "expand up to 10 GB)."
21154 #: ../resize/virt-resize.pod:104
21155 msgid "4. Create output disk"
21159 #: ../resize/virt-resize.pod:106
21161 "Virt-resize cannot do in-place disk modifications. You have to have space "
21162 "to store the resized output disk."
21166 #: ../resize/virt-resize.pod:109
21168 "To store the resized disk image in a file, create a file of a suitable size:"
21172 #: ../resize/virt-resize.pod:112
21175 " # rm -f outdisk\n"
21176 " # truncate -s 10G outdisk\n"
21181 #: ../resize/virt-resize.pod:115
21182 msgid "Or use L<lvcreate(1)> to create a logical volume:"
21186 #: ../resize/virt-resize.pod:117
21189 " # lvcreate -L 10G -n lv_name vg_name\n"
21194 #: ../resize/virt-resize.pod:119
21195 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
21199 #: ../resize/virt-resize.pod:121
21202 " # virsh pool-list\n"
21203 " # virsh vol-create-as poolname newvol 10G\n"
21208 #: ../resize/virt-resize.pod:124
21213 #: ../resize/virt-resize.pod:126
21215 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
21216 "file) and the output disk. The output disk is the one created in the "
21221 #: ../resize/virt-resize.pod:130
21224 " # virt-resize indisk outdisk\n"
21229 #: ../resize/virt-resize.pod:132
21231 "This command just copies disk image C<indisk> to disk image C<outdisk> "
21232 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
21233 "larger, then an extra, empty partition is created at the end of the disk "
21234 "covering the extra space. If C<outdisk> is smaller, then it will give an "
21239 #: ../resize/virt-resize.pod:138
21241 "More realistically you'd want to expand existing partitions in the disk "
21242 "image by passing extra options (for the full list see the L</OPTIONS> "
21247 #: ../resize/virt-resize.pod:142
21249 "L</--expand> is the most useful option. It expands the named partition "
21250 "within the disk to fill any extra space:"
21254 #: ../resize/virt-resize.pod:145
21257 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
21262 #: ../resize/virt-resize.pod:147
21264 "(In this case, an extra partition is I<not> created at the end of the disk, "
21265 "because there will be no unused space)."
21269 #: ../resize/virt-resize.pod:150
21271 "L</--resize> is the other commonly used option. The following would "
21272 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
21273 "rest of the available space:"
21277 #: ../resize/virt-resize.pod:154
21280 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
21281 " indisk outdisk\n"
21286 #: ../resize/virt-resize.pod:157
21288 "If the expanded partition in the image contains a filesystem or LVM PV, then "
21289 "if virt-resize knows how, it will resize the contents, the equivalent of "
21290 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
21291 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
21292 "filesystems, so you would have to online resize them after booting the guest."
21296 #: ../resize/virt-resize.pod:164
21297 msgid "Other options are covered below."
21301 #: ../resize/virt-resize.pod:166
21306 #: ../resize/virt-resize.pod:168
21307 msgid "Thoroughly test the new disk image I<before> discarding the old one."
21311 #: ../resize/virt-resize.pod:170
21312 msgid "If you are using libvirt, edit the XML to point at the new disk:"
21316 #: ../resize/virt-resize.pod:172
21319 " # virsh edit guestname\n"
21324 #: ../resize/virt-resize.pod:174
21326 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
21327 "html#elementsDisks>"
21331 #: ../resize/virt-resize.pod:177
21332 msgid "Then start up the domain with the new, resized disk:"
21336 #: ../resize/virt-resize.pod:179
21339 " # virsh start guestname\n"
21344 #: ../resize/virt-resize.pod:181
21346 "and check that it still works. See also the L</NOTES> section below for "
21347 "additional information."
21351 #: ../resize/virt-resize.pod:184
21352 msgid "7. Resize LVs etc inside the guest"
21356 #: ../resize/virt-resize.pod:186
21357 msgid "(This can also be done offline using L<guestfish(1)>)"
21361 #: ../resize/virt-resize.pod:188
21363 "Once the guest has booted you should see the new space available, at least "
21364 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
21365 "may need to resize LVs inside PVs, and also resize filesystem types that "
21366 "virt-resize does not know how to expand."
21370 #: ../resize/virt-resize.pod:195
21371 msgid "SHRINKING A VIRTUAL MACHINE DISK"
21375 #: ../resize/virt-resize.pod:197
21377 "Shrinking is somewhat more complex than expanding, and only an overview is "
21382 #: ../resize/virt-resize.pod:200
21384 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
21385 "filesystems). The user has to shrink content before passing the disk image "
21386 "to virt-resize, and virt-resize will check that the content has been shrunk "
21391 #: ../resize/virt-resize.pod:205
21392 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
21396 #: ../resize/virt-resize.pod:207
21398 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
21399 "steps 3 and 4 above to allocate a new disk image."
21403 #: ../resize/virt-resize.pod:210
21405 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
21409 #: ../resize/virt-resize.pod:213
21410 msgid "IGNORING OR DELETING PARTITIONS"
21414 #: ../resize/virt-resize.pod:215
21416 "virt-resize also gives a convenient way to ignore or delete partitions when "
21417 "copying from the input disk to the output disk. Ignoring a partition speeds "
21418 "up the copy where you don't care about the existing contents of a "
21419 "partition. Deleting a partition removes it completely, but note that it "
21420 "also renumbers any partitions after the one which is deleted, which can "
21421 "leave some guests unbootable."
21425 #: ../resize/virt-resize.pod:222
21426 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
21430 #: ../resize/virt-resize.pod:224
21432 "If the input disk is in qcow2 format, then you may prefer that the output is "
21433 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
21434 "the fly. The output format is simply determined by the format of the empty "
21435 "output container that you provide. Thus to create qcow2 output, use:"
21439 #: ../resize/virt-resize.pod:230
21442 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
21447 #: ../resize/virt-resize.pod:232
21448 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
21452 #: ../resize/virt-resize.pod:234
21453 msgid "Similarly, to get non-sparse raw output use:"
21457 #: ../resize/virt-resize.pod:236
21460 " fallocate -l size outdisk\n"
21465 #: ../resize/virt-resize.pod:238
21467 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
21468 "dev/zero of=outdisk bs=1M count=..>)"
21472 #: ../resize/virt-resize.pod:247
21473 msgid "Display help."
21477 #: ../resize/virt-resize.pod:249
21482 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
21483 #: ../tools/virt-win-reg.pl:120
21488 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
21489 msgid "Enable debugging messages."
21493 #: ../resize/virt-resize.pod:255
21494 msgid "B<--delete part>"
21498 #: ../resize/virt-resize.pod:257
21500 "Delete the named partition. It would be more accurate to describe this as "
21501 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
21502 "the original disk image is left intact."
21506 #: ../resize/virt-resize.pod:261
21508 "Note that when you delete a partition, then anything contained in the "
21509 "partition is also deleted. Furthermore, this causes any partitions that "
21510 "come after to be I<renumbered>, which can easily make your guest unbootable."
21514 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
21515 #: ../resize/virt-resize.pod:454
21516 msgid "You can give this option multiple times."
21520 #: ../resize/virt-resize.pod:268
21521 msgid "B<--expand part>"
21525 #: ../resize/virt-resize.pod:270
21527 "Expand the named partition so it uses up all extra space (space left over "
21528 "after any other resize changes that you request have been done)."
21532 #: ../resize/virt-resize.pod:273
21534 "If virt-resize knows how, it will expand the direct content of the "
21535 "partition. For example, if the partition is an LVM PV, it will expand the "
21536 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
21537 "content it doesn't know about alone."
21541 #: ../resize/virt-resize.pod:278
21542 msgid "Currently virt-resize can resize:"
21546 #: ../resize/virt-resize.pod:284
21547 msgid "ext2, ext3 and ext4 filesystems."
21551 #: ../resize/virt-resize.pod:288
21552 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21556 #: ../resize/virt-resize.pod:290
21558 "The filesystem must have been shut down consistently last time it was used. "
21559 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21560 "consistency check, so at the first boot after resizing Windows will check "
21565 #: ../resize/virt-resize.pod:297
21567 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
21568 "inside the PV, but see the I<--LV-expand> option. The user could also "
21569 "resize LVs as desired after boot."
21573 #: ../resize/virt-resize.pod:303
21574 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21578 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
21579 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21583 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
21584 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
21585 #: ../tools/virt-win-reg.pl:142
21586 msgid "B<--format> raw"
21590 #: ../resize/virt-resize.pod:311
21592 "Specify the format of the input disk image. If this flag is not given then "
21593 "it is auto-detected from the image itself."
21597 #: ../resize/virt-resize.pod:317
21599 "Note that this option I<does not> affect the output format. See L</QCOW2 "
21600 "AND NON-SPARSE RAW FORMATS>."
21604 #: ../resize/virt-resize.pod:320
21605 msgid "B<--ignore part>"
21609 #: ../resize/virt-resize.pod:322
21611 "Ignore the named partition. Effectively this means the partition is "
21612 "allocated on the destination disk, but the content is not copied across from "
21613 "the source disk. The content of the partition will be blank (all zero "
21618 #: ../resize/virt-resize.pod:329
21619 msgid "B<--LV-expand logvol>"
21623 #: ../resize/virt-resize.pod:331
21625 "This takes the logical volume and, as a final step, expands it to fill all "
21626 "the space available in its volume group. A typical usage, assuming a Linux "
21627 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
21628 "lv_root> would be:"
21632 #: ../resize/virt-resize.pod:336
21635 " virt-resize indisk outdisk \\\n"
21636 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21641 #: ../resize/virt-resize.pod:339
21643 "This would first expand the partition (and PV), and then expand the root "
21644 "device to fill the extra space in the PV."
21648 #: ../resize/virt-resize.pod:342
21650 "The contents of the LV are also resized if virt-resize knows how to do "
21651 "that. You can stop virt-resize from trying to expand the content by using "
21652 "the option I<--no-expand-content>."
21656 #: ../resize/virt-resize.pod:346
21657 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21661 #: ../resize/virt-resize.pod:348
21663 "You can give this option multiple times, I<but> it doesn't make sense to do "
21664 "this unless the logical volumes you specify are all in different volume "
21669 #: ../resize/virt-resize.pod:352
21670 msgid "B<--machine-readable>"
21674 #: ../resize/virt-resize.pod:354
21676 "This option is used to make the output more machine friendly when being "
21677 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
21681 #: ../resize/virt-resize.pod:360
21682 msgid "B<--dryrun>"
21686 #: ../resize/virt-resize.pod:362
21687 msgid "Print a summary of what would be done, but don't do anything."
21691 #: ../resize/virt-resize.pod:364
21692 msgid "B<--no-copy-boot-loader>"
21696 #: ../resize/virt-resize.pod:366
21698 "By default, virt-resize copies over some sectors at the start of the disk "
21699 "(up to the beginning of the first partition). Commonly these sectors "
21700 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21701 "in order for the guest to boot correctly."
21705 #: ../resize/virt-resize.pod:371
21707 "If you specify this flag, then this initial copy is not done. You may need "
21708 "to reinstall the boot loader in this case."
21712 #: ../resize/virt-resize.pod:374
21713 msgid "B<--no-extra-partition>"
21717 #: ../resize/virt-resize.pod:376
21719 "By default, virt-resize creates an extra partition if there is any extra, "
21720 "unused space after all resizing has happened. Use this option to prevent "
21721 "the extra partition from being created. If you do this then the extra space "
21722 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21723 "tool in the guest."
21727 #: ../resize/virt-resize.pod:382
21729 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21734 #: ../resize/virt-resize.pod:385
21735 msgid "B<--no-expand-content>"
21739 #: ../resize/virt-resize.pod:387
21741 "By default, virt-resize will try to expand the direct contents of "
21742 "partitions, if it knows how (see I<--expand> option above)."
21746 #: ../resize/virt-resize.pod:390
21748 "If you give the I<--no-expand-content> option then virt-resize will not "
21753 #: ../resize/virt-resize.pod:393
21754 msgid "B<--ntfsresize-force>"
21758 #: ../resize/virt-resize.pod:395
21760 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21761 "the NTFS disk is marked as needing a consistency check. You have to use "
21762 "this option if you want to resize a Windows guest multiple times without "
21763 "booting into Windows between each resize."
21767 #: ../resize/virt-resize.pod:401
21768 msgid "B<--output-format> raw"
21772 #: ../resize/virt-resize.pod:403
21774 "Specify the format of the output disk image. If this flag is not given then "
21775 "it is auto-detected from the image itself."
21779 #: ../resize/virt-resize.pod:409
21781 "Note that this option I<does not create> the output format. This option "
21782 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21783 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
21784 "SPARSE RAW FORMATS>."
21788 #: ../resize/virt-resize.pod:414
21793 #: ../resize/virt-resize.pod:416
21798 #: ../resize/virt-resize.pod:418
21799 msgid "Don't print the summary."
21803 #: ../resize/virt-resize.pod:420
21804 msgid "B<--resize part=size>"
21808 #: ../resize/virt-resize.pod:422
21810 "Resize the named partition (expanding or shrinking it) so that it has the "
21815 #: ../resize/virt-resize.pod:425
21817 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21818 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21819 "size; or as a relative number or percentage. For example:"
21823 #: ../resize/virt-resize.pod:431
21826 " --resize /dev/sda2=10G\n"
21831 #: ../resize/virt-resize.pod:433
21834 " --resize /dev/sda4=90%\n"
21839 #: ../resize/virt-resize.pod:435
21842 " --resize /dev/sda2=+1G\n"
21847 #: ../resize/virt-resize.pod:437
21850 " --resize /dev/sda2=-200M\n"
21855 #: ../resize/virt-resize.pod:439
21858 " --resize /dev/sda1=+128K\n"
21863 #: ../resize/virt-resize.pod:441
21866 " --resize /dev/sda1=+10%\n"
21871 #: ../resize/virt-resize.pod:443
21874 " --resize /dev/sda1=-10%\n"
21879 #: ../resize/virt-resize.pod:445
21881 "You can increase the size of any partition. Virt-resize will expand the "
21882 "direct content of the partition if it knows how (see I<--expand> below)."
21886 #: ../resize/virt-resize.pod:449
21888 "You can only I<decrease> the size of partitions that contain filesystems or "
21889 "PVs which have already been shrunk. Virt-resize will check this has been "
21890 "done before proceeding, or else will print an error (see also I<--resize-"
21895 #: ../resize/virt-resize.pod:456
21896 msgid "B<--resize-force part=size>"
21900 #: ../resize/virt-resize.pod:458
21902 "This is the same as I<--resize> except that it will let you decrease the "
21903 "size of any partition. Generally this means you will lose any data which "
21904 "was at the end of the partition you shrink, but you may not care about that "
21905 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21906 "as a swap partition)."
21910 #: ../resize/virt-resize.pod:464
21911 msgid "See also the I<--ignore> option."
21915 #: ../resize/virt-resize.pod:466
21916 msgid "B<--shrink part>"
21920 #: ../resize/virt-resize.pod:468
21922 "Shrink the named partition until the overall disk image fits in the "
21923 "destination. The named partition B<must> contain a filesystem or PV which "
21924 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21925 "online tools). Virt-resize will check this and give an error if it has not "
21930 #: ../resize/virt-resize.pod:474
21932 "The amount by which the overall disk must be shrunk (after carrying out all "
21933 "other operations requested by the user) is called the \"deficit\". For "
21934 "example, a straight copy (assume no other operations) from a 5GB disk image "
21935 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21936 "would give an error unless the user specified a partition to shrink and that "
21937 "partition had more than a gigabyte of free space."
21941 #: ../resize/virt-resize.pod:492
21942 msgid "MACHINE READABLE OUTPUT"
21946 #: ../resize/virt-resize.pod:494
21948 "The I<--machine-readable> option can be used to make the output more machine "
21949 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21954 #: ../resize/virt-resize.pod:498
21955 msgid "There are two ways to use this option."
21959 #: ../resize/virt-resize.pod:500
21961 "Firstly use the option on its own to query the capabilities of the virt-"
21962 "resize binary. Typical output looks like this:"
21966 #: ../resize/virt-resize.pod:503
21969 " $ virt-resize --machine-readable\n"
21971 " ntfsresize-force\n"
21979 #: ../resize/virt-resize.pod:510
21981 "A list of features is printed, one per line, and the program exits with "
21986 #: ../resize/virt-resize.pod:513
21988 "Secondly use the option in conjunction with other options to make the "
21989 "regular program output more machine friendly."
21993 #: ../resize/virt-resize.pod:516
21994 msgid "At the moment this means:"
21998 #: ../resize/virt-resize.pod:522
22000 "Progress bar messages can be parsed from stdout by looking for this regular "
22005 #: ../resize/virt-resize.pod:525
22008 " ^[0-9]+/[0-9]+$\n"
22013 #: ../resize/virt-resize.pod:529
22015 "The calling program should treat messages sent to stdout (except for "
22016 "progress bar messages) as status messages. They can be logged and/or "
22017 "displayed to the user."
22021 #: ../resize/virt-resize.pod:535
22023 "The calling program should treat messages sent to stderr as error messages. "
22024 "In addition, virt-resize exits with a non-zero status code if there was a "
22029 #: ../resize/virt-resize.pod:541
22031 "Versions of the program prior to 1.13.9 did not support the I<--machine-"
22032 "readable> option and will return an error."
22036 #: ../resize/virt-resize.pod:546
22037 msgid "\"Partition 1 does not end on cylinder boundary.\""
22041 #: ../resize/virt-resize.pod:548
22043 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
22044 "means the partitions will not be aligned to the ancient CHS geometry. "
22045 "However CHS geometry is meaningless for disks manufactured since the early "
22046 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
22047 "cylinders is not required by any modern operating system."
22051 #: ../resize/virt-resize.pod:555
22052 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
22056 #: ../resize/virt-resize.pod:557
22058 "In Windows Vista and later versions, Microsoft switched to using a separate "
22059 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
22060 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
22061 "the boot partition. Doing so seems to break the guest completely. However "
22062 "expanding the second partition (ie. C: drive) should work."
22066 #: ../resize/virt-resize.pod:564
22068 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
22069 "NTFS partitions have been expanded. This is just a safety check and (unless "
22070 "it find errors) is nothing to worry about."
22074 #: ../resize/virt-resize.pod:568
22075 msgid "GUEST BOOT STUCK AT \"GRUB\""
22079 #: ../resize/virt-resize.pod:570
22081 "If a Linux guest does not boot after resizing, and the boot is stuck after "
22082 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
22083 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
22084 "although we think is to do with partition alignment."
22088 #: ../resize/virt-resize.pod:575
22091 " guestfish -i -a newdisk\n"
22092 " ><fs> cat /boot/grub/device.map\n"
22093 " # check the contents of this file are sensible or\n"
22094 " # edit the file if necessary\n"
22095 " ><fs> grub-install / /dev/vda\n"
22101 #: ../resize/virt-resize.pod:582
22103 "For more flexible guest reconfiguration, including if you need to specify "
22104 "other parameters to grub-install, use L<virt-rescue(1)>."
22108 #: ../resize/virt-resize.pod:585
22109 msgid "ALTERNATIVE TOOLS"
22113 #: ../resize/virt-resize.pod:587
22115 "There are several proprietary tools for resizing partitions. We won't "
22116 "mention any here."
22120 #: ../resize/virt-resize.pod:590
22122 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
22123 "operations on disk images. They can resize and move partitions, but I don't "
22124 "think they can do anything with the contents, and they certainly don't "
22129 #: ../resize/virt-resize.pod:595
22131 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
22132 "but at a much lower level. You will probably end up hand-calculating sector "
22133 "offsets, which is something that virt-resize was designed to avoid. If you "
22134 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
22139 #: ../resize/virt-resize.pod:615
22141 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
22142 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
22143 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
22144 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
22148 #: ../ruby/examples/guestfs-ruby.pod:5
22149 msgid "guestfs-ruby - How to use libguestfs from Ruby"
22153 #: ../ruby/examples/guestfs-ruby.pod:9
22156 " require 'guestfs'\n"
22157 " g = Guestfs::Guestfs.new()\n"
22158 " g.add_drive_opts(\"disk.img\",\n"
22159 " :readonly => 1, :format => \"raw\")\n"
22165 #: ../ruby/examples/guestfs-ruby.pod:17
22167 "This manual page documents how to call libguestfs from the Ruby programming "
22168 "language. This page just documents the differences from the C API and gives "
22169 "some examples. If you are not familiar with using libguestfs, you also need "
22170 "to read L<guestfs(3)>."
22174 #: ../ruby/examples/guestfs-ruby.pod:24
22176 "Errors from libguestfs functions are mapped into the C<Error> exception. "
22177 "This has a single parameter which is the error message (a string)."
22181 #: ../ruby/examples/guestfs-ruby.pod:38
22183 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
22184 "(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
22185 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
22189 #: ../src/guestfs-actions.pod:1
22190 msgid "guestfs_add_cdrom"
22194 #: ../src/guestfs-actions.pod:3
22198 " guestfs_add_cdrom (guestfs_h *g,\n"
22199 " const char *filename);\n"
22204 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:249
22205 #: ../src/guestfs-actions.pod:270
22207 "I<This function is deprecated.> In new code, use the L</"
22208 "guestfs_add_drive_opts> call instead."
22212 #: ../src/guestfs-actions.pod:24
22214 "This call checks for the existence of C<filename>. This stops you from "
22215 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22216 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
22221 #: ../src/guestfs-actions.pod:31
22223 "If you just want to add an ISO file (often you use this as an efficient way "
22224 "to transfer large files into the guest), then you should probably use "
22225 "C<guestfs_add_drive_ro> instead."
22229 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:140
22230 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
22231 #: ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:280
22232 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
22233 #: ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447
22234 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506
22235 #: ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552
22236 #: ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652
22237 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681
22238 #: ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798
22239 #: ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826
22240 #: ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046
22241 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084
22242 #: ../src/guestfs-actions.pod:1168 ../src/guestfs-actions.pod:1186
22243 #: ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1219
22244 #: ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1309
22245 #: ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1365
22246 #: ../src/guestfs-actions.pod:1407 ../src/guestfs-actions.pod:1520
22247 #: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1762
22248 #: ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1871
22249 #: ../src/guestfs-actions.pod:2368 ../src/guestfs-actions.pod:2512
22250 #: ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2608
22251 #: ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3667
22252 #: ../src/guestfs-actions.pod:3692 ../src/guestfs-actions.pod:3881
22253 #: ../src/guestfs-actions.pod:3895 ../src/guestfs-actions.pod:3908
22254 #: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:3937
22255 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4045
22256 #: ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4082
22257 #: ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4128
22258 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4182
22259 #: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4236
22260 #: ../src/guestfs-actions.pod:4248 ../src/guestfs-actions.pod:4284
22261 #: ../src/guestfs-actions.pod:4300 ../src/guestfs-actions.pod:4313
22262 #: ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4345
22263 #: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4458
22264 #: ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4522
22265 #: ../src/guestfs-actions.pod:4540 ../src/guestfs-actions.pod:4558
22266 #: ../src/guestfs-actions.pod:4574 ../src/guestfs-actions.pod:4588
22267 #: ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4619
22268 #: ../src/guestfs-actions.pod:4634 ../src/guestfs-actions.pod:4661
22269 #: ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:4797
22270 #: ../src/guestfs-actions.pod:4828 ../src/guestfs-actions.pod:4847
22271 #: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4878
22272 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4908
22273 #: ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4938
22274 #: ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5006
22275 #: ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5065
22276 #: ../src/guestfs-actions.pod:5079 ../src/guestfs-actions.pod:5096
22277 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5198
22278 #: ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5288
22279 #: ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5333
22280 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5491
22281 #: ../src/guestfs-actions.pod:5548 ../src/guestfs-actions.pod:5570
22282 #: ../src/guestfs-actions.pod:5588 ../src/guestfs-actions.pod:5620
22283 #: ../src/guestfs-actions.pod:5686 ../src/guestfs-actions.pod:5703
22284 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5730
22285 #: ../src/guestfs-actions.pod:6019 ../src/guestfs-actions.pod:6038
22286 #: ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6071
22287 #: ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6097
22288 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6123
22289 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6160
22290 #: ../src/guestfs-actions.pod:6179 ../src/guestfs-actions.pod:6198
22291 #: ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6246
22292 #: ../src/guestfs-actions.pod:6269 ../src/guestfs-actions.pod:6287
22293 #: ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6327
22294 #: ../src/guestfs-actions.pod:6346 ../src/guestfs-actions.pod:6363
22295 #: ../src/guestfs-actions.pod:6382 ../src/guestfs-actions.pod:6410
22296 #: ../src/guestfs-actions.pod:6434 ../src/guestfs-actions.pod:6453
22297 #: ../src/guestfs-actions.pod:6477 ../src/guestfs-actions.pod:6496
22298 #: ../src/guestfs-actions.pod:6511 ../src/guestfs-actions.pod:6530
22299 #: ../src/guestfs-actions.pod:6574 ../src/guestfs-actions.pod:6604
22300 #: ../src/guestfs-actions.pod:6637 ../src/guestfs-actions.pod:6752
22301 #: ../src/guestfs-actions.pod:6873 ../src/guestfs-actions.pod:6885
22302 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6911
22303 #: ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946
22304 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6972
22305 #: ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7046
22306 #: ../src/guestfs-actions.pod:7063 ../src/guestfs-actions.pod:7079
22307 #: ../src/guestfs-actions.pod:7095 ../src/guestfs-actions.pod:7112
22308 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7145
22309 #: ../src/guestfs-actions.pod:7181 ../src/guestfs-actions.pod:7195
22310 #: ../src/guestfs-actions.pod:7236 ../src/guestfs-actions.pod:7249
22311 #: ../src/guestfs-actions.pod:7267 ../src/guestfs-actions.pod:7301
22312 #: ../src/guestfs-actions.pod:7337 ../src/guestfs-actions.pod:7453
22313 #: ../src/guestfs-actions.pod:7468 ../src/guestfs-actions.pod:7482
22314 #: ../src/guestfs-actions.pod:7537 ../src/guestfs-actions.pod:7550
22315 #: ../src/guestfs-actions.pod:7595 ../src/guestfs-actions.pod:7635
22316 #: ../src/guestfs-actions.pod:7691 ../src/guestfs-actions.pod:7711
22317 #: ../src/guestfs-actions.pod:7744 ../src/guestfs-actions.pod:7808
22318 #: ../src/guestfs-actions.pod:7831 ../src/guestfs-actions.pod:7860
22319 msgid "This function returns 0 on success or -1 on error."
22323 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
22324 #: ../src/guestfs-actions.pod:1170 ../src/guestfs-actions.pod:1985
22325 #: ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2197
22326 #: ../src/guestfs-actions.pod:3654 ../src/guestfs-actions.pod:3674
22327 #: ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:6248
22328 #: ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6498
22329 #: ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7114
22330 #: ../src/guestfs-actions.pod:7637
22331 msgid "(Added in 0.3)"
22335 #: ../src/guestfs-actions.pod:41
22336 msgid "guestfs_add_domain"
22340 #: ../src/guestfs-actions.pod:43
22344 " guestfs_add_domain (guestfs_h *g,\n"
22345 " const char *dom,\n"
22351 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
22352 #: ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2857
22353 #: ../src/guestfs-actions.pod:4673 ../src/guestfs-actions.pod:4992
22354 #: ../src/guestfs-actions.pod:5209
22356 "You may supply a list of optional arguments to this call. Use zero or more "
22357 "of the following pairs of parameters, and terminate the list with C<-1> on "
22358 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
22362 #: ../src/guestfs-actions.pod:53
22365 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
22366 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
22367 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
22368 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
22369 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
22374 #: ../src/guestfs-actions.pod:59
22376 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22377 "It works by connecting to libvirt, requesting the domain and domain XML from "
22378 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
22383 #: ../src/guestfs-actions.pod:94
22385 "The other optional parameters are passed directly through to "
22386 "C<guestfs_add_drive_opts>."
22390 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
22391 #: ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698
22392 #: ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747
22393 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1385
22394 #: ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1944
22395 #: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2106
22396 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2184
22397 #: ../src/guestfs-actions.pod:2499 ../src/guestfs-actions.pod:2975
22398 #: ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:5168
22399 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5800
22400 #: ../src/guestfs-actions.pod:5826 ../src/guestfs-actions.pod:7222
22401 #: ../src/guestfs-actions.pod:7648 ../src/guestfs-actions.pod:7661
22402 #: ../src/guestfs-actions.pod:7674
22403 msgid "On error this function returns -1."
22407 #: ../src/guestfs-actions.pod:99
22408 msgid "(Added in 1.7.4)"
22412 #: ../src/guestfs-actions.pod:101
22413 msgid "guestfs_add_domain_va"
22417 #: ../src/guestfs-actions.pod:103
22421 " guestfs_add_domain_va (guestfs_h *g,\n"
22422 " const char *dom,\n"
22423 " va_list args);\n"
22428 #: ../src/guestfs-actions.pod:108
22429 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
22433 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
22434 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
22435 #: ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887
22436 #: ../src/guestfs-actions.pod:2941 ../src/guestfs-actions.pod:2953
22437 #: ../src/guestfs-actions.pod:4738 ../src/guestfs-actions.pod:4750
22438 #: ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5032
22439 #: ../src/guestfs-actions.pod:5258 ../src/guestfs-actions.pod:5269
22440 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
22444 #: ../src/guestfs-actions.pod:112
22445 msgid "guestfs_add_domain_argv"
22449 #: ../src/guestfs-actions.pod:114
22453 " guestfs_add_domain_argv (guestfs_h *g,\n"
22454 " const char *dom,\n"
22455 " const struct guestfs_add_domain_argv *optargs);\n"
22460 #: ../src/guestfs-actions.pod:119
22461 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
22465 #: ../src/guestfs-actions.pod:123
22466 msgid "guestfs_add_drive"
22470 #: ../src/guestfs-actions.pod:125
22474 " guestfs_add_drive (guestfs_h *g,\n"
22475 " const char *filename);\n"
22480 #: ../src/guestfs-actions.pod:129
22482 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
22483 "optional parameters, so the disk is added writable, with the format being "
22484 "detected automatically."
22488 #: ../src/guestfs-actions.pod:133
22490 "Automatic detection of the format opens you up to a potential security hole "
22491 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22492 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22493 "you should think about replacing calls to this function with calls to "
22494 "C<guestfs_add_drive_opts>, and specifying the format."
22498 #: ../src/guestfs-actions.pod:144
22499 msgid "guestfs_add_drive_opts"
22503 #: ../src/guestfs-actions.pod:146
22507 " guestfs_add_drive_opts (guestfs_h *g,\n"
22508 " const char *filename,\n"
22514 #: ../src/guestfs-actions.pod:156
22517 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
22518 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
22519 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
22524 #: ../src/guestfs-actions.pod:185
22526 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
22527 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
22528 "Possible formats include C<raw> and C<qcow2>."
22532 #: ../src/guestfs-actions.pod:196
22534 "This rarely-used option lets you emulate the behaviour of the deprecated "
22535 "C<guestfs_add_drive_with_if> call (q.v.)"
22539 #: ../src/guestfs-actions.pod:203
22540 msgid "(Added in 1.5.23)"
22544 #: ../src/guestfs-actions.pod:205
22545 msgid "guestfs_add_drive_opts_va"
22549 #: ../src/guestfs-actions.pod:207
22553 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
22554 " const char *filename,\n"
22555 " va_list args);\n"
22560 #: ../src/guestfs-actions.pod:212
22561 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
22565 #: ../src/guestfs-actions.pod:216
22566 msgid "guestfs_add_drive_opts_argv"
22570 #: ../src/guestfs-actions.pod:218
22574 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
22575 " const char *filename,\n"
22576 " const struct guestfs_add_drive_opts_argv *optargs);\n"
22581 #: ../src/guestfs-actions.pod:223
22582 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
22586 #: ../src/guestfs-actions.pod:227
22587 msgid "guestfs_add_drive_ro"
22591 #: ../src/guestfs-actions.pod:229
22595 " guestfs_add_drive_ro (guestfs_h *g,\n"
22596 " const char *filename);\n"
22601 #: ../src/guestfs-actions.pod:233
22603 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
22604 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
22605 "disk is added read-only, with the format being detected automatically."
22609 #: ../src/guestfs-actions.pod:240
22610 msgid "(Added in 1.0.38)"
22614 #: ../src/guestfs-actions.pod:242
22615 msgid "guestfs_add_drive_ro_with_if"
22619 #: ../src/guestfs-actions.pod:244
22623 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22624 " const char *filename,\n"
22625 " const char *iface);\n"
22630 #: ../src/guestfs-actions.pod:256
22632 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22633 "QEMU interface emulation to use at run time."
22637 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
22638 #: ../src/guestfs-actions.pod:2458
22639 msgid "(Added in 1.0.84)"
22643 #: ../src/guestfs-actions.pod:263
22644 msgid "guestfs_add_drive_with_if"
22648 #: ../src/guestfs-actions.pod:265
22652 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22653 " const char *filename,\n"
22654 " const char *iface);\n"
22659 #: ../src/guestfs-actions.pod:277
22661 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22662 "QEMU interface emulation to use at run time."
22666 #: ../src/guestfs-actions.pod:284
22667 msgid "guestfs_aug_clear"
22671 #: ../src/guestfs-actions.pod:286
22675 " guestfs_aug_clear (guestfs_h *g,\n"
22676 " const char *augpath);\n"
22681 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
22682 msgid "(Added in 1.3.4)"
22686 #: ../src/guestfs-actions.pod:297
22687 msgid "guestfs_aug_close"
22691 #: ../src/guestfs-actions.pod:299
22695 " guestfs_aug_close (guestfs_h *g);\n"
22700 #: ../src/guestfs-actions.pod:302
22702 "Close the current Augeas handle and free up any resources used by it. After "
22703 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22704 "any other Augeas functions."
22708 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
22709 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
22710 #: ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449
22711 #: ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494
22712 #: ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522
22713 #: ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554
22714 #: ../src/guestfs-actions.pod:5877
22715 msgid "(Added in 0.7)"
22719 #: ../src/guestfs-actions.pod:311
22720 msgid "guestfs_aug_defnode"
22724 #: ../src/guestfs-actions.pod:313
22727 " struct guestfs_int_bool *\n"
22728 " guestfs_aug_defnode (guestfs_h *g,\n"
22729 " const char *name,\n"
22730 " const char *expr,\n"
22731 " const char *val);\n"
22736 #: ../src/guestfs-actions.pod:322
22738 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22739 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
22740 "containing that single node."
22744 #: ../src/guestfs-actions.pod:330
22746 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22747 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22751 #: ../src/guestfs-actions.pod:336
22752 msgid "guestfs_aug_defvar"
22756 #: ../src/guestfs-actions.pod:338
22760 " guestfs_aug_defvar (guestfs_h *g,\n"
22761 " const char *name,\n"
22762 " const char *expr);\n"
22767 #: ../src/guestfs-actions.pod:354
22768 msgid "guestfs_aug_get"
22772 #: ../src/guestfs-actions.pod:356
22776 " guestfs_aug_get (guestfs_h *g,\n"
22777 " const char *augpath);\n"
22782 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927
22783 #: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005
22784 #: ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124
22785 #: ../src/guestfs-actions.pod:1254 ../src/guestfs-actions.pod:1271
22786 #: ../src/guestfs-actions.pod:1290 ../src/guestfs-actions.pod:1424
22787 #: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1724
22788 #: ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1904
22789 #: ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2014
22790 #: ../src/guestfs-actions.pod:2035 ../src/guestfs-actions.pod:2209
22791 #: ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2627
22792 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2825
22793 #: ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:3058
22794 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3107
22795 #: ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3200
22796 #: ../src/guestfs-actions.pod:3220 ../src/guestfs-actions.pod:3240
22797 #: ../src/guestfs-actions.pod:3867 ../src/guestfs-actions.pod:4220
22798 #: ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4500
22799 #: ../src/guestfs-actions.pod:5406 ../src/guestfs-actions.pod:5605
22800 #: ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:5953
22801 #: ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6658
22802 #: ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6698
22803 #: ../src/guestfs-actions.pod:6722 ../src/guestfs-actions.pod:7396
22804 #: ../src/guestfs-actions.pod:7415 ../src/guestfs-actions.pod:7433
22805 #: ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7924
22807 "This function returns a string, or NULL on error. I<The caller must free "
22808 "the returned string after use>."
22812 #: ../src/guestfs-actions.pod:368
22813 msgid "guestfs_aug_init"
22817 #: ../src/guestfs-actions.pod:370
22821 " guestfs_aug_init (guestfs_h *g,\n"
22822 " const char *root,\n"
22828 #: ../src/guestfs-actions.pod:379
22829 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22833 #: ../src/guestfs-actions.pod:404
22835 "This option is only useful when debugging Augeas lenses. Use of this option "
22836 "may require additional memory for the libguestfs appliance. You may need to "
22837 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22838 "C<guestfs_set_memsize>."
22842 #: ../src/guestfs-actions.pod:419
22843 msgid "Do not load the tree in C<guestfs_aug_init>."
22847 #: ../src/guestfs-actions.pod:423
22848 msgid "To close the handle, you can call C<guestfs_aug_close>."
22852 #: ../src/guestfs-actions.pod:431
22853 msgid "guestfs_aug_insert"
22857 #: ../src/guestfs-actions.pod:433
22861 " guestfs_aug_insert (guestfs_h *g,\n"
22862 " const char *augpath,\n"
22863 " const char *label,\n"
22869 #: ../src/guestfs-actions.pod:451
22870 msgid "guestfs_aug_load"
22874 #: ../src/guestfs-actions.pod:453
22878 " guestfs_aug_load (guestfs_h *g);\n"
22883 #: ../src/guestfs-actions.pod:465
22884 msgid "guestfs_aug_ls"
22888 #: ../src/guestfs-actions.pod:467
22892 " guestfs_aug_ls (guestfs_h *g,\n"
22893 " const char *augpath);\n"
22898 #: ../src/guestfs-actions.pod:471
22900 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22901 "sorting the resulting nodes into alphabetical order."
22905 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490
22906 #: ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143
22907 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458
22908 #: ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580
22909 #: ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:2281
22910 #: ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316
22911 #: ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:2405
22912 #: ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2525
22913 #: ../src/guestfs-actions.pod:2786 ../src/guestfs-actions.pod:3160
22914 #: ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3750
22915 #: ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3787
22916 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3954
22917 #: ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:5129
22918 #: ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:5873
22919 #: ../src/guestfs-actions.pod:5987 ../src/guestfs-actions.pod:6738
22920 #: ../src/guestfs-actions.pod:6799 ../src/guestfs-actions.pod:6854
22921 #: ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7024
22922 #: ../src/guestfs-actions.pod:7500 ../src/guestfs-actions.pod:7520
22923 #: ../src/guestfs-actions.pod:7567 ../src/guestfs-actions.pod:7761
22924 #: ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7874
22925 #: ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7939
22926 #: ../src/guestfs-actions.pod:7958
22928 "This function returns a NULL-terminated array of strings (like L<environ(3)"
22929 ">), or NULL if there was an error. I<The caller must free the strings and "
22930 "the array after use>."
22934 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068
22935 #: ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496
22936 #: ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:3545
22937 #: ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4253
22938 #: ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4473
22939 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:5133
22940 #: ../src/guestfs-actions.pod:5688 ../src/guestfs-actions.pod:6085
22941 #: ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6111
22942 #: ../src/guestfs-actions.pod:6579 ../src/guestfs-actions.pod:7238
22943 #: ../src/guestfs-actions.pod:7251 ../src/guestfs-actions.pod:7484
22944 #: ../src/guestfs-actions.pod:7749
22945 msgid "(Added in 0.8)"
22949 #: ../src/guestfs-actions.pod:480
22950 msgid "guestfs_aug_match"
22954 #: ../src/guestfs-actions.pod:482
22958 " guestfs_aug_match (guestfs_h *g,\n"
22959 " const char *augpath);\n"
22964 #: ../src/guestfs-actions.pod:496
22965 msgid "guestfs_aug_mv"
22969 #: ../src/guestfs-actions.pod:498
22973 " guestfs_aug_mv (guestfs_h *g,\n"
22974 " const char *src,\n"
22975 " const char *dest);\n"
22980 #: ../src/guestfs-actions.pod:510
22981 msgid "guestfs_aug_rm"
22985 #: ../src/guestfs-actions.pod:512
22989 " guestfs_aug_rm (guestfs_h *g,\n"
22990 " const char *augpath);\n"
22995 #: ../src/guestfs-actions.pod:524
22996 msgid "guestfs_aug_save"
23000 #: ../src/guestfs-actions.pod:526
23004 " guestfs_aug_save (guestfs_h *g);\n"
23009 #: ../src/guestfs-actions.pod:531
23011 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
23016 #: ../src/guestfs-actions.pod:538
23017 msgid "guestfs_aug_set"
23021 #: ../src/guestfs-actions.pod:540
23025 " guestfs_aug_set (guestfs_h *g,\n"
23026 " const char *augpath,\n"
23027 " const char *val);\n"
23032 #: ../src/guestfs-actions.pod:547
23034 "In the Augeas API, it is possible to clear a node by setting the value to "
23035 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23036 "this call. Instead you must use the C<guestfs_aug_clear> call."
23040 #: ../src/guestfs-actions.pod:556
23041 msgid "guestfs_available"
23045 #: ../src/guestfs-actions.pod:558
23049 " guestfs_available (guestfs_h *g,\n"
23050 " char *const *groups);\n"
23055 #: ../src/guestfs-actions.pod:566
23057 "The libguestfs groups, and the functions that those groups correspond to, "
23058 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23059 "runtime by calling C<guestfs_available_all_groups>."
23063 #: ../src/guestfs-actions.pod:590
23064 msgid "You must call C<guestfs_launch> before calling this function."
23068 #: ../src/guestfs-actions.pod:612
23070 "This call was added in version C<1.0.80>. In previous versions of "
23071 "libguestfs all you could do would be to speculatively execute a command to "
23072 "find out if the daemon implemented it. See also C<guestfs_version>."
23076 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
23077 msgid "(Added in 1.0.80)"
23081 #: ../src/guestfs-actions.pod:623
23082 msgid "guestfs_available_all_groups"
23086 #: ../src/guestfs-actions.pod:625
23090 " guestfs_available_all_groups (guestfs_h *g);\n"
23095 #: ../src/guestfs-actions.pod:628
23097 "This command returns a list of all optional groups that this daemon knows "
23098 "about. Note this returns both supported and unsupported groups. To find "
23099 "out which ones the daemon can actually support you have to call "
23100 "C<guestfs_available> on each member of the returned list."
23104 #: ../src/guestfs-actions.pod:634
23105 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
23109 #: ../src/guestfs-actions.pod:640
23110 msgid "(Added in 1.3.15)"
23114 #: ../src/guestfs-actions.pod:642
23115 msgid "guestfs_base64_in"
23119 #: ../src/guestfs-actions.pod:644
23123 " guestfs_base64_in (guestfs_h *g,\n"
23124 " const char *base64file,\n"
23125 " const char *filename);\n"
23130 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
23131 msgid "(Added in 1.3.5)"
23135 #: ../src/guestfs-actions.pod:656
23136 msgid "guestfs_base64_out"
23140 #: ../src/guestfs-actions.pod:658
23144 " guestfs_base64_out (guestfs_h *g,\n"
23145 " const char *filename,\n"
23146 " const char *base64file);\n"
23151 #: ../src/guestfs-actions.pod:670
23152 msgid "guestfs_blockdev_flushbufs"
23156 #: ../src/guestfs-actions.pod:672
23160 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
23161 " const char *device);\n"
23166 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700
23167 #: ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731
23168 #: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768
23169 #: ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800
23170 #: ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
23171 msgid "(Added in 0.9.3)"
23175 #: ../src/guestfs-actions.pod:685
23176 msgid "guestfs_blockdev_getbsz"
23180 #: ../src/guestfs-actions.pod:687
23184 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
23185 " const char *device);\n"
23190 #: ../src/guestfs-actions.pod:702
23191 msgid "guestfs_blockdev_getro"
23195 #: ../src/guestfs-actions.pod:704
23199 " guestfs_blockdev_getro (guestfs_h *g,\n"
23200 " const char *device);\n"
23205 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1479
23206 #: ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1983
23207 #: ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2066
23208 #: ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2132
23209 #: ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2172
23210 #: ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:3257
23211 #: ../src/guestfs-actions.pod:3273 ../src/guestfs-actions.pod:3291
23212 #: ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3467
23213 #: ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:3496
23214 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3527
23215 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3557
23216 #: ../src/guestfs-actions.pod:3570 ../src/guestfs-actions.pod:3584
23217 #: ../src/guestfs-actions.pod:3599 ../src/guestfs-actions.pod:3614
23218 #: ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:3641
23219 #: ../src/guestfs-actions.pod:5370
23220 msgid "This function returns a C truth value on success or -1 on error."
23224 #: ../src/guestfs-actions.pod:717
23225 msgid "guestfs_blockdev_getsize64"
23229 #: ../src/guestfs-actions.pod:719
23233 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
23234 " const char *device);\n"
23239 #: ../src/guestfs-actions.pod:725
23240 msgid "See also C<guestfs_blockdev_getsz>."
23244 #: ../src/guestfs-actions.pod:733
23245 msgid "guestfs_blockdev_getss"
23249 #: ../src/guestfs-actions.pod:735
23253 " guestfs_blockdev_getss (guestfs_h *g,\n"
23254 " const char *device);\n"
23259 #: ../src/guestfs-actions.pod:742
23261 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
23266 #: ../src/guestfs-actions.pod:751
23267 msgid "guestfs_blockdev_getsz"
23271 #: ../src/guestfs-actions.pod:753
23275 " guestfs_blockdev_getsz (guestfs_h *g,\n"
23276 " const char *device);\n"
23281 #: ../src/guestfs-actions.pod:760
23283 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
23284 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
23288 #: ../src/guestfs-actions.pod:770
23289 msgid "guestfs_blockdev_rereadpt"
23293 #: ../src/guestfs-actions.pod:772
23297 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
23298 " const char *device);\n"
23303 #: ../src/guestfs-actions.pod:784
23304 msgid "guestfs_blockdev_setbsz"
23308 #: ../src/guestfs-actions.pod:786
23312 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
23313 " const char *device,\n"
23314 " int blocksize);\n"
23319 #: ../src/guestfs-actions.pod:802
23320 msgid "guestfs_blockdev_setro"
23324 #: ../src/guestfs-actions.pod:804
23328 " guestfs_blockdev_setro (guestfs_h *g,\n"
23329 " const char *device);\n"
23334 #: ../src/guestfs-actions.pod:816
23335 msgid "guestfs_blockdev_setrw"
23339 #: ../src/guestfs-actions.pod:818
23343 " guestfs_blockdev_setrw (guestfs_h *g,\n"
23344 " const char *device);\n"
23349 #: ../src/guestfs-actions.pod:830
23350 msgid "guestfs_btrfs_filesystem_resize"
23354 #: ../src/guestfs-actions.pod:832
23358 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
23359 " const char *mountpoint,\n"
23365 #: ../src/guestfs-actions.pod:842
23368 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
23373 #: ../src/guestfs-actions.pod:865
23374 msgid "(Added in 1.11.17)"
23378 #: ../src/guestfs-actions.pod:867
23379 msgid "guestfs_btrfs_filesystem_resize_va"
23383 #: ../src/guestfs-actions.pod:869
23387 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
23388 " const char *mountpoint,\n"
23389 " va_list args);\n"
23394 #: ../src/guestfs-actions.pod:874
23395 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
23399 #: ../src/guestfs-actions.pod:878
23400 msgid "guestfs_btrfs_filesystem_resize_argv"
23404 #: ../src/guestfs-actions.pod:880
23408 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
23409 " const char *mountpoint,\n"
23410 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
23415 #: ../src/guestfs-actions.pod:885
23416 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
23420 #: ../src/guestfs-actions.pod:889
23421 msgid "guestfs_case_sensitive_path"
23425 #: ../src/guestfs-actions.pod:891
23429 " guestfs_case_sensitive_path (guestfs_h *g,\n"
23430 " const char *path);\n"
23435 #: ../src/guestfs-actions.pod:917
23437 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
23438 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
23439 "how the directories were originally created under Windows)."
23443 #: ../src/guestfs-actions.pod:925
23444 msgid "See also C<guestfs_realpath>."
23448 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7418
23449 msgid "(Added in 1.0.75)"
23453 #: ../src/guestfs-actions.pod:932
23454 msgid "guestfs_cat"
23458 #: ../src/guestfs-actions.pod:934
23462 " guestfs_cat (guestfs_h *g,\n"
23463 " const char *path);\n"
23468 #: ../src/guestfs-actions.pod:940
23470 "Note that this function cannot correctly handle binary files (specifically, "
23471 "files containing C<\\0> character which is treated as end of string). For "
23472 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
23473 "functions which have a more complex interface."
23477 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3771
23478 #: ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:3870
23479 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4366
23480 #: ../src/guestfs-actions.pod:4380 ../src/guestfs-actions.pod:5751
23481 #: ../src/guestfs-actions.pod:5765 ../src/guestfs-actions.pod:7571
23482 #: ../src/guestfs-actions.pod:7585
23483 msgid "(Added in 0.4)"
23487 #: ../src/guestfs-actions.pod:953
23488 msgid "guestfs_checksum"
23492 #: ../src/guestfs-actions.pod:955
23496 " guestfs_checksum (guestfs_h *g,\n"
23497 " const char *csumtype,\n"
23498 " const char *path);\n"
23503 #: ../src/guestfs-actions.pod:1001
23504 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
23508 #: ../src/guestfs-actions.pod:1003
23509 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
23513 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316
23514 #: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3469
23515 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3559
23516 #: ../src/guestfs-actions.pod:3586 ../src/guestfs-actions.pod:7274
23517 msgid "(Added in 1.0.2)"
23521 #: ../src/guestfs-actions.pod:1010
23522 msgid "guestfs_checksum_device"
23526 #: ../src/guestfs-actions.pod:1012
23530 " guestfs_checksum_device (guestfs_h *g,\n"
23531 " const char *csumtype,\n"
23532 " const char *device);\n"
23537 #: ../src/guestfs-actions.pod:1017
23539 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23540 "device named C<device>. For the types of checksums supported see the "
23541 "C<guestfs_checksum> command."
23545 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5200
23546 #: ../src/guestfs-actions.pod:5335 ../src/guestfs-actions.pod:5372
23547 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5572
23548 #: ../src/guestfs-actions.pod:7183 ../src/guestfs-actions.pod:7197
23549 #: ../src/guestfs-actions.pod:7597
23550 msgid "(Added in 1.3.2)"
23554 #: ../src/guestfs-actions.pod:1026
23555 msgid "guestfs_checksums_out"
23559 #: ../src/guestfs-actions.pod:1028
23563 " guestfs_checksums_out (guestfs_h *g,\n"
23564 " const char *csumtype,\n"
23565 " const char *directory,\n"
23566 " const char *sumsfile);\n"
23571 #: ../src/guestfs-actions.pod:1048
23572 msgid "(Added in 1.3.7)"
23576 #: ../src/guestfs-actions.pod:1050
23577 msgid "guestfs_chmod"
23581 #: ../src/guestfs-actions.pod:1052
23585 " guestfs_chmod (guestfs_h *g,\n"
23587 " const char *path);\n"
23592 #: ../src/guestfs-actions.pod:1070
23593 msgid "guestfs_chown"
23597 #: ../src/guestfs-actions.pod:1072
23601 " guestfs_chown (guestfs_h *g,\n"
23604 " const char *path);\n"
23609 #: ../src/guestfs-actions.pod:1088
23610 msgid "guestfs_command"
23614 #: ../src/guestfs-actions.pod:1090
23618 " guestfs_command (guestfs_h *g,\n"
23619 " char *const *arguments);\n"
23624 #: ../src/guestfs-actions.pod:1099
23626 "The single parameter is an argv-style list of arguments. The first element "
23627 "is the name of the program to run. Subsequent elements are parameters. The "
23628 "list must be non-empty (ie. must contain a program name). Note that the "
23629 "command runs directly, and is I<not> invoked via the shell (see "
23634 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150
23635 #: ../src/guestfs-actions.pod:1615
23636 msgid "(Added in 0.9.1)"
23640 #: ../src/guestfs-actions.pod:1132
23641 msgid "guestfs_command_lines"
23645 #: ../src/guestfs-actions.pod:1134
23649 " guestfs_command_lines (guestfs_h *g,\n"
23650 " char *const *arguments);\n"
23655 #: ../src/guestfs-actions.pod:1138
23657 "This is the same as C<guestfs_command>, but splits the result into a list of "
23662 #: ../src/guestfs-actions.pod:1141
23663 msgid "See also: C<guestfs_sh_lines>"
23667 #: ../src/guestfs-actions.pod:1152
23668 msgid "guestfs_config"
23672 #: ../src/guestfs-actions.pod:1154
23676 " guestfs_config (guestfs_h *g,\n"
23677 " const char *qemuparam,\n"
23678 " const char *qemuvalue);\n"
23683 #: ../src/guestfs-actions.pod:1172
23684 msgid "guestfs_copy_size"
23688 #: ../src/guestfs-actions.pod:1174
23692 " guestfs_copy_size (guestfs_h *g,\n"
23693 " const char *src,\n"
23694 " const char *dest,\n"
23695 " int64_t size);\n"
23700 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:1311
23701 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1387
23702 #: ../src/guestfs-actions.pod:1764 ../src/guestfs-actions.pod:1786
23703 #: ../src/guestfs-actions.pod:3669 ../src/guestfs-actions.pod:7269
23704 #: ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7810
23705 #: ../src/guestfs-actions.pod:7833
23707 "This long-running command can generate progress notification messages so "
23708 "that the caller can display a progress bar or indicator. To receive these "
23709 "messages, the caller must register a progress event callback. See L<guestfs"
23710 "(3)/GUESTFS_EVENT_PROGRESS>."
23714 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4393
23715 #: ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:7504
23716 #: ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7610
23717 msgid "(Added in 1.0.87)"
23721 #: ../src/guestfs-actions.pod:1195
23726 #: ../src/guestfs-actions.pod:1197
23730 " guestfs_cp (guestfs_h *g,\n"
23731 " const char *src,\n"
23732 " const char *dest);\n"
23737 #: ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1221
23738 #: ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1367
23739 #: ../src/guestfs-actions.pod:1481 ../src/guestfs-actions.pod:5147
23740 #: ../src/guestfs-actions.pod:5622
23741 msgid "(Added in 1.0.18)"
23745 #: ../src/guestfs-actions.pod:1209
23746 msgid "guestfs_cp_a"
23750 #: ../src/guestfs-actions.pod:1211
23754 " guestfs_cp_a (guestfs_h *g,\n"
23755 " const char *src,\n"
23756 " const char *dest);\n"
23761 #: ../src/guestfs-actions.pod:1223
23766 #: ../src/guestfs-actions.pod:1225
23770 " guestfs_dd (guestfs_h *g,\n"
23771 " const char *src,\n"
23772 " const char *dest);\n"
23777 #: ../src/guestfs-actions.pod:1235
23779 "If the destination is a device, it must be as large or larger than the "
23780 "source file or device, otherwise the copy will fail. This command cannot do "
23781 "partial copies (see C<guestfs_copy_size>)."
23785 #: ../src/guestfs-actions.pod:1243
23790 #: ../src/guestfs-actions.pod:1245
23794 " guestfs_df (guestfs_h *g);\n"
23799 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
23801 "This command is mostly useful for interactive sessions. It is I<not> "
23802 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
23807 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274
23808 #: ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2388
23809 #: ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2480
23810 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:5047
23811 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7031
23812 #: ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7663
23813 #: ../src/guestfs-actions.pod:7676
23814 msgid "(Added in 1.0.54)"
23818 #: ../src/guestfs-actions.pod:1259
23819 msgid "guestfs_df_h"
23823 #: ../src/guestfs-actions.pod:1261
23827 " guestfs_df_h (guestfs_h *g);\n"
23832 #: ../src/guestfs-actions.pod:1276
23833 msgid "guestfs_dmesg"
23837 #: ../src/guestfs-actions.pod:1278
23841 " guestfs_dmesg (guestfs_h *g);\n"
23846 #: ../src/guestfs-actions.pod:1285
23848 "Another way to get the same information is to enable verbose messages with "
23849 "C<guestfs_set_verbose> or by setting the environment variable "
23850 "C<LIBGUESTFS_DEBUG=1> before running the program."
23854 #: ../src/guestfs-actions.pod:1295
23855 msgid "guestfs_download"
23859 #: ../src/guestfs-actions.pod:1297
23863 " guestfs_download (guestfs_h *g,\n"
23864 " const char *remotefilename,\n"
23865 " const char *filename);\n"
23870 #: ../src/guestfs-actions.pod:1307
23871 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23875 #: ../src/guestfs-actions.pod:1318
23876 msgid "guestfs_download_offset"
23880 #: ../src/guestfs-actions.pod:1320
23884 " guestfs_download_offset (guestfs_h *g,\n"
23885 " const char *remotefilename,\n"
23886 " const char *filename,\n"
23887 " int64_t offset,\n"
23888 " int64_t size);\n"
23893 #: ../src/guestfs-actions.pod:1333
23895 "Note that there is no limit on the amount of data that can be downloaded "
23896 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23897 "full amount unless an error occurs."
23901 #: ../src/guestfs-actions.pod:1338
23902 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23906 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7308
23907 msgid "(Added in 1.5.17)"
23911 #: ../src/guestfs-actions.pod:1349
23912 msgid "guestfs_drop_caches"
23916 #: ../src/guestfs-actions.pod:1351
23920 " guestfs_drop_caches (guestfs_h *g,\n"
23921 " int whattodrop);\n"
23926 #: ../src/guestfs-actions.pod:1369
23931 #: ../src/guestfs-actions.pod:1371
23935 " guestfs_du (guestfs_h *g,\n"
23936 " const char *path);\n"
23941 #: ../src/guestfs-actions.pod:1394
23942 msgid "guestfs_e2fsck_f"
23946 #: ../src/guestfs-actions.pod:1396
23950 " guestfs_e2fsck_f (guestfs_h *g,\n"
23951 " const char *device);\n"
23956 #: ../src/guestfs-actions.pod:1404
23958 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23959 "Normally you should use C<guestfs_fsck>."
23963 #: ../src/guestfs-actions.pod:1409
23964 msgid "(Added in 1.0.29)"
23968 #: ../src/guestfs-actions.pod:1411
23969 msgid "guestfs_echo_daemon"
23973 #: ../src/guestfs-actions.pod:1413
23977 " guestfs_echo_daemon (guestfs_h *g,\n"
23978 " char *const *words);\n"
23983 #: ../src/guestfs-actions.pod:1422
23984 msgid "See also C<guestfs_ping_daemon>."
23988 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174
23989 #: ../src/guestfs-actions.pod:6479
23990 msgid "(Added in 1.0.69)"
23994 #: ../src/guestfs-actions.pod:1429
23995 msgid "guestfs_egrep"
23999 #: ../src/guestfs-actions.pod:1431
24003 " guestfs_egrep (guestfs_h *g,\n"
24004 " const char *regex,\n"
24005 " const char *path);\n"
24010 #: ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1465
24011 #: ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:1568
24012 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:2304
24013 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2501
24014 #: ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:2529
24015 #: ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2597
24016 #: ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:3883
24017 #: ../src/guestfs-actions.pod:3897 ../src/guestfs-actions.pod:3910
24018 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4925
24019 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6005
24020 #: ../src/guestfs-actions.pod:6875 ../src/guestfs-actions.pod:6887
24021 #: ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6913
24022 #: ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948
24023 #: ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:6974
24024 #: ../src/guestfs-actions.pod:7768 ../src/guestfs-actions.pod:7787
24025 #: ../src/guestfs-actions.pod:7881 ../src/guestfs-actions.pod:7900
24026 #: ../src/guestfs-actions.pod:7946 ../src/guestfs-actions.pod:7965
24027 msgid "(Added in 1.0.66)"
24031 #: ../src/guestfs-actions.pod:1448
24032 msgid "guestfs_egrepi"
24036 #: ../src/guestfs-actions.pod:1450
24040 " guestfs_egrepi (guestfs_h *g,\n"
24041 " const char *regex,\n"
24042 " const char *path);\n"
24047 #: ../src/guestfs-actions.pod:1467
24048 msgid "guestfs_equal"
24052 #: ../src/guestfs-actions.pod:1469
24056 " guestfs_equal (guestfs_h *g,\n"
24057 " const char *file1,\n"
24058 " const char *file2);\n"
24063 #: ../src/guestfs-actions.pod:1483
24064 msgid "guestfs_exists"
24068 #: ../src/guestfs-actions.pod:1485
24072 " guestfs_exists (guestfs_h *g,\n"
24073 " const char *path);\n"
24078 #: ../src/guestfs-actions.pod:1492
24079 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
24083 #: ../src/guestfs-actions.pod:1498
24084 msgid "guestfs_fallocate"
24088 #: ../src/guestfs-actions.pod:1500
24092 " guestfs_fallocate (guestfs_h *g,\n"
24093 " const char *path,\n"
24099 #: ../src/guestfs-actions.pod:1505
24101 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
24106 #: ../src/guestfs-actions.pod:1524
24107 msgid "guestfs_fallocate64"
24111 #: ../src/guestfs-actions.pod:1526
24115 " guestfs_fallocate64 (guestfs_h *g,\n"
24116 " const char *path,\n"
24122 #: ../src/guestfs-actions.pod:1535
24124 "Note that this call allocates disk blocks for the file. To create a sparse "
24125 "file use C<guestfs_truncate_size> instead."
24129 #: ../src/guestfs-actions.pod:1538
24131 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
24132 "oversight it only allowed 30 bit lengths to be specified, effectively "
24133 "limiting the maximum size of files created through that call to 1GB."
24137 #: ../src/guestfs-actions.pod:1549
24138 msgid "(Added in 1.3.17)"
24142 #: ../src/guestfs-actions.pod:1551
24143 msgid "guestfs_fgrep"
24147 #: ../src/guestfs-actions.pod:1553
24151 " guestfs_fgrep (guestfs_h *g,\n"
24152 " const char *pattern,\n"
24153 " const char *path);\n"
24158 #: ../src/guestfs-actions.pod:1570
24159 msgid "guestfs_fgrepi"
24163 #: ../src/guestfs-actions.pod:1572
24167 " guestfs_fgrepi (guestfs_h *g,\n"
24168 " const char *pattern,\n"
24169 " const char *path);\n"
24174 #: ../src/guestfs-actions.pod:1589
24175 msgid "guestfs_file"
24179 #: ../src/guestfs-actions.pod:1591
24183 " guestfs_file (guestfs_h *g,\n"
24184 " const char *path);\n"
24189 #: ../src/guestfs-actions.pod:1609
24191 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
24192 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
24196 #: ../src/guestfs-actions.pod:1617
24197 msgid "guestfs_file_architecture"
24201 #: ../src/guestfs-actions.pod:1619
24205 " guestfs_file_architecture (guestfs_h *g,\n"
24206 " const char *filename);\n"
24211 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890
24212 #: ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2630
24213 #: ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2790
24214 #: ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2995
24215 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3110
24216 #: ../src/guestfs-actions.pod:3203 ../src/guestfs-actions.pod:3440
24217 #: ../src/guestfs-actions.pod:3572
24218 msgid "(Added in 1.5.3)"
24222 #: ../src/guestfs-actions.pod:1729
24223 msgid "guestfs_filesize"
24227 #: ../src/guestfs-actions.pod:1731
24231 " guestfs_filesize (guestfs_h *g,\n"
24232 " const char *file);\n"
24237 #: ../src/guestfs-actions.pod:1737
24239 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
24240 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
24241 "devices, use C<guestfs_blockdev_getsize64>."
24245 #: ../src/guestfs-actions.pod:1743
24246 msgid "(Added in 1.0.82)"
24250 #: ../src/guestfs-actions.pod:1745
24251 msgid "guestfs_fill"
24255 #: ../src/guestfs-actions.pod:1747
24259 " guestfs_fill (guestfs_h *g,\n"
24262 " const char *path);\n"
24267 #: ../src/guestfs-actions.pod:1757
24269 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24270 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
24271 "bytes use C<guestfs_fill_pattern>."
24275 #: ../src/guestfs-actions.pod:1769
24276 msgid "(Added in 1.0.79)"
24280 #: ../src/guestfs-actions.pod:1771
24281 msgid "guestfs_fill_pattern"
24285 #: ../src/guestfs-actions.pod:1773
24289 " guestfs_fill_pattern (guestfs_h *g,\n"
24290 " const char *pattern,\n"
24292 " const char *path);\n"
24297 #: ../src/guestfs-actions.pod:1779
24299 "This function is like C<guestfs_fill> except that it creates a new file of "
24300 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
24301 "pattern is truncated if necessary to ensure the length of the file is "
24302 "exactly C<len> bytes."
24306 #: ../src/guestfs-actions.pod:1791
24307 msgid "(Added in 1.3.12)"
24311 #: ../src/guestfs-actions.pod:1793
24312 msgid "guestfs_find"
24316 #: ../src/guestfs-actions.pod:1795
24320 " guestfs_find (guestfs_h *g,\n"
24321 " const char *directory);\n"
24326 #: ../src/guestfs-actions.pod:1811
24328 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
24332 #: ../src/guestfs-actions.pod:1824
24333 msgid "See also C<guestfs_find0>."
24337 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4330
24338 #: ../src/guestfs-actions.pod:6040
24339 msgid "(Added in 1.0.27)"
24343 #: ../src/guestfs-actions.pod:1835
24344 msgid "guestfs_find0"
24348 #: ../src/guestfs-actions.pod:1837
24352 " guestfs_find0 (guestfs_h *g,\n"
24353 " const char *directory,\n"
24354 " const char *files);\n"
24359 #: ../src/guestfs-actions.pod:1846
24361 "This command works the same way as C<guestfs_find> with the following "
24366 #: ../src/guestfs-actions.pod:1873
24367 msgid "(Added in 1.0.74)"
24371 #: ../src/guestfs-actions.pod:1875
24372 msgid "guestfs_findfs_label"
24376 #: ../src/guestfs-actions.pod:1877
24380 " guestfs_findfs_label (guestfs_h *g,\n"
24381 " const char *label);\n"
24386 #: ../src/guestfs-actions.pod:1885
24387 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
24391 #: ../src/guestfs-actions.pod:1892
24392 msgid "guestfs_findfs_uuid"
24396 #: ../src/guestfs-actions.pod:1894
24400 " guestfs_findfs_uuid (guestfs_h *g,\n"
24401 " const char *uuid);\n"
24406 #: ../src/guestfs-actions.pod:1902
24407 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
24411 #: ../src/guestfs-actions.pod:1909
24412 msgid "guestfs_fsck"
24416 #: ../src/guestfs-actions.pod:1911
24420 " guestfs_fsck (guestfs_h *g,\n"
24421 " const char *fstype,\n"
24422 " const char *device);\n"
24427 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7815
24428 msgid "(Added in 1.0.16)"
24432 #: ../src/guestfs-actions.pod:1948
24433 msgid "guestfs_get_append"
24437 #: ../src/guestfs-actions.pod:1950
24441 " guestfs_get_append (guestfs_h *g);\n"
24446 #: ../src/guestfs-actions.pod:1958
24448 "This function returns a string which may be NULL. There is no way to return "
24449 "an error from this function. The string is owned by the guest handle and "
24450 "must I<not> be freed."
24454 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5718
24455 #: ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6642
24456 #: ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6677
24457 #: ../src/guestfs-actions.pod:6701 ../src/guestfs-actions.pod:7455
24458 #: ../src/guestfs-actions.pod:7470 ../src/guestfs-actions.pod:7862
24459 msgid "(Added in 1.0.26)"
24463 #: ../src/guestfs-actions.pod:1964
24464 msgid "guestfs_get_attach_method"
24468 #: ../src/guestfs-actions.pod:1966
24472 " guestfs_get_attach_method (guestfs_h *g);\n"
24477 #: ../src/guestfs-actions.pod:1969
24478 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
24482 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6230
24483 msgid "(Added in 1.9.8)"
24487 #: ../src/guestfs-actions.pod:1976
24488 msgid "guestfs_get_autosync"
24492 #: ../src/guestfs-actions.pod:1978
24496 " guestfs_get_autosync (guestfs_h *g);\n"
24501 #: ../src/guestfs-actions.pod:1987
24502 msgid "guestfs_get_direct"
24506 #: ../src/guestfs-actions.pod:1989
24510 " guestfs_get_direct (guestfs_h *g);\n"
24515 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6271
24516 msgid "(Added in 1.0.72)"
24520 #: ../src/guestfs-actions.pod:1998
24521 msgid "guestfs_get_e2label"
24525 #: ../src/guestfs-actions.pod:2000
24529 " guestfs_get_e2label (guestfs_h *g,\n"
24530 " const char *device);\n"
24535 #: ../src/guestfs-actions.pod:2004
24537 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
24542 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038
24543 #: ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6308
24544 msgid "(Added in 1.0.15)"
24548 #: ../src/guestfs-actions.pod:2019
24549 msgid "guestfs_get_e2uuid"
24553 #: ../src/guestfs-actions.pod:2021
24557 " guestfs_get_e2uuid (guestfs_h *g,\n"
24558 " const char *device);\n"
24563 #: ../src/guestfs-actions.pod:2025
24565 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
24570 #: ../src/guestfs-actions.pod:2040
24571 msgid "guestfs_get_memsize"
24575 #: ../src/guestfs-actions.pod:2042
24579 " guestfs_get_memsize (guestfs_h *g);\n"
24584 #: ../src/guestfs-actions.pod:2048
24586 "If C<guestfs_set_memsize> was not called on this handle, and if "
24587 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24588 "value for memsize."
24592 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4621
24593 #: ../src/guestfs-actions.pod:4830 ../src/guestfs-actions.pod:4849
24594 #: ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4880
24595 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4910
24596 #: ../src/guestfs-actions.pod:5943 ../src/guestfs-actions.pod:6329
24597 #: ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:7224
24598 msgid "(Added in 1.0.55)"
24602 #: ../src/guestfs-actions.pod:2059
24603 msgid "guestfs_get_network"
24607 #: ../src/guestfs-actions.pod:2061
24611 " guestfs_get_network (guestfs_h *g);\n"
24616 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6348
24617 msgid "(Added in 1.5.4)"
24621 #: ../src/guestfs-actions.pod:2070
24622 msgid "guestfs_get_path"
24626 #: ../src/guestfs-actions.pod:2072
24630 " guestfs_get_path (guestfs_h *g);\n"
24635 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
24637 "This function returns a string, or NULL on error. The string is owned by "
24638 "the guest handle and must I<not> be freed."
24642 #: ../src/guestfs-actions.pod:2085
24643 msgid "guestfs_get_pgroup"
24647 #: ../src/guestfs-actions.pod:2087
24651 " guestfs_get_pgroup (guestfs_h *g);\n"
24656 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6384
24657 #: ../src/guestfs-actions.pod:7716
24658 msgid "(Added in 1.11.18)"
24662 #: ../src/guestfs-actions.pod:2096
24663 msgid "guestfs_get_pid"
24667 #: ../src/guestfs-actions.pod:2098
24671 " guestfs_get_pid (guestfs_h *g);\n"
24676 #: ../src/guestfs-actions.pod:2108
24677 msgid "(Added in 1.0.56)"
24681 #: ../src/guestfs-actions.pod:2110
24682 msgid "guestfs_get_qemu"
24686 #: ../src/guestfs-actions.pod:2112
24690 " guestfs_get_qemu (guestfs_h *g);\n"
24695 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6412
24696 msgid "(Added in 1.0.6)"
24700 #: ../src/guestfs-actions.pod:2125
24701 msgid "guestfs_get_recovery_proc"
24705 #: ../src/guestfs-actions.pod:2127
24709 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24714 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3694
24715 #: ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4428
24716 #: ../src/guestfs-actions.pod:4460 ../src/guestfs-actions.pod:5648
24717 #: ../src/guestfs-actions.pod:5991 ../src/guestfs-actions.pod:6436
24718 #: ../src/guestfs-actions.pod:7127 ../src/guestfs-actions.pod:7147
24719 #: ../src/guestfs-actions.pod:7339
24720 msgid "(Added in 1.0.77)"
24724 #: ../src/guestfs-actions.pod:2136
24725 msgid "guestfs_get_selinux"
24729 #: ../src/guestfs-actions.pod:2138
24733 " guestfs_get_selinux (guestfs_h *g);\n"
24738 #: ../src/guestfs-actions.pod:2141
24740 "This returns the current setting of the selinux flag which is passed to the "
24741 "appliance at boot time. See C<guestfs_set_selinux>."
24745 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212
24746 #: ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6513
24747 msgid "(Added in 1.0.67)"
24751 #: ../src/guestfs-actions.pod:2151
24752 msgid "guestfs_get_state"
24756 #: ../src/guestfs-actions.pod:2153
24760 " guestfs_get_state (guestfs_h *g);\n"
24765 #: ../src/guestfs-actions.pod:2165
24766 msgid "guestfs_get_trace"
24770 #: ../src/guestfs-actions.pod:2167
24774 " guestfs_get_trace (guestfs_h *g);\n"
24779 #: ../src/guestfs-actions.pod:2176
24780 msgid "guestfs_get_umask"
24784 #: ../src/guestfs-actions.pod:2178
24788 " guestfs_get_umask (guestfs_h *g);\n"
24793 #: ../src/guestfs-actions.pod:2181
24795 "Return the current umask. By default the umask is C<022> unless it has been "
24796 "set by calling C<guestfs_umask>."
24800 #: ../src/guestfs-actions.pod:2188
24801 msgid "guestfs_get_verbose"
24805 #: ../src/guestfs-actions.pod:2190
24809 " guestfs_get_verbose (guestfs_h *g);\n"
24814 #: ../src/guestfs-actions.pod:2199
24815 msgid "guestfs_getcon"
24819 #: ../src/guestfs-actions.pod:2201
24823 " guestfs_getcon (guestfs_h *g);\n"
24828 #: ../src/guestfs-actions.pod:2206
24830 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24834 #: ../src/guestfs-actions.pod:2214
24835 msgid "guestfs_getxattr"
24839 #: ../src/guestfs-actions.pod:2216
24843 " guestfs_getxattr (guestfs_h *g,\n"
24844 " const char *path,\n"
24845 " const char *name,\n"
24846 " size_t *size_r);\n"
24851 #: ../src/guestfs-actions.pod:2222
24853 "Get a single extended attribute from file C<path> named C<name>. This call "
24854 "follows symlinks. If you want to lookup an extended attribute for the "
24855 "symlink itself, use C<guestfs_lgetxattr>."
24859 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3708
24861 "Normally it is better to get all extended attributes from a file in one go "
24862 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
24863 "implementations are buggy and do not provide a way to list out attributes. "
24864 "For these filesystems (notably ntfs-3g) you have to know the names of the "
24865 "extended attributes you want in advance and call this function."
24869 #: ../src/guestfs-actions.pod:2236
24870 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24874 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2451
24875 #: ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:3720
24876 #: ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5667
24877 #: ../src/guestfs-actions.pod:5848
24879 "This function returns a buffer, or NULL on error. The size of the returned "
24880 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
24885 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3724
24886 msgid "(Added in 1.7.24)"
24890 #: ../src/guestfs-actions.pod:2244
24891 msgid "guestfs_getxattrs"
24895 #: ../src/guestfs-actions.pod:2246
24898 " struct guestfs_xattr_list *\n"
24899 " guestfs_getxattrs (guestfs_h *g,\n"
24900 " const char *path);\n"
24905 #: ../src/guestfs-actions.pod:2256
24906 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24910 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3736
24911 #: ../src/guestfs-actions.pod:4424
24913 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24914 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24918 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3740
24919 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3975
24920 #: ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6532
24921 #: ../src/guestfs-actions.pod:7927
24922 msgid "(Added in 1.0.59)"
24926 #: ../src/guestfs-actions.pod:2264
24927 msgid "guestfs_glob_expand"
24931 #: ../src/guestfs-actions.pod:2266
24935 " guestfs_glob_expand (guestfs_h *g,\n"
24936 " const char *pattern);\n"
24941 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6725
24942 #: ../src/guestfs-actions.pod:6742
24943 msgid "(Added in 1.0.50)"
24947 #: ../src/guestfs-actions.pod:2287
24948 msgid "guestfs_grep"
24952 #: ../src/guestfs-actions.pod:2289
24956 " guestfs_grep (guestfs_h *g,\n"
24957 " const char *regex,\n"
24958 " const char *path);\n"
24963 #: ../src/guestfs-actions.pod:2306
24964 msgid "guestfs_grepi"
24968 #: ../src/guestfs-actions.pod:2308
24972 " guestfs_grepi (guestfs_h *g,\n"
24973 " const char *regex,\n"
24974 " const char *path);\n"
24979 #: ../src/guestfs-actions.pod:2325
24980 msgid "guestfs_grub_install"
24984 #: ../src/guestfs-actions.pod:2327
24988 " guestfs_grub_install (guestfs_h *g,\n"
24989 " const char *root,\n"
24990 " const char *device);\n"
24995 #: ../src/guestfs-actions.pod:2370
24996 msgid "(Added in 1.0.17)"
25000 #: ../src/guestfs-actions.pod:2372
25001 msgid "guestfs_head"
25005 #: ../src/guestfs-actions.pod:2374
25009 " guestfs_head (guestfs_h *g,\n"
25010 " const char *path);\n"
25015 #: ../src/guestfs-actions.pod:2390
25016 msgid "guestfs_head_n"
25020 #: ../src/guestfs-actions.pod:2392
25024 " guestfs_head_n (guestfs_h *g,\n"
25026 " const char *path);\n"
25031 #: ../src/guestfs-actions.pod:2414
25032 msgid "guestfs_hexdump"
25036 #: ../src/guestfs-actions.pod:2416
25040 " guestfs_hexdump (guestfs_h *g,\n"
25041 " const char *path);\n"
25046 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:6806
25047 #: ../src/guestfs-actions.pod:6861
25048 msgid "(Added in 1.0.22)"
25052 #: ../src/guestfs-actions.pod:2431
25053 msgid "guestfs_initrd_cat"
25057 #: ../src/guestfs-actions.pod:2433
25061 " guestfs_initrd_cat (guestfs_h *g,\n"
25062 " const char *initrdpath,\n"
25063 " const char *filename,\n"
25064 " size_t *size_r);\n"
25069 #: ../src/guestfs-actions.pod:2449
25070 msgid "See also C<guestfs_initrd_list>."
25074 #: ../src/guestfs-actions.pod:2460
25075 msgid "guestfs_initrd_list"
25079 #: ../src/guestfs-actions.pod:2462
25083 " guestfs_initrd_list (guestfs_h *g,\n"
25084 " const char *path);\n"
25089 #: ../src/guestfs-actions.pod:2482
25090 msgid "guestfs_inotify_add_watch"
25094 #: ../src/guestfs-actions.pod:2484
25098 " guestfs_inotify_add_watch (guestfs_h *g,\n"
25099 " const char *path,\n"
25105 #: ../src/guestfs-actions.pod:2503
25106 msgid "guestfs_inotify_close"
25110 #: ../src/guestfs-actions.pod:2505
25114 " guestfs_inotify_close (guestfs_h *g);\n"
25119 #: ../src/guestfs-actions.pod:2516
25120 msgid "guestfs_inotify_files"
25124 #: ../src/guestfs-actions.pod:2518
25128 " guestfs_inotify_files (guestfs_h *g);\n"
25133 #: ../src/guestfs-actions.pod:2521
25135 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
25136 "returns a list of pathnames of objects that were touched. The returned "
25137 "pathnames are sorted and deduplicated."
25141 #: ../src/guestfs-actions.pod:2531
25142 msgid "guestfs_inotify_init"
25146 #: ../src/guestfs-actions.pod:2533
25150 " guestfs_inotify_init (guestfs_h *g,\n"
25151 " int maxevents);\n"
25156 #: ../src/guestfs-actions.pod:2541
25158 "C<maxevents> is the maximum number of events which will be queued up between "
25159 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
25160 "passed as C<0>, then the kernel (or previously set) default is used. For "
25161 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
25162 "throws away events, but records the fact that it threw them away by setting "
25163 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
25164 "C<guestfs_inotify_read>)."
25168 #: ../src/guestfs-actions.pod:2551
25170 "Before any events are generated, you have to add some watches to the "
25171 "internal watch list. See: C<guestfs_inotify_add_watch>, "
25172 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
25176 #: ../src/guestfs-actions.pod:2557
25178 "Queued up events should be read periodically by calling "
25179 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
25180 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
25181 "often enough then you risk the internal queue overflowing."
25185 #: ../src/guestfs-actions.pod:2564
25187 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
25188 "This also removes any watches automatically."
25192 #: ../src/guestfs-actions.pod:2577
25193 msgid "guestfs_inotify_read"
25197 #: ../src/guestfs-actions.pod:2579
25200 " struct guestfs_inotify_event_list *\n"
25201 " guestfs_inotify_read (guestfs_h *g);\n"
25206 #: ../src/guestfs-actions.pod:2593
25208 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
25209 "there was an error. I<The caller must call "
25210 "C<guestfs_free_inotify_event_list> after use>."
25214 #: ../src/guestfs-actions.pod:2599
25215 msgid "guestfs_inotify_rm_watch"
25219 #: ../src/guestfs-actions.pod:2601
25223 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
25229 #: ../src/guestfs-actions.pod:2605
25231 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
25235 #: ../src/guestfs-actions.pod:2612
25236 msgid "guestfs_inspect_get_arch"
25240 #: ../src/guestfs-actions.pod:2614
25244 " guestfs_inspect_get_arch (guestfs_h *g,\n"
25245 " const char *root);\n"
25250 #: ../src/guestfs-actions.pod:2618
25252 "This returns the architecture of the inspected operating system. The "
25253 "possible return values are listed under C<guestfs_file_architecture>."
25257 #: ../src/guestfs-actions.pod:2632
25258 msgid "guestfs_inspect_get_distro"
25262 #: ../src/guestfs-actions.pod:2634
25266 " guestfs_inspect_get_distro (guestfs_h *g,\n"
25267 " const char *root);\n"
25272 #: ../src/guestfs-actions.pod:2726
25273 msgid "guestfs_inspect_get_drive_mappings"
25277 #: ../src/guestfs-actions.pod:2728
25281 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
25282 " const char *root);\n"
25287 #: ../src/guestfs-actions.pod:2757
25289 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25290 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
25294 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:3029
25295 #: ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:5109
25296 #: ../src/guestfs-actions.pod:7163
25298 "This function returns a NULL-terminated array of strings, or NULL if there "
25299 "was an error. The array of strings will always have length C<2n+1>, where "
25300 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
25301 "caller must free the strings and the array after use>."
25305 #: ../src/guestfs-actions.pod:2767 ../src/guestfs-actions.pod:3223
25306 msgid "(Added in 1.9.17)"
25310 #: ../src/guestfs-actions.pod:2769
25311 msgid "guestfs_inspect_get_filesystems"
25315 #: ../src/guestfs-actions.pod:2771
25319 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
25320 " const char *root);\n"
25325 #: ../src/guestfs-actions.pod:2783
25327 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25328 "C<guestfs_inspect_get_mountpoints>."
25332 #: ../src/guestfs-actions.pod:2792
25333 msgid "guestfs_inspect_get_format"
25337 #: ../src/guestfs-actions.pod:2794
25341 " guestfs_inspect_get_format (guestfs_h *g,\n"
25342 " const char *root);\n"
25347 #: ../src/guestfs-actions.pod:2828 ../src/guestfs-actions.pod:3259
25348 #: ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3293
25349 #: ../src/guestfs-actions.pod:6059
25350 msgid "(Added in 1.9.4)"
25354 #: ../src/guestfs-actions.pod:2830
25355 msgid "guestfs_inspect_get_hostname"
25359 #: ../src/guestfs-actions.pod:2832
25363 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
25364 " const char *root);\n"
25369 #: ../src/guestfs-actions.pod:2847
25370 msgid "(Added in 1.7.9)"
25374 #: ../src/guestfs-actions.pod:2849
25375 msgid "guestfs_inspect_get_icon"
25379 #: ../src/guestfs-actions.pod:2851
25383 " guestfs_inspect_get_icon (guestfs_h *g,\n"
25384 " const char *root,\n"
25385 " size_t *size_r,\n"
25391 #: ../src/guestfs-actions.pod:2862
25394 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
25395 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
25400 #: ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:3754
25401 #: ../src/guestfs-actions.pod:5008
25402 msgid "(Added in 1.11.12)"
25406 #: ../src/guestfs-actions.pod:2931
25407 msgid "guestfs_inspect_get_icon_va"
25411 #: ../src/guestfs-actions.pod:2933
25415 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
25416 " const char *root,\n"
25417 " size_t *size_r,\n"
25418 " va_list args);\n"
25423 #: ../src/guestfs-actions.pod:2939
25424 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
25428 #: ../src/guestfs-actions.pod:2943
25429 msgid "guestfs_inspect_get_icon_argv"
25433 #: ../src/guestfs-actions.pod:2945
25437 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
25438 " const char *root,\n"
25439 " size_t *size_r,\n"
25440 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
25445 #: ../src/guestfs-actions.pod:2951
25446 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
25450 #: ../src/guestfs-actions.pod:2955
25451 msgid "guestfs_inspect_get_major_version"
25455 #: ../src/guestfs-actions.pod:2957
25459 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
25460 " const char *root);\n"
25465 #: ../src/guestfs-actions.pod:2979
25466 msgid "guestfs_inspect_get_minor_version"
25470 #: ../src/guestfs-actions.pod:2981
25474 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
25475 " const char *root);\n"
25480 #: ../src/guestfs-actions.pod:2990
25482 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25483 "C<guestfs_inspect_get_major_version>."
25487 #: ../src/guestfs-actions.pod:2997
25488 msgid "guestfs_inspect_get_mountpoints"
25492 #: ../src/guestfs-actions.pod:2999
25496 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
25497 " const char *root);\n"
25502 #: ../src/guestfs-actions.pod:3020
25504 "For operating systems like Windows which still use drive letters, this call "
25505 "will only return an entry for the first drive \"mounted on\" C</>. For "
25506 "information about the mapping of drive letters to partitions, see "
25507 "C<guestfs_inspect_get_drive_mappings>."
25511 #: ../src/guestfs-actions.pod:3026
25513 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25514 "C<guestfs_inspect_get_filesystems>."
25518 #: ../src/guestfs-actions.pod:3037
25519 msgid "guestfs_inspect_get_package_format"
25523 #: ../src/guestfs-actions.pod:3039
25527 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
25528 " const char *root);\n"
25533 #: ../src/guestfs-actions.pod:3043
25535 "This function and C<guestfs_inspect_get_package_management> return the "
25536 "package format and package management tool used by the inspected operating "
25537 "system. For example for Fedora these functions would return C<rpm> (package "
25538 "format) and C<yum> (package management)."
25542 #: ../src/guestfs-actions.pod:3061 ../src/guestfs-actions.pod:3089
25543 msgid "(Added in 1.7.5)"
25547 #: ../src/guestfs-actions.pod:3063
25548 msgid "guestfs_inspect_get_package_management"
25552 #: ../src/guestfs-actions.pod:3065
25556 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
25557 " const char *root);\n"
25562 #: ../src/guestfs-actions.pod:3069
25564 "C<guestfs_inspect_get_package_format> and this function return the package "
25565 "format and package management tool used by the inspected operating system. "
25566 "For example for Fedora these functions would return C<rpm> (package format) "
25567 "and C<yum> (package management)."
25571 #: ../src/guestfs-actions.pod:3091
25572 msgid "guestfs_inspect_get_product_name"
25576 #: ../src/guestfs-actions.pod:3093
25580 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
25581 " const char *root);\n"
25586 #: ../src/guestfs-actions.pod:3112
25587 msgid "guestfs_inspect_get_product_variant"
25591 #: ../src/guestfs-actions.pod:3114
25595 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
25596 " const char *root);\n"
25601 #: ../src/guestfs-actions.pod:3137
25603 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
25604 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
25608 #: ../src/guestfs-actions.pod:3144
25609 msgid "(Added in 1.9.13)"
25613 #: ../src/guestfs-actions.pod:3146
25614 msgid "guestfs_inspect_get_roots"
25618 #: ../src/guestfs-actions.pod:3148
25622 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25627 #: ../src/guestfs-actions.pod:3151
25629 "This function is a convenient way to get the list of root devices, as "
25630 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25631 "the whole inspection process."
25635 #: ../src/guestfs-actions.pod:3155
25637 "This returns an empty list if either no root devices were found or the "
25638 "caller has not called C<guestfs_inspect_os>."
25642 #: ../src/guestfs-actions.pod:3164
25643 msgid "(Added in 1.7.3)"
25647 #: ../src/guestfs-actions.pod:3166
25648 msgid "guestfs_inspect_get_type"
25652 #: ../src/guestfs-actions.pod:3168
25656 " guestfs_inspect_get_type (guestfs_h *g,\n"
25657 " const char *root);\n"
25662 #: ../src/guestfs-actions.pod:3205
25663 msgid "guestfs_inspect_get_windows_current_control_set"
25667 #: ../src/guestfs-actions.pod:3207
25671 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25672 " const char *root);\n"
25677 #: ../src/guestfs-actions.pod:3225
25678 msgid "guestfs_inspect_get_windows_systemroot"
25682 #: ../src/guestfs-actions.pod:3227
25686 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25687 " const char *root);\n"
25692 #: ../src/guestfs-actions.pod:3243
25693 msgid "(Added in 1.5.25)"
25697 #: ../src/guestfs-actions.pod:3245
25698 msgid "guestfs_inspect_is_live"
25702 #: ../src/guestfs-actions.pod:3247
25706 " guestfs_inspect_is_live (guestfs_h *g,\n"
25707 " const char *root);\n"
25712 #: ../src/guestfs-actions.pod:3251
25714 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25715 "disk), then this returns true if a live image was detected on the disk."
25719 #: ../src/guestfs-actions.pod:3261
25720 msgid "guestfs_inspect_is_multipart"
25724 #: ../src/guestfs-actions.pod:3263
25728 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25729 " const char *root);\n"
25734 #: ../src/guestfs-actions.pod:3267
25736 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25737 "disk), then this returns true if the disk is part of a set."
25741 #: ../src/guestfs-actions.pod:3277
25742 msgid "guestfs_inspect_is_netinst"
25746 #: ../src/guestfs-actions.pod:3279
25750 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25751 " const char *root);\n"
25756 #: ../src/guestfs-actions.pod:3283
25758 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25759 "disk), then this returns true if the disk is a network installer, ie. not a "
25760 "self-contained install CD but one which is likely to require network access "
25761 "to complete the install."
25765 #: ../src/guestfs-actions.pod:3295
25766 msgid "guestfs_inspect_list_applications"
25770 #: ../src/guestfs-actions.pod:3297
25773 " struct guestfs_application_list *\n"
25774 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25775 " const char *root);\n"
25780 #: ../src/guestfs-actions.pod:3303
25782 "I<Note:> This call works differently from other parts of the inspection "
25783 "API. You have to call C<guestfs_inspect_os>, then "
25784 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25785 "this. Listing applications is a significantly more difficult operation "
25786 "which requires access to the full filesystem. Also note that unlike the "
25787 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25788 "the libguestfs handle, this call actually reads parts of the mounted "
25789 "filesystems during the call."
25793 #: ../src/guestfs-actions.pod:3393
25795 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25796 "there was an error. I<The caller must call C<guestfs_free_application_list> "
25801 #: ../src/guestfs-actions.pod:3397
25802 msgid "(Added in 1.7.8)"
25806 #: ../src/guestfs-actions.pod:3399
25807 msgid "guestfs_inspect_os"
25811 #: ../src/guestfs-actions.pod:3401
25815 " guestfs_inspect_os (guestfs_h *g);\n"
25820 #: ../src/guestfs-actions.pod:3417
25822 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25823 "functions in order to query further information about each operating system, "
25824 "such as the name and version."
25828 #: ../src/guestfs-actions.pod:3422
25830 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25831 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25832 "the contents. This should be called with no disks currently mounted. The "
25833 "function may also use Augeas, so any existing Augeas handle will be closed."
25837 #: ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3765
25838 #: ../src/guestfs-actions.pod:3847
25839 msgid "See also C<guestfs_list_filesystems>."
25843 #: ../src/guestfs-actions.pod:3442
25844 msgid "guestfs_is_blockdev"
25848 #: ../src/guestfs-actions.pod:3444
25852 " guestfs_is_blockdev (guestfs_h *g,\n"
25853 " const char *path);\n"
25858 #: ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3480
25859 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3525
25860 #: ../src/guestfs-actions.pod:3541 ../src/guestfs-actions.pod:3597
25861 #: ../src/guestfs-actions.pod:3612
25862 msgid "See also C<guestfs_stat>."
25866 #: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3484
25867 #: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3601
25868 #: ../src/guestfs-actions.pod:3616
25869 msgid "(Added in 1.5.10)"
25873 #: ../src/guestfs-actions.pod:3457
25874 msgid "guestfs_is_busy"
25878 #: ../src/guestfs-actions.pod:3459
25882 " guestfs_is_busy (guestfs_h *g);\n"
25887 #: ../src/guestfs-actions.pod:3471
25888 msgid "guestfs_is_chardev"
25892 #: ../src/guestfs-actions.pod:3473
25896 " guestfs_is_chardev (guestfs_h *g,\n"
25897 " const char *path);\n"
25902 #: ../src/guestfs-actions.pod:3486
25903 msgid "guestfs_is_config"
25907 #: ../src/guestfs-actions.pod:3488
25911 " guestfs_is_config (guestfs_h *g);\n"
25916 #: ../src/guestfs-actions.pod:3500
25917 msgid "guestfs_is_dir"
25921 #: ../src/guestfs-actions.pod:3502
25925 " guestfs_is_dir (guestfs_h *g,\n"
25926 " const char *path);\n"
25931 #: ../src/guestfs-actions.pod:3516
25932 msgid "guestfs_is_fifo"
25936 #: ../src/guestfs-actions.pod:3518
25940 " guestfs_is_fifo (guestfs_h *g,\n"
25941 " const char *path);\n"
25946 #: ../src/guestfs-actions.pod:3531
25947 msgid "guestfs_is_file"
25951 #: ../src/guestfs-actions.pod:3533
25955 " guestfs_is_file (guestfs_h *g,\n"
25956 " const char *path);\n"
25961 #: ../src/guestfs-actions.pod:3547
25962 msgid "guestfs_is_launching"
25966 #: ../src/guestfs-actions.pod:3549
25970 " guestfs_is_launching (guestfs_h *g);\n"
25975 #: ../src/guestfs-actions.pod:3561
25976 msgid "guestfs_is_lv"
25980 #: ../src/guestfs-actions.pod:3563
25984 " guestfs_is_lv (guestfs_h *g,\n"
25985 " const char *device);\n"
25990 #: ../src/guestfs-actions.pod:3574
25991 msgid "guestfs_is_ready"
25995 #: ../src/guestfs-actions.pod:3576
25999 " guestfs_is_ready (guestfs_h *g);\n"
26004 #: ../src/guestfs-actions.pod:3588
26005 msgid "guestfs_is_socket"
26009 #: ../src/guestfs-actions.pod:3590
26013 " guestfs_is_socket (guestfs_h *g,\n"
26014 " const char *path);\n"
26019 #: ../src/guestfs-actions.pod:3603
26020 msgid "guestfs_is_symlink"
26024 #: ../src/guestfs-actions.pod:3605
26028 " guestfs_is_symlink (guestfs_h *g,\n"
26029 " const char *path);\n"
26034 #: ../src/guestfs-actions.pod:3618
26035 msgid "guestfs_is_zero"
26039 #: ../src/guestfs-actions.pod:3620
26043 " guestfs_is_zero (guestfs_h *g,\n"
26044 " const char *path);\n"
26049 #: ../src/guestfs-actions.pod:3629 ../src/guestfs-actions.pod:3643
26050 msgid "(Added in 1.11.8)"
26054 #: ../src/guestfs-actions.pod:3631
26055 msgid "guestfs_is_zero_device"
26059 #: ../src/guestfs-actions.pod:3633
26063 " guestfs_is_zero_device (guestfs_h *g,\n"
26064 " const char *device);\n"
26069 #: ../src/guestfs-actions.pod:3645
26070 msgid "guestfs_kill_subprocess"
26074 #: ../src/guestfs-actions.pod:3647
26078 " guestfs_kill_subprocess (guestfs_h *g);\n"
26083 #: ../src/guestfs-actions.pod:3656
26084 msgid "guestfs_launch"
26088 #: ../src/guestfs-actions.pod:3658
26092 " guestfs_launch (guestfs_h *g);\n"
26097 #: ../src/guestfs-actions.pod:3676
26098 msgid "guestfs_lchown"
26102 #: ../src/guestfs-actions.pod:3678
26106 " guestfs_lchown (guestfs_h *g,\n"
26109 " const char *path);\n"
26114 #: ../src/guestfs-actions.pod:3684
26116 "Change the file owner to C<owner> and group to C<group>. This is like "
26117 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
26118 "changed, not the target."
26122 #: ../src/guestfs-actions.pod:3696
26123 msgid "guestfs_lgetxattr"
26127 #: ../src/guestfs-actions.pod:3698
26131 " guestfs_lgetxattr (guestfs_h *g,\n"
26132 " const char *path,\n"
26133 " const char *name,\n"
26134 " size_t *size_r);\n"
26139 #: ../src/guestfs-actions.pod:3718
26140 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
26144 #: ../src/guestfs-actions.pod:3726
26145 msgid "guestfs_lgetxattrs"
26149 #: ../src/guestfs-actions.pod:3728
26152 " struct guestfs_xattr_list *\n"
26153 " guestfs_lgetxattrs (guestfs_h *g,\n"
26154 " const char *path);\n"
26159 #: ../src/guestfs-actions.pod:3732
26161 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
26162 "then it returns the extended attributes of the link itself."
26166 #: ../src/guestfs-actions.pod:3742
26167 msgid "guestfs_list_9p"
26171 #: ../src/guestfs-actions.pod:3744
26175 " guestfs_list_9p (guestfs_h *g);\n"
26180 #: ../src/guestfs-actions.pod:3756
26181 msgid "guestfs_list_devices"
26185 #: ../src/guestfs-actions.pod:3758
26189 " guestfs_list_devices (guestfs_h *g);\n"
26194 #: ../src/guestfs-actions.pod:3773
26195 msgid "guestfs_list_dm_devices"
26199 #: ../src/guestfs-actions.pod:3775
26203 " guestfs_list_dm_devices (guestfs_h *g);\n"
26208 #: ../src/guestfs-actions.pod:3780
26210 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
26211 "previous call to C<guestfs_luks_open>."
26215 #: ../src/guestfs-actions.pod:3783
26217 "Device mapper devices which correspond to logical volumes are I<not> "
26218 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
26223 #: ../src/guestfs-actions.pod:3791 ../src/guestfs-actions.pod:5247
26224 msgid "(Added in 1.11.15)"
26228 #: ../src/guestfs-actions.pod:3793
26229 msgid "guestfs_list_filesystems"
26233 #: ../src/guestfs-actions.pod:3795
26237 " guestfs_list_filesystems (guestfs_h *g);\n"
26242 #: ../src/guestfs-actions.pod:3815
26244 "This command runs other libguestfs commands, which might include "
26245 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
26246 "soon after launch and only when nothing is mounted."
26250 #: ../src/guestfs-actions.pod:3819
26252 "Not all of the filesystems returned will be mountable. In particular, swap "
26253 "partitions are returned in the list. Also this command does not check that "
26254 "each filesystem found is valid and mountable, and some filesystems might be "
26255 "mountable but require special options. Filesystems may not all belong to a "
26256 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
26260 #: ../src/guestfs-actions.pod:3833 ../src/guestfs-actions.pod:5608
26261 msgid "(Added in 1.5.15)"
26265 #: ../src/guestfs-actions.pod:3835
26266 msgid "guestfs_list_partitions"
26270 #: ../src/guestfs-actions.pod:3837
26274 " guestfs_list_partitions (guestfs_h *g);\n"
26279 #: ../src/guestfs-actions.pod:3844
26281 "This does not return logical volumes. For that you will need to call "
26286 #: ../src/guestfs-actions.pod:3855
26291 #: ../src/guestfs-actions.pod:3857
26295 " guestfs_ll (guestfs_h *g,\n"
26296 " const char *directory);\n"
26301 #: ../src/guestfs-actions.pod:3872
26306 #: ../src/guestfs-actions.pod:3874
26310 " guestfs_ln (guestfs_h *g,\n"
26311 " const char *target,\n"
26312 " const char *linkname);\n"
26317 #: ../src/guestfs-actions.pod:3885
26318 msgid "guestfs_ln_f"
26322 #: ../src/guestfs-actions.pod:3887
26326 " guestfs_ln_f (guestfs_h *g,\n"
26327 " const char *target,\n"
26328 " const char *linkname);\n"
26333 #: ../src/guestfs-actions.pod:3899
26334 msgid "guestfs_ln_s"
26338 #: ../src/guestfs-actions.pod:3901
26342 " guestfs_ln_s (guestfs_h *g,\n"
26343 " const char *target,\n"
26344 " const char *linkname);\n"
26349 #: ../src/guestfs-actions.pod:3912
26350 msgid "guestfs_ln_sf"
26354 #: ../src/guestfs-actions.pod:3914
26358 " guestfs_ln_sf (guestfs_h *g,\n"
26359 " const char *target,\n"
26360 " const char *linkname);\n"
26365 #: ../src/guestfs-actions.pod:3926
26366 msgid "guestfs_lremovexattr"
26370 #: ../src/guestfs-actions.pod:3928
26374 " guestfs_lremovexattr (guestfs_h *g,\n"
26375 " const char *xattr,\n"
26376 " const char *path);\n"
26381 #: ../src/guestfs-actions.pod:3933
26383 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
26384 "link, then it removes an extended attribute of the link itself."
26388 #: ../src/guestfs-actions.pod:3941
26393 #: ../src/guestfs-actions.pod:3943
26397 " guestfs_ls (guestfs_h *g,\n"
26398 " const char *directory);\n"
26403 #: ../src/guestfs-actions.pod:3951
26405 "This command is mostly useful for interactive sessions. Programs should "
26406 "probably use C<guestfs_readdir> instead."
26410 #: ../src/guestfs-actions.pod:3960
26411 msgid "guestfs_lsetxattr"
26415 #: ../src/guestfs-actions.pod:3962
26419 " guestfs_lsetxattr (guestfs_h *g,\n"
26420 " const char *xattr,\n"
26421 " const char *val,\n"
26423 " const char *path);\n"
26428 #: ../src/guestfs-actions.pod:3969
26430 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
26431 "then it sets an extended attribute of the link itself."
26435 #: ../src/guestfs-actions.pod:3977
26436 msgid "guestfs_lstat"
26440 #: ../src/guestfs-actions.pod:3979
26443 " struct guestfs_stat *\n"
26444 " guestfs_lstat (guestfs_h *g,\n"
26445 " const char *path);\n"
26450 #: ../src/guestfs-actions.pod:3985
26452 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
26453 "link, then the link is stat-ed, not the file it refers to."
26457 #: ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:6766
26459 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
26460 "error. I<The caller must call C<guestfs_free_stat> after use>."
26464 #: ../src/guestfs-actions.pod:3995 ../src/guestfs-actions.pod:6770
26465 #: ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:7169
26466 msgid "(Added in 0.9.2)"
26470 #: ../src/guestfs-actions.pod:3997
26471 msgid "guestfs_lstatlist"
26475 #: ../src/guestfs-actions.pod:3999
26478 " struct guestfs_stat_list *\n"
26479 " guestfs_lstatlist (guestfs_h *g,\n"
26480 " const char *path,\n"
26481 " char *const *names);\n"
26486 #: ../src/guestfs-actions.pod:4004
26488 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
26489 "files, where all files are in the directory C<path>. C<names> is the list "
26490 "of files from this directory."
26494 #: ../src/guestfs-actions.pod:4013
26496 "This call is intended for programs that want to efficiently list a directory "
26497 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
26498 "for a similarly efficient call for getting extended attributes. Very long "
26499 "directory listings might cause the protocol message size to be exceeded, "
26500 "causing this call to fail. The caller must split up such requests into "
26501 "smaller groups of names."
26505 #: ../src/guestfs-actions.pod:4021
26507 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
26508 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
26512 #: ../src/guestfs-actions.pod:4027
26513 msgid "guestfs_luks_add_key"
26517 #: ../src/guestfs-actions.pod:4029
26521 " guestfs_luks_add_key (guestfs_h *g,\n"
26522 " const char *device,\n"
26523 " const char *key,\n"
26524 " const char *newkey,\n"
26530 #: ../src/guestfs-actions.pod:4041
26532 "Note that if C<keyslot> already contains a key, then this command will "
26533 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
26537 #: ../src/guestfs-actions.pod:4047 ../src/guestfs-actions.pod:4087
26538 #: ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:4130
26539 #: ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4184
26541 "This function takes a key or passphrase parameter which could contain "
26542 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
26547 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4091
26548 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4134
26549 msgid "(Added in 1.5.2)"
26553 #: ../src/guestfs-actions.pod:4053
26554 msgid "guestfs_luks_close"
26558 #: ../src/guestfs-actions.pod:4055
26562 " guestfs_luks_close (guestfs_h *g,\n"
26563 " const char *device);\n"
26568 #: ../src/guestfs-actions.pod:4059
26570 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
26571 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
26572 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
26573 "underlying block device."
26577 #: ../src/guestfs-actions.pod:4067 ../src/guestfs-actions.pod:4169
26578 #: ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:4238
26579 #: ../src/guestfs-actions.pod:4286
26580 msgid "(Added in 1.5.1)"
26584 #: ../src/guestfs-actions.pod:4069
26585 msgid "guestfs_luks_format"
26589 #: ../src/guestfs-actions.pod:4071
26593 " guestfs_luks_format (guestfs_h *g,\n"
26594 " const char *device,\n"
26595 " const char *key,\n"
26601 #: ../src/guestfs-actions.pod:4093
26602 msgid "guestfs_luks_format_cipher"
26606 #: ../src/guestfs-actions.pod:4095
26610 " guestfs_luks_format_cipher (guestfs_h *g,\n"
26611 " const char *device,\n"
26612 " const char *key,\n"
26614 " const char *cipher);\n"
26619 #: ../src/guestfs-actions.pod:4102
26621 "This command is the same as C<guestfs_luks_format> but it also allows you to "
26622 "set the C<cipher> used."
26626 #: ../src/guestfs-actions.pod:4116
26627 msgid "guestfs_luks_kill_slot"
26631 #: ../src/guestfs-actions.pod:4118
26635 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26636 " const char *device,\n"
26637 " const char *key,\n"
26643 #: ../src/guestfs-actions.pod:4136
26644 msgid "guestfs_luks_open"
26648 #: ../src/guestfs-actions.pod:4138
26652 " guestfs_luks_open (guestfs_h *g,\n"
26653 " const char *device,\n"
26654 " const char *key,\n"
26655 " const char *mapname);\n"
26660 #: ../src/guestfs-actions.pod:4156
26662 "If this block device contains LVM volume groups, then calling "
26663 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26668 #: ../src/guestfs-actions.pod:4160
26669 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26673 #: ../src/guestfs-actions.pod:4171
26674 msgid "guestfs_luks_open_ro"
26678 #: ../src/guestfs-actions.pod:4173
26682 " guestfs_luks_open_ro (guestfs_h *g,\n"
26683 " const char *device,\n"
26684 " const char *key,\n"
26685 " const char *mapname);\n"
26690 #: ../src/guestfs-actions.pod:4179
26692 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26697 #: ../src/guestfs-actions.pod:4190
26698 msgid "guestfs_lvcreate"
26702 #: ../src/guestfs-actions.pod:4192
26706 " guestfs_lvcreate (guestfs_h *g,\n"
26707 " const char *logvol,\n"
26708 " const char *volgroup,\n"
26714 #: ../src/guestfs-actions.pod:4205
26715 msgid "guestfs_lvm_canonical_lv_name"
26719 #: ../src/guestfs-actions.pod:4207
26723 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26724 " const char *lvname);\n"
26729 #: ../src/guestfs-actions.pod:4218
26730 msgid "See also C<guestfs_is_lv>."
26734 #: ../src/guestfs-actions.pod:4223
26735 msgid "(Added in 1.5.24)"
26739 #: ../src/guestfs-actions.pod:4225
26740 msgid "guestfs_lvm_clear_filter"
26744 #: ../src/guestfs-actions.pod:4227
26748 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26753 #: ../src/guestfs-actions.pod:4230
26755 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
26756 "see every block device."
26760 #: ../src/guestfs-actions.pod:4240
26761 msgid "guestfs_lvm_remove_all"
26765 #: ../src/guestfs-actions.pod:4242
26769 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26774 #: ../src/guestfs-actions.pod:4255
26775 msgid "guestfs_lvm_set_filter"
26779 #: ../src/guestfs-actions.pod:4257
26783 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26784 " char *const *devices);\n"
26789 #: ../src/guestfs-actions.pod:4288
26790 msgid "guestfs_lvremove"
26794 #: ../src/guestfs-actions.pod:4290
26798 " guestfs_lvremove (guestfs_h *g,\n"
26799 " const char *device);\n"
26804 #: ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:5705
26805 #: ../src/guestfs-actions.pod:7539
26806 msgid "(Added in 1.0.13)"
26810 #: ../src/guestfs-actions.pod:4304
26811 msgid "guestfs_lvrename"
26815 #: ../src/guestfs-actions.pod:4306
26819 " guestfs_lvrename (guestfs_h *g,\n"
26820 " const char *logvol,\n"
26821 " const char *newlogvol);\n"
26826 #: ../src/guestfs-actions.pod:4315 ../src/guestfs-actions.pod:7552
26827 msgid "(Added in 1.0.83)"
26831 #: ../src/guestfs-actions.pod:4317
26832 msgid "guestfs_lvresize"
26836 #: ../src/guestfs-actions.pod:4319
26840 " guestfs_lvresize (guestfs_h *g,\n"
26841 " const char *device,\n"
26847 #: ../src/guestfs-actions.pod:4332
26848 msgid "guestfs_lvresize_free"
26852 #: ../src/guestfs-actions.pod:4334
26856 " guestfs_lvresize_free (guestfs_h *g,\n"
26857 " const char *lv,\n"
26863 #: ../src/guestfs-actions.pod:4347
26864 msgid "(Added in 1.3.3)"
26868 #: ../src/guestfs-actions.pod:4349
26869 msgid "guestfs_lvs"
26873 #: ../src/guestfs-actions.pod:4351
26877 " guestfs_lvs (guestfs_h *g);\n"
26882 #: ../src/guestfs-actions.pod:4360
26883 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26887 #: ../src/guestfs-actions.pod:4368
26888 msgid "guestfs_lvs_full"
26892 #: ../src/guestfs-actions.pod:4370
26895 " struct guestfs_lvm_lv_list *\n"
26896 " guestfs_lvs_full (guestfs_h *g);\n"
26901 #: ../src/guestfs-actions.pod:4376
26903 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26904 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
26908 #: ../src/guestfs-actions.pod:4382
26909 msgid "guestfs_lvuuid"
26913 #: ../src/guestfs-actions.pod:4384
26917 " guestfs_lvuuid (guestfs_h *g,\n"
26918 " const char *device);\n"
26923 #: ../src/guestfs-actions.pod:4395
26924 msgid "guestfs_lxattrlist"
26928 #: ../src/guestfs-actions.pod:4397
26931 " struct guestfs_xattr_list *\n"
26932 " guestfs_lxattrlist (guestfs_h *g,\n"
26933 " const char *path,\n"
26934 " char *const *names);\n"
26939 #: ../src/guestfs-actions.pod:4416
26941 "This call is intended for programs that want to efficiently list a directory "
26942 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26943 "a similarly efficient call for getting standard stats. Very long directory "
26944 "listings might cause the protocol message size to be exceeded, causing this "
26945 "call to fail. The caller must split up such requests into smaller groups of "
26950 #: ../src/guestfs-actions.pod:4430
26951 msgid "guestfs_mkdir"
26955 #: ../src/guestfs-actions.pod:4432
26959 " guestfs_mkdir (guestfs_h *g,\n"
26960 " const char *path);\n"
26965 #: ../src/guestfs-actions.pod:4442
26966 msgid "guestfs_mkdir_mode"
26970 #: ../src/guestfs-actions.pod:4444
26974 " guestfs_mkdir_mode (guestfs_h *g,\n"
26975 " const char *path,\n"
26981 #: ../src/guestfs-actions.pod:4456
26982 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26986 #: ../src/guestfs-actions.pod:4462
26987 msgid "guestfs_mkdir_p"
26991 #: ../src/guestfs-actions.pod:4464
26995 " guestfs_mkdir_p (guestfs_h *g,\n"
26996 " const char *path);\n"
27001 #: ../src/guestfs-actions.pod:4475
27002 msgid "guestfs_mkdtemp"
27006 #: ../src/guestfs-actions.pod:4477
27010 " guestfs_mkdtemp (guestfs_h *g,\n"
27011 " const char *template);\n"
27016 #: ../src/guestfs-actions.pod:4505
27017 msgid "guestfs_mke2fs_J"
27021 #: ../src/guestfs-actions.pod:4507
27025 " guestfs_mke2fs_J (guestfs_h *g,\n"
27026 " const char *fstype,\n"
27027 " int blocksize,\n"
27028 " const char *device,\n"
27029 " const char *journal);\n"
27034 #: ../src/guestfs-actions.pod:4520
27035 msgid "See also C<guestfs_mke2journal>."
27039 #: ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4542
27040 #: ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4576
27041 #: ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4604
27042 #: ../src/guestfs-actions.pod:4663 ../src/guestfs-actions.pod:4940
27043 msgid "(Added in 1.0.68)"
27047 #: ../src/guestfs-actions.pod:4526
27048 msgid "guestfs_mke2fs_JL"
27052 #: ../src/guestfs-actions.pod:4528
27056 " guestfs_mke2fs_JL (guestfs_h *g,\n"
27057 " const char *fstype,\n"
27058 " int blocksize,\n"
27059 " const char *device,\n"
27060 " const char *label);\n"
27065 #: ../src/guestfs-actions.pod:4538
27066 msgid "See also C<guestfs_mke2journal_L>."
27070 #: ../src/guestfs-actions.pod:4544
27071 msgid "guestfs_mke2fs_JU"
27075 #: ../src/guestfs-actions.pod:4546
27079 " guestfs_mke2fs_JU (guestfs_h *g,\n"
27080 " const char *fstype,\n"
27081 " int blocksize,\n"
27082 " const char *device,\n"
27083 " const char *uuid);\n"
27088 #: ../src/guestfs-actions.pod:4556
27089 msgid "See also C<guestfs_mke2journal_U>."
27093 #: ../src/guestfs-actions.pod:4562
27094 msgid "guestfs_mke2journal"
27098 #: ../src/guestfs-actions.pod:4564
27102 " guestfs_mke2journal (guestfs_h *g,\n"
27103 " int blocksize,\n"
27104 " const char *device);\n"
27109 #: ../src/guestfs-actions.pod:4578
27110 msgid "guestfs_mke2journal_L"
27114 #: ../src/guestfs-actions.pod:4580
27118 " guestfs_mke2journal_L (guestfs_h *g,\n"
27119 " int blocksize,\n"
27120 " const char *label,\n"
27121 " const char *device);\n"
27126 #: ../src/guestfs-actions.pod:4592
27127 msgid "guestfs_mke2journal_U"
27131 #: ../src/guestfs-actions.pod:4594
27135 " guestfs_mke2journal_U (guestfs_h *g,\n"
27136 " int blocksize,\n"
27137 " const char *uuid,\n"
27138 " const char *device);\n"
27143 #: ../src/guestfs-actions.pod:4606
27144 msgid "guestfs_mkfifo"
27148 #: ../src/guestfs-actions.pod:4608
27152 " guestfs_mkfifo (guestfs_h *g,\n"
27154 " const char *path);\n"
27159 #: ../src/guestfs-actions.pod:4613
27161 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
27162 "is just a convenient wrapper around C<guestfs_mknod>."
27166 #: ../src/guestfs-actions.pod:4623
27167 msgid "guestfs_mkfs"
27171 #: ../src/guestfs-actions.pod:4625
27175 " guestfs_mkfs (guestfs_h *g,\n"
27176 " const char *fstype,\n"
27177 " const char *device);\n"
27182 #: ../src/guestfs-actions.pod:4638
27183 msgid "guestfs_mkfs_b"
27187 #: ../src/guestfs-actions.pod:4640
27191 " guestfs_mkfs_b (guestfs_h *g,\n"
27192 " const char *fstype,\n"
27193 " int blocksize,\n"
27194 " const char *device);\n"
27199 #: ../src/guestfs-actions.pod:4646
27201 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
27206 #: ../src/guestfs-actions.pod:4653
27208 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
27209 "block size of the resulting filesystem. Supported block sizes depend on the "
27210 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
27214 #: ../src/guestfs-actions.pod:4665
27215 msgid "guestfs_mkfs_opts"
27219 #: ../src/guestfs-actions.pod:4667
27223 " guestfs_mkfs_opts (guestfs_h *g,\n"
27224 " const char *fstype,\n"
27225 " const char *device,\n"
27231 #: ../src/guestfs-actions.pod:4678
27234 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
27235 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
27236 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
27237 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
27242 #: ../src/guestfs-actions.pod:4726
27243 msgid "(Added in 1.7.19)"
27247 #: ../src/guestfs-actions.pod:4728
27248 msgid "guestfs_mkfs_opts_va"
27252 #: ../src/guestfs-actions.pod:4730
27256 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
27257 " const char *fstype,\n"
27258 " const char *device,\n"
27259 " va_list args);\n"
27264 #: ../src/guestfs-actions.pod:4736
27265 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
27269 #: ../src/guestfs-actions.pod:4740
27270 msgid "guestfs_mkfs_opts_argv"
27274 #: ../src/guestfs-actions.pod:4742
27278 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
27279 " const char *fstype,\n"
27280 " const char *device,\n"
27281 " const struct guestfs_mkfs_opts_argv *optargs);\n"
27286 #: ../src/guestfs-actions.pod:4748
27287 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
27291 #: ../src/guestfs-actions.pod:4752
27292 msgid "guestfs_mkmountpoint"
27296 #: ../src/guestfs-actions.pod:4754
27300 " guestfs_mkmountpoint (guestfs_h *g,\n"
27301 " const char *exemptpath);\n"
27306 #: ../src/guestfs-actions.pod:4758
27308 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
27309 "that can be used to create extra mountpoints before mounting the first "
27314 #: ../src/guestfs-actions.pod:4782
27316 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
27317 "may get unexpected errors if you try to mix these calls. It is safest to "
27318 "manually unmount filesystems and remove mountpoints after use."
27322 #: ../src/guestfs-actions.pod:4786
27324 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
27325 "first, so for this to work for manual mountpoints, you must ensure that the "
27326 "innermost mountpoints have the longest pathnames, as in the example code "
27331 #: ../src/guestfs-actions.pod:4793
27333 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
27334 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
27335 "can also trigger these issues."
27339 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:5115
27340 #: ../src/guestfs-actions.pod:6125
27341 msgid "(Added in 1.0.62)"
27345 #: ../src/guestfs-actions.pod:4801
27346 msgid "guestfs_mknod"
27350 #: ../src/guestfs-actions.pod:4803
27354 " guestfs_mknod (guestfs_h *g,\n"
27358 " const char *path);\n"
27363 #: ../src/guestfs-actions.pod:4818
27365 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
27366 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
27367 "regular file). These constants are available in the standard Linux header "
27368 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
27369 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
27370 "the appropriate constant for you."
27374 #: ../src/guestfs-actions.pod:4832
27375 msgid "guestfs_mknod_b"
27379 #: ../src/guestfs-actions.pod:4834
27383 " guestfs_mknod_b (guestfs_h *g,\n"
27387 " const char *path);\n"
27392 #: ../src/guestfs-actions.pod:4841
27394 "This call creates a block device node called C<path> with mode C<mode> and "
27395 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27396 "wrapper around C<guestfs_mknod>."
27400 #: ../src/guestfs-actions.pod:4851
27401 msgid "guestfs_mknod_c"
27405 #: ../src/guestfs-actions.pod:4853
27409 " guestfs_mknod_c (guestfs_h *g,\n"
27413 " const char *path);\n"
27418 #: ../src/guestfs-actions.pod:4860
27420 "This call creates a char device node called C<path> with mode C<mode> and "
27421 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27422 "wrapper around C<guestfs_mknod>."
27426 #: ../src/guestfs-actions.pod:4870
27427 msgid "guestfs_mkswap"
27431 #: ../src/guestfs-actions.pod:4872
27435 " guestfs_mkswap (guestfs_h *g,\n"
27436 " const char *device);\n"
27441 #: ../src/guestfs-actions.pod:4882
27442 msgid "guestfs_mkswap_L"
27446 #: ../src/guestfs-actions.pod:4884
27450 " guestfs_mkswap_L (guestfs_h *g,\n"
27451 " const char *label,\n"
27452 " const char *device);\n"
27457 #: ../src/guestfs-actions.pod:4899
27458 msgid "guestfs_mkswap_U"
27462 #: ../src/guestfs-actions.pod:4901
27466 " guestfs_mkswap_U (guestfs_h *g,\n"
27467 " const char *uuid,\n"
27468 " const char *device);\n"
27473 #: ../src/guestfs-actions.pod:4912
27474 msgid "guestfs_mkswap_file"
27478 #: ../src/guestfs-actions.pod:4914
27482 " guestfs_mkswap_file (guestfs_h *g,\n"
27483 " const char *path);\n"
27488 #: ../src/guestfs-actions.pod:4920
27490 "This command just writes a swap file signature to an existing file. To "
27491 "create the file itself, use something like C<guestfs_fallocate>."
27495 #: ../src/guestfs-actions.pod:4927
27496 msgid "guestfs_modprobe"
27500 #: ../src/guestfs-actions.pod:4929
27504 " guestfs_modprobe (guestfs_h *g,\n"
27505 " const char *modulename);\n"
27510 #: ../src/guestfs-actions.pod:4942
27511 msgid "guestfs_mount"
27515 #: ../src/guestfs-actions.pod:4944
27519 " guestfs_mount (guestfs_h *g,\n"
27520 " const char *device,\n"
27521 " const char *mountpoint);\n"
27526 #: ../src/guestfs-actions.pod:4949
27528 "I<This function is deprecated.> In new code, use the L</"
27529 "guestfs_mount_options> call instead."
27533 #: ../src/guestfs-actions.pod:4970
27535 "B<Important note:> When you use this call, the filesystem options C<sync> "
27536 "and C<noatime> are set implicitly. This was originally done because we "
27537 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27538 "very large negative performance impact and negligible effect on "
27539 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
27540 "in any code that needs performance, and instead use C<guestfs_mount_options> "
27541 "(use an empty string for the first parameter if you don't want any options)."
27545 #: ../src/guestfs-actions.pod:4984
27546 msgid "guestfs_mount_9p"
27550 #: ../src/guestfs-actions.pod:4986
27554 " guestfs_mount_9p (guestfs_h *g,\n"
27555 " const char *mounttag,\n"
27556 " const char *mountpoint,\n"
27562 #: ../src/guestfs-actions.pod:4997
27565 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
27570 #: ../src/guestfs-actions.pod:5010
27571 msgid "guestfs_mount_9p_va"
27575 #: ../src/guestfs-actions.pod:5012
27579 " guestfs_mount_9p_va (guestfs_h *g,\n"
27580 " const char *mounttag,\n"
27581 " const char *mountpoint,\n"
27582 " va_list args);\n"
27587 #: ../src/guestfs-actions.pod:5018
27588 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
27592 #: ../src/guestfs-actions.pod:5022
27593 msgid "guestfs_mount_9p_argv"
27597 #: ../src/guestfs-actions.pod:5024
27601 " guestfs_mount_9p_argv (guestfs_h *g,\n"
27602 " const char *mounttag,\n"
27603 " const char *mountpoint,\n"
27604 " const struct guestfs_mount_9p_argv *optargs);\n"
27609 #: ../src/guestfs-actions.pod:5030
27610 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
27614 #: ../src/guestfs-actions.pod:5034
27615 msgid "guestfs_mount_loop"
27619 #: ../src/guestfs-actions.pod:5036
27623 " guestfs_mount_loop (guestfs_h *g,\n"
27624 " const char *file,\n"
27625 " const char *mountpoint);\n"
27630 #: ../src/guestfs-actions.pod:5049
27631 msgid "guestfs_mount_options"
27635 #: ../src/guestfs-actions.pod:5051
27639 " guestfs_mount_options (guestfs_h *g,\n"
27640 " const char *options,\n"
27641 " const char *device,\n"
27642 " const char *mountpoint);\n"
27647 #: ../src/guestfs-actions.pod:5057
27649 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27650 "the mount options as for the L<mount(8)> I<-o> flag."
27654 #: ../src/guestfs-actions.pod:5067 ../src/guestfs-actions.pod:5081
27655 #: ../src/guestfs-actions.pod:5098
27656 msgid "(Added in 1.0.10)"
27660 #: ../src/guestfs-actions.pod:5069
27661 msgid "guestfs_mount_ro"
27665 #: ../src/guestfs-actions.pod:5071
27669 " guestfs_mount_ro (guestfs_h *g,\n"
27670 " const char *device,\n"
27671 " const char *mountpoint);\n"
27676 #: ../src/guestfs-actions.pod:5076
27678 "This is the same as the C<guestfs_mount> command, but it mounts the "
27679 "filesystem with the read-only (I<-o ro>) flag."
27683 #: ../src/guestfs-actions.pod:5083
27684 msgid "guestfs_mount_vfs"
27688 #: ../src/guestfs-actions.pod:5085
27692 " guestfs_mount_vfs (guestfs_h *g,\n"
27693 " const char *options,\n"
27694 " const char *vfstype,\n"
27695 " const char *device,\n"
27696 " const char *mountpoint);\n"
27701 #: ../src/guestfs-actions.pod:5092
27703 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27704 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
27709 #: ../src/guestfs-actions.pod:5100
27710 msgid "guestfs_mountpoints"
27714 #: ../src/guestfs-actions.pod:5102
27718 " guestfs_mountpoints (guestfs_h *g);\n"
27723 #: ../src/guestfs-actions.pod:5105
27725 "This call is similar to C<guestfs_mounts>. That call returns a list of "
27726 "devices. This one returns a hash table (map) of device name to directory "
27727 "where the device is mounted."
27731 #: ../src/guestfs-actions.pod:5117
27732 msgid "guestfs_mounts"
27736 #: ../src/guestfs-actions.pod:5119
27740 " guestfs_mounts (guestfs_h *g);\n"
27745 #: ../src/guestfs-actions.pod:5127
27746 msgid "See also: C<guestfs_mountpoints>"
27750 #: ../src/guestfs-actions.pod:5135
27755 #: ../src/guestfs-actions.pod:5137
27759 " guestfs_mv (guestfs_h *g,\n"
27760 " const char *src,\n"
27761 " const char *dest);\n"
27766 #: ../src/guestfs-actions.pod:5149
27767 msgid "guestfs_ntfs_3g_probe"
27771 #: ../src/guestfs-actions.pod:5151
27775 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27777 " const char *device);\n"
27782 #: ../src/guestfs-actions.pod:5170
27783 msgid "(Added in 1.0.43)"
27787 #: ../src/guestfs-actions.pod:5172
27788 msgid "guestfs_ntfsresize"
27792 #: ../src/guestfs-actions.pod:5174
27796 " guestfs_ntfsresize (guestfs_h *g,\n"
27797 " const char *device);\n"
27802 #: ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5278
27804 "I<This function is deprecated.> In new code, use the L</"
27805 "guestfs_ntfsresize_opts> call instead."
27809 #: ../src/guestfs-actions.pod:5202
27810 msgid "guestfs_ntfsresize_opts"
27814 #: ../src/guestfs-actions.pod:5204
27818 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27819 " const char *device,\n"
27825 #: ../src/guestfs-actions.pod:5214
27828 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27829 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27834 #: ../src/guestfs-actions.pod:5234
27836 "After the resize operation, the filesystem is always marked as requiring a "
27837 "consistency check (for safety). You have to boot into Windows to perform "
27838 "this check and clear this condition. If you I<don't> set the C<force> "
27839 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27840 "times on a single filesystem without booting into Windows between each "
27845 #: ../src/guestfs-actions.pod:5249
27846 msgid "guestfs_ntfsresize_opts_va"
27850 #: ../src/guestfs-actions.pod:5251
27854 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27855 " const char *device,\n"
27856 " va_list args);\n"
27861 #: ../src/guestfs-actions.pod:5256
27862 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27866 #: ../src/guestfs-actions.pod:5260
27867 msgid "guestfs_ntfsresize_opts_argv"
27871 #: ../src/guestfs-actions.pod:5262
27875 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27876 " const char *device,\n"
27877 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
27882 #: ../src/guestfs-actions.pod:5267
27883 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27887 #: ../src/guestfs-actions.pod:5271
27888 msgid "guestfs_ntfsresize_size"
27892 #: ../src/guestfs-actions.pod:5273
27896 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27897 " const char *device,\n"
27898 " int64_t size);\n"
27903 #: ../src/guestfs-actions.pod:5285
27905 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27906 "to specify the new size (in bytes) explicitly."
27910 #: ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5732
27911 #: ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:6073
27912 #: ../src/guestfs-actions.pod:7696
27913 msgid "(Added in 1.3.14)"
27917 #: ../src/guestfs-actions.pod:5292
27918 msgid "guestfs_part_add"
27922 #: ../src/guestfs-actions.pod:5294
27926 " guestfs_part_add (guestfs_h *g,\n"
27927 " const char *device,\n"
27928 " const char *prlogex,\n"
27929 " int64_t startsect,\n"
27930 " int64_t endsect);\n"
27935 #: ../src/guestfs-actions.pod:5301
27937 "This command adds a partition to C<device>. If there is no partition table "
27938 "on the device, call C<guestfs_part_init> first."
27942 #: ../src/guestfs-actions.pod:5313
27944 "Creating a partition which covers the whole disk is not so easy. Use "
27945 "C<guestfs_part_disk> to do that."
27949 #: ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5356
27950 #: ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5493
27951 #: ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:5550
27952 #: ../src/guestfs-actions.pod:5590
27953 msgid "(Added in 1.0.78)"
27957 #: ../src/guestfs-actions.pod:5320
27958 msgid "guestfs_part_del"
27962 #: ../src/guestfs-actions.pod:5322
27966 " guestfs_part_del (guestfs_h *g,\n"
27967 " const char *device,\n"
27973 #: ../src/guestfs-actions.pod:5337
27974 msgid "guestfs_part_disk"
27978 #: ../src/guestfs-actions.pod:5339
27982 " guestfs_part_disk (guestfs_h *g,\n"
27983 " const char *device,\n"
27984 " const char *parttype);\n"
27989 #: ../src/guestfs-actions.pod:5344
27991 "This command is simply a combination of C<guestfs_part_init> followed by "
27992 "C<guestfs_part_add> to create a single primary partition covering the whole "
27997 #: ../src/guestfs-actions.pod:5348
27999 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
28000 "possible values are described in C<guestfs_part_init>."
28004 #: ../src/guestfs-actions.pod:5358
28005 msgid "guestfs_part_get_bootable"
28009 #: ../src/guestfs-actions.pod:5360
28013 " guestfs_part_get_bootable (guestfs_h *g,\n"
28014 " const char *device,\n"
28020 #: ../src/guestfs-actions.pod:5368
28021 msgid "See also C<guestfs_part_set_bootable>."
28025 #: ../src/guestfs-actions.pod:5374
28026 msgid "guestfs_part_get_mbr_id"
28030 #: ../src/guestfs-actions.pod:5376
28034 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
28035 " const char *device,\n"
28041 #: ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5566
28043 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
28044 "undefined results for other partition table types (see "
28045 "C<guestfs_part_get_parttype>)."
28049 #: ../src/guestfs-actions.pod:5392
28050 msgid "guestfs_part_get_parttype"
28054 #: ../src/guestfs-actions.pod:5394
28058 " guestfs_part_get_parttype (guestfs_h *g,\n"
28059 " const char *device);\n"
28064 #: ../src/guestfs-actions.pod:5401
28066 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
28067 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
28068 "possible, although unusual. See C<guestfs_part_init> for a full list."
28072 #: ../src/guestfs-actions.pod:5411
28073 msgid "guestfs_part_init"
28077 #: ../src/guestfs-actions.pod:5413
28081 " guestfs_part_init (guestfs_h *g,\n"
28082 " const char *device,\n"
28083 " const char *parttype);\n"
28088 #: ../src/guestfs-actions.pod:5422
28090 "Initially there are no partitions. Following this, you should call "
28091 "C<guestfs_part_add> for each partition required."
28095 #: ../src/guestfs-actions.pod:5495
28096 msgid "guestfs_part_list"
28100 #: ../src/guestfs-actions.pod:5497
28103 " struct guestfs_partition_list *\n"
28104 " guestfs_part_list (guestfs_h *g,\n"
28105 " const char *device);\n"
28110 #: ../src/guestfs-actions.pod:5514
28112 "Start of the partition I<in bytes>. To get sectors you have to divide by "
28113 "the device's sector size, see C<guestfs_blockdev_getss>."
28117 #: ../src/guestfs-actions.pod:5527
28119 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
28120 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
28125 #: ../src/guestfs-actions.pod:5533
28126 msgid "guestfs_part_set_bootable"
28130 #: ../src/guestfs-actions.pod:5535
28134 " guestfs_part_set_bootable (guestfs_h *g,\n"
28135 " const char *device,\n"
28137 " int bootable);\n"
28142 #: ../src/guestfs-actions.pod:5552
28143 msgid "guestfs_part_set_mbr_id"
28147 #: ../src/guestfs-actions.pod:5554
28151 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
28152 " const char *device,\n"
28159 #: ../src/guestfs-actions.pod:5574
28160 msgid "guestfs_part_set_name"
28164 #: ../src/guestfs-actions.pod:5576
28168 " guestfs_part_set_name (guestfs_h *g,\n"
28169 " const char *device,\n"
28171 " const char *name);\n"
28176 #: ../src/guestfs-actions.pod:5592
28177 msgid "guestfs_part_to_dev"
28181 #: ../src/guestfs-actions.pod:5594
28185 " guestfs_part_to_dev (guestfs_h *g,\n"
28186 " const char *partition);\n"
28191 #: ../src/guestfs-actions.pod:5602
28193 "The named partition must exist, for example as a string returned from "
28194 "C<guestfs_list_partitions>."
28198 #: ../src/guestfs-actions.pod:5610
28199 msgid "guestfs_ping_daemon"
28203 #: ../src/guestfs-actions.pod:5612
28207 " guestfs_ping_daemon (guestfs_h *g);\n"
28212 #: ../src/guestfs-actions.pod:5624
28213 msgid "guestfs_pread"
28217 #: ../src/guestfs-actions.pod:5626
28221 " guestfs_pread (guestfs_h *g,\n"
28222 " const char *path,\n"
28224 " int64_t offset,\n"
28225 " size_t *size_r);\n"
28230 #: ../src/guestfs-actions.pod:5639
28231 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
28235 #: ../src/guestfs-actions.pod:5650
28236 msgid "guestfs_pread_device"
28240 #: ../src/guestfs-actions.pod:5652
28244 " guestfs_pread_device (guestfs_h *g,\n"
28245 " const char *device,\n"
28247 " int64_t offset,\n"
28248 " size_t *size_r);\n"
28253 #: ../src/guestfs-actions.pod:5665
28254 msgid "See also C<guestfs_pread>."
28258 #: ../src/guestfs-actions.pod:5674
28259 msgid "(Added in 1.5.21)"
28263 #: ../src/guestfs-actions.pod:5676
28264 msgid "guestfs_pvcreate"
28268 #: ../src/guestfs-actions.pod:5678
28272 " guestfs_pvcreate (guestfs_h *g,\n"
28273 " const char *device);\n"
28278 #: ../src/guestfs-actions.pod:5690
28279 msgid "guestfs_pvremove"
28283 #: ../src/guestfs-actions.pod:5692
28287 " guestfs_pvremove (guestfs_h *g,\n"
28288 " const char *device);\n"
28293 #: ../src/guestfs-actions.pod:5707
28294 msgid "guestfs_pvresize"
28298 #: ../src/guestfs-actions.pod:5709
28302 " guestfs_pvresize (guestfs_h *g,\n"
28303 " const char *device);\n"
28308 #: ../src/guestfs-actions.pod:5720
28309 msgid "guestfs_pvresize_size"
28313 #: ../src/guestfs-actions.pod:5722
28317 " guestfs_pvresize_size (guestfs_h *g,\n"
28318 " const char *device,\n"
28319 " int64_t size);\n"
28324 #: ../src/guestfs-actions.pod:5727
28326 "This command is the same as C<guestfs_pvresize> except that it allows you to "
28327 "specify the new size (in bytes) explicitly."
28331 #: ../src/guestfs-actions.pod:5734
28332 msgid "guestfs_pvs"
28336 #: ../src/guestfs-actions.pod:5736
28340 " guestfs_pvs (guestfs_h *g);\n"
28345 #: ../src/guestfs-actions.pod:5745
28346 msgid "See also C<guestfs_pvs_full>."
28350 #: ../src/guestfs-actions.pod:5753
28351 msgid "guestfs_pvs_full"
28355 #: ../src/guestfs-actions.pod:5755
28358 " struct guestfs_lvm_pv_list *\n"
28359 " guestfs_pvs_full (guestfs_h *g);\n"
28364 #: ../src/guestfs-actions.pod:5761
28366 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
28367 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
28371 #: ../src/guestfs-actions.pod:5767
28372 msgid "guestfs_pvuuid"
28376 #: ../src/guestfs-actions.pod:5769
28380 " guestfs_pvuuid (guestfs_h *g,\n"
28381 " const char *device);\n"
28386 #: ../src/guestfs-actions.pod:5780
28387 msgid "guestfs_pwrite"
28391 #: ../src/guestfs-actions.pod:5782
28395 " guestfs_pwrite (guestfs_h *g,\n"
28396 " const char *path,\n"
28397 " const char *content,\n"
28398 " size_t content_size,\n"
28399 " int64_t offset);\n"
28404 #: ../src/guestfs-actions.pod:5798
28405 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
28409 #: ../src/guestfs-actions.pod:5807
28410 msgid "guestfs_pwrite_device"
28414 #: ../src/guestfs-actions.pod:5809
28418 " guestfs_pwrite_device (guestfs_h *g,\n"
28419 " const char *device,\n"
28420 " const char *content,\n"
28421 " size_t content_size,\n"
28422 " int64_t offset);\n"
28427 #: ../src/guestfs-actions.pod:5824
28428 msgid "See also C<guestfs_pwrite>."
28432 #: ../src/guestfs-actions.pod:5831
28433 msgid "(Added in 1.5.20)"
28437 #: ../src/guestfs-actions.pod:5833
28438 msgid "guestfs_read_file"
28442 #: ../src/guestfs-actions.pod:5835
28446 " guestfs_read_file (guestfs_h *g,\n"
28447 " const char *path,\n"
28448 " size_t *size_r);\n"
28453 #: ../src/guestfs-actions.pod:5843
28455 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
28456 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
28457 "function is limited in the total size of file that can be handled."
28461 #: ../src/guestfs-actions.pod:5855
28462 msgid "(Added in 1.0.63)"
28466 #: ../src/guestfs-actions.pod:5857
28467 msgid "guestfs_read_lines"
28471 #: ../src/guestfs-actions.pod:5859
28475 " guestfs_read_lines (guestfs_h *g,\n"
28476 " const char *path);\n"
28481 #: ../src/guestfs-actions.pod:5868
28483 "Note that this function cannot correctly handle binary files (specifically, "
28484 "files containing C<\\0> character which is treated as end of line). For "
28485 "those you need to use the C<guestfs_read_file> function which has a more "
28486 "complex interface."
28490 #: ../src/guestfs-actions.pod:5879
28491 msgid "guestfs_readdir"
28495 #: ../src/guestfs-actions.pod:5881
28498 " struct guestfs_dirent_list *\n"
28499 " guestfs_readdir (guestfs_h *g,\n"
28500 " const char *dir);\n"
28505 #: ../src/guestfs-actions.pod:5935
28507 "This function is primarily intended for use by programs. To get a simple "
28508 "list of names, use C<guestfs_ls>. To get a printable directory for human "
28509 "consumption, use C<guestfs_ll>."
28513 #: ../src/guestfs-actions.pod:5939
28515 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
28516 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
28520 #: ../src/guestfs-actions.pod:5945
28521 msgid "guestfs_readlink"
28525 #: ../src/guestfs-actions.pod:5947
28529 " guestfs_readlink (guestfs_h *g,\n"
28530 " const char *path);\n"
28535 #: ../src/guestfs-actions.pod:5958
28536 msgid "guestfs_readlinklist"
28540 #: ../src/guestfs-actions.pod:5960
28544 " guestfs_readlinklist (guestfs_h *g,\n"
28545 " const char *path,\n"
28546 " char *const *names);\n"
28551 #: ../src/guestfs-actions.pod:5993
28552 msgid "guestfs_realpath"
28556 #: ../src/guestfs-actions.pod:5995
28560 " guestfs_realpath (guestfs_h *g,\n"
28561 " const char *path);\n"
28566 #: ../src/guestfs-actions.pod:6007
28567 msgid "guestfs_removexattr"
28571 #: ../src/guestfs-actions.pod:6009
28575 " guestfs_removexattr (guestfs_h *g,\n"
28576 " const char *xattr,\n"
28577 " const char *path);\n"
28582 #: ../src/guestfs-actions.pod:6017
28583 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
28587 #: ../src/guestfs-actions.pod:6023
28588 msgid "guestfs_resize2fs"
28592 #: ../src/guestfs-actions.pod:6025
28596 " guestfs_resize2fs (guestfs_h *g,\n"
28597 " const char *device);\n"
28602 #: ../src/guestfs-actions.pod:6032
28604 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
28605 "C<device> before calling this command. For unknown reasons C<resize2fs> "
28606 "sometimes gives an error about this and sometimes not. In any case, it is "
28607 "always safe to call C<guestfs_e2fsck_f> before calling this function."
28611 #: ../src/guestfs-actions.pod:6042
28612 msgid "guestfs_resize2fs_M"
28616 #: ../src/guestfs-actions.pod:6044
28620 " guestfs_resize2fs_M (guestfs_h *g,\n"
28621 " const char *device);\n"
28626 #: ../src/guestfs-actions.pod:6048
28628 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
28629 "resized to its minimum size. This works like the I<-M> option to the "
28630 "C<resize2fs> command."
28634 #: ../src/guestfs-actions.pod:6052
28636 "To get the resulting size of the filesystem you should call "
28637 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
28638 "These two numbers, multiplied together, give the resulting size of the "
28639 "minimal filesystem in bytes."
28643 #: ../src/guestfs-actions.pod:6061
28644 msgid "guestfs_resize2fs_size"
28648 #: ../src/guestfs-actions.pod:6063
28652 " guestfs_resize2fs_size (guestfs_h *g,\n"
28653 " const char *device,\n"
28654 " int64_t size);\n"
28659 #: ../src/guestfs-actions.pod:6068
28661 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28662 "to specify the new size (in bytes) explicitly."
28666 #: ../src/guestfs-actions.pod:6075
28671 #: ../src/guestfs-actions.pod:6077
28675 " guestfs_rm (guestfs_h *g,\n"
28676 " const char *path);\n"
28681 #: ../src/guestfs-actions.pod:6087
28682 msgid "guestfs_rm_rf"
28686 #: ../src/guestfs-actions.pod:6089
28690 " guestfs_rm_rf (guestfs_h *g,\n"
28691 " const char *path);\n"
28696 #: ../src/guestfs-actions.pod:6101
28697 msgid "guestfs_rmdir"
28701 #: ../src/guestfs-actions.pod:6103
28705 " guestfs_rmdir (guestfs_h *g,\n"
28706 " const char *path);\n"
28711 #: ../src/guestfs-actions.pod:6113
28712 msgid "guestfs_rmmountpoint"
28716 #: ../src/guestfs-actions.pod:6115
28720 " guestfs_rmmountpoint (guestfs_h *g,\n"
28721 " const char *exemptpath);\n"
28726 #: ../src/guestfs-actions.pod:6119
28728 "This calls removes a mountpoint that was previously created with "
28729 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
28733 #: ../src/guestfs-actions.pod:6127
28734 msgid "guestfs_scrub_device"
28738 #: ../src/guestfs-actions.pod:6129
28742 " guestfs_scrub_device (guestfs_h *g,\n"
28743 " const char *device);\n"
28748 #: ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6162
28749 #: ../src/guestfs-actions.pod:6181
28750 msgid "(Added in 1.0.52)"
28754 #: ../src/guestfs-actions.pod:6146
28755 msgid "guestfs_scrub_file"
28759 #: ../src/guestfs-actions.pod:6148
28763 " guestfs_scrub_file (guestfs_h *g,\n"
28764 " const char *file);\n"
28769 #: ../src/guestfs-actions.pod:6164
28770 msgid "guestfs_scrub_freespace"
28774 #: ../src/guestfs-actions.pod:6166
28778 " guestfs_scrub_freespace (guestfs_h *g,\n"
28779 " const char *dir);\n"
28784 #: ../src/guestfs-actions.pod:6170
28786 "This command creates the directory C<dir> and then fills it with files until "
28787 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28788 "and deletes them. The intention is to scrub any free space on the partition "
28789 "containing C<dir>."
28793 #: ../src/guestfs-actions.pod:6183
28794 msgid "guestfs_set_append"
28798 #: ../src/guestfs-actions.pod:6185
28802 " guestfs_set_append (guestfs_h *g,\n"
28803 " const char *append);\n"
28808 #: ../src/guestfs-actions.pod:6202
28809 msgid "guestfs_set_attach_method"
28813 #: ../src/guestfs-actions.pod:6204
28817 " guestfs_set_attach_method (guestfs_h *g,\n"
28818 " const char *attachmethod);\n"
28823 #: ../src/guestfs-actions.pod:6232
28824 msgid "guestfs_set_autosync"
28828 #: ../src/guestfs-actions.pod:6234
28832 " guestfs_set_autosync (guestfs_h *g,\n"
28833 " int autosync);\n"
28838 #: ../src/guestfs-actions.pod:6250
28839 msgid "guestfs_set_direct"
28843 #: ../src/guestfs-actions.pod:6252
28847 " guestfs_set_direct (guestfs_h *g,\n"
28853 #: ../src/guestfs-actions.pod:6260
28855 "One consequence of this is that log messages aren't caught by the library "
28856 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28861 #: ../src/guestfs-actions.pod:6273
28862 msgid "guestfs_set_e2label"
28866 #: ../src/guestfs-actions.pod:6275
28870 " guestfs_set_e2label (guestfs_h *g,\n"
28871 " const char *device,\n"
28872 " const char *label);\n"
28877 #: ../src/guestfs-actions.pod:6284
28879 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28880 "the existing label on a filesystem."
28884 #: ../src/guestfs-actions.pod:6291
28885 msgid "guestfs_set_e2uuid"
28889 #: ../src/guestfs-actions.pod:6293
28893 " guestfs_set_e2uuid (guestfs_h *g,\n"
28894 " const char *device,\n"
28895 " const char *uuid);\n"
28900 #: ../src/guestfs-actions.pod:6303
28902 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28903 "the existing UUID of a filesystem."
28907 #: ../src/guestfs-actions.pod:6310
28908 msgid "guestfs_set_memsize"
28912 #: ../src/guestfs-actions.pod:6312
28916 " guestfs_set_memsize (guestfs_h *g,\n"
28922 #: ../src/guestfs-actions.pod:6316
28924 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28925 "This only has any effect if called before C<guestfs_launch>."
28929 #: ../src/guestfs-actions.pod:6331
28930 msgid "guestfs_set_network"
28934 #: ../src/guestfs-actions.pod:6333
28938 " guestfs_set_network (guestfs_h *g,\n"
28944 #: ../src/guestfs-actions.pod:6343
28946 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28951 #: ../src/guestfs-actions.pod:6350
28952 msgid "guestfs_set_path"
28956 #: ../src/guestfs-actions.pod:6352
28960 " guestfs_set_path (guestfs_h *g,\n"
28961 " const char *searchpath);\n"
28966 #: ../src/guestfs-actions.pod:6367
28967 msgid "guestfs_set_pgroup"
28971 #: ../src/guestfs-actions.pod:6369
28975 " guestfs_set_pgroup (guestfs_h *g,\n"
28981 #: ../src/guestfs-actions.pod:6386
28982 msgid "guestfs_set_qemu"
28986 #: ../src/guestfs-actions.pod:6388
28990 " guestfs_set_qemu (guestfs_h *g,\n"
28991 " const char *qemu);\n"
28996 #: ../src/guestfs-actions.pod:6414
28997 msgid "guestfs_set_recovery_proc"
29001 #: ../src/guestfs-actions.pod:6416
29005 " guestfs_set_recovery_proc (guestfs_h *g,\n"
29006 " int recoveryproc);\n"
29011 #: ../src/guestfs-actions.pod:6420
29013 "If this is called with the parameter C<false> then C<guestfs_launch> does "
29014 "not create a recovery process. The purpose of the recovery process is to "
29015 "stop runaway qemu processes in the case where the main program aborts "
29020 #: ../src/guestfs-actions.pod:6425
29022 "This only has any effect if called before C<guestfs_launch>, and the default "
29027 #: ../src/guestfs-actions.pod:6438
29028 msgid "guestfs_set_selinux"
29032 #: ../src/guestfs-actions.pod:6440
29036 " guestfs_set_selinux (guestfs_h *g,\n"
29042 #: ../src/guestfs-actions.pod:6457
29043 msgid "guestfs_set_trace"
29047 #: ../src/guestfs-actions.pod:6459
29051 " guestfs_set_trace (guestfs_h *g,\n"
29057 #: ../src/guestfs-actions.pod:6473
29059 "Trace messages are normally sent to C<stderr>, unless you register a "
29060 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
29064 #: ../src/guestfs-actions.pod:6481
29065 msgid "guestfs_set_verbose"
29069 #: ../src/guestfs-actions.pod:6483
29073 " guestfs_set_verbose (guestfs_h *g,\n"
29079 #: ../src/guestfs-actions.pod:6492
29081 "Verbose messages are normally sent to C<stderr>, unless you register a "
29082 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
29086 #: ../src/guestfs-actions.pod:6500
29087 msgid "guestfs_setcon"
29091 #: ../src/guestfs-actions.pod:6502
29095 " guestfs_setcon (guestfs_h *g,\n"
29096 " const char *context);\n"
29101 #: ../src/guestfs-actions.pod:6515
29102 msgid "guestfs_setxattr"
29106 #: ../src/guestfs-actions.pod:6517
29110 " guestfs_setxattr (guestfs_h *g,\n"
29111 " const char *xattr,\n"
29112 " const char *val,\n"
29114 " const char *path);\n"
29119 #: ../src/guestfs-actions.pod:6528
29120 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
29124 #: ../src/guestfs-actions.pod:6534
29125 msgid "guestfs_sfdisk"
29129 #: ../src/guestfs-actions.pod:6536
29133 " guestfs_sfdisk (guestfs_h *g,\n"
29134 " const char *device,\n"
29138 " char *const *lines);\n"
29143 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6588
29144 #: ../src/guestfs-actions.pod:6622
29146 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
29151 #: ../src/guestfs-actions.pod:6571
29153 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
29157 #: ../src/guestfs-actions.pod:6581
29158 msgid "guestfs_sfdiskM"
29162 #: ../src/guestfs-actions.pod:6583
29166 " guestfs_sfdiskM (guestfs_h *g,\n"
29167 " const char *device,\n"
29168 " char *const *lines);\n"
29173 #: ../src/guestfs-actions.pod:6595
29175 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
29176 "partition sizes are specified in megabytes only (rounded to the nearest "
29177 "cylinder) and you don't need to specify the cyls, heads and sectors "
29178 "parameters which were rarely if ever used anyway."
29182 #: ../src/guestfs-actions.pod:6601
29184 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
29185 "C<guestfs_part_disk>"
29189 #: ../src/guestfs-actions.pod:6611
29190 msgid "guestfs_sfdisk_N"
29194 #: ../src/guestfs-actions.pod:6613
29198 " guestfs_sfdisk_N (guestfs_h *g,\n"
29199 " const char *device,\n"
29204 " const char *line);\n"
29209 #: ../src/guestfs-actions.pod:6632
29211 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
29212 "for the cyls/heads/sectors parameters."
29216 #: ../src/guestfs-actions.pod:6635
29217 msgid "See also: C<guestfs_part_add>"
29221 #: ../src/guestfs-actions.pod:6644
29222 msgid "guestfs_sfdisk_disk_geometry"
29226 #: ../src/guestfs-actions.pod:6646
29230 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
29231 " const char *device);\n"
29236 #: ../src/guestfs-actions.pod:6650
29238 "This displays the disk geometry of C<device> read from the partition table. "
29239 "Especially in the case where the underlying block device has been resized, "
29240 "this can be different from the kernel's idea of the geometry (see "
29241 "C<guestfs_sfdisk_kernel_geometry>)."
29245 #: ../src/guestfs-actions.pod:6663
29246 msgid "guestfs_sfdisk_kernel_geometry"
29250 #: ../src/guestfs-actions.pod:6665
29254 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
29255 " const char *device);\n"
29260 #: ../src/guestfs-actions.pod:6679
29261 msgid "guestfs_sfdisk_l"
29265 #: ../src/guestfs-actions.pod:6681
29269 " guestfs_sfdisk_l (guestfs_h *g,\n"
29270 " const char *device);\n"
29275 #: ../src/guestfs-actions.pod:6685
29277 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
29282 #: ../src/guestfs-actions.pod:6696
29283 msgid "See also: C<guestfs_part_list>"
29287 #: ../src/guestfs-actions.pod:6703
29292 #: ../src/guestfs-actions.pod:6705
29296 " guestfs_sh (guestfs_h *g,\n"
29297 " const char *command);\n"
29302 #: ../src/guestfs-actions.pod:6712
29303 msgid "This is like C<guestfs_command>, but passes the command to:"
29307 #: ../src/guestfs-actions.pod:6720
29308 msgid "All the provisos about C<guestfs_command> apply to this call."
29312 #: ../src/guestfs-actions.pod:6727
29313 msgid "guestfs_sh_lines"
29317 #: ../src/guestfs-actions.pod:6729
29321 " guestfs_sh_lines (guestfs_h *g,\n"
29322 " const char *command);\n"
29327 #: ../src/guestfs-actions.pod:6733
29329 "This is the same as C<guestfs_sh>, but splits the result into a list of "
29334 #: ../src/guestfs-actions.pod:6736
29335 msgid "See also: C<guestfs_command_lines>"
29339 #: ../src/guestfs-actions.pod:6744
29340 msgid "guestfs_sleep"
29344 #: ../src/guestfs-actions.pod:6746
29348 " guestfs_sleep (guestfs_h *g,\n"
29354 #: ../src/guestfs-actions.pod:6754
29355 msgid "(Added in 1.0.41)"
29359 #: ../src/guestfs-actions.pod:6756 ../src/guestfs-structs.pod:109
29360 msgid "guestfs_stat"
29364 #: ../src/guestfs-actions.pod:6758
29367 " struct guestfs_stat *\n"
29368 " guestfs_stat (guestfs_h *g,\n"
29369 " const char *path);\n"
29374 #: ../src/guestfs-actions.pod:6772 ../src/guestfs-structs.pod:135
29375 msgid "guestfs_statvfs"
29379 #: ../src/guestfs-actions.pod:6774
29382 " struct guestfs_statvfs *\n"
29383 " guestfs_statvfs (guestfs_h *g,\n"
29384 " const char *path);\n"
29389 #: ../src/guestfs-actions.pod:6784
29391 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
29392 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
29396 #: ../src/guestfs-actions.pod:6790
29397 msgid "guestfs_strings"
29401 #: ../src/guestfs-actions.pod:6792
29405 " guestfs_strings (guestfs_h *g,\n"
29406 " const char *path);\n"
29411 #: ../src/guestfs-actions.pod:6808
29412 msgid "guestfs_strings_e"
29416 #: ../src/guestfs-actions.pod:6810
29420 " guestfs_strings_e (guestfs_h *g,\n"
29421 " const char *encoding,\n"
29422 " const char *path);\n"
29427 #: ../src/guestfs-actions.pod:6815
29429 "This is like the C<guestfs_strings> command, but allows you to specify the "
29430 "encoding of strings that are looked for in the source file C<path>."
29434 #: ../src/guestfs-actions.pod:6825
29436 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
29437 "ISO-8859-X (this is what C<guestfs_strings> uses)."
29441 #: ../src/guestfs-actions.pod:6863
29442 msgid "guestfs_swapoff_device"
29446 #: ../src/guestfs-actions.pod:6865
29450 " guestfs_swapoff_device (guestfs_h *g,\n"
29451 " const char *device);\n"
29456 #: ../src/guestfs-actions.pod:6869
29458 "This command disables the libguestfs appliance swap device or partition "
29459 "named C<device>. See C<guestfs_swapon_device>."
29463 #: ../src/guestfs-actions.pod:6877
29464 msgid "guestfs_swapoff_file"
29468 #: ../src/guestfs-actions.pod:6879
29472 " guestfs_swapoff_file (guestfs_h *g,\n"
29473 " const char *file);\n"
29478 #: ../src/guestfs-actions.pod:6889
29479 msgid "guestfs_swapoff_label"
29483 #: ../src/guestfs-actions.pod:6891
29487 " guestfs_swapoff_label (guestfs_h *g,\n"
29488 " const char *label);\n"
29493 #: ../src/guestfs-actions.pod:6902
29494 msgid "guestfs_swapoff_uuid"
29498 #: ../src/guestfs-actions.pod:6904
29502 " guestfs_swapoff_uuid (guestfs_h *g,\n"
29503 " const char *uuid);\n"
29508 #: ../src/guestfs-actions.pod:6915
29509 msgid "guestfs_swapon_device"
29513 #: ../src/guestfs-actions.pod:6917
29517 " guestfs_swapon_device (guestfs_h *g,\n"
29518 " const char *device);\n"
29523 #: ../src/guestfs-actions.pod:6921
29525 "This command enables the libguestfs appliance to use the swap device or "
29526 "partition named C<device>. The increased memory is made available for all "
29527 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
29531 #: ../src/guestfs-actions.pod:6937
29532 msgid "guestfs_swapon_file"
29536 #: ../src/guestfs-actions.pod:6939
29540 " guestfs_swapon_file (guestfs_h *g,\n"
29541 " const char *file);\n"
29546 #: ../src/guestfs-actions.pod:6943
29548 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
29553 #: ../src/guestfs-actions.pod:6950
29554 msgid "guestfs_swapon_label"
29558 #: ../src/guestfs-actions.pod:6952
29562 " guestfs_swapon_label (guestfs_h *g,\n"
29563 " const char *label);\n"
29568 #: ../src/guestfs-actions.pod:6956
29570 "This command enables swap to a labeled swap partition. See "
29571 "C<guestfs_swapon_device> for other notes."
29575 #: ../src/guestfs-actions.pod:6963
29576 msgid "guestfs_swapon_uuid"
29580 #: ../src/guestfs-actions.pod:6965
29584 " guestfs_swapon_uuid (guestfs_h *g,\n"
29585 " const char *uuid);\n"
29590 #: ../src/guestfs-actions.pod:6969
29592 "This command enables swap to a swap partition with the given UUID. See "
29593 "C<guestfs_swapon_device> for other notes."
29597 #: ../src/guestfs-actions.pod:6976
29598 msgid "guestfs_sync"
29602 #: ../src/guestfs-actions.pod:6978
29606 " guestfs_sync (guestfs_h *g);\n"
29611 #: ../src/guestfs-actions.pod:6991
29612 msgid "guestfs_tail"
29616 #: ../src/guestfs-actions.pod:6993
29620 " guestfs_tail (guestfs_h *g,\n"
29621 " const char *path);\n"
29626 #: ../src/guestfs-actions.pod:7009
29627 msgid "guestfs_tail_n"
29631 #: ../src/guestfs-actions.pod:7011
29635 " guestfs_tail_n (guestfs_h *g,\n"
29637 " const char *path);\n"
29642 #: ../src/guestfs-actions.pod:7033
29643 msgid "guestfs_tar_in"
29647 #: ../src/guestfs-actions.pod:7035
29651 " guestfs_tar_in (guestfs_h *g,\n"
29652 " const char *tarfile,\n"
29653 " const char *directory);\n"
29658 #: ../src/guestfs-actions.pod:7043
29660 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29664 #: ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7065
29665 #: ../src/guestfs-actions.pod:7081 ../src/guestfs-actions.pod:7097
29666 msgid "(Added in 1.0.3)"
29670 #: ../src/guestfs-actions.pod:7050
29671 msgid "guestfs_tar_out"
29675 #: ../src/guestfs-actions.pod:7052
29679 " guestfs_tar_out (guestfs_h *g,\n"
29680 " const char *directory,\n"
29681 " const char *tarfile);\n"
29686 #: ../src/guestfs-actions.pod:7060
29688 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29689 "C<guestfs_txz_out>."
29693 #: ../src/guestfs-actions.pod:7067
29694 msgid "guestfs_tgz_in"
29698 #: ../src/guestfs-actions.pod:7069
29702 " guestfs_tgz_in (guestfs_h *g,\n"
29703 " const char *tarball,\n"
29704 " const char *directory);\n"
29709 #: ../src/guestfs-actions.pod:7077
29710 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29714 #: ../src/guestfs-actions.pod:7083
29715 msgid "guestfs_tgz_out"
29719 #: ../src/guestfs-actions.pod:7085
29723 " guestfs_tgz_out (guestfs_h *g,\n"
29724 " const char *directory,\n"
29725 " const char *tarball);\n"
29730 #: ../src/guestfs-actions.pod:7093
29731 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29735 #: ../src/guestfs-actions.pod:7099
29736 msgid "guestfs_touch"
29740 #: ../src/guestfs-actions.pod:7101
29744 " guestfs_touch (guestfs_h *g,\n"
29745 " const char *path);\n"
29750 #: ../src/guestfs-actions.pod:7116
29751 msgid "guestfs_truncate"
29755 #: ../src/guestfs-actions.pod:7118
29759 " guestfs_truncate (guestfs_h *g,\n"
29760 " const char *path);\n"
29765 #: ../src/guestfs-actions.pod:7129
29766 msgid "guestfs_truncate_size"
29770 #: ../src/guestfs-actions.pod:7131
29774 " guestfs_truncate_size (guestfs_h *g,\n"
29775 " const char *path,\n"
29776 " int64_t size);\n"
29781 #: ../src/guestfs-actions.pod:7139
29783 "If the current file size is less than C<size> then the file is extended to "
29784 "the required size with zero bytes. This creates a sparse file (ie. disk "
29785 "blocks are not allocated for the file until you write to it). To create a "
29786 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29790 #: ../src/guestfs-actions.pod:7149
29791 msgid "guestfs_tune2fs_l"
29795 #: ../src/guestfs-actions.pod:7151
29799 " guestfs_tune2fs_l (guestfs_h *g,\n"
29800 " const char *device);\n"
29805 #: ../src/guestfs-actions.pod:7171
29806 msgid "guestfs_txz_in"
29810 #: ../src/guestfs-actions.pod:7173
29814 " guestfs_txz_in (guestfs_h *g,\n"
29815 " const char *tarball,\n"
29816 " const char *directory);\n"
29821 #: ../src/guestfs-actions.pod:7185
29822 msgid "guestfs_txz_out"
29826 #: ../src/guestfs-actions.pod:7187
29830 " guestfs_txz_out (guestfs_h *g,\n"
29831 " const char *directory,\n"
29832 " const char *tarball);\n"
29837 #: ../src/guestfs-actions.pod:7199
29838 msgid "guestfs_umask"
29842 #: ../src/guestfs-actions.pod:7201
29846 " guestfs_umask (guestfs_h *g,\n"
29852 #: ../src/guestfs-actions.pod:7217
29854 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29855 "C<guestfs_mkdir>."
29859 #: ../src/guestfs-actions.pod:7226
29860 msgid "guestfs_umount"
29864 #: ../src/guestfs-actions.pod:7228
29868 " guestfs_umount (guestfs_h *g,\n"
29869 " const char *pathordevice);\n"
29874 #: ../src/guestfs-actions.pod:7240
29875 msgid "guestfs_umount_all"
29879 #: ../src/guestfs-actions.pod:7242
29883 " guestfs_umount_all (guestfs_h *g);\n"
29888 #: ../src/guestfs-actions.pod:7253
29889 msgid "guestfs_upload"
29893 #: ../src/guestfs-actions.pod:7255
29897 " guestfs_upload (guestfs_h *g,\n"
29898 " const char *filename,\n"
29899 " const char *remotefilename);\n"
29904 #: ../src/guestfs-actions.pod:7265
29905 msgid "See also C<guestfs_download>."
29909 #: ../src/guestfs-actions.pod:7276
29910 msgid "guestfs_upload_offset"
29914 #: ../src/guestfs-actions.pod:7278
29918 " guestfs_upload_offset (guestfs_h *g,\n"
29919 " const char *filename,\n"
29920 " const char *remotefilename,\n"
29921 " int64_t offset);\n"
29926 #: ../src/guestfs-actions.pod:7294
29928 "Note that there is no limit on the amount of data that can be uploaded with "
29929 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29930 "full amount unless an error occurs."
29934 #: ../src/guestfs-actions.pod:7299
29935 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29939 #: ../src/guestfs-actions.pod:7310
29940 msgid "guestfs_utimens"
29944 #: ../src/guestfs-actions.pod:7312
29948 " guestfs_utimens (guestfs_h *g,\n"
29949 " const char *path,\n"
29950 " int64_t atsecs,\n"
29951 " int64_t atnsecs,\n"
29952 " int64_t mtsecs,\n"
29953 " int64_t mtnsecs);\n"
29958 #: ../src/guestfs-actions.pod:7341 ../src/guestfs-structs.pod:175
29959 msgid "guestfs_version"
29963 #: ../src/guestfs-actions.pod:7343
29966 " struct guestfs_version *\n"
29967 " guestfs_version (guestfs_h *g);\n"
29972 #: ../src/guestfs-actions.pod:7371
29974 "I<Note:> Don't use this call to test for availability of features. In "
29975 "enterprise distributions we backport features from later versions into "
29976 "earlier versions, making this an unreliable way to test for features. Use "
29977 "C<guestfs_available> instead."
29981 #: ../src/guestfs-actions.pod:7377
29983 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29984 "error. I<The caller must call C<guestfs_free_version> after use>."
29988 #: ../src/guestfs-actions.pod:7381
29989 msgid "(Added in 1.0.58)"
29993 #: ../src/guestfs-actions.pod:7383
29994 msgid "guestfs_vfs_label"
29998 #: ../src/guestfs-actions.pod:7385
30002 " guestfs_vfs_label (guestfs_h *g,\n"
30003 " const char *device);\n"
30008 #: ../src/guestfs-actions.pod:7394
30009 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
30013 #: ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7436
30014 msgid "(Added in 1.3.18)"
30018 #: ../src/guestfs-actions.pod:7401
30019 msgid "guestfs_vfs_type"
30023 #: ../src/guestfs-actions.pod:7403
30027 " guestfs_vfs_type (guestfs_h *g,\n"
30028 " const char *device);\n"
30033 #: ../src/guestfs-actions.pod:7420
30034 msgid "guestfs_vfs_uuid"
30038 #: ../src/guestfs-actions.pod:7422
30042 " guestfs_vfs_uuid (guestfs_h *g,\n"
30043 " const char *device);\n"
30048 #: ../src/guestfs-actions.pod:7431
30049 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
30053 #: ../src/guestfs-actions.pod:7438
30054 msgid "guestfs_vg_activate"
30058 #: ../src/guestfs-actions.pod:7440
30062 " guestfs_vg_activate (guestfs_h *g,\n"
30064 " char *const *volgroups);\n"
30069 #: ../src/guestfs-actions.pod:7457
30070 msgid "guestfs_vg_activate_all"
30074 #: ../src/guestfs-actions.pod:7459
30078 " guestfs_vg_activate_all (guestfs_h *g,\n"
30079 " int activate);\n"
30084 #: ../src/guestfs-actions.pod:7472
30085 msgid "guestfs_vgcreate"
30089 #: ../src/guestfs-actions.pod:7474
30093 " guestfs_vgcreate (guestfs_h *g,\n"
30094 " const char *volgroup,\n"
30095 " char *const *physvols);\n"
30100 #: ../src/guestfs-actions.pod:7486
30101 msgid "guestfs_vglvuuids"
30105 #: ../src/guestfs-actions.pod:7488
30109 " guestfs_vglvuuids (guestfs_h *g,\n"
30110 " const char *vgname);\n"
30115 #: ../src/guestfs-actions.pod:7495
30117 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
30118 "associate logical volumes and volume groups."
30122 #: ../src/guestfs-actions.pod:7498
30123 msgid "See also C<guestfs_vgpvuuids>."
30127 #: ../src/guestfs-actions.pod:7506
30128 msgid "guestfs_vgpvuuids"
30132 #: ../src/guestfs-actions.pod:7508
30136 " guestfs_vgpvuuids (guestfs_h *g,\n"
30137 " const char *vgname);\n"
30142 #: ../src/guestfs-actions.pod:7515
30144 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
30145 "associate physical volumes and volume groups."
30149 #: ../src/guestfs-actions.pod:7518
30150 msgid "See also C<guestfs_vglvuuids>."
30154 #: ../src/guestfs-actions.pod:7526
30155 msgid "guestfs_vgremove"
30159 #: ../src/guestfs-actions.pod:7528
30163 " guestfs_vgremove (guestfs_h *g,\n"
30164 " const char *vgname);\n"
30169 #: ../src/guestfs-actions.pod:7541
30170 msgid "guestfs_vgrename"
30174 #: ../src/guestfs-actions.pod:7543
30178 " guestfs_vgrename (guestfs_h *g,\n"
30179 " const char *volgroup,\n"
30180 " const char *newvolgroup);\n"
30185 #: ../src/guestfs-actions.pod:7554
30186 msgid "guestfs_vgs"
30190 #: ../src/guestfs-actions.pod:7556
30194 " guestfs_vgs (guestfs_h *g);\n"
30199 #: ../src/guestfs-actions.pod:7565
30200 msgid "See also C<guestfs_vgs_full>."
30204 #: ../src/guestfs-actions.pod:7573
30205 msgid "guestfs_vgs_full"
30209 #: ../src/guestfs-actions.pod:7575
30212 " struct guestfs_lvm_vg_list *\n"
30213 " guestfs_vgs_full (guestfs_h *g);\n"
30218 #: ../src/guestfs-actions.pod:7581
30220 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
30221 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
30225 #: ../src/guestfs-actions.pod:7587
30226 msgid "guestfs_vgscan"
30230 #: ../src/guestfs-actions.pod:7589
30234 " guestfs_vgscan (guestfs_h *g);\n"
30239 #: ../src/guestfs-actions.pod:7599
30240 msgid "guestfs_vguuid"
30244 #: ../src/guestfs-actions.pod:7601
30248 " guestfs_vguuid (guestfs_h *g,\n"
30249 " const char *vgname);\n"
30254 #: ../src/guestfs-actions.pod:7612
30255 msgid "guestfs_wait_ready"
30259 #: ../src/guestfs-actions.pod:7614
30263 " guestfs_wait_ready (guestfs_h *g);\n"
30268 #: ../src/guestfs-actions.pod:7617
30270 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
30275 #: ../src/guestfs-actions.pod:7624
30276 msgid "This function is a no op."
30280 #: ../src/guestfs-actions.pod:7626
30282 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
30283 "calling C<guestfs_launch> to wait for the launch to complete. However this "
30284 "is no longer necessary because C<guestfs_launch> now does the waiting."
30288 #: ../src/guestfs-actions.pod:7631
30290 "If you see any calls to this function in code then you can just remove them, "
30291 "unless you want to retain compatibility with older versions of the API."
30295 #: ../src/guestfs-actions.pod:7639
30296 msgid "guestfs_wc_c"
30300 #: ../src/guestfs-actions.pod:7641
30304 " guestfs_wc_c (guestfs_h *g,\n"
30305 " const char *path);\n"
30310 #: ../src/guestfs-actions.pod:7652
30311 msgid "guestfs_wc_l"
30315 #: ../src/guestfs-actions.pod:7654
30319 " guestfs_wc_l (guestfs_h *g,\n"
30320 " const char *path);\n"
30325 #: ../src/guestfs-actions.pod:7665
30326 msgid "guestfs_wc_w"
30330 #: ../src/guestfs-actions.pod:7667
30334 " guestfs_wc_w (guestfs_h *g,\n"
30335 " const char *path);\n"
30340 #: ../src/guestfs-actions.pod:7678
30341 msgid "guestfs_write"
30345 #: ../src/guestfs-actions.pod:7680
30349 " guestfs_write (guestfs_h *g,\n"
30350 " const char *path,\n"
30351 " const char *content,\n"
30352 " size_t content_size);\n"
30357 #: ../src/guestfs-actions.pod:7689
30358 msgid "See also C<guestfs_write_append>."
30362 #: ../src/guestfs-actions.pod:7698
30363 msgid "guestfs_write_append"
30367 #: ../src/guestfs-actions.pod:7700
30371 " guestfs_write_append (guestfs_h *g,\n"
30372 " const char *path,\n"
30373 " const char *content,\n"
30374 " size_t content_size);\n"
30379 #: ../src/guestfs-actions.pod:7709
30380 msgid "See also C<guestfs_write>."
30384 #: ../src/guestfs-actions.pod:7718
30385 msgid "guestfs_write_file"
30389 #: ../src/guestfs-actions.pod:7720
30393 " guestfs_write_file (guestfs_h *g,\n"
30394 " const char *path,\n"
30395 " const char *content,\n"
30401 #: ../src/guestfs-actions.pod:7726
30403 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
30408 #: ../src/guestfs-actions.pod:7751
30409 msgid "guestfs_zegrep"
30413 #: ../src/guestfs-actions.pod:7753
30417 " guestfs_zegrep (guestfs_h *g,\n"
30418 " const char *regex,\n"
30419 " const char *path);\n"
30424 #: ../src/guestfs-actions.pod:7770
30425 msgid "guestfs_zegrepi"
30429 #: ../src/guestfs-actions.pod:7772
30433 " guestfs_zegrepi (guestfs_h *g,\n"
30434 " const char *regex,\n"
30435 " const char *path);\n"
30440 #: ../src/guestfs-actions.pod:7789
30441 msgid "guestfs_zero"
30445 #: ../src/guestfs-actions.pod:7791
30449 " guestfs_zero (guestfs_h *g,\n"
30450 " const char *device);\n"
30455 #: ../src/guestfs-actions.pod:7805
30457 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
30458 "C<guestfs_is_zero_device>"
30462 #: ../src/guestfs-actions.pod:7817
30463 msgid "guestfs_zero_device"
30467 #: ../src/guestfs-actions.pod:7819
30471 " guestfs_zero_device (guestfs_h *g,\n"
30472 " const char *device);\n"
30477 #: ../src/guestfs-actions.pod:7823
30479 "This command writes zeroes over the entire C<device>. Compare with "
30480 "C<guestfs_zero> which just zeroes the first few blocks of a device."
30484 #: ../src/guestfs-actions.pod:7841
30485 msgid "(Added in 1.3.1)"
30489 #: ../src/guestfs-actions.pod:7843
30490 msgid "guestfs_zerofree"
30494 #: ../src/guestfs-actions.pod:7845
30498 " guestfs_zerofree (guestfs_h *g,\n"
30499 " const char *device);\n"
30504 #: ../src/guestfs-actions.pod:7864
30505 msgid "guestfs_zfgrep"
30509 #: ../src/guestfs-actions.pod:7866
30513 " guestfs_zfgrep (guestfs_h *g,\n"
30514 " const char *pattern,\n"
30515 " const char *path);\n"
30520 #: ../src/guestfs-actions.pod:7883
30521 msgid "guestfs_zfgrepi"
30525 #: ../src/guestfs-actions.pod:7885
30529 " guestfs_zfgrepi (guestfs_h *g,\n"
30530 " const char *pattern,\n"
30531 " const char *path);\n"
30536 #: ../src/guestfs-actions.pod:7902
30537 msgid "guestfs_zfile"
30541 #: ../src/guestfs-actions.pod:7904
30545 " guestfs_zfile (guestfs_h *g,\n"
30546 " const char *meth,\n"
30547 " const char *path);\n"
30552 #: ../src/guestfs-actions.pod:7909
30554 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
30559 #: ../src/guestfs-actions.pod:7921
30561 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
30566 #: ../src/guestfs-actions.pod:7929
30567 msgid "guestfs_zgrep"
30571 #: ../src/guestfs-actions.pod:7931
30575 " guestfs_zgrep (guestfs_h *g,\n"
30576 " const char *regex,\n"
30577 " const char *path);\n"
30582 #: ../src/guestfs-actions.pod:7948
30583 msgid "guestfs_zgrepi"
30587 #: ../src/guestfs-actions.pod:7950
30591 " guestfs_zgrepi (guestfs_h *g,\n"
30592 " const char *regex,\n"
30593 " const char *path);\n"
30598 #: ../src/guestfs-availability.pod:3
30603 #: ../src/guestfs-availability.pod:5
30605 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
30606 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
30607 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
30608 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
30609 "L</guestfs_aug_save> L</guestfs_aug_set>"
30613 #: ../src/guestfs-availability.pod:21
30618 #: ../src/guestfs-availability.pod:23
30619 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
30623 #: ../src/guestfs-availability.pod:26
30628 #: ../src/guestfs-availability.pod:28
30629 msgid "The following functions: L</guestfs_grub_install>"
30633 #: ../src/guestfs-availability.pod:31
30638 #: ../src/guestfs-availability.pod:33
30640 "The following functions: L</guestfs_inotify_add_watch> L</"
30641 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
30642 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30646 #: ../src/guestfs-availability.pod:41
30647 msgid "B<linuxfsuuid>"
30651 #: ../src/guestfs-availability.pod:43
30653 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
30654 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30658 #: ../src/guestfs-availability.pod:50
30659 msgid "B<linuxmodules>"
30663 #: ../src/guestfs-availability.pod:52
30664 msgid "The following functions: L</guestfs_modprobe>"
30668 #: ../src/guestfs-availability.pod:55
30669 msgid "B<linuxxattrs>"
30673 #: ../src/guestfs-availability.pod:57
30675 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
30676 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
30677 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
30678 "guestfs_setxattr>"
30682 #: ../src/guestfs-availability.pod:68
30687 #: ../src/guestfs-availability.pod:70
30689 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
30690 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
30691 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30695 #: ../src/guestfs-availability.pod:79
30700 #: ../src/guestfs-availability.pod:81
30702 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
30703 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
30704 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
30705 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
30706 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
30707 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
30708 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
30712 #: ../src/guestfs-availability.pod:104
30717 #: ../src/guestfs-availability.pod:106
30719 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
30720 "guestfs_mknod_b> L</guestfs_mknod_c>"
30724 #: ../src/guestfs-availability.pod:112
30729 #: ../src/guestfs-availability.pod:114
30730 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30734 #: ../src/guestfs-availability.pod:117
30735 msgid "B<ntfsprogs>"
30739 #: ../src/guestfs-availability.pod:119
30741 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30742 "L</guestfs_ntfsresize_size>"
30746 #: ../src/guestfs-availability.pod:124
30747 msgid "B<realpath>"
30751 #: ../src/guestfs-availability.pod:126
30752 msgid "The following functions: L</guestfs_realpath>"
30756 #: ../src/guestfs-availability.pod:129
30761 #: ../src/guestfs-availability.pod:131
30763 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
30764 "guestfs_scrub_freespace>"
30768 #: ../src/guestfs-availability.pod:136
30773 #: ../src/guestfs-availability.pod:138
30774 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30778 #: ../src/guestfs-availability.pod:142
30783 #: ../src/guestfs-availability.pod:144
30784 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30788 #: ../src/guestfs-availability.pod:148
30789 msgid "B<zerofree>"
30793 #: ../src/guestfs-availability.pod:150
30794 msgid "The following functions: L</guestfs_zerofree>"
30798 #: ../src/guestfs-structs.pod:1
30799 msgid "guestfs_int_bool"
30803 #: ../src/guestfs-structs.pod:3
30806 " struct guestfs_int_bool {\n"
30814 #: ../src/guestfs-structs.pod:8
30817 " struct guestfs_int_bool_list {\n"
30818 " uint32_t len; /* Number of elements in list. */\n"
30819 " struct guestfs_int_bool *val; /* Elements. */\n"
30825 #: ../src/guestfs-structs.pod:13
30828 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30829 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30834 #: ../src/guestfs-structs.pod:16
30835 msgid "guestfs_lvm_pv"
30839 #: ../src/guestfs-structs.pod:18
30842 " struct guestfs_lvm_pv {\n"
30843 " char *pv_name;\n"
30844 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30845 " char pv_uuid[32];\n"
30847 " uint64_t pv_size;\n"
30848 " uint64_t dev_size;\n"
30849 " uint64_t pv_free;\n"
30850 " uint64_t pv_used;\n"
30851 " char *pv_attr;\n"
30852 " int64_t pv_pe_count;\n"
30853 " int64_t pv_pe_alloc_count;\n"
30854 " char *pv_tags;\n"
30855 " uint64_t pe_start;\n"
30856 " int64_t pv_mda_count;\n"
30857 " uint64_t pv_mda_free;\n"
30863 #: ../src/guestfs-structs.pod:36
30866 " struct guestfs_lvm_pv_list {\n"
30867 " uint32_t len; /* Number of elements in list. */\n"
30868 " struct guestfs_lvm_pv *val; /* Elements. */\n"
30874 #: ../src/guestfs-structs.pod:41
30877 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30878 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30883 #: ../src/guestfs-structs.pod:44
30884 msgid "guestfs_lvm_vg"
30888 #: ../src/guestfs-structs.pod:46
30891 " struct guestfs_lvm_vg {\n"
30892 " char *vg_name;\n"
30893 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30894 " char vg_uuid[32];\n"
30896 " char *vg_attr;\n"
30897 " uint64_t vg_size;\n"
30898 " uint64_t vg_free;\n"
30899 " char *vg_sysid;\n"
30900 " uint64_t vg_extent_size;\n"
30901 " int64_t vg_extent_count;\n"
30902 " int64_t vg_free_count;\n"
30903 " int64_t max_lv;\n"
30904 " int64_t max_pv;\n"
30905 " int64_t pv_count;\n"
30906 " int64_t lv_count;\n"
30907 " int64_t snap_count;\n"
30908 " int64_t vg_seqno;\n"
30909 " char *vg_tags;\n"
30910 " int64_t vg_mda_count;\n"
30911 " uint64_t vg_mda_free;\n"
30917 #: ../src/guestfs-structs.pod:69
30920 " struct guestfs_lvm_vg_list {\n"
30921 " uint32_t len; /* Number of elements in list. */\n"
30922 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30928 #: ../src/guestfs-structs.pod:74
30931 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30932 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30937 #: ../src/guestfs-structs.pod:77
30938 msgid "guestfs_lvm_lv"
30942 #: ../src/guestfs-structs.pod:79
30945 " struct guestfs_lvm_lv {\n"
30946 " char *lv_name;\n"
30947 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
30948 " char lv_uuid[32];\n"
30949 " char *lv_attr;\n"
30950 " int64_t lv_major;\n"
30951 " int64_t lv_minor;\n"
30952 " int64_t lv_kernel_major;\n"
30953 " int64_t lv_kernel_minor;\n"
30954 " uint64_t lv_size;\n"
30955 " int64_t seg_count;\n"
30957 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30958 " float snap_percent;\n"
30959 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30960 " float copy_percent;\n"
30961 " char *move_pv;\n"
30962 " char *lv_tags;\n"
30963 " char *mirror_log;\n"
30964 " char *modules;\n"
30970 #: ../src/guestfs-structs.pod:101
30973 " struct guestfs_lvm_lv_list {\n"
30974 " uint32_t len; /* Number of elements in list. */\n"
30975 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30981 #: ../src/guestfs-structs.pod:106
30984 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30985 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30990 #: ../src/guestfs-structs.pod:111
30993 " struct guestfs_stat {\n"
30997 " int64_t nlink;\n"
31002 " int64_t blksize;\n"
31003 " int64_t blocks;\n"
31004 " int64_t atime;\n"
31005 " int64_t mtime;\n"
31006 " int64_t ctime;\n"
31012 #: ../src/guestfs-structs.pod:127
31015 " struct guestfs_stat_list {\n"
31016 " uint32_t len; /* Number of elements in list. */\n"
31017 " struct guestfs_stat *val; /* Elements. */\n"
31023 #: ../src/guestfs-structs.pod:132
31026 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
31027 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
31032 #: ../src/guestfs-structs.pod:137
31035 " struct guestfs_statvfs {\n"
31036 " int64_t bsize;\n"
31037 " int64_t frsize;\n"
31038 " int64_t blocks;\n"
31039 " int64_t bfree;\n"
31040 " int64_t bavail;\n"
31041 " int64_t files;\n"
31042 " int64_t ffree;\n"
31043 " int64_t favail;\n"
31046 " int64_t namemax;\n"
31052 #: ../src/guestfs-structs.pod:151
31055 " struct guestfs_statvfs_list {\n"
31056 " uint32_t len; /* Number of elements in list. */\n"
31057 " struct guestfs_statvfs *val; /* Elements. */\n"
31063 #: ../src/guestfs-structs.pod:156
31066 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
31067 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
31072 #: ../src/guestfs-structs.pod:159
31073 msgid "guestfs_dirent"
31077 #: ../src/guestfs-structs.pod:161
31080 " struct guestfs_dirent {\n"
31089 #: ../src/guestfs-structs.pod:167
31092 " struct guestfs_dirent_list {\n"
31093 " uint32_t len; /* Number of elements in list. */\n"
31094 " struct guestfs_dirent *val; /* Elements. */\n"
31100 #: ../src/guestfs-structs.pod:172
31103 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
31104 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
31109 #: ../src/guestfs-structs.pod:177
31112 " struct guestfs_version {\n"
31113 " int64_t major;\n"
31114 " int64_t minor;\n"
31115 " int64_t release;\n"
31122 #: ../src/guestfs-structs.pod:184
31125 " struct guestfs_version_list {\n"
31126 " uint32_t len; /* Number of elements in list. */\n"
31127 " struct guestfs_version *val; /* Elements. */\n"
31133 #: ../src/guestfs-structs.pod:189
31136 " void guestfs_free_version (struct guestfs_free_version *);\n"
31137 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
31142 #: ../src/guestfs-structs.pod:192
31143 msgid "guestfs_xattr"
31147 #: ../src/guestfs-structs.pod:194
31150 " struct guestfs_xattr {\n"
31151 " char *attrname;\n"
31152 " /* The next two fields describe a byte array. */\n"
31153 " uint32_t attrval_len;\n"
31154 " char *attrval;\n"
31160 #: ../src/guestfs-structs.pod:201
31163 " struct guestfs_xattr_list {\n"
31164 " uint32_t len; /* Number of elements in list. */\n"
31165 " struct guestfs_xattr *val; /* Elements. */\n"
31171 #: ../src/guestfs-structs.pod:206
31174 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
31175 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
31180 #: ../src/guestfs-structs.pod:209
31181 msgid "guestfs_inotify_event"
31185 #: ../src/guestfs-structs.pod:211
31188 " struct guestfs_inotify_event {\n"
31189 " int64_t in_wd;\n"
31190 " uint32_t in_mask;\n"
31191 " uint32_t in_cookie;\n"
31192 " char *in_name;\n"
31198 #: ../src/guestfs-structs.pod:218
31201 " struct guestfs_inotify_event_list {\n"
31202 " uint32_t len; /* Number of elements in list. */\n"
31203 " struct guestfs_inotify_event *val; /* Elements. */\n"
31209 #: ../src/guestfs-structs.pod:223
31212 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
31213 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
31218 #: ../src/guestfs-structs.pod:226
31219 msgid "guestfs_partition"
31223 #: ../src/guestfs-structs.pod:228
31226 " struct guestfs_partition {\n"
31227 " int32_t part_num;\n"
31228 " uint64_t part_start;\n"
31229 " uint64_t part_end;\n"
31230 " uint64_t part_size;\n"
31236 #: ../src/guestfs-structs.pod:235
31239 " struct guestfs_partition_list {\n"
31240 " uint32_t len; /* Number of elements in list. */\n"
31241 " struct guestfs_partition *val; /* Elements. */\n"
31247 #: ../src/guestfs-structs.pod:240
31250 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
31251 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
31256 #: ../src/guestfs-structs.pod:243
31257 msgid "guestfs_application"
31261 #: ../src/guestfs-structs.pod:245
31264 " struct guestfs_application {\n"
31265 " char *app_name;\n"
31266 " char *app_display_name;\n"
31267 " int32_t app_epoch;\n"
31268 " char *app_version;\n"
31269 " char *app_release;\n"
31270 " char *app_install_path;\n"
31271 " char *app_trans_path;\n"
31272 " char *app_publisher;\n"
31273 " char *app_url;\n"
31274 " char *app_source_package;\n"
31275 " char *app_summary;\n"
31276 " char *app_description;\n"
31282 #: ../src/guestfs-structs.pod:260
31285 " struct guestfs_application_list {\n"
31286 " uint32_t len; /* Number of elements in list. */\n"
31287 " struct guestfs_application *val; /* Elements. */\n"
31293 #: ../src/guestfs-structs.pod:265
31296 " void guestfs_free_application (struct guestfs_free_application *);\n"
31297 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
31302 #: ../src/guestfs.pod:5
31303 msgid "guestfs - Library for accessing and modifying virtual machine images"
31307 #: ../src/guestfs.pod:11
31310 " guestfs_h *g = guestfs_create ();\n"
31311 " guestfs_add_drive (g, \"guest.img\");\n"
31312 " guestfs_launch (g);\n"
31313 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
31314 " guestfs_touch (g, \"/hello\");\n"
31315 " guestfs_umount (g, \"/\");\n"
31316 " guestfs_close (g);\n"
31321 #: ../src/guestfs.pod:25
31323 "Libguestfs is a library for accessing and modifying guest disk images. "
31324 "Amongst the things this is good for: making batch configuration changes to "
31325 "guests, getting disk used/free statistics (see also: virt-df), migrating "
31326 "between virtualization systems (see also: virt-p2v), performing partial "
31327 "backups, performing partial guest clones, cloning guests and changing "
31328 "registry/UUID/hostname info, and much else besides."
31332 #: ../src/guestfs.pod:33
31334 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
31335 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
31336 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
31341 #: ../src/guestfs.pod:38
31343 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
31344 "what filesystem is in each LV, etc.). It can also run commands in the "
31345 "context of the guest. Also you can access filesystems over FUSE."
31349 #: ../src/guestfs.pod:43
31351 "Libguestfs is a library that can be linked with C and C++ management "
31352 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
31353 "PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
31358 #: ../src/guestfs.pod:48
31360 "You don't need to be root to use libguestfs, although obviously you do need "
31361 "enough permissions to access the disk images."
31365 #: ../src/guestfs.pod:51
31367 "Libguestfs is a large API because it can do many things. For a gentle "
31368 "introduction, please read the L</API OVERVIEW> section next."
31372 #: ../src/guestfs.pod:54
31374 "There are also some example programs in the L<guestfs-examples(3)> manual "
31379 #: ../src/guestfs.pod:57
31380 msgid "API OVERVIEW"
31384 #: ../src/guestfs.pod:59
31386 "This section provides a gentler overview of the libguestfs API. We also try "
31387 "to group API calls together, where that may not be obvious from reading "
31388 "about the individual calls in the main section of this manual."
31392 #: ../src/guestfs.pod:64
31397 #: ../src/guestfs.pod:66
31399 "Before you can use libguestfs calls, you have to create a handle. Then you "
31400 "must add at least one disk image to the handle, followed by launching the "
31401 "handle, then performing whatever operations you want, and finally closing "
31402 "the handle. By convention we use the single letter C<g> for the name of the "
31403 "handle variable, although of course you can use any name you want."
31407 #: ../src/guestfs.pod:73
31408 msgid "The general structure of all libguestfs-using programs looks like this:"
31412 #: ../src/guestfs.pod:76
31415 " guestfs_h *g = guestfs_create ();\n"
31420 #: ../src/guestfs.pod:78
31423 " /* Call guestfs_add_drive additional times if there are\n"
31424 " * multiple disk images.\n"
31426 " guestfs_add_drive (g, \"guest.img\");\n"
31431 #: ../src/guestfs.pod:83
31434 " /* Most manipulation calls won't work until you've launched\n"
31435 " * the handle 'g'. You have to do this _after_ adding drives\n"
31436 " * and _before_ other commands.\n"
31438 " guestfs_launch (g);\n"
31443 #: ../src/guestfs.pod:89
31446 " /* Now you can examine what partitions, LVs etc are available.\n"
31448 " char **partitions = guestfs_list_partitions (g);\n"
31449 " char **logvols = guestfs_lvs (g);\n"
31454 #: ../src/guestfs.pod:94
31457 " /* To access a filesystem in the image, you must mount it.\n"
31459 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
31464 #: ../src/guestfs.pod:98
31467 " /* Now you can perform filesystem actions on the guest\n"
31470 " guestfs_touch (g, \"/hello\");\n"
31475 #: ../src/guestfs.pod:103
31478 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
31479 " * it is done automatically when you close the handle. See\n"
31480 " * discussion of autosync in this page.\n"
31482 " guestfs_sync (g);\n"
31487 #: ../src/guestfs.pod:109
31490 " /* Close the handle 'g'. */\n"
31491 " guestfs_close (g);\n"
31496 #: ../src/guestfs.pod:112
31498 "The code above doesn't include any error checking. In real code you should "
31499 "check return values carefully for errors. In general all functions that "
31500 "return integers return C<-1> on error, and all functions that return "
31501 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
31502 "how to handle errors, and consult the documentation for each function call "
31503 "below to see precisely how they return error indications. See L<guestfs-"
31504 "examples(3)> for fully worked examples."
31508 #: ../src/guestfs.pod:121
31509 msgid "DISK IMAGES"
31513 #: ../src/guestfs.pod:123
31515 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
31516 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
31517 "actual block device, or simply an empty file of zeroes that you have created "
31518 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
31523 #: ../src/guestfs.pod:129
31525 "The call you should use in modern code for adding drives is L</"
31526 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
31527 "specifying that the format is raw, do:"
31531 #: ../src/guestfs.pod:133
31534 " guestfs_add_drive_opts (g, filename,\n"
31535 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31541 #: ../src/guestfs.pod:137
31542 msgid "You can add a disk read-only using:"
31546 #: ../src/guestfs.pod:139
31549 " guestfs_add_drive_opts (g, filename,\n"
31550 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
31551 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
31557 #: ../src/guestfs.pod:144
31559 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
31560 "libguestfs won't modify the file."
31564 #: ../src/guestfs.pod:147
31566 "Be extremely cautious if the disk image is in use, eg. if it is being used "
31567 "by a virtual machine. Adding it read-write will almost certainly cause disk "
31568 "corruption, but adding it read-only is safe."
31572 #: ../src/guestfs.pod:151
31574 "You must add at least one disk image, and you may add multiple disk images. "
31575 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
31576 "first one you added), C</dev/sdb> (for the second one you added), etc."
31580 #: ../src/guestfs.pod:156
31582 "Once L</guestfs_launch> has been called you cannot add any more images. You "
31583 "can call L</guestfs_list_devices> to get a list of the device names, in the "
31584 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
31588 #: ../src/guestfs.pod:161
31593 #: ../src/guestfs.pod:163
31595 "Before you can read or write files, create directories and so on in a disk "
31596 "image that contains filesystems, you have to mount those filesystems using "
31597 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
31598 "a disk image contains (for example) one partition with a filesystem on that "
31599 "partition, then you can mount it directly:"
31603 #: ../src/guestfs.pod:170
31606 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
31611 #: ../src/guestfs.pod:172
31613 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
31614 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
31615 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
31616 "that these are libguestfs virtual devices, and are nothing to do with host "
31621 #: ../src/guestfs.pod:178
31623 "If you are given a disk image and you don't know what it contains then you "
31624 "have to find out. Libguestfs can do that too: use L</"
31625 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
31626 "LVs, and either try mounting each to see what is mountable, or else examine "
31627 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
31628 "filesystems, use L</guestfs_list_filesystems>."
31632 #: ../src/guestfs.pod:186
31634 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31635 "L</INSPECTION> below). But you might find it easier to look at higher level "
31636 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31640 #: ../src/guestfs.pod:191
31642 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
31643 "several other variations of the C<guestfs_mount_*> call."
31647 #: ../src/guestfs.pod:194
31648 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31652 #: ../src/guestfs.pod:196
31654 "The majority of the libguestfs API consists of fairly low-level calls for "
31655 "accessing and modifying the files, directories, symlinks etc on mounted "
31656 "filesystems. There are over a hundred such calls which you can find listed "
31657 "in detail below in this man page, and we don't even pretend to cover them "
31658 "all in this overview."
31662 #: ../src/guestfs.pod:202
31664 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31669 #: ../src/guestfs.pod:205
31671 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31672 "the file called C<\"etc/passwd\"> then you could do:"
31676 #: ../src/guestfs.pod:208
31679 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31684 #: ../src/guestfs.pod:210
31686 "This would return C<data> as a newly allocated buffer containing the full "
31687 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31688 "or C<NULL> if there was an error."
31692 #: ../src/guestfs.pod:214
31694 "As another example, to create a top-level directory on that filesystem "
31695 "called C<\"var\"> you would do:"
31699 #: ../src/guestfs.pod:217
31702 " guestfs_mkdir (g, \"/var\");\n"
31707 #: ../src/guestfs.pod:219
31708 msgid "To create a symlink you could do:"
31712 #: ../src/guestfs.pod:221
31715 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31716 " \"/etc/rc3.d/S30portmap\");\n"
31721 #: ../src/guestfs.pod:224
31723 "Libguestfs will reject attempts to use relative paths and there is no "
31724 "concept of a current working directory."
31728 #: ../src/guestfs.pod:227
31730 "Libguestfs can return errors in many situations: for example if the "
31731 "filesystem isn't writable, or if a file or directory that you requested "
31732 "doesn't exist. If you are using the C API (documented here) you have to "
31733 "check for those error conditions after each call. (Other language bindings "
31734 "turn these errors into exceptions)."
31738 #: ../src/guestfs.pod:233
31740 "File writes are affected by the per-handle umask, set by calling L</"
31741 "guestfs_umask> and defaulting to 022. See L</UMASK>."
31745 #: ../src/guestfs.pod:236
31746 msgid "PARTITIONING"
31750 #: ../src/guestfs.pod:238
31752 "Libguestfs contains API calls to read, create and modify partition tables on "
31757 #: ../src/guestfs.pod:241
31759 "In the common case where you want to create a single partition covering the "
31760 "whole disk, you should use the L</guestfs_part_disk> call:"
31764 #: ../src/guestfs.pod:245
31767 " const char *parttype = \"mbr\";\n"
31768 " if (disk_is_larger_than_2TB)\n"
31769 " parttype = \"gpt\";\n"
31770 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31775 #: ../src/guestfs.pod:250
31777 "Obviously this effectively wipes anything that was on that disk image before."
31781 #: ../src/guestfs.pod:253
31786 #: ../src/guestfs.pod:255
31788 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
31789 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
31790 "you familiarize yourself with the concepts of physical volumes, volume "
31791 "groups and logical volumes."
31795 #: ../src/guestfs.pod:260
31797 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
31798 "tldp.org/HOWTO/LVM-HOWTO/>."
31802 #: ../src/guestfs.pod:263
31803 msgid "DOWNLOADING"
31807 #: ../src/guestfs.pod:265
31809 "Use L</guestfs_cat> to download small, text only files. This call is "
31810 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31811 "NUL (C<\\0>) characters. However the API is very simple to use."
31815 #: ../src/guestfs.pod:269
31817 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31818 "bit data, since it returns a (pointer, size) pair. However it is still "
31819 "limited to \"small\" files, less than 2 MB."
31823 #: ../src/guestfs.pod:273
31825 "L</guestfs_download> can be used to download any file, with no limits on "
31826 "content or size (even files larger than 4 GB)."
31830 #: ../src/guestfs.pod:276
31832 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31836 #: ../src/guestfs.pod:279
31841 #: ../src/guestfs.pod:281
31843 "It's often the case that you want to write a file or files to the disk image."
31847 #: ../src/guestfs.pod:284
31849 "To write a small file with fixed content, use L</guestfs_write>. To create "
31850 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
31851 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
31852 "of other functions for creating test files, for example L</guestfs_fill> and "
31853 "L</guestfs_fill_pattern>."
31857 #: ../src/guestfs.pod:290
31859 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
31860 "file content or size (even files larger than 4 GB)."
31864 #: ../src/guestfs.pod:293
31866 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31870 #: ../src/guestfs.pod:295
31872 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31873 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
31874 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
31875 "in a predictable way (eg. adding it last after all other drives) then you "
31876 "can get the device name from L</guestfs_list_devices> and mount it directly "
31877 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
31878 "portable between kernel versions, and they don't support labels or UUIDs. "
31879 "If you want to pre-build an image or you need to mount it using a label or "
31880 "UUID, use an ISO image instead."
31884 #: ../src/guestfs.pod:306
31889 #: ../src/guestfs.pod:308
31891 "There are various different commands for copying between files and devices "
31892 "and in and out of the guest filesystem. These are summarised in the table "
31897 #: ../src/guestfs.pod:314
31898 msgid "B<file> to B<file>"
31902 #: ../src/guestfs.pod:316
31904 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31905 "directories recursively."
31909 #: ../src/guestfs.pod:319
31910 msgid "B<file or device> to B<file or device>"
31914 #: ../src/guestfs.pod:321
31916 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31917 "devices in the guest."
31921 #: ../src/guestfs.pod:324
31922 msgid "Example: duplicate the contents of an LV:"
31926 #: ../src/guestfs.pod:326
31929 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31934 #: ../src/guestfs.pod:328
31936 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31937 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
31938 "guestfs_copy_size>."
31942 #: ../src/guestfs.pod:332
31943 msgid "B<file on the host> to B<file or device>"
31947 #: ../src/guestfs.pod:334
31948 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31952 #: ../src/guestfs.pod:336
31953 msgid "B<file or device> to B<file on the host>"
31957 #: ../src/guestfs.pod:338
31958 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31962 #: ../src/guestfs.pod:342
31963 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31967 #: ../src/guestfs.pod:344
31969 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
31970 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31971 "appears you can only upload and download to files. However many Un*x-like "
31972 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
31973 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
31974 "and arbitrary file descriptor N."
31978 #: ../src/guestfs.pod:352
31979 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31983 #: ../src/guestfs.pod:355
31986 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31991 #: ../src/guestfs.pod:357
31992 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31996 #: ../src/guestfs.pod:359
31999 " char devfd[64];\n"
32000 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
32001 " guestfs_tar_out (g, \"/\", devfd);\n"
32006 #: ../src/guestfs.pod:363
32007 msgid "LISTING FILES"
32011 #: ../src/guestfs.pod:365
32013 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
32014 "L<guestfish(1)>-equivalent command C<ll>)."
32018 #: ../src/guestfs.pod:368
32020 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
32021 "programs, as a flat list of strings."
32025 #: ../src/guestfs.pod:371
32027 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
32028 "directory, plus additional information about each one. It is more "
32029 "equivalent to using the L<readdir(3)> call on a local filesystem."
32033 #: ../src/guestfs.pod:375
32035 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
32039 #: ../src/guestfs.pod:378
32040 msgid "RUNNING COMMANDS"
32044 #: ../src/guestfs.pod:380
32046 "Although libguestfs is primarily an API for manipulating files inside guest "
32047 "images, we also provide some limited facilities for running commands inside "
32052 #: ../src/guestfs.pod:384
32053 msgid "There are many limitations to this:"
32057 #: ../src/guestfs.pod:390
32059 "The kernel version that the command runs under will be different from what "
32064 #: ../src/guestfs.pod:395
32066 "If the command needs to communicate with daemons, then most likely they "
32067 "won't be running."
32071 #: ../src/guestfs.pod:400
32072 msgid "The command will be running in limited memory."
32076 #: ../src/guestfs.pod:404
32078 "The network may not be available unless you enable it (see L</"
32079 "guestfs_set_network>)."
32083 #: ../src/guestfs.pod:409
32084 msgid "Only supports Linux guests (not Windows, BSD, etc)."
32088 #: ../src/guestfs.pod:413
32090 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
32094 #: ../src/guestfs.pod:418
32096 "For SELinux guests, you may need to enable SELinux and load policy first. "
32097 "See L</SELINUX> in this manpage."
32101 #: ../src/guestfs.pod:423
32103 "I<Security:> It is not safe to run commands from untrusted, possibly "
32104 "malicious guests. These commands may attempt to exploit your program by "
32105 "sending unexpected output. They could also try to exploit the Linux kernel "
32106 "or qemu provided by the libguestfs appliance. They could use the network "
32107 "provided by the libguestfs appliance to bypass ordinary network partitions "
32108 "and firewalls. They could use the elevated privileges or different SELinux "
32109 "context of your program to their advantage."
32113 #: ../src/guestfs.pod:432
32115 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
32116 "(a script which runs when the guest next boots normally), and to have this "
32117 "script run the commands you want in the normal context of the running guest, "
32118 "network security and so on. For information about other security issues, "
32119 "see L</SECURITY>."
32123 #: ../src/guestfs.pod:440
32125 "The two main API calls to run commands are L</guestfs_command> and L</"
32126 "guestfs_sh> (there are also variations)."
32130 #: ../src/guestfs.pod:443
32132 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
32133 "shell globs, redirections, etc will work."
32137 #: ../src/guestfs.pod:446
32138 msgid "CONFIGURATION FILES"
32142 #: ../src/guestfs.pod:448
32144 "To read and write configuration files in Linux guest filesystems, we "
32145 "strongly recommend using Augeas. For example, Augeas understands how to "
32146 "read and write, say, a Linux shadow password file or X.org configuration "
32147 "file, and so avoids you having to write that code."
32151 #: ../src/guestfs.pod:453
32153 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
32154 "document Augeas itself here because there is excellent documentation on the "
32155 "L<http://augeas.net/> website."
32159 #: ../src/guestfs.pod:457
32161 "If you don't want to use Augeas (you fool!) then try calling L</"
32162 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
32167 #: ../src/guestfs.pod:461
32172 #: ../src/guestfs.pod:463
32174 "We support SELinux guests. To ensure that labeling happens correctly in "
32175 "SELinux guests, you need to enable SELinux and load the guest's policy:"
32179 #: ../src/guestfs.pod:471
32180 msgid "Before launching, do:"
32184 #: ../src/guestfs.pod:473
32187 " guestfs_set_selinux (g, 1);\n"
32192 #: ../src/guestfs.pod:477
32194 "After mounting the guest's filesystem(s), load the policy. This is best "
32195 "done by running the L<load_policy(8)> command in the guest itself:"
32199 #: ../src/guestfs.pod:481
32202 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
32207 #: ../src/guestfs.pod:483
32209 "(Older versions of C<load_policy> require you to specify the name of the "
32214 #: ../src/guestfs.pod:488
32216 "Optionally, set the security context for the API. The correct security "
32217 "context to use can only be known by inspecting the guest. As an example:"
32221 #: ../src/guestfs.pod:492
32224 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
32229 #: ../src/guestfs.pod:496
32230 msgid "This will work for running commands and editing existing files."
32234 #: ../src/guestfs.pod:498
32236 "When new files are created, you may need to label them explicitly, for "
32237 "example by running the external command C<restorecon pathname>."
32241 #: ../src/guestfs.pod:502
32246 #: ../src/guestfs.pod:504
32248 "Certain calls are affected by the current file mode creation mask (the "
32249 "\"umask\"). In particular ones which create files or directories, such as "
32250 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
32251 "either the default mode that the file is created with or modifies the mode "
32256 #: ../src/guestfs.pod:510
32258 "The default umask is C<022>, so files are created with modes such as C<0644> "
32259 "and directories with C<0755>."
32263 #: ../src/guestfs.pod:513
32265 "There are two ways to avoid being affected by umask. Either set umask to 0 "
32266 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
32267 "guestfs_chmod> after creating each file or directory."
32271 #: ../src/guestfs.pod:517
32272 msgid "For more information about umask, see L<umask(2)>."
32276 #: ../src/guestfs.pod:521
32278 "Libguestfs allows you to access Linux guests which have been encrypted using "
32279 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
32280 "standard. This includes nearly all whole disk encryption systems used by "
32281 "modern Linux guests."
32285 #: ../src/guestfs.pod:527
32287 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
32288 "returns the string C<crypto_LUKS>)."
32292 #: ../src/guestfs.pod:530
32294 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
32295 "will require the passphrase!"
32299 #: ../src/guestfs.pod:533
32301 "Opening a LUKS device creates a new device mapper device called C</dev/"
32302 "mapper/mapname> (where C<mapname> is the string you supply to L</"
32303 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
32304 "from and encrypted to the underlying block device respectively."
32308 #: ../src/guestfs.pod:539
32310 "LVM volume groups on the device can be made visible by calling L</"
32311 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
32312 "(s) can now be mounted in the usual way."
32316 #: ../src/guestfs.pod:543
32318 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
32319 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
32320 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
32321 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
32322 "underlying encrypted block device)."
32326 #: ../src/guestfs.pod:550
32331 #: ../src/guestfs.pod:552
32333 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
32334 "contains operating systems, an install CD or a live CD. (These APIs used to "
32335 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
32336 "version 1.5.3 the most frequently used part of this library has been "
32337 "rewritten in C and moved into the core code)."
32341 #: ../src/guestfs.pod:559
32343 "Add all disks belonging to the unknown virtual machine and call L</"
32344 "guestfs_launch> in the usual way."
32348 #: ../src/guestfs.pod:562
32350 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
32351 "and certain heuristics, and returns a list of operating systems that were "
32352 "found. An empty list means none were found. A single element is the root "
32353 "filesystem of the operating system. For dual- or multi-boot guests, "
32354 "multiple roots can be returned, each one corresponding to a separate "
32355 "operating system. (Multi-boot virtual machines are extremely rare in the "
32356 "world of virtualization, but since this scenario can happen, we have built "
32357 "libguestfs to deal with it.)"
32361 #: ../src/guestfs.pod:571
32363 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
32364 "to get additional details about that operating system. For example, call L</"
32365 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
32366 "Windows and Linux-based operating systems respectively."
32370 #: ../src/guestfs.pod:577
32372 "Un*x-like and Linux-based operating systems usually consist of several "
32373 "filesystems which are mounted at boot time (for example, a separate boot "
32374 "partition mounted on C</boot>). The inspection rules are able to detect how "
32375 "filesystems correspond to mount points. Call "
32376 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
32377 "hash table like this example:"
32381 #: ../src/guestfs.pod:584
32384 " /boot => /dev/sda1\n"
32385 " / => /dev/vg_guest/lv_root\n"
32386 " /usr => /dev/vg_guest/lv_usr\n"
32391 #: ../src/guestfs.pod:588
32393 "The caller can then make calls to L</guestfs_mount_options> to mount the "
32394 "filesystems as suggested."
32398 #: ../src/guestfs.pod:591
32400 "Be careful to mount filesystems in the right order (eg. C</> before C</"
32401 "usr>). Sorting the keys of the hash by length, shortest first, should work."
32405 #: ../src/guestfs.pod:595
32407 "Inspection currently only works for some common operating systems. "
32408 "Contributors are welcome to send patches for other operating systems that we "
32409 "currently cannot detect."
32413 #: ../src/guestfs.pod:599
32415 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
32416 "for more details. The L</guestfs_inspect_os> function just ignores any "
32417 "encrypted devices."
32421 #: ../src/guestfs.pod:603
32423 "A note on the implementation: The call L</guestfs_inspect_os> performs "
32424 "inspection and caches the results in the guest handle. Subsequent calls to "
32425 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
32426 "read the disks. If you change the content of the guest disks, you can redo "
32427 "inspection by calling L</guestfs_inspect_os> again. (L</"
32428 "guestfs_inspect_list_applications> works a little differently from the other "
32429 "calls and does read the disks. See documentation for that function for "
32434 #: ../src/guestfs.pod:612
32435 msgid "INSPECTING INSTALL DISKS"
32439 #: ../src/guestfs.pod:614
32441 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
32446 #: ../src/guestfs.pod:617
32448 "Call L</guestfs_inspect_get_format> to return the format of the operating "
32449 "system, which currently can be C<installed> (a regular operating system) or "
32450 "C<installer> (some sort of install disk)."
32454 #: ../src/guestfs.pod:621
32456 "Further information is available about the operating system that can be "
32457 "installed using the regular inspection APIs like L</"
32458 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
32462 #: ../src/guestfs.pod:626
32464 "Some additional information specific to installer disks is also available "
32465 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
32466 "guestfs_inspect_is_multipart> calls."
32470 #: ../src/guestfs.pod:631
32471 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
32475 #: ../src/guestfs.pod:633
32477 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
32478 "ntfs-3g.org/> driver."
32482 #: ../src/guestfs.pod:636
32483 msgid "DRIVE LETTERS AND PATHS"
32487 #: ../src/guestfs.pod:638
32489 "DOS and Windows still use drive letters, and the filesystems are always "
32490 "treated as case insensitive by Windows itself, and therefore you might find "
32491 "a Windows configuration file referring to a path like C<c:\\windows"
32492 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
32493 "might be referred to as C</WINDOWS/System32>."
32497 #: ../src/guestfs.pod:644
32499 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
32500 "L</guestfs_inspect_get_drive_mappings>)"
32504 #: ../src/guestfs.pod:647
32506 "Dealing with separator characters (backslash vs forward slash) is outside "
32507 "the scope of libguestfs, but usually a simple character replacement will "
32512 #: ../src/guestfs.pod:651
32514 "To resolve the case insensitivity of paths, call L</"
32515 "guestfs_case_sensitive_path>."
32519 #: ../src/guestfs.pod:654
32520 msgid "ACCESSING THE WINDOWS REGISTRY"
32524 #: ../src/guestfs.pod:656
32526 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
32527 "files, through the library C<hivex> which is part of the libguestfs project "
32528 "although ships as a separate tarball. You have to locate and download the "
32529 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
32530 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
32531 "reg(1)> for more help on this issue."
32535 #: ../src/guestfs.pod:664
32536 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
32540 #: ../src/guestfs.pod:666
32542 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
32543 "provide something which looks like a Linux symlink. The way it tries to do "
32544 "the rewriting is described here:"
32548 #: ../src/guestfs.pod:670
32550 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
32555 #: ../src/guestfs.pod:672
32557 "The essential problem is that ntfs-3g simply does not have enough "
32558 "information to do a correct job. NTFS links can contain drive letters and "
32559 "references to external device GUIDs that ntfs-3g has no way of resolving. "
32560 "It is almost certainly the case that libguestfs callers should ignore what "
32561 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
32565 #: ../src/guestfs.pod:679
32567 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
32568 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
32569 "attribute, and read the raw reparse data from that (you can find the format "
32570 "documented in various places around the web)."
32574 #: ../src/guestfs.pod:684
32575 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
32579 #: ../src/guestfs.pod:686
32581 "There are other useful extended attributes that can be read from ntfs-3g "
32582 "filesystems (using L</guestfs_getxattr>). See:"
32586 #: ../src/guestfs.pod:689
32588 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
32592 #: ../src/guestfs.pod:691
32593 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
32597 #: ../src/guestfs.pod:693
32599 "Although we don't want to discourage you from using the C API, we will "
32600 "mention here that the same API is also available in other languages."
32604 #: ../src/guestfs.pod:696
32606 "The API is broadly identical in all supported languages. This means that "
32607 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
32608 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
32609 "OCaml. In other words, a straightforward, predictable isomorphism between "
32614 #: ../src/guestfs.pod:702
32616 "Error messages are automatically transformed into exceptions if the language "
32621 #: ../src/guestfs.pod:705
32623 "We don't try to \"object orientify\" parts of the API in OO languages, "
32624 "although contributors are welcome to write higher level APIs above what we "
32625 "provide in their favourite languages if they wish."
32629 #: ../src/guestfs.pod:711
32634 #: ../src/guestfs.pod:713
32636 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
32637 "identical to the C API. C++ classes and exceptions are not used."
32641 #: ../src/guestfs.pod:717
32646 #: ../src/guestfs.pod:719
32648 "The C# bindings are highly experimental. Please read the warnings at the "
32649 "top of C<csharp/Libguestfs.cs>."
32653 #: ../src/guestfs.pod:722
32658 #: ../src/guestfs.pod:724
32659 msgid "See L<guestfs-erlang(3)>."
32663 #: ../src/guestfs.pod:726
32668 #: ../src/guestfs.pod:728
32670 "This is the only language binding that is working but incomplete. Only "
32671 "calls which return simple integers have been bound in Haskell, and we are "
32672 "looking for help to complete this binding."
32676 #: ../src/guestfs.pod:732
32681 #: ../src/guestfs.pod:734
32683 "Full documentation is contained in the Javadoc which is distributed with "
32684 "libguestfs. For examples, see L<guestfs-java(3)>."
32688 #: ../src/guestfs.pod:737
32693 #: ../src/guestfs.pod:739
32694 msgid "See L<guestfs-ocaml(3)>."
32698 #: ../src/guestfs.pod:741
32703 #: ../src/guestfs.pod:743
32704 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32708 #: ../src/guestfs.pod:745
32713 #: ../src/guestfs.pod:747
32715 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32716 "the php-libguestfs package for your distribution."
32720 #: ../src/guestfs.pod:750
32721 msgid "The PHP binding only works correctly on 64 bit machines."
32725 #: ../src/guestfs.pod:752
32730 #: ../src/guestfs.pod:754
32731 msgid "See L<guestfs-python(3)>."
32735 #: ../src/guestfs.pod:756
32740 #: ../src/guestfs.pod:758
32741 msgid "See L<guestfs-ruby(3)>."
32745 #: ../src/guestfs.pod:760
32746 msgid "B<shell scripts>"
32750 #: ../src/guestfs.pod:762
32751 msgid "See L<guestfish(1)>."
32755 #: ../src/guestfs.pod:766
32756 msgid "LIBGUESTFS GOTCHAS"
32760 #: ../src/guestfs.pod:768
32762 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32763 "system [...] that works in the way it is documented but is counterintuitive "
32764 "and almost invites mistakes.\""
32768 #: ../src/guestfs.pod:772
32770 "Since we developed libguestfs and the associated tools, there are several "
32771 "things we would have designed differently, but are now stuck with for "
32772 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
32773 "release, you can expect these to change. Beware of them."
32777 #: ../src/guestfs.pod:780
32778 msgid "Autosync / forgetting to sync."
32782 #: ../src/guestfs.pod:782
32784 "I<Update:> Autosync is enabled by default for all API users starting from "
32785 "libguestfs 1.5.24. This section only applies to older versions."
32789 #: ../src/guestfs.pod:785
32791 "When modifying a filesystem from C or another language, you B<must> unmount "
32792 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32793 "libguestfs handle. You can also call:"
32797 #: ../src/guestfs.pod:789
32800 " guestfs_set_autosync (g, 1);\n"
32805 #: ../src/guestfs.pod:791
32807 "to have the unmount/sync done automatically for you when the handle 'g' is "
32808 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
32812 #: ../src/guestfs.pod:795
32814 "If you forget to do this, then it is entirely possible that your changes "
32815 "won't be written out, or will be partially written, or (very rarely) that "
32816 "you'll get disk corruption."
32820 #: ../src/guestfs.pod:799
32822 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
32823 "guestfish scripts that forget to sync will work just fine, which can make "
32824 "this very puzzling if you are trying to debug a problem."
32828 #: ../src/guestfs.pod:803
32829 msgid "Mount option C<-o sync> should not be the default."
32833 #: ../src/guestfs.pod:805
32835 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
32836 "However C<-o sync> does not add any reliability benefit, but does have a "
32837 "very large performance impact."
32841 #: ../src/guestfs.pod:809
32843 "The work around is to use L</guestfs_mount_options> and set the mount "
32844 "options that you actually want to use."
32848 #: ../src/guestfs.pod:812
32849 msgid "Read-only should be the default."
32853 #: ../src/guestfs.pod:814
32855 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32856 "specify I<--rw> if you want to make changes to the image."
32860 #: ../src/guestfs.pod:817
32861 msgid "This would reduce the potential to corrupt live VM images."
32865 #: ../src/guestfs.pod:819
32867 "Note that many filesystems change the disk when you just mount and unmount, "
32868 "even if you didn't perform any writes. You need to use L</"
32869 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
32873 #: ../src/guestfs.pod:823
32874 msgid "guestfish command line is hard to use."
32878 #: ../src/guestfs.pod:825
32880 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32881 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
32882 "exist, so it fails. In earlier versions of guestfish the error message was "
32883 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
32884 "we should have used C<guestfish -c command> to run commands."
32888 #: ../src/guestfs.pod:832
32889 msgid "guestfish megabyte modifiers don't work right on all commands"
32893 #: ../src/guestfs.pod:834
32895 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32896 "other modifiers). What guestfish actually does is to multiply the number "
32897 "part by the modifier part and pass the result to the C API. However this "
32898 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32899 "expecting some other unit (eg. megabytes)."
32903 #: ../src/guestfs.pod:841
32904 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
32908 #: ../src/guestfs.pod:843
32911 " lvcreate LV VG 100M\n"
32916 #: ../src/guestfs.pod:845
32918 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32919 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32920 "megabytes * megabytes) logical volume. The error message you get from this "
32921 "is also a little obscure."
32925 #: ../src/guestfs.pod:850
32927 "This could be fixed in the generator by specially marking parameters and "
32928 "return values which take bytes or other units."
32932 #: ../src/guestfs.pod:853
32933 msgid "Ambiguity between devices and paths"
32937 #: ../src/guestfs.pod:855
32939 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
32940 "sdb2>) and a similar pathname. A file might just happen to be called "
32941 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32945 #: ../src/guestfs.pod:860
32947 "In the current API we usually resolve this ambiguity by having two separate "
32948 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32949 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32950 "detecting if the path supplied begins with C</dev/>."
32954 #: ../src/guestfs.pod:866
32956 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32957 "make paths/devices into structured names. One way to do this would be to "
32958 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32959 "aspect of grub. Another way would be to use a structured type, equivalent "
32960 "to this OCaml type:"
32964 #: ../src/guestfs.pod:872
32967 " type path = Path of string | Device of int | Partition of int * int\n"
32972 #: ../src/guestfs.pod:874
32973 msgid "which would allow you to pass arguments like:"
32977 #: ../src/guestfs.pod:876
32980 " Path \"/foo/bar\"\n"
32981 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32982 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32983 " Path \"/dev/sdb2\" (* not a device *)\n"
32988 #: ../src/guestfs.pod:881
32990 "As you can see there are still problems to resolve even with this "
32991 "representation. Also consider how it might work in guestfish."
32995 #: ../src/guestfs.pod:886
32996 msgid "KEYS AND PASSPHRASES"
33000 #: ../src/guestfs.pod:888
33002 "Certain libguestfs calls take a parameter that contains sensitive key "
33003 "material, passed in as a C string."
33007 #: ../src/guestfs.pod:891
33009 "In the future we would hope to change the libguestfs implementation so that "
33010 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
33011 "swap. However this is I<not> done at the moment, because of the complexity "
33012 "of such an implementation."
33016 #: ../src/guestfs.pod:896
33018 "Therefore you should be aware that any key parameter you pass to libguestfs "
33019 "might end up being written out to the swap partition. If this is a concern, "
33020 "scrub the swap partition or don't use libguestfs on encrypted devices."
33024 #: ../src/guestfs.pod:901
33025 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
33029 #: ../src/guestfs.pod:903
33031 "All high-level libguestfs actions are synchronous. If you want to use "
33032 "libguestfs asynchronously then you must create a thread."
33036 #: ../src/guestfs.pod:906
33038 "Only use the handle from a single thread. Either use the handle exclusively "
33039 "from one thread, or provide your own mutex so that two threads cannot issue "
33040 "calls on the same handle at the same time."
33044 #: ../src/guestfs.pod:910
33046 "See the graphical program guestfs-browser for one possible architecture for "
33047 "multithreaded programs using libvirt and libguestfs."
33051 #: ../src/guestfs.pod:913
33056 #: ../src/guestfs.pod:915
33058 "Libguestfs needs a supermin appliance, which it finds by looking along an "
33063 #: ../src/guestfs.pod:918
33065 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
33066 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
33070 #: ../src/guestfs.pod:921
33072 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
33073 "to change the directories that libguestfs will search in. The value is a "
33074 "colon-separated list of paths. The current directory is I<not> searched "
33075 "unless the path contains an empty element or C<.>. For example "
33076 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
33077 "then C</usr/lib/guestfs>."
33081 #: ../src/guestfs.pod:928
33082 msgid "QEMU WRAPPERS"
33086 #: ../src/guestfs.pod:930
33088 "If you want to compile your own qemu, run qemu from a non-standard location, "
33089 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
33094 #: ../src/guestfs.pod:934
33096 "There is one important rule to remember: you I<must C<exec qemu>> as the "
33097 "last command in the shell script (so that qemu replaces the shell and "
33098 "becomes the direct child of the libguestfs-using program). If you don't do "
33099 "this, then the qemu process won't be cleaned up correctly."
33103 #: ../src/guestfs.pod:939
33105 "Here is an example of a wrapper, where I have built my own copy of qemu from "
33110 #: ../src/guestfs.pod:942
33114 " qemudir=/home/rjones/d/qemu\n"
33115 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
33120 #: ../src/guestfs.pod:946
33122 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
33123 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
33128 #: ../src/guestfs.pod:950
33131 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
33136 #: ../src/guestfs.pod:952
33138 "Note that libguestfs also calls qemu with the -help and -version options in "
33139 "order to determine features."
33143 #: ../src/guestfs.pod:955
33144 msgid "ATTACHING TO RUNNING DAEMONS"
33148 #: ../src/guestfs.pod:957
33150 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
33151 "babies. Use with caution."
33155 #: ../src/guestfs.pod:960
33157 "I<Note (2):> This section explains how to attach to a running daemon from a "
33158 "low level perspective. For most users, simply using virt tools such as "
33159 "L<guestfish(1)> with the I<--live> option will \"just work\"."
33163 #: ../src/guestfs.pod:964
33164 msgid "Using guestfs_set_attach_method"
33168 #: ../src/guestfs.pod:966
33170 "By calling L</guestfs_set_attach_method> you can change how the library "
33171 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
33172 "ARCHITECTURE> for some background)."
33176 #: ../src/guestfs.pod:970
33178 "The normal attach method is C<appliance>, where a small appliance is created "
33179 "containing the daemon, and then the library connects to this."
33183 #: ../src/guestfs.pod:973
33185 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
33186 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
33187 "daemon over the Unix domain socket."
33191 #: ../src/guestfs.pod:977
33193 "The normal use for this is to connect to a running virtual machine that "
33194 "contains a C<guestfsd> daemon, and send commands so you can read and write "
33195 "files inside the live virtual machine."
33199 #: ../src/guestfs.pod:981
33200 msgid "Using guestfs_add_domain with live flag"
33204 #: ../src/guestfs.pod:983
33206 "L</guestfs_add_domain> provides some help for getting the correct attach "
33207 "method. If you pass the C<live> option to this function, then (if the "
33208 "virtual machine is running) it will examine the libvirt XML looking for a "
33209 "virtio-serial channel to connect to:"
33213 #: ../src/guestfs.pod:989
33220 " <channel type='unix'>\n"
33221 " <source mode='bind' path='/path/to/socket'/>\n"
33222 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
33231 #: ../src/guestfs.pod:1001
33233 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
33234 "method to C<unix:/path/to/socket>."
33238 #: ../src/guestfs.pod:1004
33240 "Some of the libguestfs tools (including guestfish) support a I<--live> "
33241 "option which is passed through to L</guestfs_add_domain> thus allowing you "
33242 "to attach to and modify live virtual machines."
33246 #: ../src/guestfs.pod:1008
33248 "The virtual machine needs to have been set up beforehand so that it has the "
33249 "virtio-serial channel and so that guestfsd is running inside it."
33253 #: ../src/guestfs.pod:1012
33254 msgid "ABI GUARANTEE"
33258 #: ../src/guestfs.pod:1014
33260 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
33261 "actions as outlined in this section. Although we will deprecate some "
33262 "actions, for example if they get replaced by newer calls, we will keep the "
33263 "old actions forever. This allows you the developer to program in confidence "
33264 "against the libguestfs API."
33268 #: ../src/guestfs.pod:1020
33269 msgid "BLOCK DEVICE NAMING"
33273 #: ../src/guestfs.pod:1022
33275 "In the kernel there is now quite a profusion of schemata for naming block "
33276 "devices (in this context, by I<block device> I mean a physical or virtual "
33277 "hard drive). The original Linux IDE driver used names starting with C</dev/"
33278 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
33279 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
33280 "for the old IDE driver (particularly for SATA devices) those devices also "
33281 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
33282 "paravirtualized drivers. This has created several different naming systems, "
33283 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
33287 #: ../src/guestfs.pod:1034
33289 "As discussed above, libguestfs uses a qemu appliance running an embedded "
33290 "Linux kernel to access block devices. We can run a variety of appliances "
33291 "based on a variety of Linux kernels."
33295 #: ../src/guestfs.pod:1038
33297 "This causes a problem for libguestfs because many API calls use device or "
33298 "partition names. Working scripts and the recipe (example) scripts that we "
33299 "make available over the internet could fail if the naming scheme changes."
33303 #: ../src/guestfs.pod:1043
33305 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
33306 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
33307 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
33308 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
33312 #: ../src/guestfs.pod:1049
33314 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
33315 "L</guestfs_list_partitions> and similar calls return the true names of the "
33316 "devices and partitions as known to the appliance."
33320 #: ../src/guestfs.pod:1054
33321 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
33325 #: ../src/guestfs.pod:1056
33327 "Usually this translation is transparent. However in some (very rare) cases "
33328 "you may need to know the exact algorithm. Such cases include where you use "
33329 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
33330 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
33334 #: ../src/guestfs.pod:1062
33336 "The algorithm is applied only to I<parameters> which are known to be either "
33337 "device or partition names. Return values from functions such as L</"
33338 "guestfs_list_devices> are never changed."
33342 #: ../src/guestfs.pod:1070
33343 msgid "Is the string a parameter which is a device or partition name?"
33347 #: ../src/guestfs.pod:1074
33348 msgid "Does the string begin with C</dev/sd>?"
33352 #: ../src/guestfs.pod:1078
33354 "Does the named device exist? If so, we use that device. However if I<not> "
33355 "then we continue with this algorithm."
33359 #: ../src/guestfs.pod:1083
33360 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
33364 #: ../src/guestfs.pod:1085
33365 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
33369 #: ../src/guestfs.pod:1087
33370 msgid "If that named device exists, use it. If not, continue."
33374 #: ../src/guestfs.pod:1091
33375 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
33379 #: ../src/guestfs.pod:1093
33380 msgid "If that named device exists, use it. If not, return an error."
33384 #: ../src/guestfs.pod:1097
33385 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
33389 #: ../src/guestfs.pod:1099
33391 "Although the standard naming scheme and automatic translation is useful for "
33392 "simple programs and guestfish scripts, for larger programs it is best not to "
33393 "rely on this mechanism."
33397 #: ../src/guestfs.pod:1103
33399 "Where possible for maximum future portability programs using libguestfs "
33400 "should use these future-proof techniques:"
33404 #: ../src/guestfs.pod:1110
33406 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
33407 "device names, and then use those names directly."
33411 #: ../src/guestfs.pod:1113
33413 "Since those device names exist by definition, they will never be translated."
33417 #: ../src/guestfs.pod:1118
33419 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
33420 "filesystem labels."
33424 #: ../src/guestfs.pod:1123
33429 #: ../src/guestfs.pod:1125
33431 "This section discusses security implications of using libguestfs, "
33432 "particularly with untrusted or malicious guests or disk images."
33436 #: ../src/guestfs.pod:1128
33437 msgid "GENERAL SECURITY CONSIDERATIONS"
33441 #: ../src/guestfs.pod:1130
33443 "Be careful with any files or data that you download from a guest (by "
33444 "\"download\" we mean not just the L</guestfs_download> command but any "
33445 "command that reads files, filenames, directories or anything else from a "
33446 "disk image). An attacker could manipulate the data to fool your program "
33447 "into doing the wrong thing. Consider cases such as:"
33451 #: ../src/guestfs.pod:1140
33452 msgid "the data (file etc) not being present"
33456 #: ../src/guestfs.pod:1144
33457 msgid "being present but empty"
33461 #: ../src/guestfs.pod:1148
33462 msgid "being much larger than normal"
33466 #: ../src/guestfs.pod:1152
33467 msgid "containing arbitrary 8 bit data"
33471 #: ../src/guestfs.pod:1156
33472 msgid "being in an unexpected character encoding"
33476 #: ../src/guestfs.pod:1160
33477 msgid "containing homoglyphs."
33481 #: ../src/guestfs.pod:1164
33482 msgid "SECURITY OF MOUNTING FILESYSTEMS"
33486 #: ../src/guestfs.pod:1166
33488 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
33489 "(VFS) module can sometimes be escalated into exploits by deliberately "
33490 "creating a malicious, malformed filesystem. These exploits are very severe "
33491 "for two reasons. Firstly there are very many filesystem drivers in the "
33492 "kernel, and many of them are infrequently used and not much developer "
33493 "attention has been paid to the code. Linux userspace helps potential "
33494 "crackers by detecting the filesystem type and automatically choosing the "
33495 "right VFS driver, even if that filesystem type is obscure or unexpected for "
33496 "the administrator. Secondly, a kernel-level exploit is like a local root "
33497 "exploit (worse in some ways), giving immediate and total access to the "
33498 "system right down to the hardware level."
33502 #: ../src/guestfs.pod:1179
33504 "That explains why you should never mount a filesystem from an untrusted "
33505 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
33506 "inside a qemu virtual machine, usually running as a non-root user. The "
33507 "attacker would need to write a filesystem which first exploited the kernel, "
33508 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
33509 "the libguestfs protocol, and finally to be as serious as the host kernel "
33510 "exploit it would need to escalate its privileges to root. This multi-step "
33511 "escalation, performed by a static piece of data, is thought to be extremely "
33512 "hard to do, although we never say 'never' about security issues."
33516 #: ../src/guestfs.pod:1190
33518 "In any case callers can reduce the attack surface by forcing the filesystem "
33519 "type when mounting (use L</guestfs_mount_vfs>)."
33523 #: ../src/guestfs.pod:1193
33524 msgid "PROTOCOL SECURITY"
33528 #: ../src/guestfs.pod:1195
33530 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
33531 "defined upper message size. However a program that uses libguestfs must "
33532 "also take care - for example you can write a program that downloads a binary "
33533 "from a disk image and executes it locally, and no amount of protocol "
33534 "security will save you from the consequences."
33538 #: ../src/guestfs.pod:1201
33539 msgid "INSPECTION SECURITY"
33543 #: ../src/guestfs.pod:1203
33545 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
33546 "directly from the guest, and these could contain any 8 bit data. Callers "
33547 "should be careful to escape these before printing them to a structured file "
33548 "(for example, use HTML escaping if creating a web page)."
33552 #: ../src/guestfs.pod:1209
33554 "Guest configuration may be altered in unusual ways by the administrator of "
33555 "the virtual machine, and may not reflect reality (particularly for untrusted "
33556 "or actively malicious guests). For example we parse the hostname from "
33557 "configuration files like C</etc/sysconfig/network> that we find in the "
33558 "guest, but the guest administrator can easily manipulate these files to "
33559 "provide the wrong hostname."
33563 #: ../src/guestfs.pod:1217
33565 "The inspection API parses guest configuration using two external libraries: "
33566 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
33567 "designed to be robust in the face of malicious data, although denial of "
33568 "service attacks are still possible, for example with oversized configuration "
33573 #: ../src/guestfs.pod:1223
33574 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
33578 #: ../src/guestfs.pod:1225
33580 "Be very cautious about running commands from the guest. By running a "
33581 "command in the guest, you are giving CPU time to a binary that you do not "
33582 "control, under the same user account as the library, albeit wrapped in qemu "
33583 "virtualization. More information and alternatives can be found in the "
33584 "section L</RUNNING COMMANDS>."
33588 #: ../src/guestfs.pod:1231
33589 msgid "CVE-2010-3851"
33593 #: ../src/guestfs.pod:1233
33594 msgid "https://bugzilla.redhat.com/642934"
33598 #: ../src/guestfs.pod:1235
33600 "This security bug concerns the automatic disk format detection that qemu "
33601 "does on disk images."
33605 #: ../src/guestfs.pod:1238
33607 "A raw disk image is just the raw bytes, there is no header. Other disk "
33608 "images like qcow2 contain a special header. Qemu deals with this by looking "
33609 "for one of the known headers, and if none is found then assuming the disk "
33610 "image must be raw."
33614 #: ../src/guestfs.pod:1243
33616 "This allows a guest which has been given a raw disk image to write some "
33617 "other header. At next boot (or when the disk image is accessed by "
33618 "libguestfs) qemu would do autodetection and think the disk image format was, "
33619 "say, qcow2 based on the header written by the guest."
33623 #: ../src/guestfs.pod:1248
33625 "This in itself would not be a problem, but qcow2 offers many features, one "
33626 "of which is to allow a disk image to refer to another image (called the "
33627 "\"backing disk\"). It does this by placing the path to the backing disk "
33628 "into the qcow2 header. This path is not validated and could point to any "
33629 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
33630 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33631 "control of the attacker."
33635 #: ../src/guestfs.pod:1256
33637 "In libguestfs this is rather hard to exploit except under two circumstances:"
33641 #: ../src/guestfs.pod:1263
33642 msgid "You have enabled the network or have opened the disk in write mode."
33646 #: ../src/guestfs.pod:1267
33648 "You are also running untrusted code from the guest (see L</RUNNING "
33653 #: ../src/guestfs.pod:1272
33655 "The way to avoid this is to specify the expected disk format when adding "
33656 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
33657 "should always do this if the disk is raw format, and it's a good idea for "
33662 #: ../src/guestfs.pod:1277
33664 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33665 "format is fetched from libvirt and passed through."
33669 #: ../src/guestfs.pod:1280
33671 "For libguestfs tools, use the I<--format> command line parameter as "
33676 #: ../src/guestfs.pod:1283
33677 msgid "CONNECTION MANAGEMENT"
33681 #: ../src/guestfs.pod:1285
33682 msgid "guestfs_h *"
33686 #: ../src/guestfs.pod:1287
33688 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
33689 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
33690 "handle and release all resources used."
33694 #: ../src/guestfs.pod:1291
33696 "For information on using multiple handles and threads, see the section L</"
33697 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33701 #: ../src/guestfs.pod:1294
33702 msgid "guestfs_create"
33706 #: ../src/guestfs.pod:1296
33709 " guestfs_h *guestfs_create (void);\n"
33714 #: ../src/guestfs.pod:1298
33715 msgid "Create a connection handle."
33719 #: ../src/guestfs.pod:1300
33721 "On success this returns a non-NULL pointer to a handle. On error it returns "
33726 #: ../src/guestfs.pod:1303
33728 "You have to \"configure\" the handle after creating it. This includes "
33729 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33730 "handle at least once."
33734 #: ../src/guestfs.pod:1307
33735 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33739 #: ../src/guestfs.pod:1309
33741 "You may also want to configure error handling for the handle. See the L</"
33742 "ERROR HANDLING> section below."
33746 #: ../src/guestfs.pod:1312
33747 msgid "guestfs_close"
33751 #: ../src/guestfs.pod:1314
33754 " void guestfs_close (guestfs_h *g);\n"
33759 #: ../src/guestfs.pod:1316
33760 msgid "This closes the connection handle and frees up all resources used."
33764 #: ../src/guestfs.pod:1318
33766 "If autosync was set on the handle and the handle was launched, then this "
33767 "implicitly calls various functions to unmount filesystems and sync the "
33768 "disk. See L</guestfs_set_autosync> for more details."
33772 #: ../src/guestfs.pod:1322
33773 msgid "If a close callback was set on the handle, then it is called."
33777 #: ../src/guestfs.pod:1324
33778 msgid "ERROR HANDLING"
33782 #: ../src/guestfs.pod:1326
33784 "API functions can return errors. For example, almost all functions that "
33785 "return C<int> will return C<-1> to indicate an error."
33789 #: ../src/guestfs.pod:1329
33791 "Additional information is available for errors: an error message string and "
33792 "optionally an error number (errno) if the thing that failed was a system "
33797 #: ../src/guestfs.pod:1333
33799 "You can get at the additional information about the last error on the handle "
33800 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33801 "up an error handler with L</guestfs_set_error_handler>."
33805 #: ../src/guestfs.pod:1338
33807 "When the handle is created, a default error handler is installed which "
33808 "prints the error message string to C<stderr>. For small short-running "
33809 "command line programs it is sufficient to do:"
33813 #: ../src/guestfs.pod:1342
33816 " if (guestfs_launch (g) == -1)\n"
33817 " exit (EXIT_FAILURE);\n"
33822 #: ../src/guestfs.pod:1345
33824 "since the default error handler will ensure that an error message has been "
33825 "printed to C<stderr> before the program exits."
33829 #: ../src/guestfs.pod:1348
33831 "For other programs the caller will almost certainly want to install an "
33832 "alternate error handler or do error handling in-line like this:"
33836 #: ../src/guestfs.pod:1351
33839 " /* This disables the default behaviour of printing errors\n"
33841 " guestfs_set_error_handler (g, NULL, NULL);\n"
33846 #: ../src/guestfs.pod:1355
33849 " if (guestfs_launch (g) == -1) {\n"
33850 " /* Examine the error message and print it etc. */\n"
33851 " char *msg = guestfs_last_error (g);\n"
33852 " int errnum = guestfs_last_errno (g);\n"
33853 " fprintf (stderr, \"%s\", msg);\n"
33854 " if (errnum != 0)\n"
33855 " fprintf (stderr, \": %s\", strerror (errnum));\n"
33856 " fprintf (stderr, \"\\n\");\n"
33863 #: ../src/guestfs.pod:1366
33865 "Out of memory errors are handled differently. The default action is to call "
33866 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
33867 "guestfs_set_out_of_memory_handler>."
33871 #: ../src/guestfs.pod:1370
33873 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33874 "because there is no handle if this happens there is no way to get additional "
33875 "error information. However L</guestfs_create> is supposed to be a "
33876 "lightweight operation which can only fail because of insufficient memory (it "
33877 "returns NULL in this case)."
33881 #: ../src/guestfs.pod:1376
33882 msgid "guestfs_last_error"
33886 #: ../src/guestfs.pod:1378
33889 " const char *guestfs_last_error (guestfs_h *g);\n"
33894 #: ../src/guestfs.pod:1380
33896 "This returns the last error message that happened on C<g>. If there has not "
33897 "been an error since the handle was created, then this returns C<NULL>."
33901 #: ../src/guestfs.pod:1384
33903 "The lifetime of the returned string is until the next error occurs, or L</"
33904 "guestfs_close> is called."
33908 #: ../src/guestfs.pod:1387
33909 msgid "guestfs_last_errno"
33913 #: ../src/guestfs.pod:1389
33916 " int guestfs_last_errno (guestfs_h *g);\n"
33921 #: ../src/guestfs.pod:1391
33922 msgid "This returns the last error number (errno) that happened on C<g>."
33926 #: ../src/guestfs.pod:1393
33927 msgid "If successful, an errno integer not equal to zero is returned."
33931 #: ../src/guestfs.pod:1395
33933 "If no error, this returns 0. This call can return 0 in three situations:"
33937 #: ../src/guestfs.pod:1402
33938 msgid "There has not been any error on the handle."
33942 #: ../src/guestfs.pod:1406
33944 "There has been an error but the errno was meaningless. This corresponds to "
33945 "the case where the error did not come from a failed system call, but for "
33946 "some other reason."
33950 #: ../src/guestfs.pod:1412
33952 "There was an error from a failed system call, but for some reason the errno "
33953 "was not captured and returned. This usually indicates a bug in libguestfs."
33957 #: ../src/guestfs.pod:1418
33959 "Libguestfs tries to convert the errno from inside the applicance into a "
33960 "corresponding errno for the caller (not entirely trivial: the appliance "
33961 "might be running a completely different operating system from the library "
33962 "and error numbers are not standardized across Un*xen). If this could not be "
33963 "done, then the error is translated to C<EINVAL>. In practice this should "
33964 "only happen in very rare circumstances."
33968 #: ../src/guestfs.pod:1426
33969 msgid "guestfs_set_error_handler"
33973 #: ../src/guestfs.pod:1428
33976 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33978 " const char *msg);\n"
33979 " void guestfs_set_error_handler (guestfs_h *g,\n"
33980 " guestfs_error_handler_cb cb,\n"
33981 " void *opaque);\n"
33986 #: ../src/guestfs.pod:1435
33988 "The callback C<cb> will be called if there is an error. The parameters "
33989 "passed to the callback are an opaque data pointer and the error message "
33994 #: ../src/guestfs.pod:1439
33996 "C<errno> is not passed to the callback. To get that the callback must call "
33997 "L</guestfs_last_errno>."
34001 #: ../src/guestfs.pod:1442
34003 "Note that the message string C<msg> is freed as soon as the callback "
34004 "function returns, so if you want to stash it somewhere you must make your "
34009 #: ../src/guestfs.pod:1446
34010 msgid "The default handler prints messages on C<stderr>."
34014 #: ../src/guestfs.pod:1448
34015 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
34019 #: ../src/guestfs.pod:1450
34020 msgid "guestfs_get_error_handler"
34024 #: ../src/guestfs.pod:1452
34027 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
34028 " void **opaque_rtn);\n"
34033 #: ../src/guestfs.pod:1455
34034 msgid "Returns the current error handler callback."
34038 #: ../src/guestfs.pod:1457
34039 msgid "guestfs_set_out_of_memory_handler"
34043 #: ../src/guestfs.pod:1459
34046 " typedef void (*guestfs_abort_cb) (void);\n"
34047 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
34048 " guestfs_abort_cb);\n"
34053 #: ../src/guestfs.pod:1463
34055 "The callback C<cb> will be called if there is an out of memory situation. "
34056 "I<Note this callback must not return>."
34060 #: ../src/guestfs.pod:1466
34061 msgid "The default is to call L<abort(3)>."
34065 #: ../src/guestfs.pod:1468
34067 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
34071 #: ../src/guestfs.pod:1471
34072 msgid "guestfs_get_out_of_memory_handler"
34076 #: ../src/guestfs.pod:1473
34079 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
34084 #: ../src/guestfs.pod:1475
34085 msgid "This returns the current out of memory handler."
34089 #: ../src/guestfs.pod:1477
34094 #: ../src/guestfs.pod:1481
34099 #: ../src/guestfs.pod:1483
34104 #: ../src/guestfs.pod:1485
34105 msgid "AVAILABILITY"
34109 #: ../src/guestfs.pod:1487
34110 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
34114 #: ../src/guestfs.pod:1489
34116 "Using L</guestfs_available> you can test availability of the following "
34117 "groups of functions. This test queries the appliance to see if the "
34118 "appliance you are currently using supports the functionality."
34122 #: ../src/guestfs.pod:1494
34123 msgid "@AVAILABILITY@"
34127 #: ../src/guestfs.pod:1496
34128 msgid "GUESTFISH supported COMMAND"
34132 #: ../src/guestfs.pod:1498
34134 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
34135 "prints out the available groups and whether they are supported by this build "
34136 "of libguestfs. Note however that you have to do C<run> first."
34140 #: ../src/guestfs.pod:1503
34141 msgid "SINGLE CALLS AT COMPILE TIME"
34145 #: ../src/guestfs.pod:1505
34147 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
34148 "function, such as:"
34152 #: ../src/guestfs.pod:1508
34155 " #define LIBGUESTFS_HAVE_DD 1\n"
34160 #: ../src/guestfs.pod:1510
34161 msgid "if L</guestfs_dd> is available."
34165 #: ../src/guestfs.pod:1512
34167 "Before version 1.5.8, if you needed to test whether a single libguestfs "
34168 "function is available at compile time, we recommended using build tools such "
34169 "as autoconf or cmake. For example in autotools you could use:"
34173 #: ../src/guestfs.pod:1517
34176 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
34177 " AC_CHECK_FUNCS([guestfs_dd])\n"
34182 #: ../src/guestfs.pod:1520
34184 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
34189 #: ../src/guestfs.pod:1523
34190 msgid "SINGLE CALLS AT RUN TIME"
34194 #: ../src/guestfs.pod:1525
34196 "Testing at compile time doesn't guarantee that a function really exists in "
34197 "the library. The reason is that you might be dynamically linked against a "
34198 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
34199 "This situation unfortunately results in a segmentation fault, which is a "
34200 "shortcoming of the C dynamic linking system itself."
34204 #: ../src/guestfs.pod:1532
34206 "You can use L<dlopen(3)> to test if a function is available at run time, as "
34207 "in this example program (note that you still need the compile time check as "
34212 #: ../src/guestfs.pod:1536
34215 " #include <stdio.h>\n"
34216 " #include <stdlib.h>\n"
34217 " #include <unistd.h>\n"
34218 " #include <dlfcn.h>\n"
34219 " #include <guestfs.h>\n"
34224 #: ../src/guestfs.pod:1542
34229 " #ifdef LIBGUESTFS_HAVE_DD\n"
34231 " int has_function;\n"
34236 #: ../src/guestfs.pod:1548
34239 " /* Test if the function guestfs_dd is really available. */\n"
34240 " dl = dlopen (NULL, RTLD_LAZY);\n"
34242 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
34243 " exit (EXIT_FAILURE);\n"
34245 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
34251 #: ../src/guestfs.pod:1557
34254 " if (!has_function)\n"
34255 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
34257 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
34258 " /* Now it's safe to call\n"
34259 " guestfs_dd (g, \"foo\", \"bar\");\n"
34263 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
34270 #: ../src/guestfs.pod:1570
34272 "You may think the above is an awful lot of hassle, and it is. There are "
34273 "other ways outside of the C linking system to ensure that this kind of "
34274 "incompatibility never arises, such as using package versioning:"
34278 #: ../src/guestfs.pod:1575
34281 " Requires: libguestfs >= 1.0.80\n"
34286 #: ../src/guestfs.pod:1577
34287 msgid "CALLS WITH OPTIONAL ARGUMENTS"
34291 #: ../src/guestfs.pod:1579
34293 "A recent feature of the API is the introduction of calls which take optional "
34294 "arguments. In C these are declared 3 ways. The main way is as a call which "
34295 "takes variable arguments (ie. C<...>), as in this example:"
34299 #: ../src/guestfs.pod:1584
34302 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
34307 #: ../src/guestfs.pod:1586
34309 "Call this with a list of optional arguments, terminated by C<-1>. So to "
34310 "call with no optional arguments specified:"
34314 #: ../src/guestfs.pod:1589
34317 " guestfs_add_drive_opts (g, filename, -1);\n"
34322 #: ../src/guestfs.pod:1591
34323 msgid "With a single optional argument:"
34327 #: ../src/guestfs.pod:1593
34330 " guestfs_add_drive_opts (g, filename,\n"
34331 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
34337 #: ../src/guestfs.pod:1597
34342 #: ../src/guestfs.pod:1599
34345 " guestfs_add_drive_opts (g, filename,\n"
34346 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
34347 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
34353 #: ../src/guestfs.pod:1604
34355 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
34360 #: ../src/guestfs.pod:1607
34361 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
34365 #: ../src/guestfs.pod:1609
34367 "The second variant has the same name with the suffix C<_va>, which works the "
34368 "same way but takes a C<va_list>. See the C manual for details. For the "
34369 "example function, this is declared:"
34373 #: ../src/guestfs.pod:1613
34376 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
34377 " va_list args);\n"
34382 #: ../src/guestfs.pod:1616
34383 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
34387 #: ../src/guestfs.pod:1618
34389 "The third variant is useful where you need to construct these calls. You "
34390 "pass in a structure where you fill in the optional fields. The structure "
34391 "has a bitmask as the first element which you must set to indicate which "
34392 "fields you have filled in. For our example function the structure and call "
34397 #: ../src/guestfs.pod:1624
34400 " struct guestfs_add_drive_opts_argv {\n"
34401 " uint64_t bitmask;\n"
34403 " const char *format;\n"
34406 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
34407 " const struct guestfs_add_drive_opts_argv *optargs);\n"
34412 #: ../src/guestfs.pod:1633
34413 msgid "You could call it like this:"
34417 #: ../src/guestfs.pod:1635
34420 " struct guestfs_add_drive_opts_argv optargs = {\n"
34421 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
34422 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
34423 " .readonly = 1,\n"
34424 " .format = \"qcow2\"\n"
34430 #: ../src/guestfs.pod:1642
34433 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
34438 #: ../src/guestfs.pod:1650
34439 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
34443 #: ../src/guestfs.pod:1655
34444 msgid "You do not need to fill in all fields of the structure."
34448 #: ../src/guestfs.pod:1659
34450 "There must be a one-to-one correspondence between fields of the structure "
34451 "that are filled in, and bits set in the bitmask."
34455 #: ../src/guestfs.pod:1664
34456 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
34460 #: ../src/guestfs.pod:1666
34462 "In other languages, optional arguments are expressed in the way that is "
34463 "natural for that language. We refer you to the language-specific "
34464 "documentation for more details on that."
34468 #: ../src/guestfs.pod:1670
34469 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
34473 #: ../src/guestfs.pod:1672
34474 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
34478 #: ../src/guestfs.pod:1674
34480 "B<Note:> This section documents the generic event mechanism introduced in "
34481 "libguestfs 1.10, which you should use in new code if possible. The old "
34482 "functions C<guestfs_set_log_message_callback>, "
34483 "C<guestfs_set_subprocess_quit_callback>, "
34484 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
34485 "C<guestfs_set_progress_callback> are no longer documented in this manual "
34486 "page. Because of the ABI guarantee, the old functions continue to work."
34490 #: ../src/guestfs.pod:1683
34492 "Handles generate events when certain things happen, such as log messages "
34493 "being generated, progress messages during long-running operations, or the "
34494 "handle being closed. The API calls described below let you register a "
34495 "callback to be called when events happen. You can register multiple "
34496 "callbacks (for the same, different or overlapping sets of events), and "
34497 "individually remove callbacks. If callbacks are not removed, then they "
34498 "remain in force until the handle is closed."
34502 #: ../src/guestfs.pod:1691
34504 "In the current implementation, events are only generated synchronously: that "
34505 "means that events (and hence callbacks) can only happen while you are in the "
34506 "middle of making another libguestfs call. The callback is called in the "
34511 #: ../src/guestfs.pod:1696
34513 "Events may contain a payload, usually nothing (void), an array of 64 bit "
34514 "unsigned integers, or a message buffer. Payloads are discussed later on."
34518 #: ../src/guestfs.pod:1700
34519 msgid "CLASSES OF EVENTS"
34523 #: ../src/guestfs.pod:1704
34524 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
34528 #: ../src/guestfs.pod:1707
34530 "The callback function will be called while the handle is being closed "
34531 "(synchronously from L</guestfs_close>)."
34535 #: ../src/guestfs.pod:1710
34537 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
34538 "handles that are open when the program exits. This means that this callback "
34539 "might be called indirectly from L<exit(3)>, which can cause unexpected "
34540 "problems in higher-level languages (eg. if your HLL interpreter has already "
34541 "been cleaned up by the time this is called, and if your callback then jumps "
34542 "into some HLL function)."
34546 #: ../src/guestfs.pod:1717
34548 "If no callback is registered: the handle is closed without any callback "
34553 #: ../src/guestfs.pod:1720
34554 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
34558 #: ../src/guestfs.pod:1723
34560 "The callback function will be called when the child process quits, either "
34561 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
34562 "corresponds to a transition from any state to the CONFIG state)."
34566 #: ../src/guestfs.pod:1727 ../src/guestfs.pod:1736 ../src/guestfs.pod:1853
34567 msgid "If no callback is registered: the event is ignored."
34571 #: ../src/guestfs.pod:1729
34572 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
34576 #: ../src/guestfs.pod:1732
34578 "The callback function will be called when the child process becomes ready "
34579 "first time after it has been launched. (This corresponds to a transition "
34580 "from LAUNCHING to the READY state)."
34584 #: ../src/guestfs.pod:1738
34585 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
34589 #: ../src/guestfs.pod:1741
34591 "Some long-running operations can generate progress messages. If this "
34592 "callback is registered, then it will be called each time a progress message "
34593 "is generated (usually two seconds after the operation started, and three "
34594 "times per second thereafter until it completes, although the frequency may "
34595 "change in future versions)."
34599 #: ../src/guestfs.pod:1747
34601 "The callback receives in the payload four unsigned 64 bit numbers which are "
34602 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34606 #: ../src/guestfs.pod:1750
34608 "The units of C<total> are not defined, although for some operations C<total> "
34609 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34610 "or megabytes), and C<position> may be the portion which has been transferred."
34614 #: ../src/guestfs.pod:1755
34615 msgid "The only defined and stable parts of the API are:"
34619 #: ../src/guestfs.pod:1761
34621 "The callback can display to the user some type of progress bar or indicator "
34622 "which shows the ratio of C<position>:C<total>."
34626 #: ../src/guestfs.pod:1766
34627 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34631 #: ../src/guestfs.pod:1770
34633 "If any progress notification is sent during a call, then a final progress "
34634 "notification is always sent when C<position> = C<total> (I<unless> the call "
34635 "fails with an error)."
34639 #: ../src/guestfs.pod:1774
34641 "This is to simplify caller code, so callers can easily set the progress "
34642 "indicator to \"100%\" at the end of the operation, without requiring special "
34643 "code to detect this case."
34647 #: ../src/guestfs.pod:1780
34649 "For some calls we are unable to estimate the progress of the call, but we "
34650 "can still generate progress messages to indicate activity. This is known as "
34651 "\"pulse mode\", and is directly supported by certain progress bar "
34652 "implementations (eg. GtkProgressBar)."
34656 #: ../src/guestfs.pod:1785
34658 "For these calls, zero or more progress messages are generated with "
34659 "C<position = 0> and C<total = 1>, followed by a final message with "
34660 "C<position = total = 1>."
34664 #: ../src/guestfs.pod:1789
34666 "As noted above, if the call fails with an error then the final message may "
34667 "not be generated."
34671 #: ../src/guestfs.pod:1794
34673 "The callback also receives the procedure number (C<proc_nr>) and serial "
34674 "number (C<serial>) of the call. These are only useful for debugging "
34675 "protocol issues, and the callback can normally ignore them. The callback "
34676 "may want to print these numbers in error messages or debugging messages."
34680 #: ../src/guestfs.pod:1800
34681 msgid "If no callback is registered: progress messages are discarded."
34685 #: ../src/guestfs.pod:1802
34686 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34690 #: ../src/guestfs.pod:1805
34692 "The callback function is called whenever a log message is generated by qemu, "
34693 "the appliance kernel, guestfsd (daemon), or utility programs."
34697 #: ../src/guestfs.pod:1808
34699 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
34700 "guestfs_launch>) then additional debug messages are generated."
34704 #: ../src/guestfs.pod:1811 ../src/guestfs.pod:1825
34706 "If no callback is registered: the messages are discarded unless the verbose "
34707 "flag is set in which case they are sent to stderr. You can override the "
34708 "printing of verbose messages to stderr by setting up a callback."
34712 #: ../src/guestfs.pod:1816
34713 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34717 #: ../src/guestfs.pod:1819
34719 "The callback function is called whenever a log message is generated by the "
34720 "library part of libguestfs."
34724 #: ../src/guestfs.pod:1822
34726 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34727 "messages are generated."
34731 #: ../src/guestfs.pod:1830
34732 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34736 #: ../src/guestfs.pod:1833
34738 "The callback function is called whenever a trace message is generated. This "
34739 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34743 #: ../src/guestfs.pod:1836
34745 "If no callback is registered: the messages are sent to stderr. You can "
34746 "override the printing of trace messages to stderr by setting up a callback."
34750 #: ../src/guestfs.pod:1840
34751 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
34755 #: ../src/guestfs.pod:1843
34757 "The callback function is called whenever a libguestfs function is entered."
34761 #: ../src/guestfs.pod:1846
34763 "The payload is a string which contains the name of the function that we are "
34764 "entering (not including C<guestfs_> prefix)."
34768 #: ../src/guestfs.pod:1849
34770 "Note that libguestfs functions can call themselves, so you may see many "
34771 "events from a single call. A few libguestfs functions do not generate this "
34776 #: ../src/guestfs.pod:1857
34777 msgid "guestfs_set_event_callback"
34781 #: ../src/guestfs.pod:1859
34784 " int guestfs_set_event_callback (guestfs_h *g,\n"
34785 " guestfs_event_callback cb,\n"
34786 " uint64_t event_bitmask,\n"
34788 " void *opaque);\n"
34793 #: ../src/guestfs.pod:1865
34795 "This function registers a callback (C<cb>) for all event classes in the "
34796 "C<event_bitmask>."
34800 #: ../src/guestfs.pod:1868
34802 "For example, to register for all log message events, you could call this "
34803 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
34804 "To register a single callback for all possible classes of events, use "
34805 "C<GUESTFS_EVENT_ALL>."
34809 #: ../src/guestfs.pod:1874
34810 msgid "C<flags> should always be passed as 0."
34814 #: ../src/guestfs.pod:1876
34816 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
34817 "it for any purpose."
34821 #: ../src/guestfs.pod:1879
34823 "The return value is the event handle (an integer) which you can use to "
34824 "delete the callback (see below)."
34828 #: ../src/guestfs.pod:1882
34830 "If there is an error, this function returns C<-1>, and sets the error in the "
34831 "handle in the usual way (see L</guestfs_last_error> etc.)"
34835 #: ../src/guestfs.pod:1885
34837 "Callbacks remain in effect until they are deleted, or until the handle is "
34842 #: ../src/guestfs.pod:1888
34844 "In the case where multiple callbacks are registered for a particular event "
34845 "class, all of the callbacks are called. The order in which multiple "
34846 "callbacks are called is not defined."
34850 #: ../src/guestfs.pod:1892
34851 msgid "guestfs_delete_event_callback"
34855 #: ../src/guestfs.pod:1894
34858 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34863 #: ../src/guestfs.pod:1896
34865 "Delete a callback that was previously registered. C<event_handle> should be "
34866 "the integer that was returned by a previous call to "
34867 "C<guestfs_set_event_callback> on the same handle."
34871 #: ../src/guestfs.pod:1900
34872 msgid "guestfs_event_callback"
34876 #: ../src/guestfs.pod:1902
34879 " typedef void (*guestfs_event_callback) (\n"
34882 " uint64_t event,\n"
34883 " int event_handle,\n"
34885 " const char *buf, size_t buf_len,\n"
34886 " const uint64_t *array, size_t array_len);\n"
34891 #: ../src/guestfs.pod:1911
34893 "This is the type of the event callback function that you have to provide."
34897 #: ../src/guestfs.pod:1914
34899 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34900 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34901 "handle, and C<flags> which in the current API you should ignore."
34905 #: ../src/guestfs.pod:1918
34907 "The remaining parameters contain the event payload (if any). Each event may "
34908 "contain a payload, which usually relates to the event class, but for future "
34909 "proofing your code should be written to handle any payload for any event "
34914 #: ../src/guestfs.pod:1923
34916 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34917 "there is no message buffer). Note that this message buffer can contain "
34918 "arbitrary 8 bit data, including NUL bytes."
34922 #: ../src/guestfs.pod:1927
34924 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34925 "moment this is only used for progress messages."
34929 #: ../src/guestfs.pod:1930
34930 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34934 #: ../src/guestfs.pod:1932
34936 "One motivation for the generic event API was to allow GUI programs to "
34937 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34938 "unconditionally to C<stderr>."
34942 #: ../src/guestfs.pod:1936
34944 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34945 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34946 "messages are not events; you must capture error messages separately)."
34950 #: ../src/guestfs.pod:1941
34952 "Programs have to set up a callback to capture the classes of events of "
34957 #: ../src/guestfs.pod:1944
34961 " guestfs_set_event_callback\n"
34962 " (g, message_callback,\n"
34963 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34964 " GUESTFS_EVENT_TRACE,\n"
34965 " 0, NULL) == -1)\n"
34966 " if (eh == -1) {\n"
34967 " // handle error in the usual way\n"
34973 #: ../src/guestfs.pod:1954
34975 "The callback can then direct messages to the appropriate place. In this "
34976 "example, messages are directed to syslog:"
34980 #: ../src/guestfs.pod:1957
34984 " message_callback (\n"
34987 " uint64_t event,\n"
34988 " int event_handle,\n"
34990 " const char *buf, size_t buf_len,\n"
34991 " const uint64_t *array, size_t array_len)\n"
34993 " const int priority = LOG_USER|LOG_INFO;\n"
34994 " if (buf_len > 0)\n"
34995 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
35001 #: ../src/guestfs.pod:1972
35002 msgid "CANCELLING LONG TRANSFERS"
35006 #: ../src/guestfs.pod:1974
35008 "Some operations can be cancelled by the caller while they are in progress. "
35009 "Currently only operations that involve uploading or downloading data can be "
35010 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
35011 "parameters in the generator)."
35015 #: ../src/guestfs.pod:1979
35016 msgid "guestfs_user_cancel"
35020 #: ../src/guestfs.pod:1981
35023 " void guestfs_user_cancel (guestfs_h *g);\n"
35028 #: ../src/guestfs.pod:1983
35030 "C<guestfs_user_cancel> cancels the current upload or download operation."
35034 #: ../src/guestfs.pod:1986
35036 "Unlike most other libguestfs calls, this function is signal safe and thread "
35037 "safe. You can call it from a signal handler or from another thread, without "
35038 "needing to do any locking."
35042 #: ../src/guestfs.pod:1990
35044 "The transfer that was in progress (if there is one) will stop shortly "
35045 "afterwards, and will return an error. The errno (see L</"
35046 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
35047 "out if the operation was cancelled or failed because of another error."
35051 #: ../src/guestfs.pod:1996
35053 "No cleanup is performed: for example, if a file was being uploaded then "
35054 "after cancellation there may be a partially uploaded file. It is the "
35055 "caller's responsibility to clean up if necessary."
35059 #: ../src/guestfs.pod:2000
35060 msgid "There are two common places that you might call C<guestfs_user_cancel>."
35064 #: ../src/guestfs.pod:2002
35066 "In an interactive text-based program, you might call it from a C<SIGINT> "
35067 "signal handler so that pressing C<^C> cancels the current operation. (You "
35068 "also need to call L</guestfs_set_pgroup> so that child processes don't "
35069 "receive the C<^C> signal)."
35073 #: ../src/guestfs.pod:2007
35075 "In a graphical program, when the main thread is displaying a progress bar "
35076 "with a cancel button, wire up the cancel button to call this function."
35080 #: ../src/guestfs.pod:2011
35081 msgid "PRIVATE DATA AREA"
35085 #: ../src/guestfs.pod:2013
35087 "You can attach named pieces of private data to the libguestfs handle, fetch "
35088 "them by name, and walk over them, for the lifetime of the handle. This is "
35089 "called the private data area and is only available from the C API."
35093 #: ../src/guestfs.pod:2018
35094 msgid "To attach a named piece of data, use the following call:"
35098 #: ../src/guestfs.pod:2020
35101 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
35106 #: ../src/guestfs.pod:2022
35108 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
35109 "pointer (which can be C<NULL>). Any previous item with the same key is "
35114 #: ../src/guestfs.pod:2026
35116 "You can use any C<key> you want, but your key should I<not> start with an "
35117 "underscore character. Keys beginning with an underscore character are "
35118 "reserved for internal libguestfs purposes (eg. for implementing language "
35119 "bindings). It is recommended that you prefix the key with some unique "
35120 "string to avoid collisions with other users."
35124 #: ../src/guestfs.pod:2032
35125 msgid "To retrieve the pointer, use:"
35129 #: ../src/guestfs.pod:2034
35132 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
35137 #: ../src/guestfs.pod:2036
35139 "This function returns C<NULL> if either no data is found associated with "
35140 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
35145 #: ../src/guestfs.pod:2040
35147 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
35148 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
35149 "all. In particular, libguestfs does I<not> try to free the data when the "
35150 "handle is closed. If the data must be freed, then the caller must either "
35151 "free it before calling L</guestfs_close> or must set up a close callback to "
35152 "do it (see L</GUESTFS_EVENT_CLOSE>)."
35156 #: ../src/guestfs.pod:2047
35157 msgid "To walk over all entries, use these two functions:"
35161 #: ../src/guestfs.pod:2049
35164 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
35169 #: ../src/guestfs.pod:2051
35172 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
35177 #: ../src/guestfs.pod:2053
35179 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
35180 "not have any particular meaning -- keys are not returned in any defined "
35181 "order). A pointer to the key is returned in C<*key_rtn> and the "
35182 "corresponding data pointer is returned from the function. C<NULL> is "
35183 "returned if there are no keys stored in the handle."
35187 #: ../src/guestfs.pod:2059
35189 "C<guestfs_next_private> returns the next key, pointer pair. The return "
35190 "value of this function is also C<NULL> is there are no further entries to "
35195 #: ../src/guestfs.pod:2063
35196 msgid "Notes about walking over entries:"
35200 #: ../src/guestfs.pod:2069
35202 "You must not call C<guestfs_set_private> while walking over the entries."
35206 #: ../src/guestfs.pod:2074
35208 "The handle maintains an internal iterator which is reset when you call "
35209 "C<guestfs_first_private>. This internal iterator is invalidated when you "
35210 "call C<guestfs_set_private>."
35214 #: ../src/guestfs.pod:2080
35215 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
35219 #: ../src/guestfs.pod:2082
35222 " guestfs_set_private (g, key, NULL);\n"
35227 #: ../src/guestfs.pod:2084
35228 msgid "then that C<key> is not returned when walking."
35232 #: ../src/guestfs.pod:2088
35234 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
35235 "C<guestfs_next_private> or C<guestfs_set_private>."
35239 #: ../src/guestfs.pod:2094
35241 "The following example code shows how to print all keys and data pointers "
35242 "that are associated with the handle C<g>:"
35246 #: ../src/guestfs.pod:2097
35249 " const char *key;\n"
35250 " void *data = guestfs_first_private (g, &key);\n"
35251 " while (data != NULL)\n"
35253 " printf (\"key = %s, data = %p\\n\", key, data);\n"
35254 " data = guestfs_next_private (g, &key);\n"
35260 #: ../src/guestfs.pod:2105
35262 "More commonly you are only interested in keys that begin with an application-"
35263 "specific prefix C<foo_>. Modify the loop like so:"
35267 #: ../src/guestfs.pod:2108
35270 " const char *key;\n"
35271 " void *data = guestfs_first_private (g, &key);\n"
35272 " while (data != NULL)\n"
35274 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
35275 " printf (\"key = %s, data = %p\\n\", key, data);\n"
35276 " data = guestfs_next_private (g, &key);\n"
35282 #: ../src/guestfs.pod:2117
35284 "If you need to modify keys while walking, then you have to jump back to the "
35285 "beginning of the loop. For example, to delete all keys prefixed with "
35290 #: ../src/guestfs.pod:2121
35293 " const char *key;\n"
35296 " data = guestfs_first_private (g, &key);\n"
35297 " while (data != NULL)\n"
35299 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
35301 " guestfs_set_private (g, key, NULL);\n"
35302 " /* note that 'key' pointer is now invalid, and so is\n"
35303 " the internal iterator */\n"
35306 " data = guestfs_next_private (g, &key);\n"
35312 #: ../src/guestfs.pod:2137
35314 "Note that the above loop is guaranteed to terminate because the keys are "
35315 "being deleted, but other manipulations of keys within the loop might not "
35316 "terminate unless you also maintain an indication of which keys have been "
35321 #: ../src/guestfs.pod:2142 ../src/guestfs.pod:2147
35326 #: ../src/guestfs.pod:2144
35328 "<!-- old anchor for the next section --> <a name="
35329 "\"state_machine_and_low_level_event_api\"/>"
35333 #: ../src/guestfs.pod:2149
35334 msgid "ARCHITECTURE"
35338 #: ../src/guestfs.pod:2151
35340 "Internally, libguestfs is implemented by running an appliance (a special "
35341 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
35342 "process of the main program."
35346 #: ../src/guestfs.pod:2155
35349 " ___________________\n"
35351 " | main program |\n"
35353 " | | child process / appliance\n"
35354 " | | __________________________\n"
35356 " +-------------------+ RPC | +-----------------+ |\n"
35357 " | libguestfs <--------------------> guestfsd | |\n"
35358 " | | | +-----------------+ |\n"
35359 " \\___________________/ | | Linux kernel | |\n"
35360 " | +--^--------------+ |\n"
35361 " \\_________|________________/\n"
35363 " _______v______\n"
35366 " | disk image |\n"
35367 " \\______________/\n"
35372 #: ../src/guestfs.pod:2175
35374 "The library, linked to the main program, creates the child process and hence "
35375 "the appliance in the L</guestfs_launch> function."
35379 #: ../src/guestfs.pod:2178
35381 "Inside the appliance is a Linux kernel and a complete stack of userspace "
35382 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
35383 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
35384 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
35385 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
35386 "attached to the qemu process which translates device access by the "
35387 "appliance's Linux kernel into accesses to the image."
35391 #: ../src/guestfs.pod:2187
35393 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
35394 "Although the disk image you are attached to might also be used by some "
35395 "virtual machine, libguestfs doesn't know or care about this. (But you will "
35396 "care if both libguestfs's qemu process and your virtual machine are trying "
35397 "to update the disk image at the same time, since these usually results in "
35398 "massive disk corruption)."
35402 #: ../src/guestfs.pod:2194
35403 msgid "STATE MACHINE"
35407 #: ../src/guestfs.pod:2196
35408 msgid "libguestfs uses a state machine to model the child process:"
35412 #: ../src/guestfs.pod:2198
35416 " guestfs_create\n"
35424 " / | \\ \\ guestfs_launch\n"
35425 " / | _\\__V______\n"
35427 " / | | LAUNCHING |\n"
35428 " / | \\___________/\n"
35430 " / | guestfs_launch\n"
35432 " ______ / __|____V\n"
35433 " / \\ ------> / \\\n"
35434 " | BUSY | | READY |\n"
35435 " \\______/ <------ \\________/\n"
35440 #: ../src/guestfs.pod:2220
35442 "The normal transitions are (1) CONFIG (when the handle is created, but there "
35443 "is no child process), (2) LAUNCHING (when the child process is booting up), "
35444 "(3) alternating between READY and BUSY as commands are issued to, and "
35445 "carried out by, the child process."
35449 #: ../src/guestfs.pod:2225
35451 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
35452 "asynchronously at any time (eg. due to some internal error), and that causes "
35453 "the state to transition back to CONFIG."
35457 #: ../src/guestfs.pod:2229
35459 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
35460 "issued when in the CONFIG state."
35464 #: ../src/guestfs.pod:2232
35466 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
35467 "L</guestfs_launch> blocks until the child process is READY to accept "
35468 "commands (or until some failure or timeout). L</guestfs_launch> internally "
35469 "moves the state from CONFIG to LAUNCHING while it is running."
35473 #: ../src/guestfs.pod:2238
35475 "API actions such as L</guestfs_mount> can only be issued when in the READY "
35476 "state. These API calls block waiting for the command to be carried out (ie. "
35477 "the state to transition to BUSY and then back to READY). There are no non-"
35478 "blocking versions, and no way to issue more than one command per handle at "
35483 #: ../src/guestfs.pod:2244
35485 "Finally, the child process sends asynchronous messages back to the main "
35486 "program, such as kernel log messages. You can register a callback to "
35487 "receive these messages."
35491 #: ../src/guestfs.pod:2248
35496 #: ../src/guestfs.pod:2250
35497 msgid "APPLIANCE BOOT PROCESS"
35501 #: ../src/guestfs.pod:2252
35503 "This process has evolved and continues to evolve. The description here "
35504 "corresponds only to the current version of libguestfs and is provided for "
35505 "information only."
35509 #: ../src/guestfs.pod:2256
35511 "In order to follow the stages involved below, enable libguestfs debugging "
35512 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
35516 #: ../src/guestfs.pod:2261
35517 msgid "Create the appliance"
35521 #: ../src/guestfs.pod:2263
35523 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
35524 "initrd and the appliance."
35528 #: ../src/guestfs.pod:2266
35530 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
35531 "directory if C<TMPDIR> is set)."
35535 #: ../src/guestfs.pod:2269
35537 "For a complete description of how the appliance is created and cached, read "
35538 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
35542 #: ../src/guestfs.pod:2273
35543 msgid "Start qemu and boot the kernel"
35547 #: ../src/guestfs.pod:2275
35548 msgid "qemu is invoked to boot the kernel."
35552 #: ../src/guestfs.pod:2277
35553 msgid "Run the initrd"
35557 #: ../src/guestfs.pod:2279
35559 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
35560 "appliance. The purpose of the initrd is to load enough kernel modules in "
35561 "order that the appliance itself can be mounted and started."
35565 #: ../src/guestfs.pod:2283
35567 "The initrd is a cpio archive called C</var/tmp/.guestfs-E<lt>UIDE<gt>/"
35572 #: ../src/guestfs.pod:2286
35574 "When the initrd has started you will see messages showing that kernel "
35575 "modules are being loaded, similar to this:"
35579 #: ../src/guestfs.pod:2289
35582 " febootstrap: ext2 mini initrd starting up\n"
35583 " febootstrap: mounting /sys\n"
35584 " febootstrap: internal insmod libcrc32c.ko\n"
35585 " febootstrap: internal insmod crc32c-intel.ko\n"
35590 #: ../src/guestfs.pod:2294
35591 msgid "Find and mount the appliance device"
35595 #: ../src/guestfs.pod:2296
35597 "The appliance is a sparse file containing an ext2 filesystem which contains "
35598 "a familiar (although reduced in size) Linux operating system. It would "
35599 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
35603 #: ../src/guestfs.pod:2300
35605 "The regular disks being inspected by libguestfs are the first devices "
35606 "exposed by qemu (eg. as C</dev/vda>)."
35610 #: ../src/guestfs.pod:2303
35612 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
35613 "there was only one regular disk)."
35617 #: ../src/guestfs.pod:2306
35619 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
35620 "and switch root into the appliance, and run C</init> from the appliance."
35624 #: ../src/guestfs.pod:2310
35625 msgid "If this works successfully you will see messages such as:"
35629 #: ../src/guestfs.pod:2312
35632 " febootstrap: picked /sys/block/vdb/dev as root device\n"
35633 " febootstrap: creating /dev/root as block special 252:16\n"
35634 " febootstrap: mounting new root on /root\n"
35635 " febootstrap: chroot\n"
35636 " Starting /init script ...\n"
35641 #: ../src/guestfs.pod:2318
35643 "Note that C<Starting /init script ...> indicates that the appliance's init "
35644 "script is now running."
35648 #: ../src/guestfs.pod:2321
35649 msgid "Initialize the appliance"
35653 #: ../src/guestfs.pod:2323
35655 "The appliance itself now initializes itself. This involves starting certain "
35656 "processes like C<udev>, possibly printing some debug information, and "
35657 "finally running the daemon (C<guestfsd>)."
35661 #: ../src/guestfs.pod:2327
35666 #: ../src/guestfs.pod:2329
35668 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
35673 #: ../src/guestfs.pod:2332
35676 " verbose daemon enabled\n"
35681 #: ../src/guestfs.pod:2334
35683 "The daemon expects to see a named virtio-serial port exposed by qemu and "
35684 "connected on the other end to the library."
35688 #: ../src/guestfs.pod:2337
35690 "The daemon connects to this port (and hence to the library) and sends a four "
35691 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
35692 "protocol (see below)."
35696 #: ../src/guestfs.pod:2343
35697 msgid "COMMUNICATION PROTOCOL"
35701 #: ../src/guestfs.pod:2345
35703 "Don't rely on using this protocol directly. This section documents how it "
35704 "currently works, but it may change at any time."
35708 #: ../src/guestfs.pod:2348
35710 "The protocol used to talk between the library and the daemon running inside "
35711 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
35712 "1014, RFC 1832, RFC 4506)."
35716 #: ../src/guestfs.pod:2352
35718 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
35719 "this file is automatically generated)."
35723 #: ../src/guestfs.pod:2355
35725 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
35726 "and C<FileOut> parameters, which are handled with very simple request/reply "
35727 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
35728 "parameters, which use the same request and reply messages, but they may also "
35729 "be followed by files sent using a chunked encoding."
35733 #: ../src/guestfs.pod:2362
35734 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
35738 #: ../src/guestfs.pod:2364
35739 msgid "For ordinary functions, the request message is:"
35743 #: ../src/guestfs.pod:2366
35746 " total length (header + arguments,\n"
35747 " but not including the length word itself)\n"
35748 " struct guestfs_message_header (encoded as XDR)\n"
35749 " struct guestfs_<foo>_args (encoded as XDR)\n"
35754 #: ../src/guestfs.pod:2371
35756 "The total length field allows the daemon to allocate a fixed size buffer "
35757 "into which it slurps the rest of the message. As a result, the total length "
35758 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
35759 "effective size of any request is limited to somewhere under this size."
35763 #: ../src/guestfs.pod:2377
35765 "Note also that many functions don't take any arguments, in which case the "
35766 "C<guestfs_I<foo>_args> is completely omitted."
35770 #: ../src/guestfs.pod:2380
35772 "The header contains the procedure number (C<guestfs_proc>) which is how the "
35773 "receiver knows what type of args structure to expect, or none at all."
35777 #: ../src/guestfs.pod:2384
35779 "For functions that take optional arguments, the optional arguments are "
35780 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
35781 "arguments. A bitmask in the header indicates which optional arguments are "
35782 "meaningful. The bitmask is also checked to see if it contains bits set "
35783 "which the daemon does not know about (eg. if more optional arguments were "
35784 "added in a later version of the library), and this causes the call to be "
35789 #: ../src/guestfs.pod:2392
35790 msgid "The reply message for ordinary functions is:"
35794 #: ../src/guestfs.pod:2394
35797 " total length (header + ret,\n"
35798 " but not including the length word itself)\n"
35799 " struct guestfs_message_header (encoded as XDR)\n"
35800 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35805 #: ../src/guestfs.pod:2399
35807 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
35808 "functions that return no formal return values."
35812 #: ../src/guestfs.pod:2402
35814 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35818 #: ../src/guestfs.pod:2405
35820 "In the case of an error, a flag is set in the header, and the reply message "
35821 "is slightly changed:"
35825 #: ../src/guestfs.pod:2408
35828 " total length (header + error,\n"
35829 " but not including the length word itself)\n"
35830 " struct guestfs_message_header (encoded as XDR)\n"
35831 " struct guestfs_message_error (encoded as XDR)\n"
35836 #: ../src/guestfs.pod:2413
35838 "The C<guestfs_message_error> structure contains the error message as a "
35843 #: ../src/guestfs.pod:2416
35844 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35848 #: ../src/guestfs.pod:2418
35850 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
35851 "The normal request message is sent (see above). However this is followed by "
35852 "a sequence of file chunks."
35856 #: ../src/guestfs.pod:2422
35859 " total length (header + arguments,\n"
35860 " but not including the length word itself,\n"
35861 " and not including the chunks)\n"
35862 " struct guestfs_message_header (encoded as XDR)\n"
35863 " struct guestfs_<foo>_args (encoded as XDR)\n"
35864 " sequence of chunks for FileIn param #0\n"
35865 " sequence of chunks for FileIn param #1 etc.\n"
35870 #: ../src/guestfs.pod:2430
35871 msgid "The \"sequence of chunks\" is:"
35875 #: ../src/guestfs.pod:2432
35878 " length of chunk (not including length word itself)\n"
35879 " struct guestfs_chunk (encoded as XDR)\n"
35880 " length of chunk\n"
35881 " struct guestfs_chunk (encoded as XDR)\n"
35883 " length of chunk\n"
35884 " struct guestfs_chunk (with data.data_len == 0)\n"
35889 #: ../src/guestfs.pod:2440
35891 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
35892 "is set in the final chunk to indicate either successful completion or early "
35897 #: ../src/guestfs.pod:2444
35899 "At time of writing there are no functions that have more than one FileIn "
35900 "parameter. However this is (theoretically) supported, by sending the "
35901 "sequence of chunks for each FileIn parameter one after another (from left to "
35906 #: ../src/guestfs.pod:2449
35908 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35909 "transfer. The library does this by sending a chunk with a special flag set "
35910 "to indicate cancellation. When the daemon sees this, it cancels the whole "
35911 "RPC, does I<not> send any reply, and goes back to reading the next request."
35915 #: ../src/guestfs.pod:2455
35917 "The daemon may also cancel. It does this by writing a special word "
35918 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
35919 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35920 "cancel chunk). The special word is chosen so that even if cancellation "
35921 "happens right at the end of the transfer (after the library has finished "
35922 "writing and has started listening for the reply), the \"spurious\" cancel "
35923 "flag will not be confused with the reply message."
35927 #: ../src/guestfs.pod:2464
35929 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35930 "limit), and also files where the size is not known in advance (eg. from "
35931 "pipes or sockets). However the chunks are rather small "
35932 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35933 "to keep much in memory."
35937 #: ../src/guestfs.pod:2470
35938 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35942 #: ../src/guestfs.pod:2472
35944 "The protocol for FileOut parameters is exactly the same as for FileIn "
35945 "parameters, but with the roles of daemon and library reversed."
35949 #: ../src/guestfs.pod:2475
35952 " total length (header + ret,\n"
35953 " but not including the length word itself,\n"
35954 " and not including the chunks)\n"
35955 " struct guestfs_message_header (encoded as XDR)\n"
35956 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35957 " sequence of chunks for FileOut param #0\n"
35958 " sequence of chunks for FileOut param #1 etc.\n"
35963 #: ../src/guestfs.pod:2483
35964 msgid "INITIAL MESSAGE"
35968 #: ../src/guestfs.pod:2485
35970 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35971 "which indicates that the guest and daemon is alive. This is what L</"
35972 "guestfs_launch> waits for."
35976 #: ../src/guestfs.pod:2489
35977 msgid "PROGRESS NOTIFICATION MESSAGES"
35981 #: ../src/guestfs.pod:2491
35983 "The daemon may send progress notification messages at any time. These are "
35984 "distinguished by the normal length word being replaced by "
35985 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35989 #: ../src/guestfs.pod:2495
35991 "The library turns them into progress callbacks (see L</"
35992 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
35997 #: ../src/guestfs.pod:2499
35999 "The daemon self-limits the frequency of progress messages it sends (see "
36000 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
36005 #: ../src/guestfs.pod:2503
36006 msgid "LIBGUESTFS VERSION NUMBERS"
36010 #: ../src/guestfs.pod:2505
36012 "Since April 2010, libguestfs has started to make separate development and "
36013 "stable releases, along with corresponding branches in our git repository. "
36014 "These separate releases can be identified by version number:"
36018 #: ../src/guestfs.pod:2510
36021 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
36022 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
36028 " | `-------- sub-version\n"
36030 " `------ always '1' because we don't change the ABI\n"
36035 #: ../src/guestfs.pod:2521
36036 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
36040 #: ../src/guestfs.pod:2523
36042 "As time passes we cherry pick fixes from the development branch and backport "
36043 "those into the stable branch, the effect being that the stable branch should "
36044 "get more stable and less buggy over time. So the stable releases are ideal "
36045 "for people who don't need new features but would just like the software to "
36050 #: ../src/guestfs.pod:2529
36051 msgid "Our criteria for backporting changes are:"
36055 #: ../src/guestfs.pod:2535
36057 "Documentation changes which don't affect any code are backported unless the "
36058 "documentation refers to a future feature which is not in stable."
36062 #: ../src/guestfs.pod:2541
36064 "Bug fixes which are not controversial, fix obvious problems, and have been "
36065 "well tested are backported."
36069 #: ../src/guestfs.pod:2546
36071 "Simple rearrangements of code which shouldn't affect how it works get "
36072 "backported. This is so that the code in the two branches doesn't get too "
36073 "far out of step, allowing us to backport future fixes more easily."
36077 #: ../src/guestfs.pod:2552
36079 "We I<don't> backport new features, new APIs, new tools etc, except in one "
36080 "exceptional case: the new feature is required in order to implement an "
36081 "important bug fix."
36085 #: ../src/guestfs.pod:2558
36087 "A new stable branch starts when we think the new features in development are "
36088 "substantial and compelling enough over the current stable branch to warrant "
36089 "it. When that happens we create new stable and development versions 1.N.0 "
36090 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
36091 "stable at this point, but by backporting fixes from development, that branch "
36092 "will stabilize over time."
36096 #: ../src/guestfs.pod:2566
36097 msgid "EXTENDING LIBGUESTFS"
36101 #: ../src/guestfs.pod:2568
36102 msgid "ADDING A NEW API ACTION"
36106 #: ../src/guestfs.pod:2570
36108 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
36109 "documentation) are generated, and this makes it easy to extend the "
36114 #: ../src/guestfs.pod:2574
36115 msgid "To add a new API action there are two changes:"
36119 #: ../src/guestfs.pod:2580
36121 "You need to add a description of the call (name, parameters, return type, "
36122 "tests, documentation) to C<generator/generator_actions.ml>."
36126 #: ../src/guestfs.pod:2583
36128 "There are two sorts of API action, depending on whether the call goes "
36129 "through to the daemon in the appliance, or is serviced entirely by the "
36130 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
36131 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
36132 "an example of the latter, since a trace flag is maintained in the handle and "
36133 "all tracing is done on the library side."
36137 #: ../src/guestfs.pod:2591
36139 "Most new actions are of the first type, and get added to the "
36140 "C<daemon_functions> list. Each function has a unique procedure number used "
36141 "in the RPC protocol which is assigned to that action when we publish "
36142 "libguestfs and cannot be reused. Take the latest procedure number and "
36147 #: ../src/guestfs.pod:2597
36149 "For library-only actions of the second type, add to the "
36150 "C<non_daemon_functions> list. Since these functions are serviced by the "
36151 "library and do not travel over the RPC mechanism to the daemon, these "
36152 "functions do not need a procedure number, and so the procedure number is set "
36157 #: ../src/guestfs.pod:2605
36158 msgid "Implement the action (in C):"
36162 #: ../src/guestfs.pod:2607
36164 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
36165 "C<daemon/> directory."
36169 #: ../src/guestfs.pod:2610
36171 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
36172 "(note: double underscore) in the C<src/> directory."
36176 #: ../src/guestfs.pod:2613
36177 msgid "In either case, use another function as an example of what to do."
36181 #: ../src/guestfs.pod:2617
36182 msgid "After making these changes, use C<make> to compile."
36186 #: ../src/guestfs.pod:2619
36188 "Note that you don't need to implement the RPC, language bindings, manual "
36189 "pages or anything else. It's all automatically generated from the OCaml "
36194 #: ../src/guestfs.pod:2623
36195 msgid "ADDING TESTS FOR AN API ACTION"
36199 #: ../src/guestfs.pod:2625
36201 "You can supply zero or as many tests as you want per API call. The tests "
36202 "can either be added as part of the API description (C<generator/"
36203 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
36204 "into C<regressions/>. Note that adding a script to C<regressions/> is "
36205 "slower, so if possible use the first method."
36209 #: ../src/guestfs.pod:2631
36211 "The following describes the test environment used when you add an API test "
36212 "in C<generator_actions.ml>."
36216 #: ../src/guestfs.pod:2634
36217 msgid "The test environment has 4 block devices:"
36221 #: ../src/guestfs.pod:2638
36222 msgid "C</dev/sda> 500MB"
36226 #: ../src/guestfs.pod:2640
36227 msgid "General block device for testing."
36231 #: ../src/guestfs.pod:2642
36232 msgid "C</dev/sdb> 50MB"
36236 #: ../src/guestfs.pod:2644
36238 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
36243 #: ../src/guestfs.pod:2647
36244 msgid "C</dev/sdc> 10MB"
36248 #: ../src/guestfs.pod:2649
36249 msgid "Used in a few tests where two block devices are needed."
36253 #: ../src/guestfs.pod:2651
36254 msgid "C</dev/sdd>"
36258 #: ../src/guestfs.pod:2653
36259 msgid "ISO with fixed content (see C<images/test.iso>)."
36263 #: ../src/guestfs.pod:2657
36265 "To be able to run the tests in a reasonable amount of time, the libguestfs "
36266 "appliance and block devices are reused between tests. So don't try testing "
36267 "L</guestfs_kill_subprocess> :-x"
36271 #: ../src/guestfs.pod:2661
36273 "Each test starts with an initial scenario, selected using one of the "
36274 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
36275 "initialize the disks mentioned above in a particular way as documented in "
36276 "C<generator_types.ml>. You should not assume anything about the previous "
36277 "contents of other disks that are not initialized."
36281 #: ../src/guestfs.pod:2667
36283 "You can add a prerequisite clause to any individual test. This is a run-"
36284 "time check, which, if it fails, causes the test to be skipped. Useful if "
36285 "testing a command which might not work on all variations of libguestfs "
36286 "builds. A test that has prerequisite of C<Always> means to run "
36291 #: ../src/guestfs.pod:2673
36293 "In addition, packagers can skip individual tests by setting environment "
36294 "variables before running C<make check>."
36298 #: ../src/guestfs.pod:2676
36301 " SKIP_TEST_<CMD>_<NUM>=1\n"
36306 #: ../src/guestfs.pod:2678
36307 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
36311 #: ../src/guestfs.pod:2680
36316 #: ../src/guestfs.pod:2682
36319 " SKIP_TEST_<CMD>=1\n"
36324 #: ../src/guestfs.pod:2684
36325 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
36329 #: ../src/guestfs.pod:2686
36330 msgid "Packagers can run only certain tests by setting for example:"
36334 #: ../src/guestfs.pod:2688
36337 " TEST_ONLY=\"vfs_type zerofree\"\n"
36342 #: ../src/guestfs.pod:2690
36344 "See C<capitests/tests.c> for more details of how these environment variables "
36349 #: ../src/guestfs.pod:2693
36350 msgid "DEBUGGING NEW API ACTIONS"
36354 #: ../src/guestfs.pod:2695
36355 msgid "Test new actions work before submitting them."
36359 #: ../src/guestfs.pod:2697
36360 msgid "You can use guestfish to try out new commands."
36364 #: ../src/guestfs.pod:2699
36366 "Debugging the daemon is a problem because it runs inside a minimal "
36367 "environment. However you can fprintf messages in the daemon to stderr, and "
36368 "they will show up if you use C<guestfish -v>."
36372 #: ../src/guestfs.pod:2703
36373 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
36377 #: ../src/guestfs.pod:2705
36379 "Our C source code generally adheres to some basic code-formatting "
36380 "conventions. The existing code base is not totally consistent on this "
36381 "front, but we do prefer that contributed code be formatted similarly. In "
36382 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
36383 "indentation level, and other than that, follow the K&R style."
36387 #: ../src/guestfs.pod:2711
36389 "If you use Emacs, add the following to one of one of your start-up files (e."
36390 "g., ~/.emacs), to help ensure that you get indentation right:"
36394 #: ../src/guestfs.pod:2714
36397 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
36398 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
36399 " (add-hook 'find-file-hook\n"
36400 " '(lambda () (if (and buffer-file-name\n"
36401 " (string-match \"/libguestfs\\\\>\"\n"
36402 " (buffer-file-name))\n"
36403 " (not (string-equal mode-name \"Change Log\"))\n"
36404 " (not (string-equal mode-name \"Makefile\")))\n"
36405 " (setq indent-tabs-mode nil))))\n"
36410 #: ../src/guestfs.pod:2724
36413 " ;;; When editing C sources in libguestfs, use this style.\n"
36414 " (defun libguestfs-c-mode ()\n"
36415 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
36417 " (c-set-style \"K&R\")\n"
36418 " (setq c-indent-level 2)\n"
36419 " (setq c-basic-offset 2))\n"
36420 " (add-hook 'c-mode-hook\n"
36421 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
36422 " (buffer-file-name))\n"
36423 " (libguestfs-c-mode))))\n"
36428 #: ../src/guestfs.pod:2736
36429 msgid "Enable warnings when compiling (and fix any problems this finds):"
36433 #: ../src/guestfs.pod:2739
36436 " ./configure --enable-gcc-warnings\n"
36441 #: ../src/guestfs.pod:2741
36442 msgid "Useful targets are:"
36446 #: ../src/guestfs.pod:2743
36449 " make syntax-check # checks the syntax of the C code\n"
36450 " make check # runs the test suite\n"
36455 #: ../src/guestfs.pod:2746
36456 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
36460 #: ../src/guestfs.pod:2748
36462 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
36463 "which are used to do shell quoting."
36467 #: ../src/guestfs.pod:2753
36472 #: ../src/guestfs.pod:2755
36474 "Simple shell quoted string. Any spaces or other shell characters are "
36479 #: ../src/guestfs.pod:2758
36484 #: ../src/guestfs.pod:2760
36486 "Same as C<%Q> except the string is treated as a path which is prefixed by "
36491 #: ../src/guestfs.pod:2767
36494 " asprintf (&cmd, \"cat %R\", path);\n"
36499 #: ../src/guestfs.pod:2769
36500 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
36504 #: ../src/guestfs.pod:2771
36506 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
36507 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
36508 "they are not passed via the shell (instead, straight to exec). You probably "
36509 "want to use the C<sysroot_path()> function however."
36513 #: ../src/guestfs.pod:2777
36514 msgid "SUBMITTING YOUR NEW API ACTIONS"
36518 #: ../src/guestfs.pod:2779
36520 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
36521 "libguestfs> and CC to L<rjones@redhat.com>."
36525 #: ../src/guestfs.pod:2783
36526 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
36530 #: ../src/guestfs.pod:2785
36531 msgid "We support i18n (gettext anyhow) in the library."
36535 #: ../src/guestfs.pod:2787
36537 "However many messages come from the daemon, and we don't translate those at "
36538 "the moment. One reason is that the appliance generally has all locale files "
36539 "removed from it, because they take up a lot of space. So we'd have to readd "
36540 "some of those, as well as copying our PO files into the appliance."
36544 #: ../src/guestfs.pod:2793
36546 "Debugging messages are never translated, since they are intended for the "
36551 #: ../src/guestfs.pod:2796
36552 msgid "SOURCE CODE SUBDIRECTORIES"
36556 #: ../src/guestfs.pod:2802
36557 msgid "The libguestfs appliance, build scripts and so on."
36561 #: ../src/guestfs.pod:2804
36562 msgid "C<capitests>"
36566 #: ../src/guestfs.pod:2806
36567 msgid "Automated tests of the C API."
36571 #: ../src/guestfs.pod:2808
36576 #: ../src/guestfs.pod:2810
36578 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
36583 #: ../src/guestfs.pod:2813
36588 #: ../src/guestfs.pod:2815
36590 "Safety and liveness tests of components that libguestfs depends upon (not of "
36591 "libguestfs itself). Mainly this is for qemu and the kernel."
36595 #: ../src/guestfs.pod:2818
36600 #: ../src/guestfs.pod:2820
36601 msgid "Outside contributions, experimental parts."
36605 #: ../src/guestfs.pod:2822
36610 #: ../src/guestfs.pod:2824
36612 "The daemon that runs inside the libguestfs appliance and carries out actions."
36616 #: ../src/guestfs.pod:2827
36621 #: ../src/guestfs.pod:2829
36622 msgid "L<virt-df(1)> command and documentation."
36626 #: ../src/guestfs.pod:2831
36631 #: ../src/guestfs.pod:2833
36632 msgid "L<virt-edit(1)> command and documentation."
36636 #: ../src/guestfs.pod:2835
36637 msgid "C<examples>"
36641 #: ../src/guestfs.pod:2837
36642 msgid "C API example code."
36646 #: ../src/guestfs.pod:2839
36651 #: ../src/guestfs.pod:2841
36653 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
36654 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36655 "L<virt-tar-out(1)>."
36659 #: ../src/guestfs.pod:2845
36664 #: ../src/guestfs.pod:2847
36666 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
36670 #: ../src/guestfs.pod:2849
36671 msgid "C<generator>"
36675 #: ../src/guestfs.pod:2851
36677 "The crucially important generator, used to automatically generate large "
36678 "amounts of boilerplate C code for things like RPC and bindings."
36682 #: ../src/guestfs.pod:2854
36687 #: ../src/guestfs.pod:2856
36688 msgid "Files used by the test suite."
36692 #: ../src/guestfs.pod:2858
36693 msgid "Some \"phony\" guest images which we test against."
36697 #: ../src/guestfs.pod:2860
36698 msgid "C<inspector>"
36702 #: ../src/guestfs.pod:2862
36703 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
36707 #: ../src/guestfs.pod:2864
36712 #: ../src/guestfs.pod:2866
36713 msgid "Logo used on the website. The fish is called Arthur by the way."
36717 #: ../src/guestfs.pod:2868
36722 #: ../src/guestfs.pod:2870
36723 msgid "M4 macros used by autoconf."
36727 #: ../src/guestfs.pod:2872
36732 #: ../src/guestfs.pod:2874
36733 msgid "Translations of simple gettext strings."
36737 #: ../src/guestfs.pod:2876
36742 #: ../src/guestfs.pod:2878
36744 "The build infrastructure and PO files for translations of manpages and POD "
36745 "files. Eventually this will be combined with the C<po> directory, but that "
36746 "is rather complicated."
36750 #: ../src/guestfs.pod:2882
36751 msgid "C<regressions>"
36755 #: ../src/guestfs.pod:2884
36756 msgid "Regression tests."
36760 #: ../src/guestfs.pod:2886
36765 #: ../src/guestfs.pod:2888
36766 msgid "L<virt-rescue(1)> command and documentation."
36770 #: ../src/guestfs.pod:2890
36775 #: ../src/guestfs.pod:2892
36776 msgid "Source code to the C library."
36780 #: ../src/guestfs.pod:2894
36785 #: ../src/guestfs.pod:2896
36786 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
36790 #: ../src/guestfs.pod:2898
36791 msgid "C<test-tool>"
36795 #: ../src/guestfs.pod:2900
36797 "Test tool for end users to test if their qemu/kernel combination will work "
36802 #: ../src/guestfs.pod:2903
36807 #: ../src/guestfs.pod:2905
36812 #: ../src/guestfs.pod:2907
36817 #: ../src/guestfs.pod:2909
36822 #: ../src/guestfs.pod:2911
36827 #: ../src/guestfs.pod:2913
36832 #: ../src/guestfs.pod:2915
36837 #: ../src/guestfs.pod:2917
36842 #: ../src/guestfs.pod:2919
36847 #: ../src/guestfs.pod:2921
36848 msgid "Language bindings."
36852 #: ../src/guestfs.pod:2925
36853 msgid "MAKING A STABLE RELEASE"
36857 #: ../src/guestfs.pod:2927
36859 "When we make a stable release, there are several steps documented here. See "
36860 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36865 #: ../src/guestfs.pod:2935
36867 "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36871 #: ../src/guestfs.pod:2940
36872 msgid "Finalize RELEASE-NOTES."
36876 #: ../src/guestfs.pod:2944
36877 msgid "Update ROADMAP."
36881 #: ../src/guestfs.pod:2948
36882 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36886 #: ../src/guestfs.pod:2952
36887 msgid "Push and pull from Transifex."
36891 #: ../src/guestfs.pod:2954
36896 #: ../src/guestfs.pod:2956
36904 #: ../src/guestfs.pod:2958
36905 msgid "to push the latest POT files to Transifex. Then run:"
36909 #: ../src/guestfs.pod:2960
36917 #: ../src/guestfs.pod:2962
36918 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36922 #: ../src/guestfs.pod:2966
36924 "Create new stable and development directories under L<http://libguestfs.org/"
36929 #: ../src/guestfs.pod:2971
36930 msgid "Create the branch in git:"
36934 #: ../src/guestfs.pod:2973
36937 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36938 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36939 " git branch stable-1.XX\n"
36940 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36945 #: ../src/guestfs.pod:2980
36950 #: ../src/guestfs.pod:2982
36951 msgid "PROTOCOL LIMITS"
36955 #: ../src/guestfs.pod:2984
36957 "Internally libguestfs uses a message-based protocol to pass API calls and "
36958 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36959 "plenty more detail about this). The maximum message size used by the "
36960 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36961 "aware of this limit. The API calls which may be affected are individually "
36962 "documented, with a link back to this section of the documentation."
36966 #: ../src/guestfs.pod:2992
36968 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36969 "a simple string. Because this string is at some point internally encoded as "
36970 "a message, the maximum size that it can return is slightly under 4 MB. If "
36971 "the requested file is larger than this then you will get an error."
36975 #: ../src/guestfs.pod:2998
36977 "In order to transfer large files into and out of the guest filesystem, you "
36978 "need to use particular calls that support this. The sections L</UPLOADING> "
36979 "and L</DOWNLOADING> document how to do this."
36983 #: ../src/guestfs.pod:3002
36985 "You might also consider mounting the disk image using our FUSE filesystem "
36986 "support (L<guestmount(1)>)."
36990 #: ../src/guestfs.pod:3005
36991 msgid "MAXIMUM NUMBER OF DISKS"
36995 #: ../src/guestfs.pod:3007
36996 msgid "When using virtio disks (the default) the current limit is B<25> disks."
37000 #: ../src/guestfs.pod:3010
37002 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
37003 "slots. However febootstrap only understands disks with names C</dev/vda> "
37004 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
37009 #: ../src/guestfs.pod:3015
37011 "We are working to substantially raise this limit in future versions but it "
37012 "requires complex changes to qemu."
37016 #: ../src/guestfs.pod:3018
37018 "In future versions of libguestfs it should also be possible to \"hot plug\" "
37019 "disks (add and remove disks after calling L</guestfs_launch>). This also "
37020 "requires changes to qemu."
37024 #: ../src/guestfs.pod:3022
37025 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
37029 #: ../src/guestfs.pod:3024
37030 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
37034 #: ../src/guestfs.pod:3026
37036 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
37037 "vda>, and C</dev/vda1> through C</dev/vda15>)."
37041 #: ../src/guestfs.pod:3029
37043 "If you attach a disk with more than 15 partitions, the extra partitions are "
37044 "ignored by libguestfs."
37048 #: ../src/guestfs.pod:3032
37049 msgid "MAXIMUM SIZE OF A DISK"
37053 #: ../src/guestfs.pod:3034
37054 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
37058 #: ../src/guestfs.pod:3036
37060 "We have tested block devices up to 1 exabyte (2**60 or "
37061 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
37066 #: ../src/guestfs.pod:3040
37068 "Although libguestfs probably does not impose any limit, the underlying host "
37069 "storage will. If you store disk images on a host ext4 filesystem, then the "
37070 "maximum size will be limited by the maximum ext4 file size (currently 16 "
37071 "TB). If you store disk images as host logical volumes then you are limited "
37072 "by the maximum size of an LV."
37076 #: ../src/guestfs.pod:3046
37078 "For the hugest disk image files, we recommend using XFS on the host for "
37083 #: ../src/guestfs.pod:3049
37084 msgid "MAXIMUM SIZE OF A PARTITION"
37088 #: ../src/guestfs.pod:3051
37090 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
37091 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
37092 "address a partition located beyond 2 TB on the disk."
37096 #: ../src/guestfs.pod:3055
37098 "It is recommended that you use GPT partitions on disks which are larger than "
37099 "this size. GPT uses 64 bit sector numbers and so can address partitions "
37100 "which are theoretically larger than the largest disk we could support."
37104 #: ../src/guestfs.pod:3060
37105 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
37109 #: ../src/guestfs.pod:3062
37111 "This depends on the filesystem type. libguestfs itself does not impose any "
37112 "known limit. Consult Wikipedia or the filesystem documentation to find out "
37113 "what these limits are."
37117 #: ../src/guestfs.pod:3066
37118 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
37122 #: ../src/guestfs.pod:3068
37124 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
37125 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
37126 "uploads and downloads."
37130 #: ../src/guestfs.pod:3072
37131 msgid "INSPECTION LIMITS"
37135 #: ../src/guestfs.pod:3074
37137 "The inspection code has several arbitrary limits on things like the size of "
37138 "Windows Registry hive it will read, and the length of product name. These "
37139 "are intended to stop a malicious guest from consuming arbitrary amounts of "
37140 "memory and disk space on the host, and should not be reached in practice. "
37141 "See the source code for more information."
37145 #: ../src/guestfs.pod:3100
37147 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
37148 "effect as calling C<guestfs_set_verbose (g, 1)>."
37152 #: ../src/guestfs.pod:3112
37154 "Set the path that libguestfs uses to search for a supermin appliance. See "
37155 "the discussion of paths in section L</PATH> above."
37159 #: ../src/guestfs.pod:3121
37160 msgid "See also L</QEMU WRAPPERS> above."
37164 #: ../src/guestfs.pod:3125
37166 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
37167 "effect as calling C<guestfs_set_trace (g, 1)>."
37171 #: ../src/guestfs.pod:3143
37173 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-"
37174 "ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
37175 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
37176 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
37177 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)"
37178 ">, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, "
37179 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
37180 "L<febootstrap(1)>, L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://"
37181 "libguestfs.org/>."
37185 #: ../src/guestfs.pod:3174
37187 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
37188 "(8)>, L<disktype(1)>."
37192 #: ../src/guestfs.pod:3181 ../tools/virt-make-fs.pl:553
37193 #: ../tools/virt-win-reg.pl:761
37198 #: ../src/guestfs.pod:3183
37199 msgid "To get a list of bugs against libguestfs use this link:"
37203 #: ../src/guestfs.pod:3185
37205 "L<https://bugzilla.redhat.com/buglist.cgi?"
37206 "component=libguestfs&product=Virtualization+Tools>"
37210 #: ../src/guestfs.pod:3187
37211 msgid "To report a new bug against libguestfs use this link:"
37215 #: ../src/guestfs.pod:3189
37217 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
37218 "component=libguestfs&product=Virtualization+Tools>"
37222 #: ../src/guestfs.pod:3191
37223 msgid "When reporting a bug, please check:"
37227 #: ../src/guestfs.pod:3197
37228 msgid "That the bug hasn't been reported already."
37232 #: ../src/guestfs.pod:3201
37233 msgid "That you are testing a recent version."
37237 #: ../src/guestfs.pod:3205
37238 msgid "Describe the bug accurately, and give a way to reproduce it."
37242 #: ../src/guestfs.pod:3209
37244 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
37249 #: ../test-tool/libguestfs-test-tool.pod:5
37250 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
37254 #: ../test-tool/libguestfs-test-tool.pod:9
37257 " libguestfs-test-tool [--options]\n"
37262 #: ../test-tool/libguestfs-test-tool.pod:13
37264 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
37265 "to check basic libguestfs functionality is working. This is needed because "
37266 "libguestfs occasionally breaks for reasons beyond our control: usually "
37267 "because of changes in the underlying qemu or kernel packages, or the host "
37272 #: ../test-tool/libguestfs-test-tool.pod:19
37273 msgid "If you suspect a problem in libguestfs, then just run:"
37277 #: ../test-tool/libguestfs-test-tool.pod:21
37280 " libguestfs-test-tool\n"
37285 #: ../test-tool/libguestfs-test-tool.pod:23
37286 msgid "It will print lots of diagnostic messages."
37290 #: ../test-tool/libguestfs-test-tool.pod:25
37291 msgid "If it runs to completion successfully, you will see this near the end:"
37295 #: ../test-tool/libguestfs-test-tool.pod:27
37298 " ===== TEST FINISHED OK =====\n"
37303 #: ../test-tool/libguestfs-test-tool.pod:29
37304 msgid "and the test tool will exit with code 0."
37308 #: ../test-tool/libguestfs-test-tool.pod:31
37310 "If it fails (and/or exits with non-zero error code), please paste the "
37311 "I<complete, unedited> output of the test tool into a bug report. More "
37312 "information about reporting bugs can be found on the L<http://libguestfs.org/"
37317 #: ../test-tool/libguestfs-test-tool.pod:42
37318 msgid "Display short usage information and exit."
37322 #: ../test-tool/libguestfs-test-tool.pod:44
37323 msgid "B<--qemu qemu_binary>"
37327 #: ../test-tool/libguestfs-test-tool.pod:46
37329 "If you have downloaded another qemu binary, point this option at the full "
37330 "path of the binary to try it."
37334 #: ../test-tool/libguestfs-test-tool.pod:49
37335 msgid "B<--qemudir qemu_source_dir>"
37339 #: ../test-tool/libguestfs-test-tool.pod:51
37341 "If you have compiled qemu from source, point this option at the source "
37342 "directory to try it."
37346 #: ../test-tool/libguestfs-test-tool.pod:54
37351 #: ../test-tool/libguestfs-test-tool.pod:56
37352 msgid "B<--timeout N>"
37356 #: ../test-tool/libguestfs-test-tool.pod:58
37358 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
37359 "minutes) which does not usually need to be adjusted."
37363 #: ../test-tool/libguestfs-test-tool.pod:63
37364 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
37368 #: ../test-tool/libguestfs-test-tool.pod:65
37370 "If you have compiled another version of qemu from source and would like to "
37371 "try that, then you can use the I<--qemudir> option to point to the qemu "
37372 "source directory."
37376 #: ../test-tool/libguestfs-test-tool.pod:69
37378 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
37379 "option to point to the binary."
37383 #: ../test-tool/libguestfs-test-tool.pod:72
37385 "Note when using these options, you can ignore the business of qemu wrapper "
37386 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
37387 "wrapper script for you if one is needed."
37391 #: ../test-tool/libguestfs-test-tool.pod:76
37392 msgid "TRYING OUT A DIFFERENT KERNEL"
37396 #: ../test-tool/libguestfs-test-tool.pod:78
37398 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
37399 "libguestfs tries. You do this by setting the environment variables "
37400 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
37404 #: ../test-tool/libguestfs-test-tool.pod:82
37406 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
37411 #: ../test-tool/libguestfs-test-tool.pod:85
37412 msgid "SELF-DIAGNOSIS"
37416 #: ../test-tool/libguestfs-test-tool.pod:87
37418 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
37419 "produced by libguestfs-test-tool and/or possible errors."
37423 #: ../test-tool/libguestfs-test-tool.pod:92
37425 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
37426 "I<1> if there was an error."
37430 #: ../test-tool/libguestfs-test-tool.pod:97
37432 "For the full list of environment variables which may affect libguestfs, "
37433 "please see the L<guestfs(3)> manual page."
37437 #: ../test-tool/libguestfs-test-tool.pod:102
37438 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
37442 #: ../tools/virt-list-filesystems.pl:32
37444 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
37448 #: ../tools/virt-list-filesystems.pl:36
37451 " virt-list-filesystems [--options] domname\n"
37456 #: ../tools/virt-list-filesystems.pl:38
37459 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
37464 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
37466 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
37471 #: ../tools/virt-list-filesystems.pl:45
37473 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
37474 "are contained in a virtual machine or disk image."
37478 #: ../tools/virt-list-filesystems.pl:49
37480 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
37481 "functionality. For more complex cases you should look at the L<guestfish(1)"
37486 #: ../tools/virt-list-filesystems.pl:112
37488 "With this option, C<virt-list-filesystems> displays the type of each "
37489 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
37493 #: ../tools/virt-list-filesystems.pl:119
37498 #: ../tools/virt-list-filesystems.pl:123
37500 "Normally we only show mountable filesystems. If this option is given then "
37501 "swap devices are shown too."
37505 #: ../tools/virt-list-filesystems.pl:197
37507 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
37508 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
37509 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37513 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
37514 msgid "Copyright (C) 2009 Red Hat Inc."
37518 #: ../tools/virt-list-partitions.pl:32
37520 "virt-list-partitions - List partitions in a virtual machine or disk image"
37524 #: ../tools/virt-list-partitions.pl:36
37527 " virt-list-partitions [--options] domname\n"
37532 #: ../tools/virt-list-partitions.pl:38
37535 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
37540 #: ../tools/virt-list-partitions.pl:45
37542 "C<virt-list-partitions> is a command line tool to list the partitions that "
37543 "are contained in a virtual machine or disk image. It is mainly useful as a "
37544 "first step to using L<virt-resize(1)>."
37548 #: ../tools/virt-list-partitions.pl:50
37550 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
37551 "functionality. For more complex cases you should look at the L<guestfish(1)"
37556 #: ../tools/virt-list-partitions.pl:113
37557 msgid "Show sizes in human-readable form (eg. \"1G\")."
37561 #: ../tools/virt-list-partitions.pl:123
37563 "With this option, C<virt-list-partitions> displays the type and size of each "
37564 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
37568 #: ../tools/virt-list-partitions.pl:130
37573 #: ../tools/virt-list-partitions.pl:132
37578 #: ../tools/virt-list-partitions.pl:134
37580 "Display the total size of each block device (as a separate row or rows)."
37584 #: ../tools/virt-list-partitions.pl:267
37586 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
37587 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
37588 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37592 #: ../tools/virt-list-partitions.pl:283
37593 msgid "Copyright (C) 2009-2010 Red Hat Inc."
37597 #: ../tools/virt-make-fs.pl:37
37598 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
37602 #: ../tools/virt-make-fs.pl:41
37605 " virt-make-fs [--options] input.tar output.img\n"
37610 #: ../tools/virt-make-fs.pl:43
37613 " virt-make-fs [--options] input.tar.gz output.img\n"
37618 #: ../tools/virt-make-fs.pl:45
37621 " virt-make-fs [--options] directory output.img\n"
37626 #: ../tools/virt-make-fs.pl:49
37628 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
37629 "archive or some files in a directory. It is similar to tools like L<mkisofs"
37630 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
37631 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
37632 "you want to attach these filesystems to existing virtual machines (eg. to "
37633 "import large amounts of read-only data to a VM)."
37637 #: ../tools/virt-make-fs.pl:57
37638 msgid "Basic usage is:"
37642 #: ../tools/virt-make-fs.pl:59
37645 " virt-make-fs input output\n"
37650 #: ../tools/virt-make-fs.pl:61
37652 "where C<input> is either a directory containing files that you want to add, "
37653 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
37654 "C<output> is a disk image. The input type is detected automatically. The "
37655 "output disk image defaults to a raw ext2 image unless you specify extra "
37656 "flags (see L</OPTIONS> below)."
37660 #: ../tools/virt-make-fs.pl:67
37661 msgid "EXTRA SPACE"
37665 #: ../tools/virt-make-fs.pl:69
37667 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
37668 "the files that it contains, but might have extra space. Depending on how "
37669 "you are going to use the output, you might think this extra space is wasted "
37670 "and want to minimize it, or you might want to leave space so that more files "
37671 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
37672 "but you can use the I<--size> flag to leave space in the filesystem if you "
37677 #: ../tools/virt-make-fs.pl:77
37679 "An alternative way to leave extra space but not make the output image any "
37680 "bigger is to use an alternative disk image format (instead of the default "
37681 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
37682 "image format (check your hypervisor supports this before using it). This "
37683 "allows you to choose a large I<--size> but the extra space won't actually be "
37684 "allocated in the image until you try to store something in it."
37688 #: ../tools/virt-make-fs.pl:85
37690 "Don't forget that you can also use local commands including L<resize2fs(8)> "
37691 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
37692 "to build another image from scratch."
37696 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
37697 #: ../tools/virt-make-fs.pl:142
37702 #: ../tools/virt-make-fs.pl:91
37705 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
37710 #: ../tools/virt-make-fs.pl:93
37711 msgid "FILESYSTEM TYPE"
37715 #: ../tools/virt-make-fs.pl:95
37717 "The default filesystem type is C<ext2>. Just about any filesystem type that "
37718 "libguestfs supports can be used (but I<not> read-only formats like "
37719 "ISO9660). Here are some of the more common choices:"
37723 #: ../tools/virt-make-fs.pl:101
37728 #: ../tools/virt-make-fs.pl:103
37730 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
37731 "you are not going to use the filesystem in a way that requires the journal, "
37732 "then this is just wasted overhead."
37736 #: ../tools/virt-make-fs.pl:107
37737 msgid "I<ntfs> or I<vfat>"
37741 #: ../tools/virt-make-fs.pl:109
37742 msgid "Useful if exporting data to a Windows guest."
37746 #: ../tools/virt-make-fs.pl:111
37748 "I<Note for vfat>: The tar archive or local directory must only contain files "
37749 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
37750 "program running within libguestfs is unable to change the ownership of non-"
37751 "root files, since vfat itself does not support this."
37755 #: ../tools/virt-make-fs.pl:116
37760 #: ../tools/virt-make-fs.pl:118
37762 "Lower overhead than C<ext2>, but certain limitations on filename length and "
37763 "total filesystem size."
37767 #: ../tools/virt-make-fs.pl:125
37770 " virt-make-fs --type=minix input minixfs.img\n"
37775 #: ../tools/virt-make-fs.pl:127
37776 msgid "TO PARTITION OR NOT TO PARTITION"
37780 #: ../tools/virt-make-fs.pl:129
37781 msgid "Optionally virt-make-fs can add a partition table to the output disk."
37785 #: ../tools/virt-make-fs.pl:131
37787 "Adding a partition can make the disk image more compatible with certain "
37788 "virtualized operating systems which don't expect to see a filesystem "
37789 "directly located on a block device (Linux doesn't care and will happily "
37790 "handle both types)."
37794 #: ../tools/virt-make-fs.pl:136
37796 "On the other hand, if you have a partition table then the output image is no "
37797 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
37798 "directly on a partitioned disk image. (However libguestfs tools such as "
37799 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
37803 #: ../tools/virt-make-fs.pl:144
37804 msgid "Add an MBR partition:"
37808 #: ../tools/virt-make-fs.pl:146
37811 " virt-make-fs --partition -- input disk.img\n"
37816 #: ../tools/virt-make-fs.pl:148
37818 "If the output disk image could be terabyte-sized or larger, it's better to "
37819 "use an EFI/GPT-compatible partition table:"
37823 #: ../tools/virt-make-fs.pl:151
37826 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
37831 #: ../tools/virt-make-fs.pl:179
37832 msgid "Enable debugging information."
37836 #: ../tools/virt-make-fs.pl:185
37837 msgid "B<--size=E<lt>NE<gt>>"
37841 #: ../tools/virt-make-fs.pl:187
37842 msgid "B<--size=+E<lt>NE<gt>>"
37846 #: ../tools/virt-make-fs.pl:189
37847 msgid "B<-s E<lt>NE<gt>>"
37851 #: ../tools/virt-make-fs.pl:191
37852 msgid "B<-s +E<lt>NE<gt>>"
37856 #: ../tools/virt-make-fs.pl:193
37858 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37862 #: ../tools/virt-make-fs.pl:196
37864 "If this option is I<not> given, then the output image will be just large "
37865 "enough to contain all the files, with not much wasted space."
37869 #: ../tools/virt-make-fs.pl:199
37871 "To choose a fixed size output disk, specify an absolute number followed by b/"
37872 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37873 "Petabytes or Exabytes. This must be large enough to contain all the input "
37874 "files, else you will get an error."
37878 #: ../tools/virt-make-fs.pl:204
37880 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
37881 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37882 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
37883 "the input files, and (approximately) an extra 200 MB free space."
37887 #: ../tools/virt-make-fs.pl:210
37889 "Note that virt-make-fs estimates free space, and therefore will not produce "
37890 "filesystems containing precisely the free space requested. (It is much more "
37891 "expensive and time-consuming to produce a filesystem which has precisely the "
37892 "desired free space)."
37896 #: ../tools/virt-make-fs.pl:219
37897 msgid "B<--format=E<lt>fmtE<gt>>"
37901 #: ../tools/virt-make-fs.pl:221
37902 msgid "B<-F E<lt>fmtE<gt>>"
37906 #: ../tools/virt-make-fs.pl:223
37907 msgid "Choose the output disk image format."
37911 #: ../tools/virt-make-fs.pl:225
37912 msgid "The default is C<raw> (raw disk image)."
37916 #: ../tools/virt-make-fs.pl:227
37918 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
37919 "that would really make sense here is C<qcow2>."
37923 #: ../tools/virt-make-fs.pl:234
37924 msgid "B<--type=E<lt>fsE<gt>>"
37928 #: ../tools/virt-make-fs.pl:236
37929 msgid "B<-t E<lt>fsE<gt>>"
37933 #: ../tools/virt-make-fs.pl:238
37934 msgid "Choose the output filesystem type."
37938 #: ../tools/virt-make-fs.pl:240
37939 msgid "The default is C<ext2>."
37943 #: ../tools/virt-make-fs.pl:242
37945 "Any filesystem which is supported read-write by libguestfs can be used here."
37949 #: ../tools/virt-make-fs.pl:249
37950 msgid "B<--partition>"
37954 #: ../tools/virt-make-fs.pl:251
37955 msgid "B<--partition=E<lt>parttypeE<gt>>"
37959 #: ../tools/virt-make-fs.pl:253
37961 "If specified, this flag adds an MBR partition table to the output disk image."
37965 #: ../tools/virt-make-fs.pl:256
37967 "You can change the partition table type, eg. I<--partition=gpt> for large "
37972 #: ../tools/virt-make-fs.pl:259
37974 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37975 "might consider the next parameter to be the partition type. For example:"
37979 #: ../tools/virt-make-fs.pl:263
37982 " virt-make-fs --partition input.tar ...\n"
37987 #: ../tools/virt-make-fs.pl:265
37989 "would cause virt-make-fs to think you wanted to use a partition type of "
37990 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37991 "dash) between options and the input file argument:"
37995 #: ../tools/virt-make-fs.pl:269
37998 " virt-make-fs --partition -- input.tar ...\n"
38003 #: ../tools/virt-make-fs.pl:541
38005 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
38006 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
38007 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
38011 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
38013 "When reporting bugs, please enable debugging and capture the I<complete> "
38018 #: ../tools/virt-make-fs.pl:558
38021 " export LIBGUESTFS_DEBUG=1\n"
38022 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
38027 #: ../tools/virt-make-fs.pl:561
38029 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
38034 #: ../tools/virt-tar.pl:33
38035 msgid "virt-tar - Extract or upload files to a virtual machine"
38039 #: ../tools/virt-tar.pl:37
38042 " virt-tar [--options] -x domname directory tarball\n"
38047 #: ../tools/virt-tar.pl:39
38050 " virt-tar [--options] -u domname tarball directory\n"
38055 #: ../tools/virt-tar.pl:41
38058 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
38063 #: ../tools/virt-tar.pl:43
38066 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
38071 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
38076 #: ../tools/virt-tar.pl:47
38078 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
38079 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
38083 #: ../tools/virt-tar.pl:52
38084 msgid "Download C</home> from the VM into a local tarball:"
38088 #: ../tools/virt-tar.pl:54
38091 " virt-tar -x domname /home home.tar\n"
38096 #: ../tools/virt-tar.pl:56
38099 " virt-tar -zx domname /home home.tar.gz\n"
38104 #: ../tools/virt-tar.pl:58
38105 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
38109 #: ../tools/virt-tar.pl:60
38112 " virt-tar -u domname uploadstuff.tar /tmp\n"
38117 #: ../tools/virt-tar.pl:62
38120 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
38125 #: ../tools/virt-tar.pl:66
38127 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
38128 "virtual machines. If you do this, you risk disk corruption in the VM. "
38129 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
38133 #: ../tools/virt-tar.pl:71
38135 "You can use I<-x> (extract) on live virtual machines, but you might get "
38136 "inconsistent results or errors if there is filesystem activity inside the "
38137 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
38138 "work, but the only way to guarantee consistent results is if the virtual "
38139 "machine is shut down."
38143 #: ../tools/virt-tar.pl:79
38145 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
38146 "parts of a guest filesystem. There are many possibilities: making backups, "
38147 "uploading data files, snooping on guest activity, fixing or customizing "
38152 #: ../tools/virt-tar.pl:84
38154 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
38155 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
38156 "should look at the L<guestfish(1)> tool."
38160 #: ../tools/virt-tar.pl:88
38162 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
38163 "its contents (recursively) from the virtual machine into a local tarball. "
38164 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
38165 "virtual machine. You cannot use these two options together."
38169 #: ../tools/virt-tar.pl:94
38171 "In addition, you may need to use the I<-z> (gZip) option to enable "
38172 "compression. When uploading, you have to specify I<-z> if the upload file "
38173 "is compressed because virt-tar won't detect this on its own."
38177 #: ../tools/virt-tar.pl:98
38179 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
38180 "example it cannot do PKZip files or bzip2 compression. If you want that "
38181 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
38182 "the L<libguestfs(3)> API)."
38186 #: ../tools/virt-tar.pl:160
38187 msgid "B<--extract>"
38191 #: ../tools/virt-tar.pl:162
38192 msgid "B<--download>"
38196 #: ../tools/virt-tar.pl:164
38201 #: ../tools/virt-tar.pl:166
38202 msgid "B<--upload>"
38206 #: ../tools/virt-tar.pl:168
38208 "Use I<-x> to extract (download) a directory from a virtual machine to a "
38213 #: ../tools/virt-tar.pl:171
38215 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
38216 "Please read the L</WARNING> section above before using this option."
38220 #: ../tools/virt-tar.pl:175
38221 msgid "You must specify exactly one of these options."
38225 #: ../tools/virt-tar.pl:181
38230 #: ../tools/virt-tar.pl:183
38235 #: ../tools/virt-tar.pl:185
38236 msgid "Specify that the input or output tarball is gzip-compressed."
38240 #: ../tools/virt-tar.pl:298
38242 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
38243 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
38244 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
38249 #: ../tools/virt-win-reg.pl:37
38251 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
38255 #: ../tools/virt-win-reg.pl:41
38258 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
38263 #: ../tools/virt-win-reg.pl:43
38266 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
38271 #: ../tools/virt-win-reg.pl:45
38274 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
38279 #: ../tools/virt-win-reg.pl:47
38282 " virt-win-reg --merge domname [input.reg ...]\n"
38287 #: ../tools/virt-win-reg.pl:49
38290 " virt-win-reg [--options] disk.img ... # instead of domname\n"
38295 #: ../tools/virt-win-reg.pl:53
38297 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
38298 "virtual machines. If you do this, you I<will> get irreversible disk "
38299 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
38300 "but doesn't catch all cases."
38304 #: ../tools/virt-win-reg.pl:58
38306 "Modifying the Windows Registry is an inherently risky operation. The format "
38307 "is deliberately obscure and undocumented, and Registry changes can leave the "
38308 "system unbootable. Therefore when using the I<--merge> option, make sure "
38309 "you have a reliable backup first."
38313 #: ../tools/virt-win-reg.pl:65
38315 "This program can export and merge Windows Registry entries from a Windows "
38320 #: ../tools/virt-win-reg.pl:68
38322 "The first parameter is the libvirt guest name or the raw disk image of a "
38327 #: ../tools/virt-win-reg.pl:71
38329 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
38330 "exported (recursively). For example:"
38334 #: ../tools/virt-win-reg.pl:74
38337 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
38342 #: ../tools/virt-win-reg.pl:76
38344 "You can also display single values from within registry keys, for example:"
38348 #: ../tools/virt-win-reg.pl:79
38351 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
38352 " $ virt-win-reg Windows7 $cvkey ProductName\n"
38353 " Windows 7 Enterprise\n"
38358 #: ../tools/virt-win-reg.pl:83
38360 "With I<--merge>, you can merge a textual regedit file into the Windows "
38365 #: ../tools/virt-win-reg.pl:86
38368 " $ virt-win-reg --merge Windows7 changes.reg\n"
38373 #: ../tools/virt-win-reg.pl:90
38375 "This program is only meant for simple access to the registry. If you want "
38376 "to do complicated things with the registry, we suggest you download the "
38377 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
38378 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
38379 "L<hivexregedit(1)>."
38383 #: ../tools/virt-win-reg.pl:159
38388 #: ../tools/virt-win-reg.pl:161
38390 "In merge mode, this merges a textual regedit file into the Windows Registry "
38391 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
38392 "displays or exports Registry entries instead."
38396 #: ../tools/virt-win-reg.pl:165
38398 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
38399 "result in disk corruption. However exporting (without this flag) is always "
38404 #: ../tools/virt-win-reg.pl:173
38405 msgid "B<--encoding> UTF-16LE|ASCII"
38409 #: ../tools/virt-win-reg.pl:175
38411 "When merging (only), you may need to specify the encoding for strings to be "
38412 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
38413 "(3)/ENCODING STRINGS>."
38417 #: ../tools/virt-win-reg.pl:179
38419 "The default is to use UTF-16LE, which should work with recent versions of "
38424 #: ../tools/virt-win-reg.pl:186
38425 msgid "B<--unsafe-printable-strings>"
38429 #: ../tools/virt-win-reg.pl:188
38431 "When exporting (only), assume strings are UTF-16LE and print them as strings "
38432 "instead of hex sequences. Remove the final zero codepoint from strings if "
38437 #: ../tools/virt-win-reg.pl:192
38439 "This is unsafe and does not preserve the fidelity of strings in the original "
38440 "Registry for various reasons:"
38444 #: ../tools/virt-win-reg.pl:199
38446 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
38447 "other encodings will be corrupted by this transformation."
38451 #: ../tools/virt-win-reg.pl:204
38453 "Assumes that everything which has type 1 or 2 is really a string and that "
38454 "everything else is not a string, but the type field in real Registries is "
38459 #: ../tools/virt-win-reg.pl:210
38461 "Loses information about whether a zero codepoint followed the string in the "
38466 #: ../tools/virt-win-reg.pl:215
38468 "This all happens because the Registry itself contains no information about "
38469 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
38473 #: ../tools/virt-win-reg.pl:219
38475 "You should only use this option for quick hacking and debugging of the "
38476 "Registry contents, and I<never> use it if the output is going to be passed "
38477 "into another program or stored in another Registry."
38481 #: ../tools/virt-win-reg.pl:556
38482 msgid "SUPPORTED SYSTEMS"
38486 #: ../tools/virt-win-reg.pl:558
38488 "The program currently supports Windows NT-derived guests starting with "
38489 "Windows XP through to at least Windows 7."
38493 #: ../tools/virt-win-reg.pl:561
38494 msgid "The following Registry keys are supported:"
38498 #: ../tools/virt-win-reg.pl:565
38499 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
38503 #: ../tools/virt-win-reg.pl:567
38504 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
38508 #: ../tools/virt-win-reg.pl:569
38509 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
38513 #: ../tools/virt-win-reg.pl:571
38514 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
38518 #: ../tools/virt-win-reg.pl:573
38519 msgid "C<HKEY_USERS\\.DEFAULT>"
38523 #: ../tools/virt-win-reg.pl:575
38524 msgid "C<HKEY_USERS\\I<SID>>"
38528 #: ../tools/virt-win-reg.pl:577
38529 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
38533 #: ../tools/virt-win-reg.pl:579
38534 msgid "C<HKEY_USERS\\I<username>>"
38538 #: ../tools/virt-win-reg.pl:581
38540 "where I<username> is a local user name (this is a libguestfs extension)."
38544 #: ../tools/virt-win-reg.pl:585
38546 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
38551 #: ../tools/virt-win-reg.pl:588
38553 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
38554 "supported (there is no \"current user\")."
38558 #: ../tools/virt-win-reg.pl:591
38563 #: ../tools/virt-win-reg.pl:593
38565 "C<virt-win-reg> expects that regedit files have already been reencoded in "
38566 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
38567 "style line endings. Since Windows regedit files are often in UTF-16LE with "
38568 "Windows-style line endings, you may need to reencode the whole file before "
38569 "or after processing."
38573 #: ../tools/virt-win-reg.pl:599
38575 "To reencode a file from Windows format to Linux (before processing it with "
38576 "the I<--merge> option), you would do something like this:"
38580 #: ../tools/virt-win-reg.pl:602
38583 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
38588 #: ../tools/virt-win-reg.pl:604
38590 "To go in the opposite direction, after exporting and before sending the file "
38591 "to a Windows user, do something like this:"
38595 #: ../tools/virt-win-reg.pl:607
38598 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
38603 #: ../tools/virt-win-reg.pl:609
38604 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
38608 #: ../tools/virt-win-reg.pl:611
38610 "If you are unsure about the current encoding, use the L<file(1)> command. "
38611 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
38612 "style (CRLF) line endings, like this:"
38616 #: ../tools/virt-win-reg.pl:615
38619 " $ file software.reg\n"
38620 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
38621 " with CRLF line terminators\n"
38626 #: ../tools/virt-win-reg.pl:619
38627 msgid "This file would need conversion before you could I<--merge> it."
38631 #: ../tools/virt-win-reg.pl:621
38632 msgid "CurrentControlSet etc."
38636 #: ../tools/virt-win-reg.pl:623
38638 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
38639 "Registry at the level of the hive file, and therefore you cannot modify "
38644 #: ../tools/virt-win-reg.pl:627
38646 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
38647 "circumstances it might refer to another control set. The way to find out is "
38648 "to look at the C<HKLM\\SYSTEM\\Select> key:"
38652 #: ../tools/virt-win-reg.pl:631
38655 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
38656 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
38657 " \"Current\"=dword:00000001\n"
38658 " \"Default\"=dword:00000001\n"
38659 " \"Failed\"=dword:00000000\n"
38660 " \"LastKnownGood\"=dword:00000002\n"
38665 #: ../tools/virt-win-reg.pl:638
38666 msgid "\"Current\" is the one which Windows will choose when it boots."
38670 #: ../tools/virt-win-reg.pl:640
38672 "Similarly, other C<Current...> keys in the path may need to be replaced."
38676 #: ../tools/virt-win-reg.pl:643
38677 msgid "WINDOWS TIPS"
38681 #: ../tools/virt-win-reg.pl:645
38683 "Note that some of these tips modify the guest disk image. The guest I<must> "
38684 "be shut off, else you will get disk corruption."
38688 #: ../tools/virt-win-reg.pl:648
38689 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
38693 #: ../tools/virt-win-reg.pl:650
38695 "Prepare a DOS batch script, VBScript or executable. Upload this using "
38696 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
38697 "is uploaded into C<C:\\>:"
38701 #: ../tools/virt-win-reg.pl:654
38704 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
38709 #: ../tools/virt-win-reg.pl:656
38710 msgid "Prepare a regedit file containing the registry change:"
38714 #: ../tools/virt-win-reg.pl:658
38717 " cat > test.reg <<'EOF'\n"
38718 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
38719 " \"Test\"=\"c:\\\\test.bat\"\n"
38725 #: ../tools/virt-win-reg.pl:663
38727 "In this example we use the key C<RunOnce> which means that the script will "
38728 "run precisely once when the first user logs in. If you want it to run every "
38729 "time a user logs in, replace C<RunOnce> with C<Run>."
38733 #: ../tools/virt-win-reg.pl:667
38734 msgid "Now update the registry:"
38738 #: ../tools/virt-win-reg.pl:669
38741 " virt-win-reg --merge WindowsGuest test.reg\n"
38746 #: ../tools/virt-win-reg.pl:671
38747 msgid "INSTALLING A SERVICE"
38751 #: ../tools/virt-win-reg.pl:673
38753 "This section assumes you are familiar with Windows services, and you either "
38754 "have a program which handles the Windows Service Control Protocol directly "
38755 "or you want to run any program using a service wrapper like SrvAny or the "
38760 #: ../tools/virt-win-reg.pl:678
38762 "First upload the program and optionally the service wrapper. In this case "
38763 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
38767 #: ../tools/virt-win-reg.pl:682
38770 " guestfish -i -d WindowsGuest <<EOF\n"
38771 " upload rhsrvany.exe /rhsrvany.exe\n"
38772 " upload test.exe /test.exe\n"
38778 #: ../tools/virt-win-reg.pl:687
38780 "Prepare a regedit file containing the registry changes. In this example, "
38781 "the first registry change is needed for the service itself or the service "
38782 "wrapper (if used). The second registry change is only needed because I am "
38783 "using the RHSrvAny service wrapper."
38787 #: ../tools/virt-win-reg.pl:692
38790 " cat > service.reg <<'EOF'\n"
38791 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
38792 " \"Type\"=dword:00000010\n"
38793 " \"Start\"=dword:00000002\n"
38794 " \"ErrorControl\"=dword:00000001\n"
38795 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
38796 " \"DisplayName\"=\"RHSrvAny\"\n"
38797 " \"ObjectName\"=\"NetworkService\"\n"
38802 #: ../tools/virt-win-reg.pl:701
38805 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
38806 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
38807 " \"PWD\"=\"c:\\\\Temp\"\n"
38813 #: ../tools/virt-win-reg.pl:712
38815 "For use of C<ControlSet001> see the section above in this manual page. You "
38816 "may need to adjust this according to the control set that is in use by the "
38821 #: ../tools/virt-win-reg.pl:718
38823 "C<\"ObjectName\"> controls the privileges that the service will have. An "
38824 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
38825 "privileged account."
38829 #: ../tools/virt-win-reg.pl:724
38831 "For the meaning of the magic numbers, see this Microsoft KB article: "
38832 "L<http://support.microsoft.com/kb/103000>."
38836 #: ../tools/virt-win-reg.pl:729
38837 msgid "Update the registry:"
38841 #: ../tools/virt-win-reg.pl:731
38844 " virt-win-reg --merge WindowsGuest service.reg\n"
38849 #: ../tools/virt-win-reg.pl:735
38851 "Be careful when passing parameters containing C<\\> (backslash) in the "
38852 "shell. Usually you will have to use 'single quotes' or double backslashes "
38853 "(but not both) to protect them from the shell."
38857 #: ../tools/virt-win-reg.pl:739
38858 msgid "Paths and value names are case-insensitive."
38862 #: ../tools/virt-win-reg.pl:748
38864 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
38865 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
38866 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38870 #: ../tools/virt-win-reg.pl:766
38873 " export LIBGUESTFS_DEBUG=1\n"
38874 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38879 #: ../tools/virt-win-reg.pl:769
38881 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."